eftec/messagecontainer

MessageContainer is a simple a minimalist message-system where messages (strings) could be stored in a tree-like structure

Maintainers

Details

github.com/EFTEC/MessageContainer

Homepage

Source

Issues

Installs: 8 976

Dependents: 3

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 1

Open Issues: 0

2.9 2024-03-02 16:26 UTC

Requires

Requires (Dev)

MIT de7f0bacee59deae7e9376c9a2432e824bcf15d5

  • Jorge Castro <jcastro.woop@eftec.cl>

This package is auto-updated.

Last update: 2024-10-31 00:24:13 UTC

README

It is a Message Container for PHP, similar in functionality MessageBag for Laravel. However, this is aimed for speed and usability, and it doesn't have any dependency.

This class is simple: 2 classes, no dependency and nothing more. You can use in any PHP project.

Packagist Total Downloads Maintenance composer php php CocoaPods

What is the objective?

This library stores messages (strings) in different lockers and each locker could contain different messages with different levels (error, warning, info and success). The goal of this library:

  • It stores messages depending on an "id", including the severity and message (a simple text).
  • The library does not generate an error if the value we want to read does not exist, So we don't need to use of isset() in our code. It also avoids the use of count() and is_array() in our code, this library already does it for us.
    • It returns an empty value (not null) if the message does not exist or if there is no message.
    • It returns an empty array (not null) if the list of messages does not exist
    • It returns an empty locker (not null) if the locker does not exist.
  • It is possible to returns the first error or warning at the same time. In this case, if the locker stores an error and a warning, then it returns the error (it has priority).
  • It is able to return:
    • all messages stored in some locker or container.
    • the first message (with or without some level)
    • the number of messages (for some level)
    • if the container of locker has error or warning.
  • It is as fast as possible

It is an example from where we could use it, the validation of a form (this library does not validate or show values it only stores the information)

docs/validation_example.png

In this example, we have :

  • one container (the form)
  • multiples textboxes (each one is a locker)
  • and each textbox (our lockers) could contain one of more messages with different levels (in this case, success or error).

If we use plain-PHP, we could show some messages of the password:

echo $container['password']['error'];

But what if the id password does not contain any message, or if there is no error? of if there is more than error?

So we could re-define something like that: (but it will still fail if there is more than one error)

Vanilla PHP:

if (isset($container['password'])) {
    if(isset($container['password']['error'])) {
        echo $container['password']['error'];
    }
}

And with our library

// We could show the first error (or empty if none):
echo $container->getLocker('password')->firstError(); 

// it shows all errors (or nothing if none):
foreach($container->getLocker('password')->allError() as $msg) {
    echo $msg;
}

How to use it

use eftec\MessageContainer;
$container=new MessageContainer(); // we create the full lockers
$container->addItem('locker1','It is a message','warning');  // we store a message inside "id1"
$container->addItem('locker1','It is a message','error');  // we store another message inside "id1"

// And later, you can process it

$lastErrorsOrWarnings=$container->get('locker1')->allErrorOrWarning();
// it will not crash even if the locker2 does not exists.
$lastErrorsOrWarnings2=$container->get('locker2')->allErrorOrWarning();

Definitions

Let's say the next example of container that shows every part of the Container.

docs/img1.png

We have 3 levels of spaces.

  • Container. Usually it is unique, and it is defined by our instance of MessageContainer.
    The container could contain from zero to multiples lockers. Each locker is identified by a unique "id".
  • Locker. Every time we add an item, we could create or update a new container.
    Every locker could contain from zero to many error, warning, info or success and each one could contain from zero to many messages.
  • Our messages or items are categorized in 4 levels, error, warning, info and success.
    Each level could contain one or many messages (or none)

Messages are leveled as follows

Example #2

Example of form and MessageContainer

examples/formexample.php

docs/form1.jpg

Example #3:

