miraiwen/messages

在特定会话队列中处理消息

维护者

详细信息

github.com/Mireiawen/messages

源代码

问题

安装: 21

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

公开问题: 0

0.2.0 2019-10-07 01:54 UTC

Requires

MIT d435f5cc08c8da32be8d8deb1e459fbb2cac63a1

  • Mira Manninen <mir.woop@mireiawen.net>

This package is auto-updated.

Last update: 2024-09-07 12:15:44 UTC

README

在特定会话队列中处理消息

  • 类名: Queue, Message, Message\Level
  • 命名空间: Mireiawen\Messages

需求

  • Intl 扩展
  • PHP 7

安装

您可以从 GitHub 仓库 克隆或下载代码，或者可以使用 composer: composer require mireiawen/messages

方法

类 Queue

消息队列类。

__construct

Queue::__construct(string $session_key)

队列类构造函数，准备队列并从会话中读取任何现有消息。

参数
  • string $session_key - 存储消息的会话键
抛出的异常
\Exception
  • 如果会话不可用
  • 如果会话键包含无效数据

__destruct()

Queue::__destruct()

队列类析构函数，将当前队列存储到会话中

抛出的异常
\Exception
  • 如果会话不可用

添加

Queue::Add(Message $message)

将消息添加到队列中

参数
  • Message $message - 要添加的消息

获取

Queue::Get(bool $remove)

从队列中获取第一条消息

参数
  • bool $remove - TRUE 从队列中删除消息，FALSE 保留消息
返回值
  • Message - 消息本身

GetAll

Queue::GetAll(bool $remove)

从队列中获取所有消息

参数
  • bool $remove - TRUE 从队列中删除消息，FALSE 保留它们
返回值
  • Message[] - 消息

GetCount

Queue::GetCount()

获取队列中的消息数量

返回值
  • int - 队列中的消息数量

类 Message

消息类。

__construct

Message::__construct(string $message, int $code, Level $level)

创建消息

参数
  • string $message - 消息本身
  • int $code - 消息代码
  • Level $level - 消息级别

GetLevel

Message::GetLevel()

获取消息级别

返回值
  • Level - 消息级别

GetCode

Message::GetCode()

获取消息代码

返回值
  • int - 消息代码

GetMessage

Message::GetMessage()

获取消息本身

返回值
  • string - 消息

类 Level

消息级别枚举。更多信息请参见 PHP 枚举

级别

  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • SUCCESS
  • DEBUG