PHP を使用して独自の MVC フレームワークを構築する

1. MVC とは

MVC パターン (Model-View-Controller) は、ソフトウェア エンジニアリングにおけるソフトウェア アーキテクチャ パターンであり、ソフトウェア システムをモデル、ビュー、コントローラー (コントローラー) の 3 つの基本部分に分割します。

MVC パターンの目的は、動的なプログラム設計を実装し、その後のプログラムの変更や拡張を簡素化し、プログラムの特定の部分を再利用できるようにすることです。さらに、このモードは複雑さを単純化することでプログラム構造をより直感的にします。ソフトウェアシステムは基本的な部分を分離し、またそれぞれの基本的な部分に適切な機能を与えます。専門家は、それぞれの専門知識によってグループ化できます。

(コントローラー) - リクエストの転送と処理を担当します。

(ビュー) – インターフェイスデザイナーは、グラフィカルインターフェイスをデザインします。

(モデル) – プログラマーはプログラムが持つべき機能を記述し (アルゴリズムの実装など)、データベースの専門家はデータ管理とデータベースの設計を実行します (特定の機能を実現できます)。

モデル(Model) 「データモデル」(Model)は、アプリケーションのビジネスロジックとそのデータの処理方法に関連するデータをカプセル化するために使用されます。 「モデル」はデータベースなどのデータに直接アクセスします。 「モデル」は「ビュー」や「コントローラー」に依存しません。つまり、モデルは、モデルがどのように表示されるか、どのように操作されるかを気にしません。ただし、モデル内のデータの変更は通常、更新メカニズムを通じて通知されます。このメカニズムを実装するには、このモデルを監視するために使用されるビューを事前にこのモデルに登録し、ビューがデータ モデルで発生した変更を理解できるようにする必要があります。

View (ビュー) ビューレイヤーを使用すると、目的を持ったデータの表示が可能になります (理論上、これは必須ではありません)。通常、ビューには手続き型ロジックはありません。ビューにリフレッシュ機能を実装するには、ビューが監視するデータモデル(Model)にアクセスする必要があるため、事前に監視するデータを登録しておく必要があります。

コントローラー (コントローラー) コントローラーは、異なるレベル間で組織的な役割を果たし、アプリケーションのフローを制御するために使用されます。イベントを処理し、応答します。 「イベント」には、ユーザーの行動やデータ モデルの変更が含まれます。

2. 独自の MVC フレームワークを開発する必要があるのはなぜですか?

インターネット上には多数の優れた MVC フレームワークが存在しますが、このチュートリアルは、包括的で究極の MVC フレームワーク ソリューションを開発することを目的としています。 PHP を内部から学ぶ素晴らしい機会です。その過程で、オブジェクト指向プログラミングとデザイン パターンを学び、開始時の考慮事項を学びます。

さらに、フレームワークを完全に制御し、開発したフレームワークにアイデアを組み込むことができます。必ずしもうまくできているわけではありませんが、独自の方法で関数やモジュールを開発できます。

3. 独自の MVC フレームワークの開発を開始します

開発を始める前に、まずプロジェクトを確立しましょう。次に、最初にディレクトリ構造を設定します。

このチュートリアルでは上記のディレクトリをすべて使用しませんが、将来のプログラムの拡張性を考慮して、最初にプログラム ディレクトリを設定することが非常に必要です。各ディレクトリの役割について詳しく説明します。

application – プログラム コードを保存する

config – プログラム設定またはデータベース設定を保存する

db – データベースのバックアップ コンテンツを保存する

library – フレームワーク コードを保存する

public – 静的ファイルを保存する

scripts - コマンドラインツールを保存する

tmp - 一時データを保存する

ディレクトリが設定された後、いくつかのコード仕様に従います:

MySQL テーブル名は小文字で複数形にする必要があります。アイテム、車

モジュール名 (モデル) は大文字にする必要があり、Item、Car

コントローラーなどの単数形を使用する必要があります。コントローラー (コントローラー) は大文字で複数形を使用し、名前に「Controller」を追加する必要があります。 ItemsController、CarsController

Views (ビュー) は複数形を使用し、末尾にファイルとして動作を追加します。例: items/view.php、cars/buy.php