$container=new MessageContainer();
$container->addItem('id1','some msg 1','error');
$container->addItem('id1','some msg 2','error');
$container->addItem('id1','some msg 1','warning');

$container->addItem('id2','some msg 1','info');
$container->addItem('id2','some msg 1','success');

$container->addItem('id33','some msg 1','error');
$container->addItem('id33','some msg 2','error');
$container->addItem('id33','some msg 1','success');
$container->addItem('id33','some msg 2','success');
$container->addItem('id33','some msg 2','success');

// obtaining information per locker
$msg=$container->getLocker('id1')->firstErrorOrWarning(); // returns if the locker id1 has an error or warning
$msg2=$container->getLocker('id2')->allInfo(); // returns all info store in locker id2 ["some msg1","some msg2"]
$msg3=$container->getLocker('id3')->allInfo(); // (note this locker is not defined so it returns an empty array.
$msg4=$container->getLocker('id33')->hasError(); // returns true if there is an error.
$msg5=$container->getLocker('id33')->countError(); // returns the number of errors (or zero if none).

// obtaining information globally (all lockers)
$msg7=$container->hasError(); // returns true if there is an error in any locker.
$msg8=$container->allErrorArray(true); // returns all errors and warnings presents in any locker.

Adding a new message

To add a new message inside a locker, we use the method addItem()

$container->addItem(<idlocker>,<message>,<level>,<context array>);

Where

  • idlocker is the identifier of the locker to where we will store our message.
  • message is the string of the message.
    • The message could show variables using the syntax: {{variablename}}. Example "The value {{variable}} is not valid"
    • We could show the id of the locker using the syntax {{_idlocker}}. Example: "The variable {{_idlocker}} is empty"
  • level is the level of message. It could be error, warning, info and success. By default, this value is "error"
  • context (optional) is an associative array used to show a message with a variable. The context is set only once per locker.
// without context:
$container->addItem('locker1','The variable price must be higher than 200','warning');

// with context:
// The variable price must be higher than 200
$container->addItem('locker2'
                    ,'The variable {{var1}} must be higher than {{var2}}'
                    ,'warning'
                    ,['var1'=>'price','var2'=>200]);
// The variable price must be higher than 200 (not 500, the context is not updated this second time)
$container->addItem('locker2'
                    ,'The variable {{var1}} must be higher than {{var2}}'
                    ,'warning'
                    ,['var1'=>'price','var2'=>500]);
// The variable price must be higher than 200 (we use the previous context)
$container->addItem('locker2'
                    ,'The variable {{var1}} must be higher than {{var2}}'
                    ,'warning');

Note: We could add one or many messages to a locker. In the later example, the locker locker2 stores 3 messages.

Note: The message is evaluated when we call the method addItem()

Getting the messages

MessageContainer stores a list of lockers of messages. It's aimed at convenience, so it features many methods to access the information in different ways.

Messages are ranked as follows

Sometimes, both errors are warning are considered as equals. So the system allows reading an error or warning.

Error always has the priority, then warning, info and success. If you want to read the first message, then it starts searching for errors.

You can obtain a message as an array of objects of the type MessageLocker, as an array of string, or as a single string (first message)

$container->get('idfield'); // container idfield
$container->get('idfield2'); // container idfield2

if($container->hasError()) {
    // Error: we do something here.
    echo "we found ".$container->errorCount()." errors in all lockers";   
}

// using messageList
if($container->hasError()) {
    // Error: we do something here.
    echo "we found ".$container->errorcount." errors in all lockers";
    
}

MessageContainer

Count of messages of all lockers

Example:

if ($container->errorcount>0) {
    // some error
}

Obtain messages or text of all lockers

echo $container->firstErrorText(); // returns first error if any
$array=$container->allError();  // MessageLocker[]
echo $array[0]->firstError(); 
$array=$container->allErrorArray();  // string[]
echo $array[0];

Css for a specific container

