Scope.php

Go to the documentation of this file.

<?php
 
namespace OAuth2;
 
use OAuth2\Storage\Memory;
use OAuth2\Storage\ScopeInterface as ScopeStorageInterface;
 
class Scope implements ScopeInterface
{
    protected $storage;
 
    public function __construct($storage = null)
    {
        if (is_null($storage) || is_array($storage)) {
            $storage = new Memory((array) $storage);
        }
 
        if (!$storage instanceof ScopeStorageInterface) {
            throw new \InvalidArgumentException("Argument 1 to OAuth2\Scope must be null, an array, or instance of OAuth2\Storage\ScopeInterface");
        }
 
        $this->storage = $storage;
    }
 
    public function checkScope($required_scope, $available_scope)
    {
        $required_scope = explode(' ', trim($required_scope));
        $available_scope = explode(' ', trim($available_scope));
 
        return (count(array_diff($required_scope, $available_scope)) == 0);
    }
 
    public function scopeExists($scope)
    {
        // Check reserved scopes first.
        $scope = explode(' ', trim($scope));
        $reservedScope = $this->getReservedScopes();
        $nonReservedScopes = array_diff($scope, $reservedScope);
        if (count($nonReservedScopes) == 0) {
            return true;
        } else {
            // Check the storage for non-reserved scopes.
            $nonReservedScopes = implode(' ', $nonReservedScopes);
 
            return $this->storage->scopeExists($nonReservedScopes);
        }
    }
 
    public function getScopeFromRequest(RequestInterface $request)
    {
        // "scope" is valid if passed in either POST or QUERY
        return $request->request('scope', $request->query('scope'));
    }
 
    public function getDefaultScope($client_id = null)
    {
        return $this->storage->getDefaultScope($client_id);
    }
 
    public function getReservedScopes()
    {
        return array('openid', 'offline_access');
    }
}