文档
通过“文档”详细了解iphp开发


欢迎使用iphp

欢迎使用iphp,iphp是一套给php网站开发者使用的应用程序开发框架,它的目标是让你能够更自由更快速的开发,它提供了一个简单的接口和 逻辑结构。通过完整且简单的结构,iphp让你更加专注于你的创造性工作。


基础

通过快速开始,我们已经大概了解iphp是如何驱动整个web程序运行的了。但如果要更深入的使用和扩展iphp框架, 就需要了解更多的iphp的结构和运行环境。iphp非常的简单,只有一个核心的类库文件,掌握起来非常简单。


获取iphp

通过 http://git.oschina.net/lec/iphp 获取iphp的最新内容。

环境要求

iphp的最低php要求是5.3版本,不过建议使用5.6版本的php。因为很多的特性都是基于php5.6+的,如果本文档未及时更新,请使用php5.6版本。 目前最新的php版本是7。iphp并没有在php7的环境中测试运行过。


iphp的文件结构

├─iphp 框架主目录(包含iphp运行所需的所有文件)
│  ├─app                  程序主要文件夹
│  │  ├─c                 逻辑控制文件夹
│  │  ├─conf              程序配置文件夹
│  │  ├─lib               程序运行核心库文件夹
│  │  ├─m                 数据处理文件夹
│  │  ├─v                 模板文件夹
│  │  |  ├─test1          模板test1分组
│  │  |  ├─test2          模板test2分组
│  │  |  ├─....           更多模板分组
│  ├─core                 iphp核心文件夹
│  │  ├─conf.php          核心配置文件
│  │  ├─i.php             iphp启动文件
│  │  ├─iclass.php        iphp核心类文件
│  │  ├─iinit.php         iphp数据初始化
│  │  ├─testconf.php      测试环境核心配置文件
│  ├─plus                 第三方类库文件夹
│  ├─public               web程序运行目录(服务器的根目录设置为此文件夹)
│  │  ├─css               css文件夹
│  │  ├─img               img文件夹
│  │  ├─js                js文件夹
│  │  ├─cmd.php           命令行模式运行iphp的入口文件
│  │  ├─index.php         web模式运行iphp的入口文件
                        

入口文件

web模式入口文件

web模式入口文件是通过浏览器运行程序的入口文件:index.php。在配置web服务器时, 需要将网站的根目录解析到public,并且将默认首页设置为index.php

命令行模式入口文件

命令行模式入口文件是通过命令行来启动整个程序的运行文件:cmd.php

命令行模式运行iphp框架,如 php cmd.php control_name method_name
第一个参数为_c 第二个参数为_m 剩余的参数传入function中 PScmd运行的函数最好接受一个参数
                            


规范与建议

iphp有一个简单且非常自由的结构,开发者可以使用各种格式来开发,不过我们还是要遵循一定的开发规范来确保程序的通用可读和安全。
  • app/c目录存放逻辑控制的文件(就称之为控制器吧),这里的文件控制整个网站程序的运行和业务流程;
    app/m目录存放数据处理的文件,各种数据的处理和包括数据库的访问都在这里完成,这个目录里的类不能直接被运行,只有通过“逻辑控制文件”调用。因此,尽管可以在任何位置访问数据库,但最好遵循只在app/m这里访问数据库的原则。
  • 为了保证程序在任何的操作系统中都可以正常运行(windows不区分文件名的大小写,好吧),所以文件夹和文件名都用小写字母,单词之间可以用下划线"_"间隔。如,comm.php,index.php,user_manage.php
  • app/capp/m中的文件有基本同意的格式:如test_class.php
    namespace c;
    class test_class extends \i{
        private static $_i;
        public $db;
        public static function i($pars=[]){
            self::$_i or self::$_i=new \c\test_class($pars);
            return self::$_i;
        }
        public function __construct($pars=[]){
            parent::__construct($pars);
        }
    }
                                    
    文件名必须和类名相同,才能够通过核心类的自动调用机制加载相应的类中的方法。
  • app/v存放的是模板文件,网站中模板文件使用比较多,最好可以通过文件夹对模板进行分组。

初始化

iphp不用任何初始化的配置就可以运行。当然,在有些需要连接数据库或者其他的需要特殊的配置的时候需要事先配置。
例如:conf.php中默认包含了数据库配置。

