b2pweb / parroauth2-client

src/EndPoint/EndPoints.php

<?php

namespace Parroauth2\Client\EndPoint;

use InvalidArgumentException;
use Parroauth2\Client\EndPoint\Authorization\AuthorizationEndPoint;
use Parroauth2\Client\EndPoint\Introspection\IntrospectionEndPoint;
use Parroauth2\Client\EndPoint\Token\RevocationEndPoint;
use Parroauth2\Client\EndPoint\Token\TokenEndPoint;
use Parroauth2\Client\Exception\UnsupportedServerOperation;
use Parroauth2\Client\OpenID\EndPoint\EndSessionEndPoint;
use Parroauth2\Client\OpenID\EndPoint\Userinfo\UserinfoEndPoint;
use Parroauth2\Client\Provider\Provider;
use Parroauth2\Client\Provider\ProviderInterface;
use Psr\Http\Message\RequestInterface;

/**
 * Store endpoints
 */
class EndPoints
{
    /**
     * @var ProviderInterface
     * @readonly
     */
    private $provider;

    /**
     * List of registered endpoints, indexed by name
     *
     * @var EndPointInterface[]
     */
    private $endpoints = [];

    /**
     * @var EndPointTransformerInterface[]
     */
    private $extensions = [];

    /**
     * EndPointsSet constructor.
     *
     * @param ProviderInterface $provider
     */
    public function __construct(ProviderInterface $provider)
    {
        $this->provider = $provider;
    }

    /**
     * Get an endpoint, and apply extensions
     *
     * @param string $name The endpoint name
     *
     * @return EndPointInterface
     *
     * @throws InvalidArgumentException When the client do not implements the endpoint
     */
    public function get(string $name): EndPointInterface
    {
        if (!isset($this->endpoints[$name])) {
            throw new InvalidArgumentException('The endpoint "' . $name . '" is not implemented');
        }

        $endpoint = $this->endpoints[$name];

        foreach ($this->extensions as $extension) {
            $endpoint = $endpoint->apply($extension);
        }

        return $endpoint;
    }

    /**
     * Generates the URI for an endpoint
     *
     * @param EndPointInterface $endpoint
     *
     * @return string
     *
     * @throws UnsupportedServerOperation When the server is not configured for supports the endpoint
     *
     * @see Provider::uri() For generate lower level URI
     */
    public function uri(EndPointInterface $endpoint): string
    {
        return $this->provider->uri($endpoint->name(), $endpoint->parameters());
    }

    /**
     * Create a request for the endpoint
     * The endpoint name is used for generates the URI
     * The parameters are set as query parameters for GET request, or as body with other methods
     *
     * @param string $method The HTTP method
     * @param EndPointInterface $endpoint The endpoint
     *
     * @return RequestInterface
     *
     * @throws UnsupportedServerOperation When the server is not configured for supports the endpoint
     *
     * @see Provider::request() For create lower level request
     */
    public function request(string $method, EndPointInterface $endpoint): RequestInterface
    {
        $isGet = $method === 'GET';
        $parameters = $endpoint->parameters();

        $request = $this->provider->request(
            $method,
            $endpoint->name(),
            $isGet ? $parameters : [],
            $isGet ? null : $parameters
        );

        if (!$isGet && $parameters) {

The expression $parameters of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $request = $request->withHeader('Content-Type', 'application/x-www-form-urlencoded');
        }

        return $request;
    }

    /**
     * Add an endpoint to the set
     *
     * @param EndPointInterface $endPoint
     */
    public function add(EndPointInterface $endPoint): void
    {
        $this->endpoints[$endPoint->name()] = $endPoint;
    }

    /**
     * Register a new extension
     *
     * @param EndPointTransformerInterface $extension
     */
    public function register(EndPointTransformerInterface $extension): void
    {
        $this->extensions[] = $extension;
    }

