Collaboration diagram for ilWACPath:

Public Member Functions
	__construct ($path)
	ilWACPath constructor. More...

	getDirName ()

	isImage ()

	isVideo ()

	isAudio ()

	isStreamable ()

	fileExists ()

	hasToken ()

	hasTimestamp ()

	hasTTL ()

	getToken ()

	setToken ($token)

	getTimestamp ()

	setTimestamp ($timestamp)

	getTTL ()

	setTTL ($ttl)

	getClient ()

	setClient ($client)

	getSecurePathId ()

	setSecurePathId ($secure_path_id)

	getPath ()

	setPath ($path)

	getSuffix ()

	setSuffix ($suffix)

	getQuery ()

	setQuery ($query)

	getParameters ()

	setParameters ($parameters)

	getFileName ()

	setFileName ($file_name)

	getOriginalRequest ()

	setOriginalRequest ($original_request)

	getPathWithoutQuery ()

	setPathWithoutQuery ($path_without_query)

	getSecurePath ()

	setSecurePath ($secure_path)

	isInSecFolder ()

	setInSecFolder ($in_sec_folder)

Static Public Member Functions
static	getImageSuffixes ()

static	setImageSuffixes ($image_suffixes)

static	getVideoSuffixes ()

static	setVideoSuffixes ($video_suffixes)

Data Fields
const	DIR_DATA = "data"

const	DIR_SEC = "sec"

Protected Member Functions
	handleParameters ()

Protected Attributes
	$client = ''

	$secure_path_id = ''

	$secure_path = ''

	$path = ''

	$suffix = ''

	$query = ''

	$parameters = array()

	$file_name = ''

	$original_request = ''

	$path_without_query = ''

	$in_sec_folder = false

	$token = ''

	$timestamp = 0

	$ttl = 0

Static Protected Attributes
static	$image_suffixes

static	$video_suffixes

static	$audio_suffixes

Detailed Description

Class ilWACPath.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

Definition at line 9 of file class.ilWACPath.php.

Constructor & Destructor Documentation

◆ __construct()

ilWACPath::__construct ( $path )

ilWACPath constructor.

Parameters

string $path

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

                                           {
                $this->setOriginalRequest($path);
 
                $regex_client = "[\\w-\\.]*";
 
                preg_match("/\\/" . self::DIR_DATA . "\\/({$regex_client})\\/(" . self::DIR_SEC . "\\/|)([\\w]*)\\/(.*)/ui", $path, $results);
                preg_match("/(\\/" . self::DIR_DATA . "\\/{$regex_client}\\/[\\w]*\\/.*)\\?/ui", $path, $results2);
                $this->setPathWithoutQuery(isset($results2[1]) ? '.' . $results2[1] : '.' . $results[0]);
                $this->setPath('.' . $results[0]);
                $this->setClient($results[1]);
                $this->setInSecFolder($results[2] == 'sec/');
                $this->setSecurePathId($results[3]);
                $parts = parse_url($path);
                $this->setFileName(basename($parts['path']));
                if (isset($parts['query'])) {
                        $parts_query = $parts['query'];
                        $this->setQuery($parts_query);
                        parse_str($parts_query, $query);
                        $this->setParameters($query);
                }
                $this->setSuffix(pathinfo($parts['path'], PATHINFO_EXTENSION));
                preg_match("/\\/" . self::DIR_DATA . "\\/({$regex_client})\\/(" . self::DIR_SEC
                           . "\\/[\\w]*\\/[\\d]*\\/|[\\w]*\\/)([\\w]*)\\//ui", $path, $results3);
                $this->setSecurePath(isset($results3[0]) ? '.' . $results3[0] : null);
                $this->handleParameters();
        }

References $path, $query, $results, handleParameters(), setClient(), setFileName(), setInSecFolder(), setOriginalRequest(), setParameters(), setPath(), setPathWithoutQuery(), setQuery(), setSecurePath(), setSecurePathId(), and setSuffix().

Here is the call graph for this function:

Member Function Documentation

◆ fileExists()

ilWACPath::fileExists ( )

Returns: bool

Definition at line 190 of file class.ilWACPath.php.

                                     {
                return is_file($this->getPathWithoutQuery());
        }

References getPathWithoutQuery().

Here is the call graph for this function:

◆ getClient()

ilWACPath::getClient ( )