It is possible to obtain a CSS class based in the current level or state of a container.

  • $cssClasses (field) is an associative array to use with the method cssClass()

  • cssClasses() is method that returns a class based in the type of level of the container

$css=$this-messageList->cssClasses('container1');

Misc

echo $container->resetAll(); // resets all lockers
$container->addItem('containerid','it is a message','error'); // we add an error in the container with #id containerid
$array=$container->allIds(); // ['containerid']
var_dump($validation->get('containerid'));  // object MessageLocker

$array=$this-messageList->items;
var_dump($this-messageList->items['containerid']); // object MessageLocker

if($container->hasError()) { // $validation->hasError() does the same
    echo "there is an error";
}

MessageLocker

Inside MessageContainer we could have one or many lockers( MessageLocker ).

Obtain messages of a specific container

$container->get('idfield'); // container idfield 

echo $container->firstErrorText(); // we show the first error (if any) in the container
var_dump($container->allError); // we show the all errors

Definitions of the classes

Table of contents

MessageContainer

Class MessageList

Field items (MessageLocker[])

Array of containers

Field errorCount (int)

Number of errors stored globally

Field warningCount (int)

Number of warnings stored globally

Field errorOrWarningCount (int)

Number of errors or warning stored globally

Field infoCount (int)

Number of information stored globally

Field successCount (int)

Number of success stored globally

Field cssClasses (string[])

Used to convert a type of message to a css class

Method __construct()

MessageList constructor.

Method resetAll()

It resets all the container and flush all the results.

Method addItem()

You could add a message (including errors,warning..) and store it in a $idLocker

Parameters:

  • $idLocker Identified of the locker (where the message will be stored) (string)
  • $message message to show. Example: 'the value is incorrect' (string)
  • $level =['error','warning','info','success'][$i] (string)
  • $context [optional] it is an associative array with the values of the item
    For optimization, the context is not update if exists another context. (array)

Method allIds()

It obtains all the ids for all the lockers.

Method get()

Alias of $this->getMessage()

Parameters:

  • $idLocker ID of the locker (string)

Method getLocker()

It returns a MessageLocker containing a locker.
If the locker doesn't exist then it returns an empty object (not null)

Parameters:

  • $idLocker ID of the locker (string)

Method cssClass()

It returns a css class associated with the type of errors inside a locker
If the locker contains more than one message, then it uses the most severe one (error,warning,etc.)
The method uses the field $this->cssClasses, so you can change the CSS classes.

$this->clsssClasses=['error'=>'class-red','warning'=>'class-yellow','info'=>'class-green','success'=>'class-blue'];
$css=$this->cssClass('customerId');

Parameters:

  • $idLocker ID of the locker (string)

Method firstErrorOrWarning()

It returns the first message of error or empty if none
If not, then it returns the first message of warning or empty if none

Parameters:

  • $default if not message is found, then it returns this value (string)

Method firstErrorText()

It returns the first message of error or empty if none

Parameters:

  • $default if not message is found, then it returns this value. (string)
  • $includeWarning if true then it also includes warning but any error has priority. (bool)

Method firstWarningText()

It returns the first message of warning or empty if none

Parameters:

  • $default if not message is found, then it returns this value (string)

Method firstInfoText()

It returns the first message of information or empty if none

Parameters:

  • $default if not message is found, then it returns this value (string)

Method firstSuccessText()

It returns the first message of success or empty if none

Parameters:

  • $default if not message is found, then it returns this value (string)

Method lastErrorOrWarning()

It returns the last message of error or empty if none
If not, then it returns the last message of warning or empty if none

Parameters:

  • $default if not message is found, then it returns this value (string)

Method lastErrorText()

It returns the last message of error or empty if none

Parameters:

  • $default if not message is found, then it returns this value. (string)
  • $includeWarning if true then it also includes warning but any error has priority. (bool)

Method lastWarningText()

It returns the last message of warning or empty if none

