cakesuit/metatable

Cakesuit/MetaTable plugin for CakePHP

0.1.3 2017-11-21 06:19 UTC

Requires

• cakephp/cakephp: ^3.4

Requires (Dev)

• phpunit/phpunit: ^5.7|^6.0

MIT

README

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require Cakesuit/MetaTable

bin/cake plugin load Cakesuit/MetaTable

How to use it (for example)

Create table user:

CREATE table users (
    id int(11) auto_increment NOT NULL key,
    username varchar(20) NOT NULL,
    password varchar(60) NOT NULL,
);

Create a table meta for user

CREATE table meta_users (
  id int(11) auto_increment key NOT NULL,
  user_id int(11) NOT NULL,
  meta_key varchar(255) NOT NULL,
  meta_value TEXT NULL
);

Insert user row:

id	username	password
1	Cakesuit	12345

Insert user meta row:

id	meta_key	meta_value	user_id
1	age	26	1
2	sexe	male	1

Config UsersTable:

<?php

// ...
class UsersTable extends Table
{
    public function initialize(array $config)
    {
        parent::initialize($config);

        $this->setTable('users');
        $this->setDisplayField('username');
        $this->setPrimaryKey('id');

       $this->hasMany('MetaUsers', [
           'foreignKey' => 'user_id',
       ]);
        
       // Add behavior
        $this->addBehavior('Cakesuit/MetaTable.Meta', [
            /**
             * Define meta table name
             * Required: true 
             * Default: null 
             */
            'metaTableName' => 'MetaUsers',
            
            /**
             * Define the name for return de meta
             * Required: false
             * Default: meta
             */
            'propertyName' => 'meta',
            
            /**
             * Define de key column
             * Required: false
             * Default: meta_key
             */
            'keyField' => 'meta_key',
            
            /**
             * Default value
             * Require: false
             * Default Table::getDisplayField()
             */
             'valueField' => 'meta_value',
            
            /**
             * Method for save meta 
             * Required: false
             * Default: 'both'
             * false: insert into meta
             * true: insert into object entities
             * both: meta & object entities
             */
            'addProperties' => 'both',
        ]);
    }
}

Fetch meta:

<?php

$usersTable = \Cake\ORM\TableRegistry::get('Users');

$user = $usersTable->get(1, [
    'contain' => ['MetaUsers']
]);
    

echo $user->username; // Cakesuit

// With addProperties (true) in behavior config
echo $user->age; // 26
echo $user->sexe; // male

// Without addProperties (false) in behavior config
echo $user->meta->age; // 26
echo $user->meta->sexe; // male

// Get age value
echo $user->meta->get('age'); // 26

// Fetch the entity ID : fetch($key, default)
echo $user->meta->fetch('age'); // 26
echo $user->meta->fetch('age.id', null); // 1

// Check has ID : has($key)
echo $user->meta->has('sexe'); // true
echo $user->meta->has('sexe.id'); // true
echo $user->meta->has('sexe.other'); // false

// Check if empty value : isEmpty($key)
echo $user->meta->isEmpty('sexe'); // false
echo $user->meta->isEmpty('sexe.meta_value'); // false
echo $user->meta->isEmpty('other'); // true

// Check equal value : equalTo($expected, $key, strict = false)
echo $user->meta->equalTo('male', 'sexe', false); // true
echo $user->meta->equalTo(1, 'age.id', true); // true
if ($user->meta->equalTo('26', 'age', true)) {
    // Return Cakesuit is 26 years old
    echo sprintf(
        '%s is %d years old', 
        $user->username,
        $user->age // or $user->meta->gat('age') 
    );
}

...

If you encounter any difficulties, contact me. Thank you.

C@kesuit