SilverStripe\Control\Middleware\ConfirmationMiddleware\GetParameter

Complexity

Total Complexity

9

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	checkRequestForBypass()	0	3	1
A	generateToken()	0	3	1
A	__construct()	0	3	1
A	setName()	0	4	1
A	checkRequestHasParameter()	0	3	1
A	buildConfirmationItem()	0	6	1
A	getName()	0	3	1
A	getRequestConfirmationItem()	0	12	2

<?php

namespace SilverStripe\Control\Middleware\ConfirmationMiddleware;

use SilverStripe\Control\HTTPRequest;
use SilverStripe\Security\Confirmation;

/**
 * A rule to match a GET parameter within HTTPRequest
 */
class GetParameter implements Rule, Bypass
{
    /**
     * Parameter name
     *
     * @var string
     */
    private $name;

    /**
     * Initialize the rule with a parameter name
     *
     * @param string $name
     */
    public function __construct($name)
    {
        $this->setName($name);
    }

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

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

    /**
     * Generates the confirmation item
     *
     * @param string $token
     *
     * @return Confirmation\Item
     */
    protected function buildConfirmationItem($token, $value)
    {
        return new Confirmation\Item(
            $token,
            _t(__CLASS__.'.CONFIRMATION_NAME', '"{key}" GET parameter', ['key' => $this->name]),
            sprintf('%s = "%s"', $this->name, $value)
        );
    }

    /**
     * Generates the unique token depending on the path and the parameter
     *
     * @param string $path URL path
     * @param string $param The parameter value
     *
     * @return string
     */
    protected function generateToken($path, $value)
    {
        return sprintf('%s::%s?%s=%s', static::class, $path, $this->name, $value);
    }

    /**
     * Check request contains the GET parameter
     *
     * @param HTTPRequest $request
     *
     * @return bool
     */
    protected function checkRequestHasParameter(HTTPRequest $request)
    {
        return array_key_exists($this->name, $request->getVars());
    }

    public function checkRequestForBypass(HTTPRequest $request)
    {
        return $this->checkRequestHasParameter($request);
    }

    public function getRequestConfirmationItem(HTTPRequest $request)
    {
        if (!$this->checkRequestHasParameter($request)) {
            return null;
        }

        $path = $request->getURL();
        $value = $request->getVar($this->name);

        $token = $this->generateToken($path, $value);

        return $this->buildConfirmationItem($token, $value);
    }
}