Graviton\RestBundle\Serializer\ContextFactoryAbstract

Complexity

Total Complexity

14

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

40.54%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setRequestStack()	0	4	1
A	setSetSerializeNull()	0	4	1
A	setGroups()	0	4	1
A	setOverrideHeaderName()	0	4	1
A	setOverrideHeaderAllowed()	0	4	1
A	addExclusionStrategy()	0	4	1
C	workOnInstance()	0	26	8

<?php
/**
 * abstract for context factories
 */

namespace Graviton\RestBundle\Serializer;

use JMS\Serializer\Context;
use JMS\Serializer\Exclusion\ExclusionStrategyInterface;
use JMS\Serializer\Exclusion\GroupsExclusionStrategy;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  https://opensource.org/licenses/MIT MIT License
 * @link     http://swisscom.ch
 */
abstract class ContextFactoryAbstract
{

    /**
     * @var RequestStack
     */
    private $requestStack = null;

    /**
     * @var bool
     */
    private $setSerializeNull = true;

    /**
     * @var null|array
     */
    private $groups = null;

    /**
     * @var string
     */
    private $overrideHeaderName = null;

    /**
     * @var bool
     */
    private $overrideHeaderAllowed = false;

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

    /**
     * set RequestStack
     *
     * @param RequestStack $requestStack requestStack
     *
     * @return void
     */
    public function setRequestStack($requestStack)
    {
        $this->requestStack = $requestStack;
    }

    /**
     * set SetSerializeNull
     *
     * @param bool $setSerializeNull setSerializeNull
     *
     * @return void
     */
    public function setSetSerializeNull($setSerializeNull)
    {
        $this->setSerializeNull = $setSerializeNull;
    }

    /**
     * set Groups
     *
     * @param array $groups groups
     *
     * @return void
     */
    public function setGroups($groups)
    {
        $this->groups = $groups;
    }

    /**
     * set OverrideHeaderName
     *
     * @param null $overrideHeaderName overrideHeaderName
     *
     * @return void
     */
    public function setOverrideHeaderName($overrideHeaderName)
    {
        $this->overrideHeaderName = $overrideHeaderName;
    }

    /**
     * set OverrideHeaderAllowed
     *
     * @param bool $overrideHeaderAllowed overrideHeaderAllowed
     *
     * @return void
     */
    public function setOverrideHeaderAllowed($overrideHeaderAllowed)
    {
        $this->overrideHeaderAllowed = $overrideHeaderAllowed;
    }

    /**
     * set ExclusionStrategies
     *
     * @param ExclusionStrategyInterface $exclusionStrategy exclusionStrategy
     *
     * @return void
     */
    public function addExclusionStrategy(ExclusionStrategyInterface $exclusionStrategy)
    {
        $this->exclusionStrategies[] = $exclusionStrategy;
    }

    /**
     * sets the necessary properties on the context
     *
     * @param Context $context context
     *
     * @return Context context
     */
    protected function workOnInstance(Context $context)
    {
        $context = $context->setSerializeNull($this->setSerializeNull);

        // group override?
        if (true === $this->overrideHeaderAllowed &&
            $this->requestStack instanceof RequestStack &&
            $this->requestStack->getCurrentRequest() instanceof Request
        ) {
            $headerValue = $this->requestStack->getCurrentRequest()->headers->get($this->overrideHeaderName);
            if (!is_null($headerValue)) {
                $this->groups = array_map('trim', explode(',', $headerValue));
            }
        }

        $serializerGroups = [GroupsExclusionStrategy::DEFAULT_GROUP];
        if (is_array($this->groups) && !empty($this->groups)) {
            $serializerGroups = array_merge($serializerGroups, $this->groups);
        }

        foreach ($this->exclusionStrategies as $strategy) {
            $context->addExclusionStrategy($strategy);
        }

        return $context->setGroups($serializerGroups);
    }
}