    /**
     * Get the authorization endpoint
     *
     * @throws UnsupportedServerOperation When the server is not configured for supports the endpoint
     * @throws InvalidArgumentException When the client do not implements the endpoint
     */
    public function authorization(): AuthorizationEndPoint
    {
        /** @var AuthorizationEndPoint */
        return $this->get(AuthorizationEndPoint::NAME);

The expression return $this->get(Parroauth2\Client\EndPoint\Authorization\AuthorizationEndPoint::NAME) returns the type Parroauth2\Client\EndPoint\EndPointInterface which includes types incompatible with the type-hinted return Parroauth2\Client\EndPoint\Authorization\AuthorizationEndPoint.

    }

    /**
     * Get the token endpoint
     *
     * @throws UnsupportedServerOperation When the server is not configured for supports the endpoint
     * @throws InvalidArgumentException When the client do not implements the endpoint
     */
    public function token(): TokenEndPoint
    {
        /** @var TokenEndPoint */
        return $this->get(TokenEndPoint::NAME);

The expression return $this->get(Parroauth2\Client\EndPoint\Token\TokenEndPoint::NAME) returns the type Parroauth2\Client\EndPoint\EndPointInterface which includes types incompatible with the type-hinted return Parroauth2\Client\EndPoint\Token\TokenEndPoint.

    }

    /**
     * Get the revocation endpoint
     *
     * @throws UnsupportedServerOperation When the server is not configured for supports the endpoint
     * @throws InvalidArgumentException When the client do not implements the endpoint
     */
    public function revocation(): RevocationEndPoint
    {
        /** @var RevocationEndPoint */
        return $this->get(RevocationEndPoint::NAME);

The expression return $this->get(Parroauth2\Client\EndPoint\Token\RevocationEndPoint::NAME) returns the type Parroauth2\Client\EndPoint\EndPointInterface which includes types incompatible with the type-hinted return Parroauth2\Client\EndPoint\Token\RevocationEndPoint.

    }

    /**
     * Get the introspection endpoint
     *
     * @throws UnsupportedServerOperation When the server is not configured for supports the endpoint
     * @throws InvalidArgumentException When the client do not implements the endpoint
     */
    public function introspection(): IntrospectionEndPoint
    {
        /** @var IntrospectionEndPoint */
        return $this->get(IntrospectionEndPoint::NAME);

The expression return $this->get(Parroauth2\Client\EndPoint\Introspection\IntrospectionEndPoint::NAME) returns the type Parroauth2\Client\EndPoint\EndPointInterface which includes types incompatible with the type-hinted return Parroauth2\Client\EndPoint\Introspection\IntrospectionEndPoint.

    }

    /**
     * Get the userinfo endpoint
     *
     * @throws UnsupportedServerOperation When the server is not configured for supports the endpoint
     * @throws InvalidArgumentException When the client do not implements the endpoint
     */
    public function userinfo(): UserinfoEndPoint
    {
        /** @var UserinfoEndPoint */
        return $this->get(UserinfoEndPoint::NAME);

The expression return $this->get(Parroauth2\Client\OpenID\EndPoint\Userinfo\UserinfoEndPoint::NAME) returns the type Parroauth2\Client\EndPoint\EndPointInterface which includes types incompatible with the type-hinted return Parroauth2\Client\OpenID\EndPoint\Userinfo\UserinfoEndPoint.

    }

    /**
     * Get the endSession endpoint
     *
     * @throws UnsupportedServerOperation When the server is not configured for supports the endpoint
     * @throws InvalidArgumentException When the client do not implements the endpoint
     */
    public function endSession(): EndSessionEndPoint
    {
        /** @var EndSessionEndPoint */
        return $this->get(EndSessionEndPoint::NAME);

The expression return $this->get(Parroauth2\Client\OpenID\EndPoint\EndSessionEndPoint::NAME) returns the type Parroauth2\Client\EndPoint\EndPointInterface which includes types incompatible with the type-hinted return Parroauth2\Client\OpenID\EndPoint\EndSessionEndPoint.

    }
}