Graviton\GeneratorBundle\Definition\Schema\Field

Complexity

Total Complexity

26

Size/Duplication

Total Lines	291
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

95.38%

Importance

Changes	1
Bugs	0	Features	0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	4	1
A	setName()	0	5	1
A	getType()	0	4	1
A	setType()	0	5	1
A	getLength()	0	4	1
A	setLength()	0	5	1
A	getTitle()	0	4	1
A	setTitle()	0	5	1
A	getDescription()	0	4	1
A	setDescription()	0	5	1
A	getExposeAs()	0	4	1
A	setExposeAs()	0	5	1
A	getReadOnly()	0	4	1
A	setReadOnly()	0	5	1
A	getRequired()	0	4	1
A	setRequired()	0	5	1
A	getTranslatable()	0	4	1
A	setTranslatable()	0	5	1
A	getConstraints()	0	4	1
A	setConstraints()	0	5	1
A	getCollection()	0	4	1
A	setCollection()	0	5	1
A	getXDynamicKey()	0	4	1
A	setXDynamicKey()	0	5	1
A	getSearchable()	0	4	1
A	setSearchable()	0	4	1

<?php
/**
 * Part of JSON definition
 */
namespace Graviton\GeneratorBundle\Definition\Schema;

use Graviton\GeneratorBundle\Definition\Schema\XDynamicKey;

/**
 * JSON definition "target.fields"
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class Field
{
    /**
     * @var string
     */
    private $name;
    /**
     * @var string
     */
    private $type;
    /**
     * @var int
     */
    private $length;
    /**
     * @var string
     */
    private $title;
    /**
     * @var string
     */
    private $description;
    /**
     * @var string
     */
    private $exposeAs;
    /**
     * @var bool
     */
    private $readOnly = false;
    /**
     * @var bool
     */
    private $required = false;
    /**
     * @var bool
     */
    private $searchable = false;
    /**
     * @var bool
     */
    private $translatable = false;
    /**
     * @var Constraint[]
     */
    private $constraints = [];

    /**
     * @var array
     */
    private $collection = [];

    /**
     * @var XDynamicKey
     */
    private $xDynamicKey;

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param string $name Field name
     * @return $this
     */
    public function setName($name)
    {
        $this->name = $name;
        return $this;
    }

    /**
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @param string $type Field type
     * @return $this
     */
    public function setType($type)
    {
        $this->type = $type;
        return $this;
    }

    /**
     * @return int
     */
    public function getLength()
    {
        return $this->length;
    }

    /**
     * @param int $length Field length
     * @return $this
     */
    public function setLength($length)
    {
        $this->length = $length;
        return $this;
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @param string $title Field title
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;
        return $this;
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @param string $description Field description
     * @return $this
     */
    public function setDescription($description)
    {
        $this->description = $description;
        return $this;
    }

    /**
     * @return string
     */
    public function getExposeAs()
    {
        return $this->exposeAs;
    }

    /**
     * @param string $exposeAs Expose field as ...
     * @return $this
     */
    public function setExposeAs($exposeAs)
    {
        $this->exposeAs = $exposeAs;
        return $this;
    }

    /**
     * @return bool
     */
    public function getReadOnly()

function getReadOnly() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        return $this->readOnly;
    }

    /**
     * @param bool $readOnly Is field readonly
     * @return $this
     */
    public function setReadOnly($readOnly)
    {
        $this->readOnly = $readOnly;
        return $this;
    }

    /**
     * @return bool
     */
    public function getRequired()

function getRequired() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        return $this->required;
    }

    /**
     * @param bool $required Is field required
     * @return $this
     */
    public function setRequired($required)
    {
        $this->required = $required;
        return $this;
    }

    /**
     * @return bool
     */
    public function getTranslatable()

function getTranslatable() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        return $this->translatable;
    }

    /**
     * @param bool $translatable Is field translatable
     * @return $this
     */
    public function setTranslatable($translatable)
    {
        $this->translatable = $translatable;
        return $this;
    }

    /**
     * @return Constraint[]
     */
    public function getConstraints()
    {
        return $this->constraints;
    }

    /**
     * @param Constraint[] $constraints Field constraints
     * @return $this
     */
    public function setConstraints(array $constraints)
    {
        $this->constraints = $constraints;
        return $this;
    }

    /**
     * @return array
     */
    public function getCollection()
    {
        return $this->collection;
    }

    /**
     * @param array $collection Field
     * @return $this
     */
    public function setCollection(array $collection)
    {
        $this->collection = $collection;
        return $this;
    }

    /**
     * @return XDynamicKey
     */
    public function getXDynamicKey()
    {
        return $this->xDynamicKey;
    }

    /**
     * @param XDynamicKey $xDynamicKey x-dynamic-key field value
     * @return $this
     */
    public function setXDynamicKey(XDynamicKey $xDynamicKey)
    {
        $this->xDynamicKey = $xDynamicKey;
        return $this;
    }

    /**
     * @return mixed

Consider making the return type a bit more specific; maybe use boolean.

     */
    public function getSearchable()

function getSearchable() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        return $this->searchable;
    }

    /**
     * @param mixed $searchable searchable flag
     *
     * @return void
     */
    public function setSearchable($searchable)
    {
        $this->searchable = $searchable;
    }
}