Parameters:

  • $default if not message is found, then it returns this value (string)

Method lastInfoText()

It returns the last message of information or empty if none

Parameters:

  • $default if not message is found, then it returns this value (string)

Method lastSuccessText()

It returns the last message of success or empty if none

Parameters:

  • $default if not message is found, then it returns this value (string)

Method allArray()

It returns an array with all messages of any type of all lockers

Parameters:

  • $level =[null,'error','warning','errorwarning','info','success'][$i] the level to show.
    Null means it shows all errors (null|string)

Method allErrorArray()

It returns an array with all messages of error of all lockers.

Parameters:

  • $includeWarning if true then it also includes warnings. (bool)

Method allWarningArray()

It returns an array with all messages of warning of all lockers.

Method allErrorOrWarningArray()

It returns an array with all messages of errors and warnings of all lockers.

Method allInfoArray()

It returns an array with all messages of info of all lockers.

Method AllSuccessArray()

It returns an array with all messages of success of all lockers.

Method allAssocArray()

It returns an associative array of the form 

[
['id'=>'', // id of the locker
'level'=>'' // level of message (error, warning, info or success)
'msg'=>'' // the message to show
]
]

Parameters:

  • $level param null|string $level (null|string)

Method hasError()

It returns true if there is an error (or error and warning).

Parameters:

  • $includeWarning If true then it also returns if there is a warning (bool)

MessageLocker

Class MessageLocker

Method __construct()

MessageLocker constructor.

Parameters:

  • $idLocker param null|string $idLocker (null|string)
  • $context param array|null $context (array|null)

Method setContext()

We set the context only if the current context is null.

Parameters:

  • $context The new context. (array|null)

Method addError()

It adds an error to the locker.

Parameters:

  • $msg The message to store (mixed)

Method replaceCurlyVariable()

Replaces all variables defined between {{ }} by a variable inside the dictionary of values.
Example:
replaceCurlyVariable('hello={{var}}',['var'=>'world']) // hello=world
replaceCurlyVariable('hello={{var}}',['varx'=>'world']) // hello=
replaceCurlyVariable('hello={{var}}',['varx'=>'world'],true) // hello={{var}}

Parameters:

  • $string The input value. It could contain variables defined as {{namevar}} (string)

Method addWarning()

It adds a warning to the locker.

Parameters:

  • $msg The message to store (mixed)

Method addInfo()

It adds an information to the locker.

Parameters:

  • $msg The message to store (mixed)

Method addSuccess()

It adds a success to the locker.

Parameters:

  • $msg The message to store (mixed)

Method countErrorOrWarning()

It returns the number of errors or warnings contained in the locker

Method countError()

It returns the number of errors contained in the locker

Method countWarning()

It returns the number of warnings contained in the locker

Method countInfo()

It returns the number of infos contained in the locker

Method countSuccess()

It returns the number of successes contained in the locker

Method first()

It returns the first message of any kind.
If error then it returns the first message of error
If not, if warning then it returns the first message of warning
If not, then it shows the first info message (if any)
If not, then it shows the first success message (if any)
If not, then it shows the default message.

Parameters:

  • $defaultMsg param string $defaultMsg (string)
  • $level =[null,'error','warning','errorwarning','info','success'][$i] the level to show (by default it shows the first message of any level , starting with error) (null|string)

Method firstError()

It returns the first message of error, if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method firstWarning()

It returns the first message of warning, if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method firstErrorOrWarning()

It returns the first message of error or warning (in this order), if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method firstInfo()

It returns the first message of info, if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method firstSuccess()

It returns the first message of success, if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method last()

It returns the last message of any kind.
If error then it returns the last message of error
If not, if warning then it returns the last message of warning
If not, then it shows the last info message (if any)
If not, then it shows the last success message (if any)
If not, then it shows the default message.

Parameters:

  • $defaultMsg param string $defaultMsg (string)
  • $level =[null,'error','warning','errorwarning','info','success'][$i] the level to show (by default it shows the last message of any level , starting with error) (null|string)

