Behaviors are shared constructs that several models may adopt in order to re-use code. Although you can use traits to reuse code, behaviors have several benefits that make them more appealing. Los Traits requieren que use exactamente los mismos nombres de campos para que el código común funcione. Los Comportamientos son más flexibles.
El ORM proporciona un API para implementar los comportamientos en sus modelos. Además, puede usar los eventos y las llamadas de retorno vistas anteriormente como alternativa para implementar los comportamientos.
Un comportamiento se debe añadir en el inicializador del modelo, un modelo puede tener ninguno o más comportamientos:
Czech
German
Greek
English (US)
Persian
French
Indonesian
Italian
Japanese
Korean
Polish
Portuguese, Brazilian
Russian
Turkish
Ukrainian
Chinese Simplified<?php
use Phalcon\Mvc\Model;
use Phalcon\Mvc\Model\Behavior\Timestampable;
class Invoices extends Model
{
/**
* @var int
*/
public $inv_id;
/**
* @var string
*/
public $inv_created_at;
/**
* @var int
*/
public $inv_status_flag;
/**
* @var string
*/
public $inv_title;
public function initialize()
{
$this->addBehavior(
new Timestampable(
[
'beforeCreate' => [
'field' => 'inv_created_at',
'format' => 'Y-m-d',
],
]
)
);
}
}
El framework proporciona los siguientes comportamientos integrados:
| Nombre | Descripción |
|---|---|
| SoftDelete | En lugar de borrar permanentemente un registro, marca el registro como borrado cambiando el valor de una columna bandera |
| Timestampable | Le permite actualizar automáticamente un atributo del modelo guardando la fecha cuando un registro se crea o actualiza |
Este comportamiento recibe un vector de opciones, la clave del primer nivel debe ser un nombre de evento que indica cuando se debe asignar la columna:
<?php
use Phalcon\Mvc\Model\Behavior\Timestampable;
public function initialize()
{
$this->addBehavior(
new Timestampable(
[
'beforeCreate' => [
'field' => 'inv_created_at',
'format' => 'Y-m-d',
],
]
)
);
}
Each event can have its own options, field is the name of the column that must be updated, if format is a string it will be used as the format of the date function. format puede ser una función anónima que ofrece funcionalidad adicional para generar cualquier tipo de cadena de marca de tiempo:
<?php
use DateTime;
use DateTimeZone;
use Phalcon\Mvc\Model\Behavior\Timestampable;
public function initialize()
{
$this->addBehavior(
new Timestampable(
[
'beforeCreate' => [
'field' => 'inv_created_at',
'format' => function () {
$datetime = new Datetime(
new DateTimeZone('Europe/Stockholm')
);
return $datetime->format('Y-m-d H:i:sP');
},
],
]
)
);
}
If the option format is omitted a timestamp using the PHP’s function time, will be used.
Este comportamiento se puede usar como sigue:
<?php
use Phalcon\Mvc\Model;
use Phalcon\Mvc\Model\Behavior\SoftDelete;
class Invoices extends Model
{
const ACTIVE = 1;
const INACTIVE = 0;
/**
* @var int
*/
public $inv_id;
/**
* @var string
*/
public $inv_created_at;
/**
* @var int
*/
public $inv_deleted_flag;
/**
* @var string
*/
public $inv_title;
public function initialize()
{
$this->addBehavior(
new SoftDelete(
[
'field' => 'inv_deleted_flag',
'value' => Invoices::INACTIVE,
]
)
);
}
}
Este comportamiento acepta dos opciones: field y value, field determina el campo a ser actualizado y value el valor para estar borrado. Suponiendo que nuestra tabla tiene las siguientes filas:
mysql> select * from co_invoices;
+--------+------------------+-----------------------------+
| inv_id | inv_deleted_flag | inv_title |
+--------+------------------+-----------------------------+
| 1 | 0 | Invoice for ACME Inc. |
| 2 | 0 | Invoice for Spaceballs Inc. |
+--------+------------------+-----------------------------+
2 rows in set (0.00 sec)
Si borramos cualquiera de los dos registros se actualizará el estado en lugar de borrar el registro:
<?php
Invoices::findFirst(2)->delete();
La operación provocará los siguientes datos en la tabla:
mysql> select * from co_invoices;
+--------+------------------+-----------------------------+
| inv_id | inv_deleted_flag | inv_title |
+--------+------------------+-----------------------------+
| 1 | 0 | Invoice for ACME Inc. |
| 2 | 1 | Invoice for Spaceballs Inc. |
+--------+------------------+-----------------------------+
2 rows in set (0.00 sec)
NOTE: You will need to ensure to specify the deleted condition to filter your records so that you can get deleted or not deleted results back. Este comportamiento no soporta filtrado automático.
El ORM proporciona un API para crear sus propios comportamientos. A behavior must be a class implementing the Phalcon\Mvc\Model\BehaviorInterface or extend Phalcon\Mvc\Model\Behavior which exposes most of the methods required for implementing custom behaviors.
The Phalcon\Mvc\Model\BehaviorInterface requires two methods to be present in your custom behavior:
public function missingMethod(
ModelInterface $model,
string $method,
array $arguments = []
)
This method acts as a fallback when a missing method is called on the model
public function notify(
string $type,
ModelInterface $model
)
Este método recibe las notificaciones del Events Manager.
Additionally, if you extend Phalcon\Mvc\Model\Behavior, you have access to:
| Método | Descripción |
|---|---|
getOptions(string $eventName = null) |
Devuelve las opciones de comportamiento relacionadas a un evento |
mustTakeAction(string $eventName) |
Comprueba si el comportamiento debe actuar en ciertos eventos |
El siguiente comportamiento es un ejemplo, implementa el comportamiento Blameable que ayuda a identificar el usuario que ha ejecutado operaciones sobre el modelo:
<?php
use Phalcon\Di;
use Phalcon\Mvc\ModelInterface;
use Phalcon\Mvc\Model\Behavior;
class Blameable extends Behavior
{
public function notify(string $eventType, ModelInterface $model)
{
$container = Di::getDefault();
$userName = $container->get('auth')->getFullName();
switch ($eventType) {
case 'afterCreate':
case 'afterDelete':
case 'afterUpdate':
file_put_contents(
'logs/blamable-log.txt',
$userName . ' ' . $eventType . ' ' . $model->inv_id
);
break;
default:
// ...
}
}
}
Lo anterior es un comportamiento muy simple, pero ilustra como crear un comportamiento. Añadir el comportamiento a un modelo se ilustra a continuación:
<?php
use Phalcon\Mvc\Model;
class Invoices extends Model
{
public function initialize()
{
$this->addBehavior(
new Blameable()
);
}
}
Un comportamiento también es capaz de interceptar métodos inexistentes en sus modelos, y ofrecer funcionalidad para ellos:
<?php
use Phalcon\Tag;
use Phalcon\Mvc\ModelInterface;
use Phalcon\Mvc\Model\Behavior;
use Phalcon\Mvc\Model\BehaviorInterface;
class Sluggable extends Behavior
{
public function missingMethod(
ModelInterface $model,
string $method,
$arguments = []
) {
if ($method === 'getSlug') {
return Tag::friendlyTitle($model->title);
}
}
}
Llamar a ese método en un modelo que implementa Sluggable devuelve un título amigable SEO:
<?php
$title = $invoice->getSlug();
You can use Traits to re-use code in your classes, this is another way to implement custom behaviors. El siguiente rasgo implementa una versión simple del comportamiento Timestampable:
<?php
trait Timestampable
{
public function beforeCreate()
{
$this->inv_created_at = date('r');
}
public function beforeUpdate()
{
$this->inv_updated_at = date('r');
}
}
Entonces puede usarlo en su modelo de la siguiente manera:
<?php
use Phalcon\Mvc\Model;
class Invoices extends Model
{
use Timestampable;
}
NOTE: You can use traits instead of behaviors, but they do require that all your fields, that the behavior will affect, must have the same name. Also, if you implement an event method in a trait (e.g.
beforeCreate) you cannot have it also in your model since the two will produce an error.