Mutator

A data mutator is an object that ingests a data source and provides a standard, well known interface for working with that data. Data mutators are a integral part of Hive and allow your system to accept data from almost any source, whether it be an HTTP request, JSON payload, a file upload, stream, or from another server. The mutator interface exposes the methods get, all, values, has and set.

get(...)

Expects a string $key and retrieves the value associated with the given key.

return $this->store[$key];

all()

Returns all the key/value pairs available.

return $this->store;

values(...)

Expects an array $keys = []. Will return all the key/value pairs associated with the list of keys provided.

return array_intersect_key($this->store, array_flip($keys));

has(...)

Expects a string $key and returns true when the given key exists.

return
    isset($this->store[$key])
    || array_key_exists($key, $this->store);

set(...)

Expects a key $key and $value to set on the mutator.

$this->store[$key] = $value;

Message

A message carries a description of something that went wrong and optionally a reference to a validator. The interface exposes the methods getMessage, attachValidator, hasValidator and getValidator

getMessage()

Returns this associated message.

return $this->message;

attachValidator(...)

Expects a ValidatorInterface $validator. This will attach the specified validator to the message to be passed along with it.

$this->validator = $validator;

hasValidator()

Returns true if a validator is attached to this message.

return $this->validator !== null;

getValidator()

Returns the attached validator.

return $this->validator;

Validator

A validator validates given attributes for an instance type and returns any errors it may have encountered while doing so. The interface exposes the methods validate, hasErrors, getErrors, getCreateRules, getUpdateRules and markAsUpdate.

instantiation(...)

protected $errors = null;
protected $factory = null;
protected $update = false;

public function __construct(ValidationFactory $factory)
{
    $this->factory = $factory;
}

validate(...)

Expects a MutatorInterface $mutator instance to validate. This method should check whether the validation is for an update. If any errors occur, they should be stored on the class instance and it should return itself for easy chaining.

$validator = $this->update
? $this->factory->make($mutator->all(), $this->getUpdateRules())
: $this->factory->make($mutator->all(), $this->getCreateRules());

if ($validator->fails()) {
    $this->errors = $validator->errors();
}

// Reset the update flag back to it's default value.
$this->update = false;

return $this;

hasErrors()

Returns true if any errors have occurred during validation.

return $this->errors !== null;

getErrors()

Returns the errors encountered during validation.

return $this->errors;

getCreateRules()

Gets the rules needed during creation of an instance.

return ['name' => 'required'];

getUpdateRules()

Gets the rules needed during the modification of an instance.

return ['name' => 'sometimes|required'];

markAsUpdate()

Mark the validation to happen next as an update. This method should generally return the validator class for easy chaining. Eg: $bookValidator->markAsUpdate()->validate([...]);

$this->update = true;
return $this;