RequireAnyOneOf

Since v1.2016052101

Description

RequireAnyOneOf allows you to apply a list of requirements to a piece of data. If none of the requirements are met, an exception is thrown.

RequireAnyOneOf is a customisable function object.

Public Interface

RequireAnyOneOf has the following public interface:

// RequireAnyOneOf lives in this namespace
namespace GanbaroDigital\Defensive\V1\Requirements;

// RequireAnyOneOf is a Requirement
use GanbaroDigital\Defensive\V1\Interfaces\Requirement;
// RequireAnyOneOf is a ListRequirement
use GanbaroDigital\Defensive\V1\Interfaces\ListRequirement;

// our input and return type(s)
use GanbaroDigital\DIContainers\V1\Interfaces\FactoryList;

class RequireAnyOneOf implements Requirement, ListRequirement
{
    /**
     * create a Requirement that is ready to execute
     *
     * @param array $requirements
     *        a list of the requirements to apply
     * @param FactoryList|null $exceptions
     *        the functions to call when we want to throw an exception
     * @return RequireAnyOneOf
     */
    public static function apply($requirements, FactoryList $exceptions = null);

    /**
     * throws exception if our inspection fails
     *
     * @inheritedFrom ListRequirement
     *
     * @param  mixed $fieldOrVar
     *         the data to be examined
     * @param  string $fieldOrVarName
     *         what is the name of $fieldOrVar in the calling code?
     * @return void
     */
    public function to($fieldOrVar, $fieldOrVarName = "value");

    /**
     * throws exceptions if any of our requirements are not met
     *
     * this is an alias of to() for better readability when your
     * inspection is an object
     *
     * @inheritedFrom ListRequirement
     *
     * @param  mixed $data
     *         the data to be examined by each requirement in turn
     * @param  string $fieldOrVarName
     *         what is the name of $data in the calling code?
     * @return void
     */
    public function inspect($data, $fieldOrVarName = "value");

    /**
     * throws exception if our inspection fails
     *
     * this is an alias of to() when your inspection is an object
     * in a list
     *
     * @inheritedFrom ListRequirement
     *
     * @param  mixed $fieldOrVar
     *         the data to be examined
     * @param  string $fieldOrVarName
     *         what is the name of $fieldOrVar in the calling code?
     * @return void
     */
    public function __invoke($fieldOrVar, $fieldOrVarName = "value");

    /**
     * throws exception if our inspection fails
     *
     * the inspection defined in the to() method is applied to every element
     * of the list passed in
     *
     * @inheritedFrom ListRequirement
     *
     * @param  mixed $fieldOrVar
     *         the data to be examined
     *         must be a traversable list
     * @param  string $fieldOrVarName
     *         what is the name of $fieldOrVar in the calling code?
     * @return void
     */
    public function toList($fieldOrVar, $fieldOrVarName = "value");

    /**
     * throws exception if our inspection fails
     *
     * this is an alias of toList() for better readability when your
     * inspection is an object
     *
     * @inheritedFrom ListRequirement
     *
     * @param  mixed $fieldOrVar
     *         the data to be examined
     *         must be a traversable list
     * @param  string $fieldOrVarName
     *         what is the name of $fieldOrVar in the calling code?
     * @return void
     */
    public function inspectList($fieldOrVar, $fieldOrVarName = "value");
}

How To Use

Applying Requirements

Use the ::apply()->to() pattern:

$requirements = [
    // a list of objects that implement the 'Requirement' interface
];
RequireAnyOneOf::apply($requirements)->to($data, '$data');

Use RequireAnyOneOf to enforce robustness in your library's public API:

function doSomething($arg1)
{
    // robustness!
    $requirements = [
        new RequireString(),
        new RequireNull()
    ];
    RequireAnyOneOf::apply($requirements)->to($arg1, '$arg1');

    // if we get here, then $arg1 is good
}

If none of the requirements are met, RequireAnyOneOf will throw an exception.

Applying Requirements To A List

Use the ::apply()->toList() pattern:

$requirements = [
    // a list of objects that implement the 'Requirement' interface
];

$list = [
    // a list of items that need checking
];
RequireAnyOneOf::apply($requirements)->to($list, '$list');

If none of the requirements are met, RequireAnyOneOf will throw an exception.

Class Contract

Here is the contract for this class:

GanbaroDigital\Defensive\V1\Requirements\RequireAnyOneOf
 [x] Can instantiate
 [x] is Requirement
 [x] Can use as object
 [x] Can call statically
 [x] Must provide a list of requirements
 [x] Requirements list must contain valid requirements
 [x] Will match any requirement given
 [x] Throws exception if nothing matches
 [x] is ListRequirement
 [x] can apply to a data list
 [x] throws InvalidArgumentException if non list passed to toList

Class contracts are built from this class's unit tests.

Future releases of this class will not break this contract.

Future releases of this class may add to this contract. New additions may include:

  • clarifying existing behaviour (e.g. stricter contract around input or return types)
  • add new behaviours (e.g. extra class methods)

When you use this class, you can only rely on the behaviours documented by this contract.

If you:

  • find other ways to use this class,
  • or depend on behaviours that are not covered by a unit test,
  • or depend on undocumented internal states of this class,

... your code may not work in the future.

Notes

None at this time.

Changelog

v1.2016081301

See Also