super model
Version 0.1.0
強烈建議您使用 Flightphp/active-record 而不是這個函式庫。該庫不會進行進一步的開發，但它確實可以像現在一樣工作。
super model是一個非常簡單的 ORM 類型 php 類，可以輕鬆地與資料庫中的表進行交互，而無需到處編寫大量 SQL 程式碼。
為了證明這一點，這裡是幾行程式碼...
$ cloc src/
1 text file.
1 unique file.
0 files ignored.
github.com/AlDanial/cloc v 1.74 T=0.01 s (71.8 files/s, 48768.5 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
PHP 1 86 246 347
-------------------------------------------------------------------------------
這是出於性能考慮而編寫的。因此，雖然它不能滿足已建置的每個專案中的每一個要求，但它在大多數情況下都可以工作，並且也能完成出色的工作！
super model的入門很簡單，只需擴展super model類別並定義一個表名稱。就是這樣。
<?php
use n0nag0n Super_Model ;
class User extends Super_Model {
protected $ table = ' users ' ;
}現在來一些簡單的例子來說明她的工作方式怎麼樣？
首先，我們假設下表：
Table: users
---------------------------------------------------------
| id | email | company_id |
| 1 | [email protected] | 50 |
| 2 | [email protected] | 61 |
| 3 | [email protected] | 61 |
---------------------------------------------------------
<?php
// somefile.php
$ pdo = new PDO ( ' sqlite::memory: ' , '' , '' , [ PDO :: ATTR_DEFAULT_FETCH_MODE => PDO :: FETCH_ASSOC ]);
$ User = new User ( $ pdo );
// WHERE company_id = 50
$ users = $ User -> getAllBycompany_id ( 50 );
// same as above
$ users = $ User -> getAll ([ ' company_id ' => 50 ]);簡單的豌豆，檸檬汁對嗎？
getBy*(mixed $value): array [result]這是一種從指定值傳回一行的方法。此方法的*部分引用資料庫中的欄位。欄位名稱區分大小寫，無論您的資料庫表中的欄位名稱是什麼。
// get by the id field on the users table
$ User -> getByid ( 3 );
/*
[
'id' => 3,
'email' => '[email protected]',
'company_id' => 61
]
*/
$ User -> getBycompany_id ( 61 );
/*
// it only will pull the first row, not all rows
[
'id' => 2,
'email' => '[email protected]',
'company_id' => 61
]
*/getAllBy*(mixed $value): array [ [result], [result] ]這是一個快捷過濾器，用於按給定值返回所有行。此方法的*部分引用資料庫中的欄位。欄位名稱區分大小寫，無論您的資料庫表中的欄位名稱是什麼。
// this is pointless, but will still work
$ User -> getAllByid ( 3 );
/*
[
[
'id' => 3,
'email' => '[email protected]',
'company_id' => 61
]
]
*/
$ User -> getAllBycompany_id ( 61 );
/*
[
[
'id' => 2,
'email' => '[email protected]',
'company_id' => 61
],
[
'id' => 3,
'email' => '[email protected]',
'company_id' => 61
]
]
*/getAll(array $filters, bool $return_one_row = false): array [ [result], [result] ] or [result]您可以在該篩選器中新增大量自訂項目來篩選表格中的資料。有一些獨特的按鍵需要注意，一些運算符可以幫助您提取特定的資料。
// Full example
$ filters = [
//
// arguments in the WHERE statement
//
' some_field ' => 5 , // some_field = ?
' some_field-= ' => 5 , // some_field = ?
' another_field ' => ' IS NULL ' , // some_field IS NULL
' another_field ' => ' IS NOT NULL ' , // some_field IS NOT NULL
' another_field-> ' => ' Apple ' , // another_field > ?
' another_field->= ' => ' Apple ' , // another_field >= ?
' another_field-< ' => ' Apple ' , // another_field < ?
' another_field-<= ' => ' Apple ' , // another_field <= ?
' another_field-!= ' => ' Apple ' , // another_field != ?
' another_field-<> ' => ' Apple ' , // another_field <> ?
' another_field-LIKE ' => ' Ap%ple ' , // another_field LIKE ?
' another_field-NOT LIKE ' => ' Apple% ' , // another_field NOT LIKE ?
' another_field-IN ' => [ ' Apple ' , ' Banana ' , ' Peach ' ], // another_field IN(??) double question mark gets parsed as array
' another_field-NOT IN ' => [ ' Apple ' , ' Banana ' , ' Peach ' ], // another_field NOT IN(??) double question mark gets parsed as array
// If you need some custom action
' another_field-RAW-> DATE_SUB(?, INTERVAL 1 DAY) ' => ' 1980-01-01 ' , // another_field > DATE_SUB(?, INTERVAL 1 DAY)
//
// Other parts of the query
//
// choose what columns you want to select
' select_fields ' => ' id, first_name ' ,
// Get any joins
' joins ' => [ ' LEFT JOIN companies ON companies.id = users.company_id ' ],
// Group by
' group_by ' => ' company_id ' ,
// having
' having ' => ' count > 5 ' ,
// order by
' order_by ' => ' id DESC ' ,
// limit
' limit ' => 15 ,
// offset
' offset ' => 10000 ,
];
$ users = $ User -> getAll ( $ filters );還有一些帶有模型屬性的基本配置選項。
如果您知道模型將始終傳回一個小結果集並且希望能夠查詢整個表，請設定此屬性。否則，它是一種保護，因此如果沒有提供 sql 參數，您將無法檢索整個結果集（這可能會崩潰並燒毀許多東西）。
use n0nag0n Super_Model ;
class User extends Super_Model {
protected $ table = ' users ' ;
protected $ disallow_wide_open_queries = false ;
}create(array $data): int [insert id]這將在表上建立一行，但如果您提供多維數組，它將插入多行。假定主鍵為id 。
$ User -> create ([ ' email ' => ' [email protected] ' , ' company_id ' => 55 ]);
// returns 4
$ User -> create ([ [ ' email ' => ' [email protected] ' , ' company_id ' => 55 ], [ ' email ' => ' [email protected] ' , ' company_id ' => 56 ] ]);
// returns 6, only the last id will be returnedupdate(array $data, string $update_field = 'id'): int (number of rows updated)這將在表上建立一行，但如果您提供多維數組，它將插入多行。假定主鍵為id 。
$ User -> update ([ ' id ' => 1 , ' email ' => ' [email protected] ' ]);
// returns 1 and will only update the email field
$ User -> update ([ ' email ' => ' [email protected] ' , ' company_id ' => 61 ], ' email ' );
// returns 1
$ User -> update ([ ' company_id ' => 61 , ' email ' => ' [email protected] ' ], ' company_id ' );
// returns 3, not really logical, but it would update all the emails 如果您想要一種在特定標誌被觸發時自動改變結果的方法，該怎麼辦？簡單易行。有一個名為processResult()的方法，它將運行您拉回的每個結果。您可以在$filters['processResults']鍵中為此方法注入特殊過濾器。
<?php
use n0nag0n Super_Model ;
class User extends Super_Model {
protected $ table = ' users ' ;
public processResult (array $ process_filters , array $ result ): array {
// add some trigger here and do whatever checks you need
if( isset ( $ process_filters ['set_full_name']) && $ process_filters ['set_full_name'] === true && !empty( $ result ['first_name']) && !empty( $ result ['last_name'])) {
$ result ['full_name'] = $ result [ ' first_name ' ]. ' ' . $ result [ ' last_name ' ];
}
return $ result ;
}
}
// later on in some other file.
$ User = new User ( $ pdo );
// setting the processResults filter here is the key to connecting the getAll statement with your processResult method
$ users = $ User -> getAll ([ ' company_id ' => 51 , ' processResults ' => [ ' set_full_name ' => true ] ]);
echo $ users [ 0 ][ ' full_name ' ]; // Bob Smith如果您需要執行一個瘋狂的複雜 SQL 查詢，但該查詢不屬於此類或getAll()過濾器的範圍，該怎麼辦？
請記住，本課程的重點不是滿足每個已經存在或將存在的項目的所有要求，但它會讓您達到 90% 的目標。有鑑於此，有一個簡單的方法來執行上述問題。只需一次性使用 RAW SQL。
<?php
use n0nag0n Super_Model ;
class User extends Super_Model {
protected $ table = ' users ' ;
public function processCrazyKukooQuery ( /* add whatever required fields you need */ ): array {
$ db = $ this -> getDbConnection ();
// shamelessly ripped from StackOverflow
$ statement = $ db -> prepare ( " SELECT
DISTINCT
t.id,
t.tag,
c.title AS Category
FROM
tags2Articles t2a
INNER JOIN tags t ON t.id = t2a.idTag
INNER JOIN categories c ON t.tagCategory = c.id
INNER JOIN (
SELECT
a.id
FROM
articles AS a
JOIN tags2articles AS ta ON a.id=ta.idArticle
JOIN tags AS tsub ON ta.idTag=tsub.id
WHERE
tsub.id IN (12,13,16)
GROUP BY a.id
HAVING COUNT(DISTINCT tsub.id)=3
) asub ON t2a.idArticle = asub.id " );
$ statement -> execute ();
return $ statement -> fetchAll ();
}
}
只需運行composer test即可運行phpunit和phpstan 。目前覆蓋率為 100%，這就是我希望保留的位置。
關於 100% 覆蓋率的注意事項：雖然程式碼可能具有 100% 覆蓋率，但實際覆蓋率是不同的。目標是針對程式碼測試許多不同的場景，以深入思考程式碼並預測意外結果。我對“真實”覆蓋率進行編碼，而不是“代碼是否運行”覆蓋率。
