Inheritance diagram for ilLTIConsumerResourceBase:

Collaboration diagram for ilLTIConsumerResourceBase:

Public Member Functions
	__construct (ilLTIConsumerServiceBase $service)
	Class constructor. More...

	getTemplate ()
	Get the resource template. More...

	getFormats ()
	Get the resource media types. More...

	getMethods ()
	Get the resource methods. More...

	getService ()
	Get the resource's service. More...

	checkTool (array $scopes=array())
	Check to make sure the request is valid. More...

Data Fields
const	HTTP_POST = 'POST'
	HTTP Post method. More...

const	HTTP_GET = 'GET'
	HTTP Get method. More...

const	HTTP_PUT = 'PUT'
	HTTP Put method. More...

const	HTTP_DELETE = 'DELETE'
	HTTP Delete method. More...

Protected Member Functions
	parseTemplate ()
	Parse the template for variables. More...

Protected Attributes
string	$type
	Type for this resource. More...

string	$id
	ID for this resource. More...

string	$template
	Template for this resource. More...

array	$variables
	Custom parameter substitution variables associated with this resource. More...

array	$formats
	Media types supported by this resource. More...

array	$methods
	HTTP actions supported by this resource. More...

array	$params
	Template variables parsed from the resource template. More...

Private Attributes
ilLTIConsumerServiceBase	$service
	Service associated with this resource. More...

Detailed Description

Definition at line 30 of file class.ilLTIConsumerResourceBase.php.

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerResourceBase::__construct ( ilLTIConsumerServiceBase $service )

Class constructor.

Service instance

Definition at line 74 of file class.ilLTIConsumerResourceBase.php.

References $service.

     {
         $this->service = $service;
         $this->type = 'RestService';
         $this->id = '';
         $this->template = '';
         $this->variables = array();
         $this->formats = array();
         $this->methods = array();
         $this->params = array();
     }

Member Function Documentation

◆ checkTool()

ilLTIConsumerResourceBase::checkTool ( array $scopes = array() )

Check to make sure the request is valid.

Definition at line 147 of file class.ilLTIConsumerResourceBase.php.

References $scopes, $token, and getService().

                                                       : ?object
     {
         $token = $this->getService()->checkTool();
         $permittedScopes = $this->getService()->getPermittedScopes();
         if (empty($scopes) || empty(array_intersect($permittedScopes, $scopes))) {
             $token = null;
         }
         return $token;
     }

Here is the call graph for this function:

◆ getFormats()

ilLTIConsumerResourceBase::getFormats ( )

Get the resource media types.

Definition at line 97 of file class.ilLTIConsumerResourceBase.php.

References $formats.

                                 : array
     {
         return $this->formats;
     }

◆ getMethods()

ilLTIConsumerResourceBase::getMethods ( )

Get the resource methods.

Definition at line 105 of file class.ilLTIConsumerResourceBase.php.

References $methods.

                                 : array
     {
         return $this->methods;
     }

◆ getService()

ilLTIConsumerResourceBase::getService ( )

Get the resource's service.

Definition at line 113 of file class.ilLTIConsumerResourceBase.php.

References $service.

Referenced by checkTool().

                                 : ilLTIConsumerServiceBase
     {
         return $this->service;
     }

Here is the caller graph for this function:

◆ getTemplate()

ilLTIConsumerResourceBase::getTemplate ( )

Get the resource template.

Definition at line 89 of file class.ilLTIConsumerResourceBase.php.

References $template.

Referenced by parseTemplate().

                                  : string
     {
         return $this->template;
     }

Here is the caller graph for this function:

◆ parseTemplate()

ilLTIConsumerResourceBase::parseTemplate ( )

protected

Parse the template for variables.

Definition at line 121 of file class.ilLTIConsumerResourceBase.php.

References $_SERVER, $params, $parts, $path, and getTemplate().

Referenced by ilLTIConsumerGradeServiceScores\execute().

                                       : array
     {
         if (empty($this->params)) {
             $this->params = array();
             if (!empty($_SERVER['PATH_INFO'])) {
                 $path = explode('/', $this->service->getResourcePath());
                 $template = preg_replace('/\([0-9a-zA-Z_\-,\/]+\)/', '', $this->getTemplate());
                 $parts = explode('/', $template);
                 for ($i = 0; $i < count($parts); $i++) {
                     //if ((substr($parts[$i], 0, 1) == '{') && (substr($parts[$i], -1) == '}')) {
                     if ((str_starts_with($parts[$i], '{')) && (str_ends_with($parts[$i], '}'))) {
                         $value = '';
                         if ($i < count($path)) {
                             $value = $path[$i];
                         }
                         $this->params[substr($parts[$i], 1, -1)] = $value;
                     }
                 }
             }
         }
         return $this->params;
     }