windwalker/datamapper

Windwalker DataMapper package

3.1.3 2016-11-19 14:29 UTC

README

Installation via Composer

Add this to the require block in your composer.json.

{
    "require": {
        "windwalker/datamapper": "~3.0"
    }
}

Getting Started

Prepare Windwalker Database object

use Windwalker\Database\DatabaseFactory;

// Make the database driver.
$db = DatabaseFactory::getDbo(
    'mysql',
    array(
        'driver'   => 'mysql',
        'host'     => 'localhost',
        'user'     => 'root',
        'password' => 'xxxx',
        'database' => 'mydb',
        'prefix'   => 'prefix_'
    )
);

The DatabaseDriver will be cached in Factory, now DataMapper will auto load database driver.

See Database

Create DataMapper

use Windwalker\DataMapper\DataMapper;

$fooMapper = new DataMapper('#__foo');

$fooSet = $fooMapper->find(array('id' => 1));

Inject DB to DataMapper

// $db is Windwalker DatabaseDriver
$mapper = new DataMapper('table', null, $db);

Custom primary keys:

// If keep keys NULL, the default `id` will auto set.
$mapper = new DataMapper('table'); // Keys: array('id')

// Set custom key
$mapper = new DataMapper('table', 'table_id'); // Keys: array('table_id')

// Set multiple keys
$mapper = new DataMapper('table', array('table_id', 'uuid')); // Keys: array('table_id', 'uuid')

Extend It

You can also create a class to operate specific table:

class FooMapper extends DataMapper
{
    protected static $table = '#__foo';

    protected static $keys = 'id';
}

$data = (new FooMapper)->findAll();

Or using facade:

use Windwalker\DataMapper\AbstractDatabaseMapperProxy;

abstract class FooMapper extends AbstractDatabaseMapperProxy
{
    protected $table = '#__foo';

    protected $keys = 'id'; // Keep NULL will use default `id`
}

$data = FooMapper::findOne(array('id' => 5, 'alias' => 'bar'));

Find Records

Find method will fetch rows from table, and return DataSet class.

find()

Get id = 1 record

$fooSet = $fooMapper->find(array('id' => 1));

Fetch published = 1, and sort by date

$fooSet = $fooMapper->find(array('published' => 1), 'date');

Fetch published = 1, language = en-US, sort by date DESC and start with 30, limit 10.

$fooSet = $fooMapper->find(array('published' => 1, 'language' => 'en-US'), 'date DESC', 30, 10);

Using array, will be IN condition:

$fooSet = $fooMapper->find(array('id' => array(1,2,3))); // WHERE id IN (1,2,3)

findOne()

Just return one row.

$foo = $dooMapper->findOne(array('published' => 1), 'date');

findAll()

Equal to find(array(), $order, $start, $limit).

Find With Custom Query

$fooMapper = new DataMapper('#__foo');

$fooMapper->where('a = "b"') // Simple where
    ->where('%n = $q', 'foo', 'bar') // Where format
    ->where('flower = :sakura')->bind('sakura', 'Sakura') // Bind params
    ->orWhere(array('c = d', 'e = f')) // AND (c=d OR e=f)
    ->having('...')
    ->limit(10, 20) // Limit, offset
    ->order('created DESC') // Can be array or string
    ->select(array('id', 'title', 'alias')) // Can be array or string
    ->find();

The available query methods.

  • join($type = 'LEFT', $alias, $table, $condition = null, $prefix = null)
  • leftJoin($alias, $table, $condition = null, $prefix = null)
  • rightJoin($alias, $table, $condition = null, $prefix = null)
  • nnerJoin($alias, $table, $condition = null, $prefix = null)
  • outerJoin($alias, $table, $condition = null, $prefix = null)
  • call($columns)
  • group($columns)
  • order($columns)
  • limit($limit = null, $offset = null)
  • select($columns)
  • where($conditions, ...$args)
  • orWhere($conditions)
  • having($conditions, ...$args)
  • orHaving($conditions)
  • clear($clause = null)
  • bind($key = null, $value = null, $dataType = \PDO::PARAM_STR, $length = 0, $driverOptions = array())

See Query Format

Create Records

Using DataSet to wrap every data, then send this object to create() method, these data will insert to table.

create()

use Windwalker\Data\Data;
use Windwalker\Data\DataSet;

$data1 = new Data;
$data1->title = 'Foo';
$data1->auhor = 'Magneto';

$data2 = new Data(
    array(
        'title' => 'Bar',
        'author' => 'Wolverine'
    )
);

$dataset = new DataSet(array($data1, $data2));

$return = $fooMapper->create($dataset);

The return value will be whole dataset and add inserted ids.

Windwalker\Data\DataSet Object
(
    [storage:ArrayObject:private] => Array
        (
            [0] => Windwalker\Data\Data Object
                (
                    [title] => Foo
                    [auhor] => Magneto
                    [id] => 39
                )

            [1] => Windwalker\Data\Data Object
                (
                    [title] => Bar
                    [auhor] => Wolverine
                    [id] => 40
                )
        )
)

createOne()

Only insert one row, do not need DataSet.

$data = new Data;
$data->title = 'Foo';
$data->auhor = 'Magneto';

$fooMapper->createOne($data);

Update Records

Update methods help us update rows in table.

update()

use Windwalker\Data\Data;
use Windwalker\Data\DataSet;

