Docs4dev
Docs
cakephp / 4.4 / class-cake.i18n.package.html

Class Package

Message Catalog

Namespace: Cake\I18n

Property Summary

  • $fallback protected
    string|null

    The name of a fallback package to use when a message key does not exist.

  • $formatter protected
    string

    The name of the formatter to use when formatting translated messages.

  • $messages protected
    array<array|string>

    Message keys and translations in this package.

Method Summary

Method Detail

__construct() public

__construct(string $formatter = 'default', string|null $fallback = null, array<array|string> $messages = [])

Constructor.

Parameters

string $formatter optional

The name of the formatter to use.

string|null $fallback optional

The name of the fallback package to use.

array<array|string> $messages optional

The messages in this package.

addMessage() public

addMessage(string $key, array|string $message): void

Adds one message for this package.

Parameters

string $key

the key of the message

array|string $message

the actual message

Returns

void

addMessages() public

addMessages(array<array|string> $messages): void

Adds new messages for this package.

Parameters

array<array|string> $messages

The messages to add in this package.

Returns

void

getFallback() public

getFallback(): string|null

Gets the fallback package name.

Returns

string|null

getFormatter() public

getFormatter(): string

Gets the formatter name for this package.

Returns

string

getMessage() public

getMessage(string $key): array|string|false

Gets the message of the given key for this package.

Parameters

string $key

the key of the message to return

Returns

array|string|false

getMessages() public

getMessages(): array<array|string>

Gets the messages for this package.

Returns

array<array|string>

setFallback() public

setFallback(string|null $fallback): void

Sets the fallback package name.

Parameters

string|null $fallback

The fallback package name.

Returns

void

setFormatter() public

setFormatter(string $formatter): void

Sets the formatter name for this package.

Parameters

string $formatter

The formatter name for this package.

Returns

void

setMessages() public

setMessages(array<array|string> $messages): void

Sets the messages for this package.

Parameters

array<array|string> $messages

The messages for this package.

Returns

void

Property Detail

$fallback protected

The name of a fallback package to use when a message key does not exist.

Type

string|null

$formatter protected

The name of the formatter to use when formatting translated messages.

Type

string

$messages protected

Message keys and translations in this package.

Type

array<array|string>

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.I18n.Package.html