flipbox\saml\core\models\AbstractSettings

Complexity

Total Complexity

22

Size/Duplication

Total Lines	246
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	3

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	attributes()	0	9	1
A	setEntityId()	0	6	1
A	getEntityId()	0	8	2
A	getEntityIdRaw()	0	8	2
A	getEndpointPrefix()	0	4	1
A	setMyType()	0	5	1
A	getMyType()	0	4	1
A	getRemoteType()	0	4	2
A	isIDP()	0	4	1
A	isSP()	0	4	1
A	buildEndpointUrl()	0	4	1
A	getDefaultLoginEndpoint()	0	8	1
A	getDefaultLogoutEndpoint()	0	6	1
A	getDefaultLogoutRequestEndpoint()	0	6	1
A	getDefaultLoginRequestEndpoint()	0	6	1
A	getDefaultLoginPath()	0	4	1
A	getDefaultLogoutPath()	0	4	1
A	getDefaultLogoutRequestPath()	0	4	1
A	getDefaultLoginRequestPath()	0	5	1

<?php
/**
 * Created by PhpStorm.
 * User: dsmrt
 * Date: 1/23/18
 * Time: 9:26 PM
 */

namespace flipbox\saml\core\models;

use craft\base\Model;
use craft\config\GeneralConfig;
use craft\helpers\UrlHelper;

abstract class AbstractSettings extends Model implements SettingsInterface
{

    const ENDPOINT_PREFIX = 'sso';

    /**
     * @var string
     */
    protected $myType;

    /**
     * @var string
     */
    protected $entityId;

    /**
     * @var string
     */
    public $endpointPrefix = self::ENDPOINT_PREFIX;

    /**
     * This is the endpoint used to initiate login. Set the general.php config for `loginPath` to this.
     * @see GeneralConfig::$loginPath
     *
     * @var string
     */
    protected $loginEndpoint = 'login';

    /**
     * This is the endpoint used to initiate login. Set the general.php config for `loginPath` to this.
     * @see GeneralConfig::$loginPath
     *
     * @var string
     */
    protected $logoutEndpoint = 'logout';

    /**
     * This is the endpoint used to initiate login. Set the general.php config for `loginPath` to this.
     * @see GeneralConfig::$loginPath
     *
     * @var string
     */
    protected $loginRequestEndpoint = 'login/request';

    /**
     * This is the endpoint used to initiate logout. In this case, `logoutPath` cannot be used.
     * Point your logout button to this endpoint.
     *
     * @var string
     */
    protected $logoutRequestEndpoint = 'logout/request';


    /**
     * This setting will destroy sessions when the Name Id matches a user with existing sessions.
     * A current user session doesn't have to exist, ie, `\Craft::$app->user->isGuest === true`.
     *
     * This can be useful if the LogoutRequest is sent over AJAX.
     *
     * Warning: this will delete all current sessions for the user
     *
     * @var bool
     */
    public $sloDestroySpecifiedSessions = false;

    /**
     * @inheritdoc
     */
    public function attributes()
    {
        return array_merge(
            parent::attributes(),
            [
                'entityId',
            ]
        );
    }

    /*******************************************
     * ENTITY ID
     *******************************************/

    /**
     * @param $entityId
     * @return $this
     */
    public function setEntityId($entityId)
    {
        $this->entityId = $entityId;

        return $this;
    }

    /**
     * @return string
     * @throws \craft\errors\SiteNotFoundException
     */
    public function getEntityId()
    {
        if (! $this->entityId) {
            $this->entityId = UrlHelper::baseUrl();
        }

        return \Craft::parseEnv($this->entityId);

The return type of return \Craft::parseEnv($this->entityId); (null|boolean|string|array) is incompatible with the return type declared by the interface flipbox\saml\core\models\SettingsInterface::getEntityId of type string.

    }

    /**
     * @return string
     * @throws \craft\errors\SiteNotFoundException
     */
    public function getEntityIdRaw()
    {
        if (! $this->entityId) {
            $this->entityId = UrlHelper::baseUrl();
        }

        return $this->entityId;
    }

    public function getEndpointPrefix()
    {
        return \Craft::parseEnv($this->endpointPrefix);
    }

    /**
     * @param $myType
     * @return $this
     */
    public function setMyType($myType)
    {
        $this->myType = $myType;
        return $this;
    }

    /**
     * @return string
     */
    public function getMyType()
    {
        return $this->myType;
    }

    /**
     * @return string
     */
    public function getRemoteType()
    {
        return $this->getMyType() === self::IDP ? self::SP : self::IDP;
    }

    /**
     * @return bool
     */
    public function isIDP()
    {
        return $this->getMyType() === self::IDP;
    }

    /**
     * @return bool
     */
    public function isSP()
    {
        return $this->getMyType() === self::SP;
    }

    protected function buildEndpointUrl($url)
    {
        return sprintf('/%s/%s', $this->getEndpointPrefix(), $url);
    }

    /**
     * @inheritdoc
     */
    public function getDefaultLoginEndpoint()
    {
        return UrlHelper::siteUrl(
            $this->buildEndpointUrl(
                $this->loginEndpoint
            )
        );
    }

    /**
     * @inheritdoc
     */
    public function getDefaultLogoutEndpoint()
    {
        return UrlHelper::siteUrl(
            $this->buildEndpointUrl($this->logoutEndpoint)
        );
    }

    /**
     * @inheritdoc
     */
    public function getDefaultLogoutRequestEndpoint()
    {
        return UrlHelper::siteUrl(
            $this->buildEndpointUrl($this->logoutRequestEndpoint)
        );
    }

    /**
     * @inheritdoc
     */
    public function getDefaultLoginRequestEndpoint()
    {
        return UrlHelper::siteUrl(
            $this->buildEndpointUrl($this->loginRequestEndpoint)
        );
    }

    /**
     * @inheritdoc
     */
    public function getDefaultLoginPath()
    {
        return $this->buildEndpointUrl($this->loginEndpoint);
    }

    /**
     * @inheritdoc
     */
    public function getDefaultLogoutPath()
    {
        return $this->buildEndpointUrl($this->logoutEndpoint);
    }

    /**
     * @inheritdoc
     */
    public function getDefaultLogoutRequestPath()
    {
        return $this->buildEndpointUrl($this->logoutRequestEndpoint);
    }

    /**
     * @inheritdoc
     */
    public function getDefaultLoginRequestPath()
    {
        return
            $this->buildEndpointUrl($this->loginRequestEndpoint);
    }
}