Phalcon消息

注意

所有类都以前缀命名Phalcon

消息\Exception¶

GitHub上的源码

命名空间
- Phalcon\Messages
使用
继承

\Exception
实现

在Phalcon\Messages*类中抛出的异常将使用此类

消息\Message¶

GitHub上的源码

命名空间
- Phalcon\Messages
使用
- JsonSerializable
继承
实现
- JsonSerializable
- MessageInterface

Phalcon\Messages\Message

存储来自各种组件的消息

属性¶

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

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

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

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

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

方法¶

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

Phalcon\Messages\Message构造函数

public function __toString(): string;

魔术__toString方法返回详细消息

public function getCode(): int;

public function getField(): string;

public function getMessage(): string;

public function getMetaData(): array;

public function getType(): string;

public function jsonSerialize(): array;

序列化对象以供json_encode使用

public function setCode( int $code ): MessageInterface;

为消息设置代码

public function setField( mixed $field ): MessageInterface;

设置与消息相关的字段名称

public function setMessage( string $message ): MessageInterface;

设置详细消息

public function setMetaData( array $metaData ): MessageInterface;

设置消息元数据

public function setType( string $type ): MessageInterface;

设置消息类型

消息\MessageInterface¶

GitHub上的源码

命名空间
- Phalcon\Messages
使用
继承
实现

Phalcon\Messages\MessageInterface

Phalcon\Messages\MessageInterface接口

方法¶

public function __toString(): string;

魔术__toString方法返回详细消息

public function getCode();

返回与此消息相关的消息代码

public function getField();

返回与消息相关的字段名称

public function getMessage(): string;

返回详细消息

public function getMetaData(): array;

返回消息元数据

public function getType(): string;

返回消息类型

public function setCode( int $code ): MessageInterface;

为消息设置代码

public function setField( string $field ): MessageInterface;

设置与消息相关的字段名称

public function setMessage( string $message ): MessageInterface;

设置详细消息

public function setMetaData( array $metaData ): MessageInterface;

设置消息元数据

public function setType( string $type ): MessageInterface;

设置消息类型

消息\Messages¶

GitHub上的源码

命名空间
- Phalcon\Messages
使用
- ArrayAccess
- Countable
- Iterator
- JsonSerializable
继承
实现
- ArrayAccess
- Countable
- Iterator
- JsonSerializable

表示消息集合

属性¶

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

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

方法¶

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

Phalcon\Messages\Messages构造函数

public function appendMessage( MessageInterface $message );

将消息附加到集合

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

public function appendMessages( mixed $messages );

将消息数组附加到集合

$messages->appendMessages($messagesArray);

public function count(): int;

返回列表中的消息数量

public function current(): MessageInterface;

返回迭代器中的当前消息

public function filter( string $fieldName ): array;

按字段名称过滤消息集合

public function jsonSerialize(): array;

返回作为数组的序列化消息对象以供json_encode使用。如果存在，则在每个对象上调用jsonSerialize

$data = $messages->jsonSerialize();
echo json_encode($data);

public function key(): int;

返回迭代器中的当前位置/键

public function next(): void;

将内部迭代指针移动到下一个位置

public function offsetExists( mixed $index ): bool;

检查索引是否存在

var_dump(
    isset($message["database"])
);

public function offsetGet( mixed $index ): mixed;

使用数组语法获取消息属性

print_r(
    $messages[0]
);

public function offsetSet( mixed $offset, mixed $value ): void;

使用数组语法设置属性

$messages[0] = new \Phalcon\Messages\Message("This is a message");

public function offsetUnset( mixed $index ): void;

从列表中删除消息

unset($message["database"]);

public function rewind(): void;

重绕内部迭代器

public function valid(): bool;

检查迭代器中的当前消息是否有效