Метаданные моделей

Для ускорения разработки Phalcon\Mvc\Model помогает вам получать поля и ограничения из таблиц, связанных с моделями. Для этого доступен Phalcon\Mvc\Model\MetaData для управления и кеширования метаданных таблиц.

Иногда необходимо получить эти атрибуты при работе с моделями. Вы можете получить экземпляр метаданных следующим образом:

$robot = new Robots();

// Get Phalcon\Mvc\Model\Metadata instance
$metadata = $robot->getModelsMetaData();

// Get robots fields names
$attributes = $metadata->getAttributes($robot);
print_r($attributes);

// Get robots fields data types
$dataTypes = $metadata->getDataTypes($robot);
print_r($dataTypes);

Кеширование метаданных

Когда приложение находится на стадии производства, нет необходимости каждый раз запрашивать метаданные таблицы из системы баз данных. Это можно сделать, кэшируя метаданные с помощью одного из следующих адаптеров:

Как и другие зависимости ORM, менеджер метаданных запрашивается из контейнера сервисов:

use Phalcon\Mvc\Model\MetaData\Apc as ApcMetaData;

$di["modelsMetadata"] = function () {
    // Create a metadata manager with APC
    $metadata = new ApcMetaData(
        [
            "lifetime" => 86400,
            "prefix"   => "my-prefix",
        ]
    );

    return $metadata;
};

Стратегии метаданных

Как упоминалось выше, по умолчанию для получения метаданных модели используется интроспекция базы данных. В этой стратегии используется информация схемы, чтобы узнать поля в таблице, первичный ключ, поля с возможностью NULL, типы данных и т. д.

Вы можете изменить стандартную интроспекцию метаданных следующим образом:

use Phalcon\Mvc\Model\MetaData\Apc as ApcMetaData;

$di["modelsMetadata"] = function () {
    // Instantiate a metadata adapter
    $metadata = new ApcMetaData(
        [
            "lifetime" => 86400,
            "prefix"   => "my-prefix",
        ]
    );

    // Set a custom metadata introspection strategy
    $metadata->setStrategy(
        new MyIntrospectionStrategy()
    );

    return $metadata;
};

Стратегия интроспекции базы данных

Эта стратегия не требует настройки и неявно используется всеми адаптерами метаданных.

Стратегия аннотаций

Эта стратегия использует аннотации для описания столбцов в модели:

use Phalcon\Mvc\Model;

class Robots extends Model
{
    /**
     * @Primary
     * @Identity
     * @Column(type="integer", nullable=false)
     */
    public $id;

    /**
     * @Column(type="string", length=70, nullable=false)
     */
    public $name;

    /**
     * @Column(type="string", length=32, nullable=false)
     */
    public $type;

    /**
     * @Column(type="integer", nullable=false)
     */
    public $year;
}

Аннотации должны быть размещены в свойствах, которые сопоставляются со столбцами в сопоставленном источнике. Свойства без аннотации @Column обрабатываются как простые атрибуты класса.

Поддерживаются следующие аннотации:

Аннотация @Column поддерживает следующие параметры:

Стратегия аннотаций может быть настроена следующим образом:

use Phalcon\Mvc\Model\MetaData\Apc as ApcMetaData;
use Phalcon\Mvc\Model\MetaData\Strategy\Annotations as StrategyAnnotations;

$di["modelsMetadata"] = function () {
    // Instantiate a metadata adapter
    $metadata = new ApcMetaData(
        [
            "lifetime" => 86400,
            "prefix"   => "my-prefix",
        ]
    );

    // Set a custom metadata database introspection
    $metadata->setStrategy(
        new StrategyAnnotations()
    );

    return $metadata;
};

Метаданные вручную

Phalcon может автоматически получать метаданные для каждой модели, без необходимости разработчику устанавливать их вручную, используя любую из представленных выше стратегий интроспекции.

Разработчик также имеет возможность вручную определить метаданные. Эта стратегия переопределяет любую установленную в менеджере метаданных стратегию. Новые столбцы, добавленные/измененные/удаленные в/из сопоставленной таблицы, также должны быть добавлены/изменены/удалены для правильной работы.

Следующий пример демонстрирует, как определить метаданные вручную:

use Phalcon\Mvc\Model;
use Phalcon\Db\Column;
use Phalcon\Mvc\Model\MetaData;

class Robots extends Model
{
    public function metaData()
    {
        return array(
            // Every column in the mapped table
            MetaData::MODELS_ATTRIBUTES => [
                "id",
                "name",
                "type",
                "year",
            ],

            // Every column part of the primary key
            MetaData::MODELS_PRIMARY_KEY => [
                "id",
            ],

            // Every column that isn't part of the primary key
            MetaData::MODELS_NON_PRIMARY_KEY => [
                "name",
                "type",
                "year",
            ],

            // Every column that doesn't allows null values
            MetaData::MODELS_NOT_NULL => [
                "id",
                "name",
                "type",
            ],

            // Every column and their data types
            MetaData::MODELS_DATA_TYPES => [
                "id"   => Column::TYPE_INTEGER,
                "name" => Column::TYPE_VARCHAR,
                "type" => Column::TYPE_VARCHAR,
                "year" => Column::TYPE_INTEGER,
            ],

            // The columns that have numeric data types
            MetaData::MODELS_DATA_TYPES_NUMERIC => [
                "id"   => true,
                "year" => true,
            ],

            // The identity column, use boolean false if the model doesn't have
            // an identity column
            MetaData::MODELS_IDENTITY_COLUMN => "id",

            // How every column must be bound/casted
            MetaData::MODELS_DATA_TYPES_BIND => [
                "id"   => Column::BIND_PARAM_INT,
                "name" => Column::BIND_PARAM_STR,
                "type" => Column::BIND_PARAM_STR,
                "year" => Column::BIND_PARAM_INT,
            ],

            // Fields that must be ignored from INSERT SQL statements
            MetaData::MODELS_AUTOMATIC_DEFAULT_INSERT => [
                "year" => true,
            ],

            // Fields that must be ignored from UPDATE SQL statements
            MetaData::MODELS_AUTOMATIC_DEFAULT_UPDATE => [
                "year" => true,
            ],

            // Default values for columns
            MetaData::MODELS_DEFAULT_VALUES => [
                "year" => "2015",
            ],

            // Fields that allow empty strings
            MetaData::MODELS_EMPTY_STRING_VALUES => [
                "name" => true,
            ],
        );
    }
}