windwalker / record
Windwalker Record package
Installs: 13
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 4
Forks: 0
Open Issues: 0
Type:windwalker-package
Requires
- php: >=7.1.3
- windwalker/database: ~3.0
- windwalker/datamapper: ~3.0
Requires (Dev)
- windwalker/test: ~3.0
- windwalker/utilities: ~3.0
Suggests
- windwalker/event: Install 2.* if you want to use hooks.
- 3.x-dev
- dev-master / 3.x-dev
- 3.5.23
- 3.5.22
- 3.5.21
- 3.5.20
- 3.5.19
- 3.5.18
- 3.5.17
- 3.5.16
- 3.5.15
- 3.5.14
- 3.5.13
- 3.5.12
- 3.5.11
- 3.5.10
- 3.5.9
- 3.5.8
- 3.5.7
- 3.5.6
- 3.5.5
- 3.5.4
- 3.5.3
- 3.5.2
- 3.5.1
- 3.5
- 3.4.9
- 3.4.8
- 3.4.7
- 3.4.6
- 3.4.5
- 3.4.4
- 3.4.3
- 3.4.2
- 3.4.1
- 3.4
- 3.3.2
- 3.3.1
- 3.3
- 3.2.8
- 3.2.7
- 3.2.6
- 3.2.5
- 3.2.4
- 3.2.3
- 3.2.2
- 3.2.1
- 3.2
- 3.1.6
- 3.1.5
- 3.1.4
- 3.1.3
- 3.1.2
- 3.1.1
- 3.1
- 3.0.1
- 3.0
- 3.0-beta2
- 3.0-beta
- 2.1.9
- 2.1.8
- 2.1.7
- 2.1.6
- 2.1.5
- 2.1.4
- 2.1.2
- 2.1.1
- 2.1
- 2.0.9
- 2.0.8
- 2.0.7
- 2.0.6
- 2.0.5
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 2.0.0-beta2
- 2.0.0-beta1
- 2.0.0-alpha
- dev-test
This package is auto-updated.
Last update: 2024-10-18 14:53:36 UTC
README
Windwalker Record is a simple ActiveRecord to operate database row.
Installation via Composer
Add this to the require block in your composer.json
.
{ "require": { "windwalker/record": "~3.0" } }
Use Record
New a instance.
use Windwalker\Record\Record; // Record object for users table $user = new Record('users');
Or create a class:
use Windwalker\Record\Record; class UserRecord extends Record { protected $table = 'users'; protected $keys = 'id'; } $user = new UserRecord;
Load A Record
$user->load(25); // Load by primary key $user->load(array('alias' => $alias)); // Load by field name.
Check row exists
try { $record->load(25); } catch (NoResultException $e) { // Handle error }
Bind Data
$data = array( 'name' => 'Sakura', 'username' => 'sakura', 'alias' => 'sakura', 'password' => '1234', 'desc' => 'foo bar.' ); $user->bind($data); $user->name; // Sakura
If we have a table with only 3 columns:
The fields which not in this table will be remove after binding data.
$user->alias; // null
That makes our fields in Record will always same as DB table.
Store
Create A New Row
If primary not exists, Record will create a new row in table.
$data = array( 'name' => 'Sakura', 'username' => 'sakura', 'password' => '1234' ); $user->bind($data); $user->store(); echo $user->id; // Auto generated id
Update A Existing Row
If primary key exists, Record will update it.
$data = array( 'id' => 30, 'name' => 'Sakura', 'username' => 'sakura', 'password' => '1234' ); $user->bind($data); $user->store();
Validate
Check method help you validate data.
class UserRecord extends Record { // ... public function validate() { if (!$this['name']) { throw new InvalidArgumentException('Name empty.'); } return true; } }
Then we call validate()
before store()
.
$user->bind($data) ->validate() ->store();
Delete
$user->load(30); $result = $user->delete(); // boolean // OR delete by conditions $result = $user->delete(30); // boolean $result = $user->delete(array('username' => $username)); // boolean
Mutator and Accessor
Mutator and accessor is a setter and getter to do some extra modification when you access value via magic methods.
This is an example of mutator:
class ArticleRecord extends Record { protected function setCreatedDateValue($value) { if ($value instanceof \DateTime) { $value = $value->format('Y-m-d H:i:s'); } $this->data['created_date'] = $value; } }
Use camel-case style to define a method, then when you access the created_date
field, this method will
be auto executed.
$articleRecord->created_date = new \DateTime('now'); echo $articleRecord->created_date; // 2016-03-02 12:30:29
And an example of accessor:
class ArticleRecord extends Record { protected function getCreatedDateValue($value) { return new \DateTime($value); } }
And now you can get DateTime
object back:
echo $articleRecord->created_date->format('Y-m-d H:i:s'); // 2016-03-02 12:30:29
Casts
Add casts to auto convert value type after read from DB:
<? class SakuraRecord extends Record { protected $casts = [ 'id' => 'int', 'price' => 'string', 'created' => 'datetime', 'modified' => 'timestamp', 'images' => 'object', // or array will be json decoded 'params' => \Windwalker\Structure\Structure::class, 'other' => ['SomeClass', 'handle'] // Use callback ]; } $sakuraRecord->load(3); $sakuraRecord->id; // 3 $sakuraRecord->price; // '1200.00' $sakuraRecord->created->format('Y/d/m'); // Auto convert to DateTime object $sakuraRecord->modified; // 1497067876 $sakuraRecord->images[0]->url; // Store json in DB, can will auto decode to object. $sakuraRecord->params->get('foo.bar'); // Use class name to store value to object
Supports casts:
- int | integer
- real | float | double
- string
- bool | boolean
- object
- array | json
- date | datetime
- timestamp
- (Class name)
- (Callback array)
NestedRecord
NestedRecord is a tool help us handle Nested Set Model.
Create Table
Name: categories
Initialise
Every nested set should have a root node.
$cat = new NestedRecord('categories'); $cat->createRoot();
NOTE: The root node id is 1
.
Create Node
Set as first child of ROOT
$cat->bind($data) ->setLocation(1, NestedRecord::LOCATION_FIRST_CHILD) ->store();
Now we will have a new node and it id is 2
. Create a new node as last child of 2
.
$cat->bind($data) ->setLocation(2, NestedRecord::LOCATION_LAST_CHILD) ->store();
Available positions:
- LOCATION_FIRST_CHILD
- LOCATION_LAST_CHILD
- LOCATION_BEFORE
- LOCATION_AFTER
Move Node
Re Ordering
$cat->move(1); // move up $cat->move(-1); // Move down
Move To Other Node
Move to node 3
as last child.
$cat->moveByReference(3, NestedRecord::LOCATION_LAST_CHILD);
Rebuild
If a tree was not correct, using rebuild to reset all lft
, rgt
of this branch.
$cat->load(5); $cat->rebuild(); // Rebuild node: 5 and it's children.
getPath
Method to get an array of nodes from a given node to its root.
$path = $cat->getPath();
getTree
Method to get a node and all its child nodes.
$records = $cat->getTree();
Event
Record has an event system that we can process logic before & after every DB operation.
Add event methods in your Record class.
class UserRecord extends Record { public function onAfterLoad(Event $event) { $this->foo = array('a', 'b', 'c'); } }
Or add listeners to Dispatcher (You must install windwalker/event
first).
// Use listener object $record->getDispatcher()->addListener(new MyRecordListener); // Use callback $record->getDispatcher()->listen('onAfterStore', function (Event $event) { // Process your logic });
Available events:
- onBeforeLoad
- onAfterLoad
- onBeforeStore
- onAfterStore
- onBeforeDelete
- onAfterDelete
- onBeforeBind
- onAfterBind
- onBeforeCreate
- onAfterCreate
- onBeforeUpdate
- onAfterUpdate