ilWACPath Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilWACPath:

Public Member Functions
	__construct (string $path)
	getParameters ()
	setParameters (array $parameters)
	getPrefix ()
	setPrefix (string $prefix)
	getAppendix ()
	setAppendix (string $appendix)
	getModulePath ()
	setModulePath (string $module_path)
	getDirName ()
	getPathWithoutQuery ()
	setPathWithoutQuery (string $path_without_query)
	isImage ()
	getSuffix ()
	setSuffix (string $suffix)
	isStreamable ()
	isAudio ()
	isVideo ()
	fileExists ()
	hasToken ()
	hasTimestamp ()
	hasTTL ()
	getToken ()
	setToken (string $token)
	getTimestamp ()
	setTimestamp (int $timestamp)
	getTTL ()
	setTTL (int $ttl)
	getClient ()
	setClient (string $client)
	getSecurePathId ()
	setSecurePathId (string $secure_path_id)
	getPath ()
	getCleanURLdecodedPath ()
	Returns a clean (everything behind ? is removed and rawurldecoded path. More...
	setPath (string $path)
	getQuery ()
	setQuery (string $query)
	getFileName ()
	setFileName (string $file_name)
	getOriginalRequest ()
	setOriginalRequest (string $original_request)
	getSecurePath ()
	setSecurePath (string $secure_path)
	isInSecFolder ()
	setInSecFolder (bool $in_sec_folder)
	getModuleType ()
	setModuleType (string $module_type)
	getModuleIdentifier ()
	setModuleIdentifier (string $module_identifier)

Static Public Member Functions
static	getAudioSuffixes ()
static	setAudioSuffixes (array $audio_suffixes)
static	getImageSuffixes ()
static	setImageSuffixes (array $image_suffixes)
static	getVideoSuffixes ()
static	setVideoSuffixes (array $video_suffixes)

Data Fields
const	DIR_DATA = "data"
const	DIR_SEC = "sec"
const	REGEX = "(?<prefix>.*?)(?<path>(?<path_without_query>(?<secure_path_id>(?<module_path>\/data\/(?<client>[\w\-\.]*)\/(?<sec>sec\/|)(?<module_type>.*?)\/(?<module_identifier>.*\/|)))(?<appendix>[^\?\n]*)).*)"
	Copy this without to regex101.com and test with some URL of files. More...

Protected Member Functions
	handleParameters ()
	normalizePath (string $path)

Protected Attributes
string	$client = ''
array	$parameters = []
bool	$in_sec_folder = false
string	$token = ''
int	$timestamp = 0
int	$ttl = 0
string	$secure_path = ''
string	$secure_path_id = ''
string	$original_request = ''
string	$file_name = ''
string	$query = ''
string	$suffix = ''
string	$prefix = ''
string	$appendix = ''
string	$module_path = ''
string	$path = ''
string	$module_type = ''
string	$module_identifier = ''
string	$path_without_query = ''

Static Protected Attributes
static array	$image_suffixes
static array	$video_suffixes
static array	$audio_suffixes

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 26 of file class.ilWACPath.php.

Constructor & Destructor Documentation

__construct()

ilWACPath::__construct

(

string

$path

)

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

References $module_path, $parts, getModuleIdentifier(), handleParameters(), normalizePath(), setAppendix(), setClient(), setFileName(), setInSecFolder(), setModuleIdentifier(), setModulePath(), setModuleType(), setOriginalRequest(), setParameters(), setPath(), setPathWithoutQuery(), setPrefix(), setQuery(), setSecurePath(), setSecurePathId(), and setSuffix().

    {
        $path = $this->normalizePath($path);

        $this->setOriginalRequest($path);
        $re = '/' . self::REGEX . '/';
        preg_match($re, $path, $result);

        $result['path_without_query'] = strstr(
            parse_url($path)['path'],
            '/data/',
            false
        );


        foreach (array_keys(array_keys($result)) as $k) {
            if (is_numeric($k)) {
                unset($result[$k]);
            }
        }

        $moduleId = strstr(
            !isset($result['module_identifier']) || is_null($result['module_identifier']) ? '' : $result['module_identifier'],
            '/',
            true
        );
        $moduleId = $moduleId === false ? '' : $moduleId;

        $this->setPrefix(!isset($result['prefix']) || is_null($result['prefix']) ? '' : $result['prefix']);
        $this->setClient(!isset($result['client']) || is_null($result['client']) ? '' : $result['client']);
        $this->setAppendix(!isset($result['appendix']) || is_null($result['appendix']) ? '' : $result['appendix']);
        $this->setModuleIdentifier($moduleId);
        $this->setModuleType(!isset($result['module_type']) || is_null($result['module_type']) ? '' : $result['module_type']);

        if ($this->getModuleIdentifier() !== '' && $this->getModuleIdentifier() !== '0') {
            $module_path = strstr(
                !isset($result['module_path']) || is_null($result['module_path']) ? '' : $result['module_path'],
                $this->getModuleIdentifier(),
                true
            );
            $module_path = '.' . ($module_path === false ? '' : $module_path);
        } else {
            $module_path = ('.' . (!isset($result['module_path']) || is_null($result['module_path']) ? '' : $result['module_path']));
        }

        $this->setModulePath($module_path);
        $this->setInSecFolder(isset($result['sec']) && $result['sec'] === 'sec/');
        $this->setPathWithoutQuery(
            '.' . (!isset($result['path_without_query']) || is_null($result['path_without_query']) ? '' : $result['path_without_query'])
        );
        $this->setPath('.' . (!isset($result['path']) || is_null($result['path']) ? '' : $result['path']));
        $this->setSecurePath(
            '.' . (!isset($result['secure_path_id']) || is_null($result['secure_path_id']) ? '' : $result['secure_path_id'])
        );
        $this->setSecurePathId(!isset($result['module_type']) || is_null($result['module_type']) ? '' : $result['module_type']);
        // Pathinfo
        $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));
        $this->handleParameters();
    }

