SilverStripe\Subsites\State\SubsiteState

Complexity

Total Complexity

9

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getSubsiteId()	0	4	1
A	setSubsiteId()	0	10	2
A	getUseSessions()	0	4	1
A	setUseSessions()	0	6	1
A	getSubsiteIdWasChanged()	0	4	1
A	withState()	0	10	1
A	reset()	0	4	1
A	resetState()	0	6	1

<?php

namespace SilverStripe\Subsites\State;

use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Core\Resettable;

/**
 * SubsiteState provides static access to the current state for subsite related data during a request
 */
class SubsiteState implements Resettable
{
    use Injectable;

    /**
     * @var int|null
     */
    protected $subsiteId;


    /**
     * @var int|null
     */
    protected $originalSubsiteId;

    /**
     * @var bool
     */
    protected $useSessions;

    /**
     * Get the current subsite ID
     *
     * @return int|null
     */
    public function getSubsiteId()
    {
        return $this->subsiteId;
    }

    /**
     * Set the current subsite ID, and track the first subsite ID set as the "original". This is used to check
     * whether the ID has been changed through a request.
     *
     * @param int $id
     * @return $this
     */
    public function setSubsiteId($id)
    {
        if (is_null($this->originalSubsiteId)) {
            $this->originalSubsiteId = (int) $id;
        }

        $this->subsiteId = (int) $id;

        return $this;
    }

    /**
     * Get whether to use sessions for storing the subsite ID
     *
     * @return bool
     */
    public function getUseSessions()
    {
        return $this->useSessions;
    }

    /**
     * Set whether to use sessions for storing the subsite ID
     *
     * @param bool $useSessions
     * @return $this
     */
    public function setUseSessions($useSessions)
    {
        $this->useSessions = $useSessions;

        return $this;
    }

    /**
     * Get whether the subsite ID has been changed during a request, based on the original and current IDs
     *
     * @return bool
     */
    public function getSubsiteIdWasChanged()
    {
        return $this->originalSubsiteId !== $this->getSubsiteId();
    }

    /**
     * Perform a given action within the context of a new, isolated state. Modifications are temporary
     * and the existing state will be restored afterwards.
     *
     * @param callable $callback Callback to run. Will be passed the nested state as a parameter
     * @return mixed Result of callback
     */
    public function withState(callable $callback)
    {
        $newState = clone $this;
        try {
            Injector::inst()->registerService($newState);
            return $callback($newState);
        } finally {
            Injector::inst()->registerService($this);
        }
    }

    /**
     * Reset the local cache of the singleton
     */
    public static function reset()
    {
        SubsiteState::singleton()->resetState();
    }

    /**
     * Reset the local cache of this object
     */
    public function resetState()
    {
        $this->originalSubsiteId = null;
        $this->subsiteId = null;
        $this->useSessions = null;
    }
}