上述的一些规则是为了能在程序钟更好的进行互相的调用。接下来就开始真正的编码了。

第一步将所有的的请求都重定向到public目录下，解决方案是在todo文件下添加一个.htaccesss文件，文件内容为：

<IfModule mod_rewrite.c>
RewriteEngine on
RewriteRule    ^$    public/    [L]
RewriteRule    (.*) public/$1    [L]
</IfModule>

在我们把所有的请求都重定向到public目录下以后，我们就需要将所有的数据请求都再重定向到public下的index.php文件，于是就需要在public文件夹下也新建一个.htaccess文件，文件内容为：

<IfModule mod_rewrite.c>
RewriteEngine On
#如果文件存在就直接访问目录不进行RewriteRule
RewriteCond %{REQUEST_FILENAME} !-f
#如果目录存在就直接访问目录不进行RewriteRule
RewriteCond %{REQUEST_FILENAME} !-d
#将所有其他URL重写到 index.php/URL
RewriteRule ^(.*)$ index.php?url=$1 [PT,L]
</IfModule>

这么做的主要原因有：

可以使程序有一个单一的入口，将所有除静态程序以外的程序都重定向到index.php上；

可以用来生成利于SEO的URL，想要更好的配置URL，后期可能会需要URL路由，这里先不做介绍了。

做完上面的操作，就应该知道我们需要做什么了，没错！在public目录下添加index.php文件，文件内容为：

