Secciones

Class Phalcon\Messages\Exception

Código fuente en GitHub

Namespace Phalcon\Messages   Extends \Phalcon\Exception

Phalcon\Validation\Exception

Las excepciones lanzadas en las clases Phalcon\Messages* usarán esta clase

Class Phalcon\Messages\Message

Código fuente en GitHub

Namespace Phalcon\Messages   Uses JsonSerializable   Implements MessageInterface, JsonSerializable

Phalcon\Messages\Message

Almacena un mensaje de varios componentes

Propiedades

/**
 * @var int
 */
protected code;

/**
 * @var string
 */
protected field;

/**
 * @var string
 */
protected message;

/**
 * @var string
 */
protected type;

/**
 * @var array
 */
protected metaData;

Métodos

public function __construct( string $message, mixed $field = string, string $type = string, int $code = int, array $metaData = [] );

Constructor Phalcon\Messages\Message

public function __toString(): string;

Método mágico __toString que devuelve un mensaje detallado

public function getCode(): int
public function getField(): string
public function getMessage(): string
public function getMetaData(): array
public function getType(): string
public function jsonSerialize(): array;

Serializa el objeto por json_encode

public function setCode( int $code ): MessageInterface;

Establece el código del mensaje

public function setField( mixed $field ): MessageInterface;

Establece el campo nombre relacionado con el mensaje

public function setMessage( string $message ): MessageInterface;

Establece un mensaje detallado

public function setMetaData( array $metaData ): MessageInterface;

Establece los metadatos del mensaje

public function setType( string $type ): MessageInterface;

Establece el tipo del mensaje

Interface Phalcon\Messages\MessageInterface

Código fuente en GitHub

Namespace Phalcon\Messages

Phalcon\Messages\MessageInterface

Interfaz para Phalcon\Messages\MessageInterface

Métodos

public function __toString(): string;

Método mágico __toString que devuelve un mensaje detallado

public function getCode();

Devuelve el código del mensaje relacionado con este mensaje

public function getField();

Devuelve el nombre del campo relacionado con el mensaje

public function getMessage(): string;

Devuelve un mensaje detallado

public function getMetaData(): array;

Devuelve los metadatos del mensaje

public function getType(): string;

Devuelve el tipo de mensaje

public function setCode( int $code ): MessageInterface;

Establece el código del mensaje

public function setField( string $field ): MessageInterface;

Establece el campo nombre relacionado con el mensaje

public function setMessage( string $message ): MessageInterface;

Establece un mensaje detallado

public function setMetaData( array $metaData ): MessageInterface;

Establece los metadatos del mensaje

public function setType( string $type ): MessageInterface;

Establece el tipo del mensaje

Class Phalcon\Messages\Messages

Código fuente en GitHub

Namespace Phalcon\Messages   Uses ArrayAccess, Countable, Iterator, JsonSerializable   Implements ArrayAccess, Countable, Iterator, JsonSerializable

Representa una colección de mensajes

Propiedades

/**
 * @var int
 */
protected position = 0;

/**
 * @var array
 */
protected messages;

Métodos

public function __construct( array $messages = [] );

Constructor Phalcon\Messages\Messages

public function appendMessage( MessageInterface $message );

Añade un mensaje a la colección

$messages->appendMessage(
    new \Phalcon\Messages\Message("This is a message")
);
public function appendMessages( mixed $messages );

Añade un vector de mensajes a la colección

$messages->appendMessages($messagesArray);
public function count(): int;

Devuelve el número de mensajes en la lista

public function current(): MessageInterface;

Devuelve el mensaje actual en el iterador

public function filter( string $fieldName ): array;

Filtra la colección de mensajes por nombre de campo

public function jsonSerialize(): array;

Devuelve objetos de mensaje serializados como vector por json_encode. Llama jsonSerialize en cada objeto si está presente

$data = $messages->jsonSerialize();
echo json_encode($data);
public function key(): int;

Devuelve la llave/posición actual del iterador

public function next(): void;

Mueve el puntero interno de iteración a la siguiente posición

public function offsetExists( mixed $index ): bool;

Comprueba si existe un índice

var_dump(
    isset($message["database"])
);
public function offsetGet( mixed $index ): mixed;

Obtiene un atributo de un mensaje usando la sintaxis vector

print_r(
    $messages[0]
);
public function offsetSet( mixed $index, mixed $message ): void;

Establece un atributo usando la sintaxis-vector

$messages[0] = new \Phalcon\Messages\Message("This is a message");
public function offsetUnset( mixed $index ): void;

Elimina un mensaje de la lista

unset($message["database"]);
public function rewind(): void;

Rebobina el iterador interno

public function valid(): bool;

Comprueba si el mensaje actual en el iterador es válido