Returns: string

Definition at line 273 of file class.ilWACPath.php.

                                    {
                return $this->client;
        }

References $client.

◆ getDirName()

ilWACPath::getDirName ( )

Returns: string

Definition at line 150 of file class.ilWACPath.php.

                                     {
                return dirname($this->getPathWithoutQuery());
        }

References getPathWithoutQuery().

Here is the call graph for this function:

◆ getFileName()

ilWACPath::getFileName ( )

Returns: string

Definition at line 369 of file class.ilWACPath.php.

                                      {
                return $this->file_name;
        }

References $file_name.

Referenced by ilObjUserAccess\canBeDelivered().

Here is the caller graph for this function:

◆ getImageSuffixes()

static ilWACPath::getImageSuffixes ( )

static

Returns: array

Definition at line 401 of file class.ilWACPath.php.

                                                  {
                return self::$image_suffixes;
        }

References $image_suffixes.

◆ getOriginalRequest()

ilWACPath::getOriginalRequest ( )

Returns: string

Definition at line 385 of file class.ilWACPath.php.

                                             {
                return $this->original_request;
        }

References $original_request.

◆ getParameters()

ilWACPath::getParameters ( )

Returns: array

Definition at line 353 of file class.ilWACPath.php.

                                        {
                return $this->parameters;
        }

References $parameters.

Referenced by handleParameters().

Here is the caller graph for this function:

◆ getPath()

ilWACPath::getPath ( )

Returns: string

Definition at line 305 of file class.ilWACPath.php.

                                  {
                return $this->path;
        }

References $path.

Referenced by ilObjBlogAccess\canBeDelivered(), ilObjChatroomAccess\canBeDelivered(), ilObjFileAccess\canBeDelivered(), ilObjPollAccess\canBeDelivered(), ilPortfolioAccessHandler\canBeDelivered(), and ilObjMediaObjectAccess\canBeDelivered().

Here is the caller graph for this function:

◆ getPathWithoutQuery()

ilWACPath::getPathWithoutQuery ( )

Returns: string

Definition at line 433 of file class.ilWACPath.php.

                                              {
                return $this->path_without_query;
        }

References $path_without_query.

Referenced by fileExists(), and getDirName().

Here is the caller graph for this function:

◆ getQuery()

ilWACPath::getQuery ( )

Returns: string

Definition at line 337 of file class.ilWACPath.php.

                                   {
                return $this->query;
        }

References $query.

◆ getSecurePath()

ilWACPath::getSecurePath ( )

Returns: string

Definition at line 449 of file class.ilWACPath.php.

                                        {
                return $this->secure_path;
        }

References $secure_path.

◆ getSecurePathId()

ilWACPath::getSecurePathId ( )

Returns: string

Definition at line 289 of file class.ilWACPath.php.

                                          {
                return $this->secure_path_id;
        }

References $secure_path_id.

Referenced by ilObjFileAccess\canBeDelivered().

Here is the caller graph for this function:

◆ getSuffix()

ilWACPath::getSuffix ( )

Returns: string

Definition at line 321 of file class.ilWACPath.php.

                                    {
                return $this->suffix;
        }

References $suffix.

Referenced by isAudio(), isImage(), and isVideo().

Here is the caller graph for this function:

◆ getTimestamp()

ilWACPath::getTimestamp ( )

Returns: int

Definition at line 239 of file class.ilWACPath.php.

                                       {
                return $this->timestamp;
        }

References $timestamp.

◆ getToken()

ilWACPath::getToken ( )

Returns: string

Definition at line 222 of file class.ilWACPath.php.

                                   {
                return $this->token;
        }

References $token.

◆ getTTL()

ilWACPath::getTTL ( )

Returns: int

Definition at line 256 of file class.ilWACPath.php.

                                 {
                return $this->ttl;
        }

References $ttl.

◆ getVideoSuffixes()

static ilWACPath::getVideoSuffixes ( )

static

Returns: array

Definition at line 417 of file class.ilWACPath.php.

                                                  {
                return self::$video_suffixes;
        }

References $video_suffixes.

◆ handleParameters()

ilWACPath::handleParameters ( )

protected