Method lastError()

It returns the last message of error, if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method lastWarning()

It returns the last message of warning, if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method lastErrorOrWarning()

It returns the last message of error or warning (in this order), if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method lastInfo()

It returns the last message of info, if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method lastSuccess()

It returns the last message of success, if any. Otherwise, it returns the default value

Parameters:

  • $default param string $default (string)

Method all()

Returns all messages or an empty array if none.

Parameters:

  • $level =[null,'error','warning','errorwarning','info','success'][$i] the level to show. Null means it shows all errors (null|string)

Method allError()

Returns all messages of errors (as an array of string), or an empty array if none.

Method allWarning()

Returns all messages of warning, or an empty array if none.

Method allErrorOrWarning()

Returns all messages of errors or warnings, or an empty array if none

Method allInfo()

Returns all messages of info, or an empty array if none.

Method allSuccess()

Returns all messages of success, or an empty array if none.

Method allAssocArray()

It returns an associative array of the form:

[
['id'=>'', // id of the locker
'level'=>'' // level of message (error, warning, info or success)
'msg'=>'' // the message to show
]
]

Parameters:

  • $level =[null,'error','warning','errorwarning','info','success'][$i] the level to show. Null means it shows all messages regardless of the level (starting with error) (null|string)

Method hasError()

It returns true if there is an error (or error and warning).

Parameters:

  • $includeWarning If true then it also returns if there is a warning (bool)

Method throwOnError()

If we store an error then we also throw a PHP exception.

Parameters:

  • $throwOnError if true (default), then it throws an excepcion every time we store an error.
  • $includeWarning If true then it also includes warnings.

changelog

  • 2.9 2024-03-02 * Updating dependency to PHP 7.4. The extended support of PHP 7.2 ended 3 years ago.

    • Added more type hinting in the code.

  • 2.8 2023-01-28

    • [new] function getLog(),setLogFilename(),backupLog(),restoreLog()

  • 2.7 2023-01-28

    • Now it is possible to log every message when it is an error,warning,info or success.
    • [new] function setLog(),log(),getLogFilename() and count()

  • 2.6 2023-01-26

    • Fixed some typos.

  • 2.5 2022-03-22

    • [new] Added type hinting to the library
    • [fix] Added a description to composer.json

  • 2.4 2022-02-06

    • [new] [container] new methods resetLocker() and hasLocker()
    • [new] [locker] new method resetAll()

  • 2.3 2022-02-05

    • Added the right version in the documentation. No other change is done.

  • 2.2 2022-02-05

    • [new] Now it is possible to read the last message (error, warning, info, all) in the container and in the locker
    • [new] MessageLocker does not store the first message anymore as a private field, it is now calculated each time.
    • [new] Method logOnError() that calls to error_log() when we generate an error or warning.
      • [new] Method ::instance() allows to get an instance of the container (singleton), if not, then it is created.
      • [new] Construct by default replaces the instance, however, you can set to not to replace it. It is useful if you want to have more than one instance.

  • 2.1 2022-02-05

    • [fix] Update dependency. Now, it only works with PHP 7.2 and higher. It is also tested for PHP 8.1
    • [fix] Update PHPUnit dependency.
    • [new] Now methods have type hinting (return values)

  • 2.0.1 2022-01-29

    • [fix] some cleanups
    • [new] added method throwOnError(). So it is possible to throw an exception when we store an error and/or warning.
      • It only throws if the error or warning is throw via the container.

  • 2.0 2022-01-15

    • Dropping PHP 5.X. Now it requires PHP 7.1 or higher

  • 1.2 2021-03-21 Added new methods.

    • Optionally, messages could use variables obtained from a context. The context is per locker. Example "it is a {{variable}}"

  • 1.1 2021-03-17 some cleanups

  • 1.0 2021-03-17 first version