Aura\Filter\Failure\Failure

Complexity

Total Complexity

5

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	getField()	0	4	1
A	getMessage()	0	4	1
A	getArgs()	0	4	1
A	jsonSerialize()	0	8	1

<?php
/**
 * This file is part of Aura for PHP.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 */
namespace Aura\Filter\Failure;

use JsonSerializable;

/**
 * Represents the failure of a rule specification.
 */
class Failure implements JsonSerializable
{
    /**
     * The field that failed.
     *
     * @var string
     */
    protected $field;

    /**
     * The failure message.
     *
     * @var string
     */
    protected $message;

    /**
     * The arguments passed to the rule specification.
     *
     * @var array
     */
    protected $args = array();

    /**
     * Constructor.
     *
     * @param string $field   The field that failed.
     * @param string $message The failure message.
     * @param array  $args    The arguments passed to the rule specification.
     *
     * @return self

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(
        $field,
        $message,
        array $args = array()
    ) {
        $this->field = $field;
        $this->message = $message;
        $this->args = $args;
    }

    /**
     * Returns the field that failed.
     *
     * @return string
     */
    public function getField()
    {
        return $this->field;
    }

    /**
     * Returns the failure message.
     *
     * @return string
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Returns the arguments passed to the rule specification.
     *
     * @return array
     */
    public function getArgs()
    {
        return $this->args;
    }

    /**
     * Returns an array for json_encode.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return array(
            'field' => $this->field,
            'message' => $this->message,
            'args' => $this->args,
        );
    }
}