$data1 = new Data;
$data1->id = 1;
$data1->title = 'Foo';

$data2 = new Data(
    array(
        'id' => 2,
        'title' => 'Bar'
    )
);

$dataset = new DataSet(array($data1, $data2));

$fooMapper->update($dataset);

updateOne()

Just update one row.

$data = new Data;
$data->id = 1;
$data->title = 'Foo';

$fooMapper->updateOne($data);

updateAll()

UpdateAll is different from update method, we just send one data object, but using conditions as where to update every row match these conditions. We don't need primary key for updateAll().

$data = new Data;
$data->published = 0;

$fooMapper->updateAll($data, array('author' => 'Mystique'));

Delete

Delete rows by conditions.

delete()

$boolean = $fooMapper->delete(array('author' => 'Jean Grey'));

Join Tables

Use newRelation() to create a DataMapper and join other tables.

use Windwalker\DataMapper\DataMapper;

$items = DataMapper::newRelation('flower', '#__flower')
    ->leftJoin('author', '#__users', 'flower.user_id = author.id')
    ->innerJoin('category', '#__categories', array('category.lft >= flower.lft', 'category.rgt <= flower.rgt'))
    ->where('flower.id = 1')
    ->order('created DESC')
    ->group('category.id')
    ->find();

The Join query will be:

SELECT `flower`.`id`,
    `flower`.`catid`,
    `flower`.`title`,
    `flower`.`user_id`,
    `flower`.`meaning`,
    `flower`.`ordering`,
    `flower`.`state`,
    `flower`.`params`,
    `author`.`id` AS `author_id`,
    `author`.`name` AS `author_name`,
    `author`.`pass` AS `author_pass`,
    `category`.`id` AS `category_id`,
    `category`.`title` AS `category_title`,
    `category`.`ordering` AS `category_ordering`,
    `category`.`params` AS `category_params`
FROM #__foo AS foo
    LEFT JOIN #__users AS author ON foo.user_id = author.id
    INNER JOIN #__categories AS category ON category.lft >= foo.lft AND category.rgt <= foo.rgt
WHERE
    flower.id = 1
ORDER BY flower.created DESC
GROUP BY category.id

Where condition will auto add alias if not provided.

$fooMapper->find(array(
    'foo.id' => 3 // This is correct condition
    'state' => 1 // This field may cause column conflict, DataMapper will auto covert it to `foo.state` => 1
));

Reset all tables and query:

$fooMapper->reset();

Using OR Condition

$fooMapper->addTable(
    'category',
    '#__categories',
    'category.lft >= foo.lft OR category.rgt <= foo.rgt',
    'LEFT'
);

Group

$fooMapper->group('category.id');

Compare objects

Using Compare objects help us set some where conditions which hard to use array to defind.

$fooSet = $fooMapper->find(
    array(
        new GteCompare('id', 5),
        new NeqCompare('name', 'bar')
        new LtCompare('published', 1),
        new NinCompare('catid', array(1,2,3,4,5))
    )
);

This will generate where conditions like below:

WHERE `id` >= '5'
    AND `name` != 'bar'
    AND `published` < '1'
    AND `catid` NOT IN (1,2,3,4,5)

Available compares:

Name Description Operator
EqCompare Equal =
NeqCompare Not Equal !=
GtCompare Greater than >
GteCompare Greater than or Equal >=
LtCompare Less than <
LteCompare Less than or Equal <=
InCompare In IN
NinCompare Not In IN

Custom Compare

echo (string) new Compare('title', '%flower%', 'LIKE');

Will be

`title` LIKE `%flower%`

See: https://github.com/ventoviro/windwalker-compare

Using Data and DataSet

See: https://github.com/ventoviro/windwalker-data

Hooks

Add "windwalker/event": "~3.0" to composer.json.

Then we are able to use hooks after every operations.

class FooListener
{
    public function onAfterCreate(Event $event)
    {
        $result = $event['result'];

        // Do something
    }
}

$mapper = new DataMapper('table');

// Add object as listener
$mapper->getDispatcher()->addListener(new FooListener);

// Use listen() to add a callback as listener
$mapper->getDispatcher()->listen('onAfterUpdate', function () { ... });

$mapper->create($dataset);

Extends DataMapper:

class SakuraMapper extends DataMapper
{
    protected $table = 'saluras';

    public function onAfterFind(Event $event)
    {
        $result = $event['result'];

        // Find some relations
    }
}

$mapper = new DataMapper('table');
$mapper->find(array('id' => 5));

Available events:

  • onBeforeFind
  • onAfterFind
  • onBeforeFindAll
  • onAfterFindAll
  • onBeforeFindOne
  • onAfterFindOne
  • onBeforeFindColumn
  • onAfterFindColumn
  • onBeforeCreate
  • onAfterCreate
  • onBeforeCreateOne
  • onAfterCreateOne
  • onBeforeUpdate
  • onAfterUpdate
  • onBeforeUpdateOne
  • onAfterUpdateOne
  • onBeforeUpdateBatch
  • onAfterUpdateBatch
  • onBeforeSave
  • onAfterSave
  • onBeforeSaveOne
  • onAfterSaveOne
  • onBeforeFlush
  • onAfterFlush
  • onBeforeDelete
  • onAfterDelete

More about Event: Windwalker Event