Definition at line 133 of file class.ilWACPath.php.

                                              {
                $param = $this->getParameters();
                if (isset($param[ilWACSignedPath::WAC_TOKEN_ID])) {
                        $this->setToken($param[ilWACSignedPath::WAC_TOKEN_ID]);
                }
                if (isset($param[ilWACSignedPath::WAC_TIMESTAMP_ID])) {
                        $this->setTimestamp($param[ilWACSignedPath::WAC_TIMESTAMP_ID]);
                }
                if (isset($param[ilWACSignedPath::WAC_TTL_ID])) {
                        $this->setTTL($param[ilWACSignedPath::WAC_TTL_ID]);
                }
        }

References getParameters(), setTimestamp(), setToken(), setTTL(), ilWACSignedPath\WAC_TIMESTAMP_ID, ilWACSignedPath\WAC_TOKEN_ID, and ilWACSignedPath\WAC_TTL_ID.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasTimestamp()

ilWACPath::hasTimestamp ( )

Returns: bool

Definition at line 206 of file class.ilWACPath.php.

                                       {
                return ($this->timestamp != 0);
        }

◆ hasToken()

ilWACPath::hasToken ( )

Returns: bool

Definition at line 198 of file class.ilWACPath.php.

                                   {
                return ($this->token != '');
        }

◆ hasTTL()

ilWACPath::hasTTL ( )

Returns: bool

Definition at line 214 of file class.ilWACPath.php.

                                 {
                return ($this->ttl != 0);
        }

◆ isAudio()

ilWACPath::isAudio ( )

Returns: bool

Definition at line 174 of file class.ilWACPath.php.

                                  {
                return in_array(strtolower($this->getSuffix()), self::$audio_suffixes);
        }

References getSuffix().

Referenced by isStreamable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isImage()

ilWACPath::isImage ( )

Returns: bool

Definition at line 158 of file class.ilWACPath.php.

                                  {
                return in_array(strtolower($this->getSuffix()), self::$image_suffixes);
        }

References getSuffix().

Here is the call graph for this function:

◆ isInSecFolder()

ilWACPath::isInSecFolder ( )

Returns: boolean

Definition at line 465 of file class.ilWACPath.php.

                                        {
                return $this->in_sec_folder;
        }

References $in_sec_folder.

◆ isStreamable()

ilWACPath::isStreamable ( )

Returns: bool

Definition at line 182 of file class.ilWACPath.php.

                                       {
                return ($this->isAudio() || $this->isVideo());
        }

References isAudio(), and isVideo().

Here is the call graph for this function:

◆ isVideo()

ilWACPath::isVideo ( )

Returns: bool

Definition at line 166 of file class.ilWACPath.php.

                                  {
                return in_array(strtolower($this->getSuffix()), self::$video_suffixes);
        }

References getSuffix().

Referenced by isStreamable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setClient()

ilWACPath::setClient ( $client )

Parameters

string $client

Definition at line 281 of file class.ilWACPath.php.

                                           {
                $this->client = $client;
        }

References $client.

Referenced by __construct().

Here is the caller graph for this function:

◆ setFileName()

ilWACPath::setFileName ( $file_name )

Parameters

string $file_name

Definition at line 377 of file class.ilWACPath.php.

                                                {
                $this->file_name = $file_name;
        }

References $file_name.

Referenced by __construct().

Here is the caller graph for this function:

◆ setImageSuffixes()

static ilWACPath::setImageSuffixes ( $image_suffixes )

static

Parameters

array $image_suffixes

Definition at line 409 of file class.ilWACPath.php.

                                                                 {
                self::$image_suffixes = $image_suffixes;
        }

References $image_suffixes.

◆ setInSecFolder()

ilWACPath::setInSecFolder ( $in_sec_folder )

Parameters

boolean $in_sec_folder

Definition at line 473 of file class.ilWACPath.php.

                                                       {
                $this->in_sec_folder = $in_sec_folder;
        }

References $in_sec_folder.

Referenced by __construct().

Here is the caller graph for this function:

◆ setOriginalRequest()

ilWACPath::setOriginalRequest ( $original_request )

Parameters

string $original_request

Definition at line 393 of file class.ilWACPath.php.

                                                              {
                $this->original_request = $original_request;
        }

References $original_request.

Referenced by __construct().

Here is the caller graph for this function:

◆ setParameters()

ilWACPath::setParameters ( $parameters )

Parameters

array $parameters

