FMCSSOClient\OAuth\StateManager

Complexity

Total Complexity

9

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Test Coverage

Coverage

36.84%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	pullState()	0	7	2
A	__construct()	0	3	1
A	state()	0	7	2
A	makeState()	0	9	2
A	generateState()	0	3	1
A	needValidateState()	0	3	1

<?php

namespace FMCSSOClient\OAuth;

use Illuminate\Support\Str;

class StateManager
{
    protected bool $useState = true;

    protected string $cacheKey = 'state';

    /**
     * @param bool $useState
     */
    public function __construct(bool $useState = true)
    {
        $this->useState = $useState;
    }

    /**
     * Is need validate state.
     *
     * @return bool
     */
    public function needValidateState(): bool
    {
        return $this->useState;
    }

    /**
     * Create and cache state.
     *
     * @return string|null
     */
    public function makeState(): ?string
    {
        if (!$this->useState) {
            return null;
        }

        request()->session()->put($this->cacheKey, $state = $this->generateState());

        return $state;
    }

    /**
     * Get state and remove from cache.
     *
     * @return string|null
     */
    public function pullState(): ?string
    {
        if (!$this->useState) {
            return null;
        }

        return (string) request()->session()->pull($this->cacheKey);
    }

    /**
     * Get current state value.
     *
     * @return string|null
     */
    public function state(): ?string
    {
        if (!$this->useState) {
            return null;
        }

        return (string) request()->session()->get($this->cacheKey);
    }

    /**
     * Get the string used for session state.
     *
     * @return string
     */
    protected function generateState(): string
    {
        return Str::random(40);
    }
}