Collaboration diagram for ilWACPath:

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

	getParameters ()

	setParameters (array $parameters)

	getPrefix ()

	setPrefix ($prefix)

	getAppendix ()

	setAppendix ($appendix)

	getModulePath ()

	setModulePath ($module_path)

	getDirName ()

	getPathWithoutQuery ()

	setPathWithoutQuery ($path_without_query)

	isImage ()

	getSuffix ()

	setSuffix ($suffix)

	isStreamable ()

	isAudio ()

	isVideo ()

	fileExists ()

	hasToken ()

	hasTimestamp ()

	hasTTL ()

	getToken ()

	setToken ($token)

	getTimestamp ()

	setTimestamp ($timestamp)

	getTTL ()

	setTTL ($ttl)

	getClient ()

	setClient ($client)

	getSecurePathId ()

	setSecurePathId ($secure_path_id)

	getPath ()

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

	setPath ($path)

	getQuery ()

	setQuery ($query)

	getFileName ()

	setFileName ($file_name)

	getOriginalRequest ()

	setOriginalRequest ($original_request)

	getSecurePath ()

	setSecurePath ($secure_path)

	isInSecFolder ()

	setInSecFolder ($in_sec_folder)

	getModuleType ()

	setModuleType ($module_type)

	getModuleIdentifier ()

	setModuleIdentifier ($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 ()

Protected Attributes
	$client = ''

	$parameters = array()

	$in_sec_folder = false

	$token = ''

	$timestamp = 0

	$ttl = 0

	$secure_path = ''

	$secure_path_id = ''

	$original_request = ''

	$file_name = ''

	$query = ''

	$suffix = ''

	$prefix = ''

	$appendix = ''

	$module_path = ''

	$path = ''

	$module_type = ''

	$module_identifier = ''

	$path_without_query = ''

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 10 of file class.ilWACPath.php.

Constructor & Destructor Documentation

◆ __construct()

ilWACPath::__construct ( $path )

ilWACPath constructor.

Parameters

string $path

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

    {
        assert(is_string($path));
        $this->setOriginalRequest($path);
        $re = '/' . self::REGEX . '/';
        preg_match($re, $path, $result);
 
        foreach ($result as $k => $v) {
            if (is_numeric($k)) {
                unset($result[$k]);
            }
        }
 
        $moduleId = strstr(is_null($result['module_identifier']) ? '' : $result['module_identifier'], "/", true);
        $moduleId = $moduleId === false ? '' : $moduleId;
 
        $this->setPrefix(is_null($result['prefix']) ? '' : $result['prefix']);
        $this->setClient(is_null($result['client']) ? '' : $result['client']);
        $this->setAppendix(is_null($result['appendix']) ? '' : $result['appendix']);
        $this->setModuleIdentifier($moduleId);
        $this->setModuleType(is_null($result['module_type']) ? '' : $result['module_type']);
 
        $modulePath = null;
 
        if ($this->getModuleIdentifier()) {
            $modulePath = strstr(is_null($result['module_path']) ? '' : $result['module_path'], $this->getModuleIdentifier(), true);
            $modulePath = '.' . ($modulePath === false ? '' : $modulePath);
        } else {
            $modulePath = ('.' . (is_null($result['module_path']) ? '' : $result['module_path']));
        }
 
        $this->setModulePath("$modulePath");
        $this->setInSecFolder($result['sec'] === 'sec/');
        $this->setPathWithoutQuery('.'
                                   . (is_null($result['path_without_query']) ? '' : $result['path_without_query']));
        $this->setPath('.' . (is_null($result['path']) ? '' : $result['path']));
        $this->setSecurePath('.'
                             . (is_null($result['secure_path_id']) ? '' : $result['secure_path_id']));
        $this->setSecurePathId(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();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ fileExists()

ilWACPath::fileExists ( )

Returns: bool

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

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

References getPathWithoutQuery().

Here is the call graph for this function:

◆ getAppendix()

ilWACPath::getAppendix ( )

Returns: string

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

    {
        return (string) $this->appendix;
    }

References $appendix.

◆ getAudioSuffixes()

static ilWACPath::getAudioSuffixes ( )

static

Returns: array

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

    {
        return (array) self::$audio_suffixes;
    }

References $audio_suffixes.

◆ getCleanURLdecodedPath()

ilWACPath::getCleanURLdecodedPath ( )

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

Returns: string

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

    {
        $path = explode("?", (string) $this->path); // removing everything behind ?
        $path_to_file = rawurldecode($path[0]);
 
        return $path_to_file;
    }

References $path.

◆ getClient()

ilWACPath::getClient ( )

Returns: string

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

    {
        return (string) $this->client;
    }

References $client.

◆ getDirName()

ilWACPath::getDirName ( )

Returns: string

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

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

References getPathWithoutQuery().

Here is the call graph for this function:

◆ getFileName()

ilWACPath::getFileName ( )

Returns: string

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

    {
        return (string) $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 238 of file class.ilWACPath.php.

    {
        return (array) self::$image_suffixes;
    }

References $image_suffixes.

◆ getModuleIdentifier()

ilWACPath::getModuleIdentifier ( )

Returns: string

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

    {
        return (string) $this->module_identifier;
    }

References $module_identifier.

Referenced by __construct().

Here is the caller graph for this function:

◆ getModulePath()

ilWACPath::getModulePath ( )

Returns: string

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

    {
        return (string) $this->module_path;
    }

References $module_path.

◆ getModuleType()

ilWACPath::getModuleType ( )

Returns: string

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

    {
        return (string) $this->module_type;
    }

References $module_type.

Referenced by ilWACSecurePath\hasCheckingInstanceRegistered().

Here is the caller graph for this function:

◆ getOriginalRequest()

ilWACPath::getOriginalRequest ( )

Returns: string

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

    {
        return (string) $this->original_request;
    }

References $original_request.

◆ getParameters()

ilWACPath::getParameters ( )

Returns: array

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

    {
        return (array) $this->parameters;
    }

References $parameters.

Referenced by handleParameters().

Here is the caller graph for this function:

◆ getPath()

ilWACPath::getPath ( )

Returns: string

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

    {
        return (string) $this->path;
    }

References $path.

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

Here is the caller graph for this function:

◆ getPathWithoutQuery()

ilWACPath::getPathWithoutQuery ( )

Returns: string

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

    {
        return (string) $this->path_without_query;
    }

References $path_without_query.

Referenced by fileExists(), and getDirName().

Here is the caller graph for this function:

◆ getPrefix()

ilWACPath::getPrefix ( )

Returns: string

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

    {
        return (string) $this->prefix;
    }

References $prefix.

◆ getQuery()

ilWACPath::getQuery ( )

Returns: string

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

    {
        return (string) $this->query;
    }

References $query.

◆ getSecurePath()

ilWACPath::getSecurePath ( )

Returns: string

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

    {
        return (string) $this->secure_path;
    }

References $secure_path.

◆ getSecurePathId()

ilWACPath::getSecurePathId ( )

Returns: string

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

    {
        return (string) $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 368 of file class.ilWACPath.php.

    {
        return (string) $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 470 of file class.ilWACPath.php.

    {
        return (int) $this->timestamp;
    }

References $timestamp.

◆ getToken()

ilWACPath::getToken ( )

Returns: string

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

    {
        return (string) $this->token;
    }

References $token.

◆ getTTL()

ilWACPath::getTTL ( )

Returns: int

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

    {
        return (int) $this->ttl;
    }

References $ttl.

◆ getVideoSuffixes()

static ilWACPath::getVideoSuffixes ( )

static

Returns: array

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

    {
        return (array) self::$video_suffixes;
    }

References $video_suffixes.

◆ handleParameters()

ilWACPath::handleParameters ( )

protected

Definition at line 184 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(intval($param[ilWACSignedPath::WAC_TIMESTAMP_ID]));
        }
        if (isset($param[ilWACSignedPath::WAC_TTL_ID])) {
            $this->setTTL(intval($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 432 of file class.ilWACPath.php.

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

◆ hasToken()

ilWACPath::hasToken ( )

Returns: bool

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

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

◆ hasTTL()

ilWACPath::hasTTL ( )

Returns: bool

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

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

◆ isAudio()

ilWACPath::isAudio ( )

Returns: bool

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

    {
        return (bool) 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 359 of file class.ilWACPath.php.

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

References getSuffix().

Here is the call graph for this function:

◆ isInSecFolder()

ilWACPath::isInSecFolder ( )

Returns: bool

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

    {
        return (bool) $this->in_sec_folder;
    }

References $in_sec_folder.

◆ isStreamable()

ilWACPath::isStreamable ( )

Returns: bool

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

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

References isAudio(), and isVideo().

Here is the call graph for this function:

◆ isVideo()

ilWACPath::isVideo ( )

Returns: bool

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

    {
        return (bool) 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:

◆ setAppendix()

ilWACPath::setAppendix ( $appendix )

Parameters

string $appendix

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

    {
        assert(is_string($appendix));
        $this->appendix = $appendix;
    }

References $appendix.

Referenced by __construct().

Here is the caller graph for this function:

◆ setAudioSuffixes()

static ilWACPath::setAudioSuffixes ( array $audio_suffixes )

static

Parameters

array $audio_suffixes

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

    {
        self::$audio_suffixes = $audio_suffixes;
    }

References $audio_suffixes.

◆ setClient()

ilWACPath::setClient ( $client )

Parameters

string $client

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

    {
        assert(is_string($client));
        $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 608 of file class.ilWACPath.php.

    {
        assert(is_string($file_name));
        $this->file_name = $file_name;
    }

References $file_name.

Referenced by __construct().

Here is the caller graph for this function:

◆ setImageSuffixes()

static ilWACPath::setImageSuffixes ( array $image_suffixes )

static

Parameters

array $image_suffixes

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

    {
        self::$image_suffixes = $image_suffixes;
    }

References $image_suffixes.

◆ setInSecFolder()

ilWACPath::setInSecFolder ( $in_sec_folder )

Parameters

bool $in_sec_folder

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

    {
        assert(is_bool($in_sec_folder));
        $this->in_sec_folder = $in_sec_folder;
    }

References $in_sec_folder.

Referenced by __construct().

Here is the caller graph for this function:

◆ setModuleIdentifier()

ilWACPath::setModuleIdentifier ( $module_identifier )

Parameters

string $module_identifier

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

    {
        assert(is_string($module_identifier));
        $this->module_identifier = $module_identifier;
    }

References $module_identifier.

Referenced by __construct().

Here is the caller graph for this function:

◆ setModulePath()

ilWACPath::setModulePath ( $module_path )

Parameters

string $module_path

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

    {
        assert(is_string($module_path));
        $this->module_path = $module_path;
    }

References $module_path.

Referenced by __construct().

Here is the caller graph for this function:

◆ setModuleType()

ilWACPath::setModuleType ( $module_type )

Parameters

string $module_type

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

    {
        assert(is_string($module_type));
        $this->module_type = $module_type;
    }

References $module_type.

Referenced by __construct().

Here is the caller graph for this function:

◆ setOriginalRequest()

ilWACPath::setOriginalRequest ( $original_request )

Parameters

string $original_request

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

    {
        assert(is_string($original_request));
        $this->original_request = $original_request;
    }

References $original_request.

Referenced by __construct().

Here is the caller graph for this function:

◆ setParameters()

ilWACPath::setParameters ( array $parameters )

Parameters

array $parameters

Definition at line 211 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 570 of file class.ilWACPath.php.

    {
        assert(is_string($path));
        $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 349 of file class.ilWACPath.php.

    {
        assert(is_string($path_without_query));
        $this->path_without_query = $path_without_query;
    }

References $path_without_query.

Referenced by __construct().

Here is the caller graph for this function:

◆ setPrefix()

ilWACPath::setPrefix ( $prefix )

Parameters

string $prefix

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

    {
        assert(is_string($prefix));
        $this->prefix = $prefix;
    }

References $prefix.

Referenced by __construct().

Here is the caller graph for this function:

◆ setQuery()

ilWACPath::setQuery ( $query )

Parameters

string $query

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

    {
        assert(is_string($query));
        $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 646 of file class.ilWACPath.php.

    {
        assert(is_string($secure_path));
        $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 537 of file class.ilWACPath.php.

    {
        assert(is_string($secure_path_id));
        $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 377 of file class.ilWACPath.php.

    {
        assert(is_string($suffix));
        $this->suffix = $suffix;
    }

References $suffix.

Referenced by __construct().

Here is the caller graph for this function:

◆ setTimestamp()

ilWACPath::setTimestamp ( $timestamp )

Parameters

int $timestamp

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

    {
        assert(is_int($timestamp));
        $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

string $token

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

    {
        assert(is_string($token));
        $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 499 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 ( array $video_suffixes )

static

Parameters

array $video_suffixes

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

    {
        self::$video_suffixes = $video_suffixes;
    }

References $video_suffixes.

Field Documentation

◆ $appendix

ilWACPath::$appendix = ''

protected

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

Referenced by getAppendix(), and setAppendix().

◆ $audio_suffixes

ilWACPath::$audio_suffixes

staticprotected

Initial value:

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

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

Referenced by getAudioSuffixes(), and setAudioSuffixes().

◆ $client

ilWACPath::$client = ''

protected

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

Referenced by getClient(), and setClient().

◆ $file_name

ilWACPath::$file_name = ''

protected

Definition at line 87 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 21 of file class.ilWACPath.php.

Referenced by getImageSuffixes(), and setImageSuffixes().

◆ $in_sec_folder

ilWACPath::$in_sec_folder = false

protected

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

Referenced by isInSecFolder(), and setInSecFolder().

◆ $module_identifier

ilWACPath::$module_identifier = ''

protected

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

Referenced by getModuleIdentifier(), and setModuleIdentifier().

◆ $module_path

ilWACPath::$module_path = ''

protected

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

Referenced by getModulePath(), and setModulePath().

◆ $module_type

ilWACPath::$module_type = ''

protected

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

Referenced by getModuleType(), and setModuleType().

◆ $original_request

ilWACPath::$original_request = ''

protected

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

Referenced by getOriginalRequest(), and setOriginalRequest().

◆ $parameters

ilWACPath::$parameters = array()

protected

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

Referenced by getParameters(), and setParameters().

◆ $path

ilWACPath::$path = ''

protected

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

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

◆ $path_without_query

ilWACPath::$path_without_query = ''

protected

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

Referenced by getPathWithoutQuery(), and setPathWithoutQuery().

◆ $prefix

ilWACPath::$prefix = ''

protected

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

Referenced by getPrefix(), and setPrefix().

◆ $query

ilWACPath::$query = ''

protected

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

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

◆ $secure_path

ilWACPath::$secure_path = ''

protected

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

Referenced by getSecurePath(), and setSecurePath().

◆ $secure_path_id

ilWACPath::$secure_path_id = ''

protected

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

Referenced by getSecurePathId(), and setSecurePathId().

◆ $suffix

ilWACPath::$suffix = ''

protected

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

Referenced by getSuffix(), and setSuffix().

◆ $timestamp

ilWACPath::$timestamp = 0

protected

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

Referenced by getTimestamp(), and setTimestamp().

◆ $token

ilWACPath::$token = ''

protected

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

Referenced by getToken(), and setToken().

◆ $ttl

ilWACPath::$ttl = 0

protected

Definition at line 71 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 31 of file class.ilWACPath.php.

Referenced by getVideoSuffixes(), and setVideoSuffixes().

◆ DIR_DATA

const ilWACPath::DIR_DATA = "data"

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

◆ DIR_SEC

const ilWACPath::DIR_SEC = "sec"

Definition at line 13 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 17 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()

◆ getAppendix()

◆ getAudioSuffixes()

◆ getCleanURLdecodedPath()

◆ getClient()

◆ getDirName()

◆ getFileName()

◆ getImageSuffixes()

◆ getModuleIdentifier()

◆ getModulePath()

◆ getModuleType()

◆ getOriginalRequest()

◆ getParameters()

◆ getPath()

◆ getPathWithoutQuery()

◆ getPrefix()

◆ getQuery()

◆ getSecurePath()

◆ getSecurePathId()

◆ getSuffix()

◆ getTimestamp()

◆ getToken()

◆ getTTL()

◆ getVideoSuffixes()

◆ handleParameters()

◆ hasTimestamp()

◆ hasToken()

◆ hasTTL()

◆ isAudio()

◆ isImage()

◆ isInSecFolder()

◆ isStreamable()

◆ isVideo()

◆ setAppendix()

◆ setAudioSuffixes()

◆ setClient()

◆ setFileName()

◆ setImageSuffixes()

◆ setInSecFolder()

◆ setModuleIdentifier()

◆ setModulePath()

◆ setModuleType()

◆ setOriginalRequest()

◆ setParameters()

◆ setPath()

◆ setPathWithoutQuery()

◆ setPrefix()

◆ setQuery()

◆ setSecurePath()

◆ setSecurePathId()

◆ setSuffix()

◆ setTimestamp()

◆ setToken()

◆ setTTL()

◆ setVideoSuffixes()

Field Documentation

◆ $appendix

◆ $audio_suffixes

◆ $client

◆ $file_name

◆ $image_suffixes

◆ $in_sec_folder

◆ $module_identifier

◆ $module_path

◆ $module_type

◆ $original_request

◆ $parameters

◆ $path

◆ $path_without_query

◆ $prefix