Definition at line 361 of file class.ilWACPath.php.

                                                   {
                $this->parameters = $parameters;
        }

References $parameters.

Referenced by __construct().

Here is the caller graph for this function:

◆ setPath()

ilWACPath::setPath ( $path )

Parameters

string $path

Definition at line 313 of file class.ilWACPath.php.

                                       {
                $this->path = $path;
        }

References $path.

Referenced by __construct().

Here is the caller graph for this function:

◆ setPathWithoutQuery()

ilWACPath::setPathWithoutQuery ( $path_without_query )

Parameters

string $path_without_query

Definition at line 441 of file class.ilWACPath.php.

                                                                 {
                $this->path_without_query = $path_without_query;
        }

References $path_without_query.

Referenced by __construct().

Here is the caller graph for this function:

◆ setQuery()

ilWACPath::setQuery ( $query )

Parameters

string $query

Definition at line 345 of file class.ilWACPath.php.

                                         {
                $this->query = $query;
        }

References $query.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSecurePath()

ilWACPath::setSecurePath ( $secure_path )

Parameters

string $secure_path

Definition at line 457 of file class.ilWACPath.php.

                                                    {
                $this->secure_path = $secure_path;
        }

References $secure_path.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSecurePathId()

ilWACPath::setSecurePathId ( $secure_path_id )

Parameters

string $secure_path_id

Definition at line 297 of file class.ilWACPath.php.

                                                         {
                $this->secure_path_id = $secure_path_id;
        }

References $secure_path_id.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSuffix()

ilWACPath::setSuffix ( $suffix )

Parameters

string $suffix

Definition at line 329 of file class.ilWACPath.php.

                                           {
                $this->suffix = $suffix;
        }

References $suffix.

Referenced by __construct().

Here is the caller graph for this function:

◆ setTimestamp()

ilWACPath::setTimestamp ( $timestamp )

Parameters

$timestamp

Definition at line 247 of file class.ilWACPath.php.

                                                 {
                $this->parameters[ilWACSignedPath::WAC_TIMESTAMP_ID] = $timestamp;
                $this->timestamp = $timestamp;
        }

References $timestamp, and ilWACSignedPath\WAC_TIMESTAMP_ID.

Referenced by handleParameters().

Here is the caller graph for this function:

◆ setToken()

ilWACPath::setToken ( $token )

Parameters

$token

Definition at line 230 of file class.ilWACPath.php.

                                         {
                $this->parameters[ilWACSignedPath::WAC_TOKEN_ID] = $token;
                $this->token = $token;
        }

References $token, and ilWACSignedPath\WAC_TOKEN_ID.

Referenced by handleParameters().

Here is the caller graph for this function:

◆ setTTL()

ilWACPath::setTTL ( $ttl )

Parameters

int $ttl

Definition at line 264 of file class.ilWACPath.php.

                                     {
                $this->parameters[ilWACSignedPath::WAC_TTL_ID] = $ttl;
                $this->ttl = $ttl;
        }

References $ttl, and ilWACSignedPath\WAC_TTL_ID.

Referenced by handleParameters().

Here is the caller graph for this function:

◆ setVideoSuffixes()

static ilWACPath::setVideoSuffixes ( $video_suffixes )

static

Parameters

array $video_suffixes

Definition at line 425 of file class.ilWACPath.php.

                                                                 {
                self::$video_suffixes = $video_suffixes;
        }

References $video_suffixes.

Field Documentation

◆ $audio_suffixes

ilWACPath::$audio_suffixes

staticprotected

Initial value:

= array(
                'mp3',
                'aiff',
                'aif',
                'wav',
        )

Definition at line 92 of file class.ilWACPath.php.

◆ $client

ilWACPath::$client = ''

protected

Definition at line 16 of file class.ilWACPath.php.

Referenced by getClient(), and setClient().

◆ $file_name

ilWACPath::$file_name = ''

protected

Definition at line 44 of file class.ilWACPath.php.

Referenced by getFileName(), and setFileName().

◆ $image_suffixes

ilWACPath::$image_suffixes

staticprotected

Initial value:

= array(
                'png',
                'jpg',
                'jpeg',
                'gif',
                'svg',
        )

Definition at line 72 of file class.ilWACPath.php.

Referenced by getImageSuffixes(), and setImageSuffixes().

◆ $in_sec_folder

ilWACPath::$in_sec_folder = false

