命名范圍 · 文檔規范示例

# 命名范圍 [上一頁](# "上一頁")[下一頁](# "下一頁") 在應用開發過程中，使用最多的操作還是數據查詢操作，憑借ThinkPHP的連貫操作的特性，可以使得查詢操作變得更優雅和清晰，命名范圍功能則是給模型操作定義了一系列的封裝，讓你更方便的操作數據。命名范圍功能的優勢在于可以一次定義多次調用，并且在項目中也能起到分工配合的規范，避免開發人員在寫CURD操作的時候出現問題，項目經理只需要合理的規劃命名范圍即可。 ### 定義屬性要使用命名范圍功能，主要涉及到模型類的`_scope`屬性定義和`scope`連貫操作方法的使用。我們首先定義_scope屬性： ~~~ namespace Home\Model; use Think\Model; class NewsModel extends Model { protected $_scope = array( // 命名范圍normal 'normal'=>array( 'where'=>array('status'=>1), ), // 命名范圍latest 'latest'=>array( 'order'=>'create_time DESC', 'limit'=>10, ), ); } ~~~ `_scope`屬性是一個數組，每個數組項表示定義一個命名范圍，命名范圍的定義格式為： ~~~ '命名范圍標識'=>array( '屬性1'=>'值1', '屬性2'=>'值2', ... ) ~~~ 命名范圍標識：可以是任意的字符串，用于標識當前定義的命名范圍名稱。命名范圍支持的屬性包括： | 屬性 | 描述 | |-----|-----| | where | 查詢條件 | | field | 查詢字段 | | order | 結果排序 | | table | 查詢表名 | | limit | 結果限制 | | page | 結果分頁 | | having | having查詢 | | group | group查詢 | | lock | 查詢鎖定 | | distinct | 唯一查詢 | | cache | 查詢緩存 | 每個命名范圍的定義可以包括這些屬性中一個或者多個。 ### 方法調用屬性定義完成后，接下來就是使用`scope`方法進行命名范圍的調用了，每調用一個命名范圍，就相當于執行了命名范圍中定義的相關操作選項對應的連貫操作方法。 ##### 調用某個命名范圍最簡單的調用方式就直接調用某個命名范圍，例如： ~~~ $Model = D('News'); // 這里必須使用D方法因為命名范圍在模型里面定義 $Model->scope('normal')->select(); $Model->scope('latest')->select(); ~~~ 生成的SQL語句分別是： ~~~ SELECT * FROM think_news WHERE status=1 SELECT * FROM think_news ORDER BY create_time DESC LIMIT 10 ~~~ ##### 調用多個命名范圍也可以支持同時調用多個命名范圍定義，例如： ~~~ $Model->scope('normal')->scope('latest')->select(); ~~~ 或者簡化為： ~~~ $Model->scope('normal,latest')->select(); ~~~ 生成的SQL都是： ~~~ SELECT * FROM think_news WHERE status=1 ORDER BY create_time DESC LIMIT 10 ~~~ 如果兩個命名范圍的定義存在沖突，則后面調用的命名范圍定義會覆蓋前面的相同屬性的定義。如果調用的命名范圍標識不存在，則會忽略該命名范圍，例如： ~~~ $Model->scope('normal,new')->select(); ~~~ 上面的命名范圍中new是不存在的，因此只有normal命名范圍生效，生成的SQL語句是： ~~~ SELECT * FROM think_news WHERE status=1 ~~~ ### 默認命名范圍系統支持默認命名范圍功能，如果你定義了一個default命名范圍，例如： ~~~ protected $_scope = array( // 默認的命名范圍 'default'=>array( 'where'=>array('status'=>1), 'limit'=>10, ), ); ~~~ 那么調用default命名范圍可以直接使用： ~~~ $Model->scope()->select(); ~~~ 而無需再傳入命名范圍標識名 ~~~ $Model->scope('default')->select(); ~~~ 雖然這兩種方式是等效的。 ##### 命名范圍調整如果你需要在normal命名范圍的基礎上增加額外的調整，可以使用： ~~~ $Model->scope('normal',array('limit'=>5))->select(); ~~~ 生成的SQL語句是： ~~~ SELECT * FROM think_news WHERE status=1 LIMIT 5 ~~~ 當然，也可以在兩個命名范圍的基礎上進行調整，例如： ~~~ $Model->scope('normal,latest',array('limit'=>5))->select(); ~~~ 生成的SQL是： ~~~ SELECT * FROM think_news WHERE status=1 ORDER BY create_time DESC LIMIT 5 ~~~ ##### 自定義命名范圍又或者，干脆不用任何現有的命名范圍，我直接傳入一個命名范圍： ~~~ $Model->scope(array('field'=>'id,title','limit'=>5,'where'=>'status=1','order'=>'create_time DESC'))->select(); ~~~ 這樣，生成的SQL變成： ~~~ SELECT id,title FROM think_news WHERE status=1 ORDER BY create_time DESC LIMIT 5 ~~~ ##### 與連貫操作混合使用命名范圍一樣可以和之前的連貫操作混合使用，例如定義了命名范圍_scope屬性： ~~~ protected $_scope = array( 'normal'=>array( 'where'=>array('status'=>1), 'field'=>'id,title', 'limit'=>10, ), ); ~~~ 然后在使用的時候，可以這樣調用： ~~~ $Model->scope('normal')->limit(8)->order('id desc')->select(); ~~~ 這樣，生成的SQL變成： ~~~ SELECT id,title FROM think_news WHERE status=1 ORDER BY id desc LIMIT 8 ~~~ 如果定義的命名范圍和連貫操作的屬性有沖突，則后面調用的會覆蓋前面的。如果是這樣調用： ~~~ $Model->limit(8)->scope('normal')->order('id desc')->select(); ~~~ 生成的SQL則是： ~~~ SELECT id,title FROM think_news WHERE status=1 ORDER BY id desc LIMIT 10 ~~~ ##### 動態調用除了采用scope方法調用命名范圍外，我們還支持直接調用命名范圍名稱的方式來動態調用，例如： ~~~ $Model->scope('normal',array('limit'=>5))->select(); ~~~ 查詢操作也可以采用： ~~~ $Model->normal(array('limit'=>5))->select(); ~~~ 的方式調用。`normal(array('limit'=>5))`表示調用normal命名范圍，并且傳入額外的`array('limit'=>5)`參數。由于采用的是`__call`魔術方法機制，因此這樣調用的前提是你定義的命名范圍名稱沒有和現有操作方法沖突。 [上一頁](# "上一頁")[下一頁](# "下一頁")