配置

iphp包含了两类配置:
一类是核心配置,存放在core/conf.php文件中,通过\i::commconf()方法获取配置的值;(当我们通过localhost访问的时候,默认加载/core/testconf.php配置文件。)
另一类是程序配置,存放在app/conf文件夹中,通过\i::appconf()方法获取配置内容;
core/conf.php配置示例:
return [
    "_sys"=>[
        'xsrf'=>true,
    ],
    "db"=>[
        "dbname" => '数据库名字',
        'dbhost' => '数据库地址',
        'dbport' => '数据库端口',
        'dbuser' => '用户名',
        'dbpwd'  => '用户密码',
    ],
];
                        
通过\i::commconf('db')获取db的所有配置。通过\i::commconf('db','dbhost')可以单独获取数据库地址这一项配置的值;
app/conf文件夹中的配置文件示例:(以app/conf/test.php为例)
return [
    'key1'=>['array1'],
    'key2'=>val2,
];
                        
通过\i::appconf('test')来获取整个配置文件的内容;

核心类

iphp只有一个核心的类库:core/iclass.php,类名是:i
核心类包含了所有的需要使用的方法。

核心方法

几个常用的核心方法:

模板渲染public static function v($_vn=[],$_vd=[],$r=false)

参数:
array $_vn:传入模板数组。
array $_vd:传入模板的参数。
bool $r:是否返回渲染好的模板,默认直接输出,传入参数true则返回模板。
返回值:
如果设置第三个参数为true,则返回渲染好的模板。
示例:
\i::v(['viewtest1/vt11','viewtest1/vt12','viewtest2/vt21'],['word'=>'hello world','ary'=>['hello','world']]);
                            
依次加载 v/viewtest1/vt11v/viewtest1/vt12v/viewtest2/vt21三个模板文件,并传入参数 ['word'=>'hello world','ary'=>['hello','world']],在模板文件中可以使用 $word$ary 这两个参数。

构造链接public static function a($_c,$_m,$pars=[],$r=true)

参数:
string $_c:传入要加载的逻辑控制类。
string $_m:传入要加载的方法br。
array $pars:url中其他的参数。
bool $r:是否返回构造好的类br。
返回值:
如果设置参数为返回结果,那么就返回构造好的链接地址。
示例:
$link=\i::a('comm','test',['h'=>'hello','w'=>'world'],true);
                            
返回http://[地址]/?_c=comm&_m=test&h=hello&w=world并赋值给$link;[地址]如果是本地默认是 localhost

控制器与模型?

iphp并没有严格意义上的控制器或者模型,对于逻辑控制层和数据层的区分就是一个是在app/c文件夹中,一个在app/m。逻辑控制部分(app/c中的文件和类)与数据处理部分(app/m中的文件和类)通过文件夹不同来区分。
当然,可以自定义一个 app/x文件夹,并且将命名空间设置为 x,那么就可以通过 \x\class_name::i()->method_name()调用相应类中的方法。不过,iphp默认的通过url或者命令行,只能访问 app/c中的文件和类。

模板

iphp的模板也是最简单的,通过 iclass中的 v方法来渲染模板。
当然,也可以将其他的模板引擎作为第三方类加载。

常用核心库

lib文件夹存放的是核心的常用第三方类库,目前有 db.phpverify.php
db.php是数据库连接类,配合 app/m/dbo.php使用,很方便的通过“链式操作”进行数据操作。【PS:详见dbo类使用教程】
verify.php是数据验证类,可以直接用来做用户输入数据验证的。
lib文件夹中的第三方类库通过 \lib\class_name就可以调用。
示例:调用数据库连接类:
$db=\lib\db::i(\i::commconf('db'));
                        

第三方类库

plus文件夹中存放的是第三方的类库,通过 \i::pluslib('文件位置')调用。
示例:调用 plus/phpQuery/phpQuery.php
\i::pluslib("phpQuery/phpQuery");
                        
示例:调用 plus/test.php
\i::pluslib("test");
                        

其他问题

这只是一个简单的文档,iphp的结构并不复杂,因此只需要读一读入口文件与核心的代码,基本上就可以了解iphp的运作原理。
app/m/dbo.php文件是依赖dbo链接的一个数据库访问层,将会单独做详细的说明。

123

by iphp