protected

Definition at line 56 of file class.ilWACPath.php.

Referenced by isInSecFolder(), and setInSecFolder().

◆ $original_request

ilWACPath::$original_request = ''

protected

Definition at line 48 of file class.ilWACPath.php.

Referenced by getOriginalRequest(), and setOriginalRequest().

◆ $parameters

ilWACPath::$parameters = array()

protected

Definition at line 40 of file class.ilWACPath.php.

Referenced by getParameters(), and setParameters().

◆ $path

ilWACPath::$path = ''

protected

Definition at line 28 of file class.ilWACPath.php.

Referenced by __construct(), getPath(), and setPath().

◆ $path_without_query

ilWACPath::$path_without_query = ''

protected

Definition at line 52 of file class.ilWACPath.php.

Referenced by getPathWithoutQuery(), and setPathWithoutQuery().

◆ $query

ilWACPath::$query = ''

protected

Definition at line 36 of file class.ilWACPath.php.

Referenced by __construct(), getQuery(), and setQuery().

◆ $secure_path

ilWACPath::$secure_path = ''

protected

Definition at line 24 of file class.ilWACPath.php.

Referenced by getSecurePath(), and setSecurePath().

◆ $secure_path_id

ilWACPath::$secure_path_id = ''

protected

Definition at line 20 of file class.ilWACPath.php.

Referenced by getSecurePathId(), and setSecurePathId().

◆ $suffix

ilWACPath::$suffix = ''

protected

Definition at line 32 of file class.ilWACPath.php.

Referenced by getSuffix(), and setSuffix().

◆ $timestamp

ilWACPath::$timestamp = 0

protected

Definition at line 64 of file class.ilWACPath.php.

Referenced by getTimestamp(), and setTimestamp().

◆ $token

ilWACPath::$token = ''

protected

Definition at line 60 of file class.ilWACPath.php.

Referenced by getToken(), and setToken().

◆ $ttl

ilWACPath::$ttl = 0

protected

Definition at line 68 of file class.ilWACPath.php.

Referenced by getTTL(), and setTTL().

◆ $video_suffixes

ilWACPath::$video_suffixes

staticprotected

Initial value:

= array(
                'mp4',
                'm4v',
                'mov',
                'wmv',
                'webm',
        )

Definition at line 82 of file class.ilWACPath.php.

Referenced by getVideoSuffixes(), and setVideoSuffixes().

◆ DIR_DATA

const ilWACPath::DIR_DATA = "data"

Definition at line 11 of file class.ilWACPath.php.

◆ DIR_SEC

const ilWACPath::DIR_SEC = "sec"

Definition at line 12 of file class.ilWACPath.php.

The documentation for this class was generated from the following file:

Services/WebAccessChecker/classes/class.ilWACPath.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fileExists()

◆ getClient()

◆ getDirName()

◆ getFileName()

◆ getImageSuffixes()

◆ getOriginalRequest()

◆ getParameters()

◆ getPath()

◆ getPathWithoutQuery()

◆ getQuery()

◆ getSecurePath()

◆ getSecurePathId()

◆ getSuffix()

◆ getTimestamp()

◆ getToken()

◆ getTTL()

◆ getVideoSuffixes()

◆ handleParameters()

◆ hasTimestamp()

◆ hasToken()

◆ hasTTL()

◆ isAudio()

◆ isImage()

◆ isInSecFolder()

◆ isStreamable()

◆ isVideo()

◆ setClient()

◆ setFileName()

◆ setImageSuffixes()

◆ setInSecFolder()

◆ setOriginalRequest()

◆ setParameters()

◆ setPath()

◆ setPathWithoutQuery()

◆ setQuery()

◆ setSecurePath()

◆ setSecurePathId()

◆ setSuffix()

◆ setTimestamp()

◆ setToken()

◆ setTTL()

◆ setVideoSuffixes()

Field Documentation

◆ $audio_suffixes

◆ $client

◆ $file_name

◆ $image_suffixes

◆ $in_sec_folder

◆ $original_request

◆ $parameters

◆ $path

◆ $path_without_query

◆ $query

◆ $secure_path

◆ $secure_path_id

◆ $suffix

◆ $timestamp

◆ $token

◆ $ttl

◆ $video_suffixes

◆ DIR_DATA

◆ DIR_SEC