---
title: "Phalcon Messages"
version: "5.20"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Messages
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Messages\Exception
Class
Exceptions thrown in Phalcon\Messages\* classes will use this class
- `\Exception`
- **`Phalcon\Messages\Exception`**
- [`Phalcon\Messages\Exceptions\MessageNotObject`](#messagesexceptionsmessagenotobject)
- [`Phalcon\Messages\Exceptions\MessagesNotIterable`](#messagesexceptionsmessagesnotiterable)
## Messages\Exceptions\MessageNotObject
Class
- `\Exception`
- [`Phalcon\Messages\Exception`](#messagesexception)
- **`Phalcon\Messages\Exceptions\MessageNotObject`**
`Phalcon\Messages\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Messages\Exceptions\MessagesNotIterable
Class
- `\Exception`
- [`Phalcon\Messages\Exception`](#messagesexception)
- **`Phalcon\Messages\Exceptions\MessagesNotIterable`**
`Phalcon\Messages\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Messages\Message
Class
Class Message
Stores a message from various components
- **`Phalcon\Messages\Message`** - implements [`Phalcon\Messages\MessageInterface`](#messagesmessageinterface), `\JsonSerializable`
`JsonSerializable` · `Phalcon\Contracts\Messages\MessagesTypes`
### Method Summary
Phalcon\Messages\Message constructor
Magic __toString method returns verbose message
Serializes the object for json_encode
Sets code for the message
Sets field name related to message
Sets verbose message
Sets message metadata
Sets message type
### Properties
### Methods
__construct()
```php
public function __construct(
string $message,
string $field = "",
string $type = "",
int $code = 0,
array $metaData = []
);
```
Phalcon\Messages\Message constructor
__toString()
```php
public function __toString(): string;
```
Magic __toString method returns verbose message
getCode()
```php
public function getCode(): int;
```
getField()
```php
public function getField(): string;
```
getMessage()
```php
public function getMessage(): string;
```
```php
public function getMetaData(): array;
```
getType()
```php
public function getType(): string;
```
jsonSerialize()
```php
public function jsonSerialize(): array;
```
Serializes the object for json_encode
setCode()
```php
public function setCode( int $code ): MessageInterface;
```
Sets code for the message
setField()
```php
public function setField( string $field ): MessageInterface;
```
Sets field name related to message
setMessage()
```php
public function setMessage( string $message ): MessageInterface;
```
Sets verbose message
```php
public function setMetaData( array $metaData ): MessageInterface;
```
Sets message metadata
setType()
```php
public function setType( string $type ): MessageInterface;
```
Sets message type
## Messages\MessageInterface
Interface
Interface for Phalcon\Messages\Message
- **`Phalcon\Messages\MessageInterface`**
`Phalcon\Contracts\Messages\MessagesTypes`
### Method Summary
Magic __toString method returns verbose message
Returns the message code related to this message
Returns field name related to message
Returns verbose message
Returns message metadata
Returns message type
Sets code for the message
Sets field name related to message
Sets verbose message
Sets message metadata
Sets message type
### Methods
__toString()
```php
public function __toString(): string;
```
Magic __toString method returns verbose message
getCode()
```php
public function getCode(): int;
```
Returns the message code related to this message
getField()
```php
public function getField(): string;
```
Returns field name related to message
getMessage()
```php
public function getMessage(): string;
```
Returns verbose message
```php
public function getMetaData(): array;
```
Returns message metadata
getType()
```php
public function getType(): string;
```
Returns message type
setCode()
```php
public function setCode( int $code ): MessageInterface;
```
Sets code for the message
setField()
```php
public function setField( string $field ): MessageInterface;
```
Sets field name related to message
setMessage()
```php
public function setMessage( string $message ): MessageInterface;
```
Sets verbose message
```php
public function setMetaData( array $metaData ): MessageInterface;
```
Sets message metadata
setType()
```php
public function setType( string $type ): MessageInterface;
```
Sets message type
## Messages\Messages
Class
Represents a collection of messages
Messages are stored and iterated by integer position. An entry added under a
string key through the ArrayAccess interface (for example
`$messages["database"] = $message`) stays reachable by that offset but is not
visited during iteration (`foreach`), which walks the integer sequence only.
Use the append methods (`appendMessage()` / `appendMessages()`) when entries
must take part in iteration.
- **`Phalcon\Messages\Messages`** - implements [`Phalcon\Contracts\Messages\Messages`](/5.20/api/phalcon_contracts/#contractsmessagesmessages), `\JsonSerializable`
`Iterator` · `JsonSerializable` · `Phalcon\Contracts\Messages\Messages` · `Phalcon\Contracts\Messages\MessagesTypes` · `Phalcon\Messages\Exceptions\MessageNotObject` · `Phalcon\Messages\Exceptions\MessagesNotIterable` · `Phalcon\Messages\Traits\MessagesHelperTrait` · `Traversable`
### Method Summary
Phalcon\Messages\Messages constructor
Appends a message to the collection
Appends an array of messages to the collection
Filters the message collection by field name
Returns serialised message objects as array for json_encode. Calls
### Methods
__construct()
```php
public function __construct( array $messages = [] );
```
Phalcon\Messages\Messages constructor
appendMessage()
```php
public function appendMessage( MessageInterface $message ): void;
```
Appends a message to the collection
```php
$messages->appendMessage(
new \Phalcon\Messages\Message("This is a message")
);
```
appendMessages()
```php
public function appendMessages( mixed $messages );
```
Appends an array of messages to the collection
```php
$messages->appendMessages($messagesArray);
```
Accepts an array of MessageInterface objects or an Iterator yielding
them. The parameter stays untyped so that a non-iterable argument
reaches the guard below and raises MessagesNotIterable rather than a
TypeError.
filter()
```php
public function filter( string $fieldName ): array;
```
Filters the message collection by field name
jsonSerialize()
```php
public function jsonSerialize(): array;
```
Returns serialised message objects as array for json_encode. Calls
jsonSerialize on each object if present
```php
$data = $messages->jsonSerialize();
echo json_encode($data);
```
## Messages\Traits\MessagesHelperTrait
Trait
Trait MessagesHelperTrait
- **`Phalcon\Messages\Traits\MessagesHelperTrait`**
`Phalcon\Contracts\Messages\MessagesTypes` · `Phalcon\Messages\Exceptions\MessageNotObject` · `Phalcon\Messages\MessageInterface`
[`Phalcon\Messages\Messages`](#messagesmessages)
### Method Summary
Returns the number of messages in the list
Returns the current message in the iterator
Returns the current position/key in the iterator
Moves the internal iteration pointer to the next position
Checks if an index exists
Gets an attribute a message using the array syntax
Sets an attribute using the array-syntax
Removes a message from the list
Rewinds the internal iterator
Check if the current message in the iterator is valid
### Properties
### Methods
count()
```php
public function count(): int;
```
Returns the number of messages in the list
current()
```php
public function current(): MessageInterface;
```
Returns the current message in the iterator
key()
```php
public function key(): int;
```
Returns the current position/key in the iterator
next()
```php
public function next(): void;
```
Moves the internal iteration pointer to the next position
offsetExists()
```php
public function offsetExists( mixed $offset ): bool;
```
Checks if an index exists
```php
var_dump(
isset($message["database"])
);
```
offsetGet()
```php
public function offsetGet( mixed $offset ): mixed;
```
Gets an attribute a message using the array syntax
```php
print_r(
$messages[0]
);
```
offsetSet()
```php
public function offsetSet(
mixed $offset,
mixed $value
): void;
```
Sets an attribute using the array-syntax
```php
$messages[0] = new \Phalcon\Messages\Message("This is a message");
```
offsetUnset()
```php
public function offsetUnset( mixed $offset ): void;
```
Removes a message from the list
```php
unset($message["database"]);
```
rewind()
```php
public function rewind(): void;
```
Rewinds the internal iterator
valid()
```php
public function valid(): bool;
```
Check if the current message in the iterator is valid
Source: https://docs.phalcon.io/5.20/api/phalcon_messages/index.mdx