Location: PHPKode > projects > PHP Quick > PHPQuick_1.0-a/docs/developer_guide/index.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>PHP Quick Developer Guide</title>
<link type="text/css" rel="stylesheet" media="all" href="default.css" title="PHP Quick" />
</head>

<body>
<div id="wrapper">
<a id="top" name="top" accesskey="t"></a>
<!-- begin:header -->
<div id="header">
<p><img src="logo.png" width="120" height="28" alt="PHP Quick Logo" /></p>
<p>&nbsp; </p>
<p>Thank you for downloading PHP Quick. This document will guide through the installation and operations of PHP Quick. Please ensure you read this document fully before proceeding with the use of PHP Quick.</p>
<p>&nbsp; </p>
</div>
<!-- end:header -->
<!-- begin:nav -->
<h1>PHP Quick Developer Guide</h1>
<div id="nav">
<ol>
<li><a href="#overview">Overview</a></li>
<li><a href="#install">Installation</a></li>
<li><a href="#use">Using PHP Quick</a>
<ol class="roman">
<li><a href="#url">PHP Quick URLs</a></li>
<li><a href="#modelview">Model and View</a></li>
</ol>
</li>
<li>
<a href="#gethelp">Getting help</a>
<ol class="roman">
<li><a href="#docs">Documentation</a></li>
<li><a href="#tracker">Support Request via Tracker</a></li>
<li><a href="#forums">Help Forums</a></li>
<li><a href="#irc">Internet Relay Chat</a></li>
</ol>
</li>
<li><a href="#vstatus">Status of this version</a></li>
<li><a href="#bugreport">Reporting bugs</a></li>
<li><a href="#disclaimer">Copyright and disclaimer</a></li>
</ol>
<hr />
<p>&nbsp; </p>
</div>
<!-- end:nav -->
<a name="overview"></a><h2>1. Overview</h2>
<p>PHP Quick is an extensible barebones web application development framework for PHP. PHP Quick is a lightweight, highly extensible development framework with search engine friendly URLs and exceptional performance.</p>
<p class="top"><a href="#top">Back to Top</a></p>
<p>&nbsp; </p>
<a name="install"></a><h2>2. Installation</h2>
<p>The installation of PHP Quick is fairly easy. Extract the contents of the archive to the root directory. Open the main configuration file <em>config.php</em> (which is in the config directory) in editor and provide the valid URL and path for the configuration variables. That's all, you are ready to develop your Web application!</p>
<p class="top"><a href="#top">Back to Top</a></p>
<p>&nbsp; </p>
<a name="use"></a><h2>3. Using PHP Quick</h2>
<p>PHP Quick makes it very convenient to rapidly develop applications. Let's first understand the URL structure and then Model and View.</p>
<p>&nbsp; </p>
<a name="url"></a><h2>3.i PHP Quick URLs</h2>
<p>Your URL structure can be of two types in PHP Quick. First type of URL has query string and the second does not, making it search engine friendly.</p>
<p>&nbsp; </p>
<p><strong>Example URL with query string</strong></p>
<p>&nbsp; </p>
<code>http://www.example.com/index.php?c=example&amp;m=custom</code>
<p>&nbsp; </p>
<p>where <em>c</em> holds the name of the model file and the class inside it, and <em>m</em> holds the name of the associated method in that class.</p>
<p>&nbsp; </p>
<p><strong>Example URL without query string</strong></p>
<p>&nbsp; </p>
<code>http://www.example.com/example/custom</code>
<p>&nbsp; </p>
<strong>Note:</strong> <em>c</em> and <em>m</em> must be the first two parameters in the query string.
<p>&nbsp; </p>
<a name="modelview"></a><h2>3.ii Model and View</h2>
<p>A model manages the behaviour and data of the application domain. A view renders the model into a form suitable for interaction, typically a user interface element.</p>
<p>Every model (class) must be named identical to its file name and must contain a method named <em>default_method</em>. The method <em>default_method</em> is invoked when no method is provided in the URL. Refer to the example.php in the <em>models</em> directory.</p>
<p>The class properties <em>$cfg</em> and <em>$request</em> provide the configuration values and URL elements respectively.</p>
<p>&nbsp; </p>
<p class="top"><a href="#top">Back to Top</a></p>
<p>&nbsp; </p>
<a name="gethelp"></a><h2>4. Getting help</h2>
<p>It is very easy to get help for PHP Quick. There are several places you should look.</p>
<p>&nbsp; </p>
<a name="docs"></a><h2>4.i Documentation</h2>
<p>If you are looking for help, first and foremost you should read this document entirely. There are also other places you should look for help.</p>
<p>&nbsp; </p>
<a name="tracker"></a><h2>4.ii Support Request via Tracker</h2>
<p>You can submit support requests via Tracker <a href="http://sourceforge.net/tracker/?group_id=558054">http://sourceforge.net/tracker/?group_id=558054</a></p>
<p>&nbsp; </p>
<a name="forums"></a><h2>4.iii Help Forums</h2>
<p>You can visit help forums at <a href="http://sourceforge.net/projects/phpquick/forums">http://sourceforge.net/projects/phpquick/forums</a></p>
<p>If you do seek help via our forums please be sure to do a Search before posting. This may well save both you and us time and allow the developer, moderator and support groups to spend more time responding to people with unknown issues and problems. Please also remember that PHP Quick is an entirely volunteer effort, no one receives any compensation for the time they give, this includes moderators as well as developers. So please be respectful and mindful when awaiting responses.</p>
<p>&nbsp; </p>
<a name="irc"></a><h2>4.iv Internet Relay Chat</h2>
<p>Another place you may find help is our IRC channel. This operates on the Freenode IRC network, <em>irc.freenode.net</em> and the channel is <em>#TechLounge</em>. Again, please do not abuse this service and be respectful of other users.</p>
<p>&nbsp; </p>
<p class="top"><a href="#top">Back to Top</a></p>
<p>&nbsp; </p>
<a name="vstatus"></a><h2>5. Status of this version</h2>
<p>This is PHP Quick version 1.0-a</p>
<p>&nbsp; </p>
<p class="top"><a href="#top">Back to Top</a></p>
<p>&nbsp; </p>
<a name="bugreport"></a><h2>6. Reporting bugs</h2>
<p>PHP Quick project uses a bug tracking system to store, list and manage all reported bugs, it can be found at <br /><a href="http://sourceforge.net/tracker/?group_id=558054">http://sourceforge.net/tracker/?group_id=558054</a></p>
<p>&nbsp; </p>
<p class="top"><a href="#top">Back to Top</a></p>
<p>&nbsp; </p>
<a name="disclaimer"></a><h2>7. Copyright and disclaimer</h2>
<p>This application is open source software released under the GNU General Public License version 3.0 (GPLv3). Please see the source code and the docs directory for more details. This package and its contents are Copyright (c) 2011 <a href="http://sourceforge.net/projects/phpquick/">PHP Quick</a>, All Rights Reserved.</p>
<p>&nbsp; </p>
<p class="top"><a href="#top">Back to Top</a></p>
<p>&nbsp; </p>
</div>
</body>
</html>
Return current item: PHP Quick