Here is the call graph for this function:

Member Function Documentation

fileExists()

ilWACPath::fileExists

(

)

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

References getPathWithoutQuery().

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

Here is the call graph for this function:

getAppendix()

ilWACPath::getAppendix

(

)

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

References $appendix.

Referenced by ilWACSignedResourceStorage\canBeDelivered().

                                 : string
    {
        return $this->appendix;
    }

Here is the caller graph for this function:

getAudioSuffixes()

static ilWACPath::getAudioSuffixes ( )

static

Returns

string[]

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

                                             : array
    {
        return self::$audio_suffixes;
    }

getCleanURLdecodedPath()

ilWACPath::getCleanURLdecodedPath

(

)

Returns a clean (everything behind ? is removed and rawurldecoded path.

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

References getPathWithoutQuery().

Referenced by ilWebAccessChecker\check().

                                            : string
    {
        $string = $this->getPathWithoutQuery();
        return rawurldecode($string);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getClient()

ilWACPath::getClient

(

)

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

References $client.

                               : string
    {
        return $this->client;
    }

getDirName()

ilWACPath::getDirName

(

)

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

References getPathWithoutQuery().

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

Here is the call graph for this function:

getFileName()

ilWACPath::getFileName

(

)

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

References $file_name.

Referenced by ilObjUserAccess\canBeDelivered().

                                 : string
    {
        return $this->file_name;
    }

Here is the caller graph for this function:

getImageSuffixes()

static ilWACPath::getImageSuffixes ( )

static

Returns

string[]

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

                                             : array
    {
        return self::$image_suffixes;
    }

getModuleIdentifier()

ilWACPath::getModuleIdentifier

(

)

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

References $module_identifier.

Referenced by __construct().

                                         : string
    {
        return $this->module_identifier;
    }

Here is the caller graph for this function:

getModulePath()

ilWACPath::getModulePath

(

)

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

References $module_path.

                                   : string
    {
        return $this->module_path;
    }

getModuleType()

ilWACPath::getModuleType

(

)

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

References $module_type.

Referenced by ilWebAccessChecker\check(), ilWACSecurePath\hasCheckingInstanceRegistered(), and ilWACSecurePath\returnDbTableName().

                                   : string
    {
        return $this->module_type;
    }

Here is the caller graph for this function:

getOriginalRequest()

ilWACPath::getOriginalRequest

(

)

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

References $original_request.

                                        : string
    {
        return $this->original_request;
    }

getParameters()

ilWACPath::getParameters

(

)

Returns

string[]

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

References $parameters.

Referenced by handleParameters().

                                   : array
    {
        return $this->parameters;
    }

Here is the caller graph for this function:

getPath()

ilWACPath::getPath

(

)

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

References $path.

Referenced by ilObjLearningModuleAccess\_getCommands(), ilBadgeWAC\canBeDelivered(), ilContainerAccess\canBeDelivered(), ilObjMediaObjectAccess\canBeDelivered(), ilObjTestAccess\canBeDelivered(), ilObjBlogAccess\canBeDelivered(), ilObjPollAccess\canBeDelivered(), ilObjectAccess\canBeDelivered(), and ilPortfolioAccessHandler\canBeDelivered().

                             : string
    {
        return $this->path;
    }

Here is the caller graph for this function:

getPathWithoutQuery()

ilWACPath::getPathWithoutQuery

(

)

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

References $path_without_query.

Referenced by fileExists(), getCleanURLdecodedPath(), and getDirName().

                                         : string
    {
        return $this->path_without_query;
    }

Here is the caller graph for this function:

getPrefix()

ilWACPath::getPrefix

(

)

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

References $prefix.

                               : string
    {
        return $this->prefix;
    }

getQuery()

ilWACPath::getQuery

(

)

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

References $query.

                              : string
    {
        return $this->query;
    }

getSecurePath()

ilWACPath::getSecurePath

(

)

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

References $secure_path.

                                   : string
    {
        return $this->secure_path;
    }

getSecurePathId()

ilWACPath::getSecurePathId

(

)

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

References $secure_path_id.

Referenced by ilWACSecurePath\returnDbTableName().

                                     : string
    {
        return $this->secure_path_id;
    }

Here is the caller graph for this function:

getSuffix()

ilWACPath::getSuffix

(

)

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

References $suffix.

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

                               : string
    {
        return $this->suffix;
    }

Here is the caller graph for this function:

getTimestamp()

ilWACPath::getTimestamp

(

)

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

References $timestamp.

                                  : int
    {
        return $this->timestamp;
    }

getToken()

ilWACPath::getToken

(

)

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

References $token.

                              : string
    {
        return $this->token;
    }

getTTL()

ilWACPath::getTTL

(

)

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

References $ttl.

                            : int
    {
        return $this->ttl;
    }

getVideoSuffixes()

static ilWACPath::getVideoSuffixes ( )

static

Returns

string[]

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

                                             : array
    {
        return self::$video_suffixes;
    }

handleParameters()

ilWACPath::handleParameters ( )

protected

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

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

Referenced by __construct().

                                         : void
    {
        $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((int) $param[ilWACSignedPath::WAC_TIMESTAMP_ID]);
        }
        if (isset($param[ilWACSignedPath::WAC_TTL_ID])) {
            $this->setTTL((int) $param[ilWACSignedPath::WAC_TTL_ID]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasTimestamp()

ilWACPath::hasTimestamp

(

)

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

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

hasToken()

ilWACPath::hasToken

(

)

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

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

hasTTL()

ilWACPath::hasTTL

(

)

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

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

isAudio()

ilWACPath::isAudio

(

)

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

References getSuffix().

Referenced by isStreamable().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isImage()

ilWACPath::isImage

(

)

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

References getSuffix().

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

Here is the call graph for this function:

isInSecFolder()

ilWACPath::isInSecFolder

(

)

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

References $in_sec_folder.

Referenced by ilWebAccessChecker\check().

                                   : bool
    {
        return $this->in_sec_folder;
    }

Here is the caller graph for this function:

isStreamable()

ilWACPath::isStreamable

(

)

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

References isAudio(), and isVideo().

                                  : bool
    {
        if ($this->isAudio()) {
            return true;
        }
        return $this->isVideo();
    }

Here is the call graph for this function:

isVideo()

ilWACPath::isVideo

(

)

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

References getSuffix().

Referenced by isStreamable().

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

Here is the call graph for this function:

Here is the caller graph for this function:

normalizePath()

ilWACPath::normalizePath ( string  $path )

protected

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

References $path, $query, and ilWACException\NOT_FOUND.

Referenced by __construct().

                                                  : string
    {
        $path = ltrim($path, '.');
        $path = rawurldecode($path);

        // cut everything before "data/" (for installations using a subdirectory)
        $path = strstr($path, '/' . self::DIR_DATA . '/') ?: $path;
        $path = ltrim($path, '/');

        $original_path = parse_url($path, PHP_URL_PATH);
        $query = parse_url($path, PHP_URL_QUERY);

        $real_data_dir = realpath("./" . self::DIR_DATA);
        $realpath = realpath("./" . $original_path);

        if (!str_starts_with($realpath, $real_data_dir)) {
            throw new ilWACException(ilWACException::NOT_FOUND, "Path is not in data directory");
        }

        $normalized_path = ltrim(
            str_replace(
                $real_data_dir,
                '',
                $realpath
            ),
            '/'
        );

        return "/" . self::DIR_DATA . '/' . $normalized_path . (empty($query) ? '' : '?' . $query);
    }

Here is the caller graph for this function:

setAppendix()

ilWACPath::setAppendix

(

string

$appendix

)

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

References $appendix.

Referenced by __construct().

                                                 : void
    {
        $this->appendix = $appendix;
    }

Here is the caller graph for this function:

setAudioSuffixes()

static ilWACPath::setAudioSuffixes ( array  $audio_suffixes )

static

Parameters

string[]

$audio_suffixes

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

References $audio_suffixes.

                                                                  : void
    {
        self::$audio_suffixes = $audio_suffixes;
    }

setClient()

ilWACPath::setClient

(

string

$client

)

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

References $client, and ILIAS\UI\examples\Progress\Bar\client().

Referenced by __construct().

                                             : void
    {
        $this->client = $client;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFileName()

ilWACPath::setFileName

(

string

$file_name

)

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

References $file_name.

Referenced by __construct().

                                                  : void
    {
        $this->file_name = $file_name;
    }

Here is the caller graph for this function:

setImageSuffixes()

static ilWACPath::setImageSuffixes ( array  $image_suffixes )

static

Parameters

string[]

$image_suffixes

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

References $image_suffixes.

                                                                  : void
    {
        self::$image_suffixes = $image_suffixes;
    }

setInSecFolder()

ilWACPath::setInSecFolder

(

bool

$in_sec_folder

)

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

References $in_sec_folder.

Referenced by __construct().

                                                       : void
    {
        $this->in_sec_folder = $in_sec_folder;
    }

Here is the caller graph for this function:

setModuleIdentifier()

ilWACPath::setModuleIdentifier

(

string

$module_identifier

)

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

References $module_identifier.

Referenced by __construct().

                                                                  : void
    {
        $this->module_identifier = $module_identifier;
    }

Here is the caller graph for this function:

setModulePath()

ilWACPath::setModulePath

(

string

$module_path

)

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

References $module_path.

Referenced by __construct().

                                                      : void
    {
        $this->module_path = $module_path;
    }

Here is the caller graph for this function:

setModuleType()

ilWACPath::setModuleType

(

string

$module_type

)

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

References $module_type.

Referenced by __construct().

                                                      : void
    {
        $this->module_type = $module_type;
    }

Here is the caller graph for this function:

setOriginalRequest()

ilWACPath::setOriginalRequest

(

string

$original_request

)

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

References $original_request.

Referenced by __construct().

                                                                : void
    {
        $this->original_request = $original_request;
    }

Here is the caller graph for this function:

setParameters()

ilWACPath::setParameters

(

array

$parameters

)

Parameters

string[]

$parameters

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

References $parameters, and ILIAS\UI\examples\Prompt\Standard\parameters().

Referenced by __construct().

                                                    : void
    {
        $this->parameters = $parameters;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPath()

ilWACPath::setPath

(

string

$path

)

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

References $path.

Referenced by __construct().

                                         : void
    {
        $this->path = $path;
    }

Here is the caller graph for this function:

setPathWithoutQuery()

ilWACPath::setPathWithoutQuery

(

string

$path_without_query

)

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

References $path_without_query.

Referenced by __construct().

                                                                   : void
    {
        $this->path_without_query = $path_without_query;
    }

Here is the caller graph for this function:

setPrefix()

ilWACPath::setPrefix

(

string

$prefix

)

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

References $prefix.

Referenced by __construct().

                                             : void
    {
        $this->prefix = $prefix;
    }

Here is the caller graph for this function:

setQuery()

ilWACPath::setQuery

(

string

$query

)

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

References $query.

Referenced by __construct().

                                           : void
    {
        $this->query = $query;
    }

Here is the caller graph for this function:

setSecurePath()

ilWACPath::setSecurePath

(

string

$secure_path

)

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

References $secure_path.

Referenced by __construct().

                                                      : void
    {
        $this->secure_path = $secure_path;
    }

Here is the caller graph for this function:

setSecurePathId()

ilWACPath::setSecurePathId

(

string

$secure_path_id

)

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

References $secure_path_id.

Referenced by __construct().

                                                           : void
    {
        $this->secure_path_id = $secure_path_id;
    }

Here is the caller graph for this function:

setSuffix()

ilWACPath::setSuffix

(

string

$suffix

)

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

References $suffix.

Referenced by __construct().

                                             : void
    {
        $this->suffix = $suffix;
    }

Here is the caller graph for this function:

setTimestamp()

ilWACPath::setTimestamp

(

int

$timestamp

)

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

References $timestamp, ILIAS\UI\examples\Prompt\Standard\parameters(), and ilWACSignedPath\WAC_TIMESTAMP_ID.

Referenced by handleParameters().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setToken()

ilWACPath::setToken

(

string

$token

)

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

References $token, ILIAS\UI\examples\Prompt\Standard\parameters(), and ilWACSignedPath\WAC_TOKEN_ID.

Referenced by handleParameters().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setTTL()

ilWACPath::setTTL

(

int

$ttl

)

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

References $ttl, ILIAS\UI\examples\Prompt\Standard\parameters(), and ilWACSignedPath\WAC_TTL_ID.

Referenced by handleParameters().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setVideoSuffixes()

static ilWACPath::setVideoSuffixes ( array  $video_suffixes )

static

Parameters

string[]

$video_suffixes

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

References $video_suffixes.

                                                                  : void
    {
        self::$video_suffixes = $video_suffixes;
    }

Field Documentation

$appendix

string ilWACPath::$appendix = ''

protected

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

Referenced by getAppendix(), and setAppendix().

$audio_suffixes

array ilWACPath::$audio_suffixes

staticprotected

Initial value:

= [
        'mp3',
        'aiff',
        'aif',
        'm4a',
        'wav',
    ]

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

Referenced by setAudioSuffixes().

$client

string ilWACPath::$client = ''

protected

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

Referenced by getClient(), and setClient().

$file_name

string ilWACPath::$file_name = ''

protected

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

Referenced by getFileName(), and setFileName().

$image_suffixes

array ilWACPath::$image_suffixes

staticprotected

Initial value:

= [
        'png',
        'jpg',
        'jpeg',
        'gif',
        'svg',
    ]

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

Referenced by setImageSuffixes().

$in_sec_folder

bool ilWACPath::$in_sec_folder = false

protected

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

Referenced by isInSecFolder(), and setInSecFolder().

$module_identifier

string ilWACPath::$module_identifier = ''

protected

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

Referenced by getModuleIdentifier(), and setModuleIdentifier().

$module_path

string ilWACPath::$module_path = ''

protected

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

Referenced by __construct(), getModulePath(), and setModulePath().

$module_type

string ilWACPath::$module_type = ''

protected

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

Referenced by getModuleType(), and setModuleType().

$original_request

string ilWACPath::$original_request = ''

protected

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

Referenced by getOriginalRequest(), and setOriginalRequest().

$parameters

array ilWACPath::$parameters = []

protected

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

Referenced by getParameters(), and setParameters().

$path

string ilWACPath::$path = ''

protected

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

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

$path_without_query

string ilWACPath::$path_without_query = ''

protected

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

Referenced by getPathWithoutQuery(), and setPathWithoutQuery().

$prefix

string ilWACPath::$prefix = ''

protected

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

Referenced by getPrefix(), and setPrefix().

$query

string ilWACPath::$query = ''

protected

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

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

$secure_path

string ilWACPath::$secure_path = ''

protected

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

Referenced by getSecurePath(), and setSecurePath().

$secure_path_id

string ilWACPath::$secure_path_id = ''

protected

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

Referenced by getSecurePathId(), and setSecurePathId().

$suffix

string ilWACPath::$suffix = ''

protected

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

Referenced by getSuffix(), and setSuffix().

$timestamp

int ilWACPath::$timestamp = 0

protected

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

Referenced by getTimestamp(), and setTimestamp().

$token

string ilWACPath::$token = ''

protected

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

Referenced by getToken(), and setToken().

$ttl

int ilWACPath::$ttl = 0

protected

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

Referenced by getTTL(), and setTTL().

$video_suffixes

array ilWACPath::$video_suffixes

staticprotected

Initial value:

= [
        'mp4',
        'm4v',
        'mov',
        'wmv',
        'webm',
    ]

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

Referenced by setVideoSuffixes().

DIR_DATA

const ilWACPath::DIR_DATA = "data"

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

DIR_SEC

const ilWACPath::DIR_SEC = "sec"

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

REGEX

const ilWACPath::REGEX = "(?<prefix>.*?)(?<path>(?<path_without_query>(?<secure_path_id>(?<module_path>\/data\/(?<client>[\w\-\.]*)\/(?<sec>sec\/|)(?<module_type>.*?)\/(?<module_identifier>.*\/|)))(?<appendix>[^\?\n]*)).*)"

Copy this without to regex101.com and test with some URL of files.

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

---

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

• components/ILIAS/WebAccessChecker/classes/class.ilWACPath.php