Soluble\FlexStore\Options\HydrationOptions

Complexity

Total Complexity

10

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	disableFormatters()	0	6	1
A	enableFormatters()	0	6	1
A	isFormattersEnabled()	0	4	1
A	disableRenderers()	0	6	1
A	enableRenderers()	0	6	1
A	isRenderersEnabled()	0	4	1
A	disableColumnExclusion()	0	6	1
A	enableColumnExclusion()	0	6	1
A	isColumnExclusionEnabled()	0	4	1

<?php

/*
 * soluble-flexstore library
 *
 * @author    Vanvelthem Sébastien
 * @link      https://github.com/belgattitude/soluble-flexstore
 * @copyright Copyright (c) 2016-2017 Vanvelthem Sébastien
 * @license   MIT License https://github.com/belgattitude/soluble-flexstore/blob/master/LICENSE.md
 *
 */

namespace Soluble\FlexStore\Options;

class HydrationOptions
{
    /**
     * @var array
     */
    protected $params = [];

    /**
     * @var array
     */
    protected $default_params = [
        'disable_formatters' => false,
        'disable_renderers' => false,
        'disable_column_exclusion' => false
    ];

    public function __construct()
    {
        $this->params = $this->default_params;
    }

    /**
     * Disable formatters processing when getting data.
     *
     * @return HydrationOptions
     */
    public function disableFormatters()
    {
        $this->params['disable_formatters'] = true;

        return $this;
    }

    /**
     * Enable formatters processing when getting data.
     *
     * @return HydrationOptions
     */
    public function enableFormatters()
    {
        $this->params['disable_formatters'] = false;

        return $this;
    }

    /**
     * Test chether formatters should be called when getting data.
     *
     * @return bool
     */
    public function isFormattersEnabled()
    {
        return $this->params['disable_formatters'] == false;
    }

    /**
     * Disable renderers processing when getting data.
     *
     * @return HydrationOptions
     */
    public function disableRenderers()
    {
        $this->params['disable_renderers'] = true;

        return $this;
    }

    /**
     * Enable renderers processing when getting data.
     *
     * @return HydrationOptions
     */
    public function enableRenderers()
    {
        $this->params['disable_renderers'] = false;

        return $this;
    }

    /**
     * Test whether renderers should be called when getting data.
     *
     * @return bool
     */
    public function isRenderersEnabled()
    {
        return $this->params['disable_renderers'] == false;
    }

    /**
     * Disable column exclusion when getting data.
     *
     * @return HydrationOptions
     */
    public function disableColumnExclusion()
    {
        $this->params['disable_column_exclusion'] = true;

        return $this;
    }

    /**
     * Enable column exclusion when getting data.
     *
     * @return HydrationOptions
     */
    public function enableColumnExclusion()
    {
        $this->params['disable_column_exclusion'] = false;

        return $this;
    }

    /**
     * Test whether column model exclusions are enabled.
     *
     * @return bool
     */
    public function isColumnExclusionEnabled()
    {
        return $this->params['disable_column_exclusion'] == false;
    }
}