Los Comportamientos son construcciones compartidas que varios modelos pueden adoptar para reutilizar código. Aunque puede usar traits para reutilizar código, los comportamientos tienen varios beneficios que los hacen más atractivos. 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',
],
]
)
);
}
Cada evento puede tener sus propias opciones, field es el nombre de la columna que se debe actualizar, si format es una cadena se usará como formato de la función date. 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');
},
],
]
)
);
}
Si se omite la opción format se usará una marca de tiempo generada con la función PHP time.
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)
NOTA: Deberá asegurarse de especificar la condición deleted para filtrar sus registros con lo que podrá obtener de vuelta los resultados borrados o no borrados. Este comportamiento no soporta filtrado automático.
El ORM proporciona un API para crear sus propios comportamientos. Un comportamiento debe ser una clase que implemente Phalcon\Mvc\Model\BehaviorInterface o extienda Phalcon\Mvc\Model\Behavior que expone la mayoría de métodos necesarios para implementar comportamientos personalizados.
Phalcon\Mvc\Model\BehaviorInterface requiere que estén presentes dos métodos en su comportamiento personalizado:
public function missingMethod(
ModelInterface $model,
string $method,
array $arguments = []
)
Este método actúa como respaldo cuando se llama un método inexistente en el modelo
public function notify(
string $type,
ModelInterface $model
)
Este método recibe las notificaciones del Events Manager.
Adicionalmente, si extiende Phalcon\Mvc\Model\Behavior, tiene acceso a:
getOptions(string $eventName = null) - Devuelve las opciones del comportamiento relativas a un eventomustTakeAction(string $eventName) - bool - Comprueba si el comportamiento debe realizar acciones sobre un cierto eventoEl 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(
string $model,
ModelInterface $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();
Puede usar Rasgos para reutilizar código en sus clases, esta es otra manera de implementar comportamientos personalizados. 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;
}
NOTA: Puede usar rasgos en lugar de comportamientos, pero requerirán que todos los campos afectados por el comportamiento tengan el mismo nombre. También, si implementa un método de evento en un rasgo (ej.
beforeCreate) no podrá tenerlo también en su modelo ya que los dos producirán un error.