chevere/message

Strings with template tags support

1.0.0 2024-01-08 11:38 UTC

Requires

• php: ^8.1

Requires (Dev)

• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^9.5
• symplify/easy-coding-standard: ^11.1

Apache-2.0

• Rodolfo Berrios

README

Summary

Message enables to create strings with template tags support.

Installing

Message is available through Packagist and the repository source is at chevere/message.

composer require chevere/message

Creating a Message

Use function message to create a Message by passing the message template. Use named named arguments to define replacement pairs.

use function Chevere\Message\message;

$message = message(
    'Hello, **%tag%**!',
    tag: 'World'
);

🪄 Message supports %tag%, {{tag}} and {{ tag }} replacement template tags.

To string

The __toString method return the message with translated placeholders.

$message->__toString();
// Hello, **World**!

Utility methods

Template

Use template method to return the message template.

$message->replacements();
// Hello, **%tag%**!

Replacements

Use replacements method to read message replacement pairs.

$message->replacements();
// ['tag' => 'World']

Documentation

Documentation is available at chevere.org.

License

Copyright Rodolfo Berrios A.

Chevere is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.