<?php
    define(&#39;DS&#39;,DIRECTORY_SEPARATOR);
    define(&#39;ROOT&#39;,dirname(dirname(__FILE__)));
    $url = $_GET[&#39;url&#39;];
    require_once(ROOT.DS.&#39;library&#39;.DS.&#39;bootstrap.php&#39;);

注意上面的PHP代码中，并没有添加PHP结束符号”?>”，这么做的主要原因是：对于只包含PHP代码的文件，结束标志(“?>”)最好不存在，PHP自身并不需要结束符号，不添加结束符号可以很大程度上防止末尾被添加额外的注入内容，让程序更加安全。

在index.php中，我们对library文件夹下的bootstrap.php发起了请求，那么bootstrap.php这个启动文件中到底会包含哪些内容呢？

<?php
    require_once(ROOT.DS.&#39;config&#39;.DS .&#39;config.php&#39;);
    require_once(ROOT.DS.&#39;library&#39;.DS .&#39;shared.php&#39;);

以上文件都可以直接在index.php文件中引用，我们这么做的原因是为了在后期管理和拓展中更加的方便，所以把需要在一开始的时候就加载运行的程序统一放到一个单独的文件中引用。

先来看看config文件下的config .php文件，该文件的主要作用是设置一些程序的配置项及数据库连接等，主要内容为：

<?php
    # 设置是否为开发状态
    define(&#39;DEVELOPMENT_ENVIRONMENT&#39;,true);
    # 设置数据库连接所需数据
    define(&#39;DB_HOST&#39;,&#39;localhost&#39;);
    define(&#39;DB_NAME&#39;,&#39;todo&#39;);
    define(&#39;DB_USER&#39;,&#39;root&#39;);
    define(&#39;DB_PASSWORD&#39;,&#39;root&#39;);

应该说config.php涉及到的内容并不多，不过是一些基础数据的一些设置，再来看看library下的共用文件shared.php应该怎么写。

<?php
    /* 检查是否为开发环境并设置是否记录错误日志 */
    function setReporting(){
        if (DEVELOPMENT_ENVIRONMENT == true) {
            error_reporting(E_ALL);
            ini_set(&#39;display_errors&#39;,&#39;On&#39;);
        } else {
            error_reporting(E_ALL);
            ini_set(&#39;display_errors&#39;,&#39;Off&#39;);
            ini_set(&#39;log_errors&#39;,&#39;On&#39;);
            ini_set(&#39;error_log&#39;,ROOT.DS. &#39;tmp&#39; .DS. &#39;logs&#39; .DS. &#39;error.log&#39;);
        }
    }
    /* 检测敏感字符转义（Magic Quotes）并移除他们 */
    function stripSlashDeep($value){
    $value = is_array($value) ? array_map(&#39;stripSlashDeep&#39;,$value) : stripslashes($value);
        return $value;
    }
    function removeMagicQuotes(){
        if (get_magic_quotes_gpc()) {
            $_GET = stripSlashDeep($_GET);
            $_POST = stripSlashDeep($_POST);
            $_COOKIE = stripSlashDeep($_COOKIE);
        }
    }
    /* 检测全局变量设置（register globals）并移除他们 */
    function unregisterGlobals(){
       if (ini_get(&#39;register_globals&#39;)) {
           $array = array(&#39;_SESSION&#39;,&#39;_POST&#39;,&#39;_GET&#39;,&#39;_COOKIE&#39;,&#39;_REQUEST&#39;,&#39;_SERVER&#39;,&#39;_ENV&#39;,&#39;_FILES&#39;);
           foreach ($array as $value) {
               foreach ($GLOBALS[$value] as $key => $var) {
                  if ($var === $GLOBALS[$key]) {
                      unset($GLOBALS[$key]);
                  }
               }
           }
       }
    }
    /* 主请求方法，主要目的拆分URL请求 */
    function callHook() {
        global $url;
        $urlArray = array();
        $urlArray = explode("/",$url);
        $controller = $urlArray[0];
        array_shift($urlArray);
        $action = $urlArray[0];
        array_shift($urlArray);
        $queryString = $urlArray;
        $controllerName = $controller;
        $controller = ucwords($controller);
        $model = rtrim($controller, &#39;s&#39;);
        $controller .= &#39;Controller&#39;;
        $dispatch = new $controller($model,$controllerName,$action);
        if ((int)method_exists($controller, $action)) {
           call_user_func_array(array($dispatch,$action),$queryString);
        } else {
           /* 生成错误代码 */
        }
    }
    /* 自动加载控制器和模型 */
    function __autoload($className) {
        if (file_exists(ROOT . DS . &#39;library&#39; . DS . strtolower($className) . &#39;.class.php&#39;)) {
            require_once(ROOT . DS . &#39;library&#39; . DS . strtolower($className) . &#39;.class.php&#39;);
        } else if (file_exists(ROOT . DS . &#39;application&#39; . DS . &#39;controllers&#39; . DS . strtolower($className) . &#39;.php&#39;)) {
            require_once(ROOT . DS . &#39;application&#39; . DS . &#39;controllers&#39; . DS . strtolower($className) . &#39;.php&#39;);
        } else if (file_exists(ROOT . DS . &#39;application&#39; . DS . &#39;models&#39; . DS . strtolower($className) . &#39;.php&#39;)) {
            require_once(ROOT . DS . &#39;application&#39; . DS . &#39;models&#39; . DS . strtolower($className) . &#39;.php&#39;);
        } else {
           /* 生成错误代码 */
        }
    }
    setReporting();
    removeMagicQuotes();
    unregisterGlobals();
    callHook();

接下来的操作就是在library中建立程序所需要的基类，包括控制器、模型和视图的基类。

新建控制器基类为controller.class.php，控制器的主要功能就是总调度，具体具体内容如下：

<?php
    class Controller {
        protected $_model;
        protected $_controller;
        protected $_action;
        protected $_template;
        function __construct($model, $controller,$action) {
            $this->_controller = $controller;
            $this->_action = $action;
            $this->_model = $model;
            $this->$model =& new $model;
            $this->_template =& new Template($controller,$action);
        }
        function set($name,$value) {
            $this->_template->set($name,$value);
        }
        function __destruct() {
            $this->_template->render();
        }
    }

新建控制器基类为model.class.php，考虑到模型需要对数据库进行处理，所以可以新建一个数据库基类sqlquery.class.php，模型去继承sqlquery.class.php。

新建sqlquery.class.php，代码如下：

<?php
    class SQLQuery {
        protected $_dbHandle;
        protected $_result;
        /** 连接数据库 **/
        function connect($address, $account, $pwd, $name) {
            $this->_dbHandle = @mysql_connect($address, $account, $pwd);
            if ($this->_dbHandle != 0) {
               if (mysql_select_db($name, $this->_dbHandle)) {
                   return 1;
               }else {
                   return 0;
               }
            }else {
               return 0;
            }
         }
        /** 中断数据库连接 **/
        function disconnect() {
             if (@mysql_close($this->_dbHandle) != 0) {
                 return 1;
             } else {
                 return 0;
             }
        }
        /** 查询所有数据表内容 **/
        function selectAll() {
            $query = &#39;select * from `&#39;.$this->_table.&#39;`&#39;;
            return $this->query($query);
        }
        /** 查询数据表指定列内容 **/
        function select($id) {
            $query = &#39;select * from `&#39;.$this->_table.&#39;` where `id` = \&#39;&#39;.mysql_real_escape_string($id).&#39;\&#39;&#39;;
            return $this->query($query, 1);
        }
        /** 自定义SQL查询语句 **/
        function query($query, $singleResult = 0) {
            $this->_result = mysql_query($query, $this->_dbHandle);
            if (preg_match("/select/i",$query)) {
                 $result = array();
                 $table = array();
                 $field = array();
                 $tempResults = array();
                 $numOfFields = mysql_num_fields($this->_result);
                 for ($i = 0; $i < $numOfFields; ++$i) {
                      array_push($table,mysql_field_table($this->_result, $i));
                      array_push($field,mysql_field_name($this->_result, $i));
                  }
                 while ($row = mysql_fetch_row($this->_result)) {
                     for ($i = 0;$i < $numOfFields; ++$i) {
                        $table[$i] = trim(ucfirst($table[$i]),"s");
                        $tempResults[$table[$i]][$field[$i]] = $row[$i];
                     }
                     if ($singleResult == 1) {
                         mysql_free_result($this->_result);
                         return $tempResults;
                     }
                     array_push($result,$tempResults);
                 }
                 mysql_free_result($this->_result);
                 return($result);
             }
          }
         /** 返回结果集行数 **/
        function getNumRows() {
            return mysql_num_rows($this->_result);
        }
        /** 释放结果集内存 **/
        function freeResult() {
            mysql_free_result($this->_result);
        }
       /** 返回MySQL操作错误信息 **/
       function getError() {
           return mysql_error($this->_dbHandle);
       }
    }

新建model.class.php，代码如下：

<?php
    class Model extends SQLQuery{
        protected $_model;
        function __construct() {
            $this->connect(DB_HOST,DB_USER,DB_PASSWORD,DB_NAME);
            $this->_model = get_class($this);
            $this->_table = strtolower($this->_model)."s";
        }
        function __destruct() {
        }
    }

新建视图基类为template.class.php，具体代码如下：

<?php
    class Template {
       protected $variables = array();
       protected $_controller;
       protected $_action;
       function __construct($controller,$action) {
           $this->_controller = $controller;
           $this->_action =$action;
       }
       /* 设置变量 */
       function set($name,$value) {
            $this->variables[$name] = $value;
       }
       /* 显示模板 */
       function render() {
           extract($this->variables);
           if (file_exists(ROOT.DS. &#39;application&#39; .DS. &#39;views&#39; .DS. $this->_controller .DS. &#39;header.php&#39;)) {
               include(ROOT.DS. &#39;application&#39; .DS. &#39;views&#39; .DS. $this->_controller .DS. &#39;header.php&#39;);
           } else {
               include(ROOT.DS. &#39;application&#39; .DS. &#39;views&#39; .DS. &#39;header.php&#39;);
           }
           include (ROOT.DS. &#39;application&#39; .DS. &#39;views&#39; .DS. $this->_controller .DS. $this->_action . &#39;.php&#39;);
           if (file_exists(ROOT.DS. &#39;application&#39; .DS. &#39;views&#39; .DS. $this->_controller .DS. &#39;footer.php&#39;)) {
               include (ROOT.DS. &#39;application&#39; .DS. &#39;views&#39; .DS. $this->_controller .DS. &#39;footer.php&#39;);
           } else {
               include (ROOT.DS. &#39;application&#39; .DS. &#39;views&#39; .DS. &#39;footer.php&#39;);
           }
        }
    }

做完了以上这么多操作，基本上整个MVC框架已经出来了，下面就该制作我们的站点了。我们要做的站点其实很简单，一个ToDo程序。

首先是在我们的/application/controller/ 目录下面新建一个站点控制器类为ItemsController，命名为itemscontroller.php，内容为：

<?php
    class ItemsController extends Controller {
       function view($id = null,$name = null) {
           $this->set(&#39;title&#39;,$name.&#39; - My Todo List App&#39;);
           $this->set(&#39;todo&#39;,$this->Item->select($id));
       }
       function viewall() {
           $this->set(&#39;title&#39;,&#39;All Items - My Todo List App&#39;);
           $this->set(&#39;todo&#39;,$this->Item->selectAll());
       }
       function add() {
           $todo = $_POST[&#39;todo&#39;];
           $this->set(&#39;title&#39;,&#39;Success - My Todo List App&#39;);
           $this->set(&#39;todo&#39;,$this->Item->query(&#39;insert into items (item_name) values (\&#39;&#39;.mysql_real_escape_string($todo).&#39;\&#39;)&#39;));
       }
       function delete($id) {
           $this->set(&#39;title&#39;,&#39;Success - My Todo List App&#39;);
           $this->set(&#39;todo&#39;,$this->Item->query(&#39;delete from items where id = \&#39;&#39;.mysql_real_escape_string($id).&#39;\&#39;&#39;));
       }
    }

接下来就是先建站点的模型，在我们的/application/model/ 目录下面先建一个站点模型类为Item，内容直接继承Model，代码如下：

<?php
class Item extends Model {
}

最后一步是设置我们站点的视图部分，我们现在/application/views/目录下新建一个items的文件夹，再在items文件夹下建立与控制器重Action相同的文件，分别为view.php，viewall.php，add.php，delete.php，考虑到这么页面中可能需要共用页首和页尾，所以再新建两个文件，命名为header.php，footer.php，每个文件的代码如下：

view.php文件：查看单条待处理事务

<h2><?php echo $todo[&#39;Item&#39;][&#39;item_name&#39;]?></h2>
<a href="../../../items/delete/<?php echo $todo[&#39;Item&#39;][&#39;id&#39;]?>">
<span>Delete this item</span>
</a>

viewall.php文件：查看所有待处理事务

<form action="../items/add" method="post">
    <input type="text" value="I have to..." onclick="this.value=&#39;&#39;" name="todo"> <input type="submit" value="add">
</form>
<br/><br/>
<?php $number = 0?>
<?php foreach ($todo as $todoitem):?>
    <a href="../items/view/<?php echo $todoitem[&#39;Item&#39;][&#39;id&#39;]?>/<?php echo strtolower(str_replace(" ","-",$todoitem[&#39;Item&#39;][&#39;item_name&#39;]))?>">
        <span>
            <?php echo ++$number?>
            <?php echo $todoitem[&#39;Item&#39;][&#39;item_name&#39;]?>
        </span>
    </a><br/>
<?php endforeach?>

add.php文件：添加待处理事务

<a href="../items/viewall">Todo successfully added. Click here to go back.</a><br/>

delete.php文件：删除事务

<a href="../../items/viewall">Todo successfully deleted. Click here to go back.</a><br/>

header.php：页首文件

<html>
<head>
<title><?php echo $title?></title>
<style>
.item {width:400px;}
input {color:#222222;font-family:georgia,times;font-size:24px;font-weight:normal;line-height:1.2em;color:black;}
a {color:#222222;font-family:georgia,times;font-size:24px;font-weight:normal;line-height:1.2em;color:black;text-decoration:none;}
a:hover {background-color:#BCFC3D;}
h1 {color:#000000;font-size:41px;letter-spacing:-2px;line-height:1em;font-family:helvetica,arial,sans-serif;border-bottom:1px dotted #cccccc;}
h2 {color:#000000;font-size:34px;letter-spacing:-2px;line-height:1em;font-family:helvetica,arial,sans-serif;}
</style>
</head>
<body>
<h1 id="My-nbsp-Todo-List-nbsp-App">My Todo-List App</h1>

footer.php：页尾文件

</body>
</html>

当然还有一个必不可少的操作就是在数据中中建立一张表，具体代码如下：

CREATE TABLE IF NOT EXISTS `items` (
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `item_name` varchar(255) NOT NULL,
    PRIMARY KEY (`id`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1 AUTO_INCREMENT=17 ;

至此一个使用MVC开发的网站就开发完成了，你现在可以通过访问http://localhost/todo/items/viewall 查看新建的站点。