ilWACSecurePath Class Reference

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

Inheritance diagram for ilWACSecurePath:

Collaboration diagram for ilWACSecurePath:

Public Member Functions
	hasCheckingInstance ()
	getPath ()
	setPath (string $path)
	getComponentDirectory ()
	setComponentDirectory (string $component_directory)
	getCheckingClass ()
	setCheckingClass (string $checking_class)
	setHasCheckingInstance (bool $has_checking_instance)
	setInSecFolder (bool $in_sec_folder)
Public Member Functions inherited from ActiveRecord
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	Return the Name of your Connector Table More...
	setConnectorContainerName (string $connector_container_name)
	getPrimaryFieldValue ()
	setPrimaryFieldValue ($value)
	__construct (mixed $primary_key=0)
	storeObjectToCache ()
	asStdClass ()
	asArray ()
	buildFromArray (array $array)
	fixDateField ($field_name, string $value)
	sleep ($field_name)
	wakeUp ($field_name, $field_value)
	getArrayForConnector ()
	installConnector ()
	store ()
	save ()
	create ()
	copy (int $new_id=0)
	afterObjectLoad ()
	read ()
	update ()
	delete ()
	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()
	Return the Name of your Database Table More...
static	hasCheckingInstanceRegistered (ilWACPath $ilWACPath)
	Searches a checking instance for the given wac path. More...
Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()
static	installDB ()
static	renameDBField (string $old_name, string $new_name)
static	tableExists ()
static	fieldExists (string $field_name)
static	removeDBField (string $field_name)
static	updateDB ()
static	resetDB ()
static	truncateDB ()
static	flushDB ()
	never use in ILIAS Core, Plugins only More...
static	preloadObjects ()
static	additionalParams (array $additional_params)
static	findOrFail ($primary_key, array $add_constructor_args=[])
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...
static	findOrGetInstance ($primary_key, array $add_constructor_args=[])
static	where ($where, $operator=null)
static	innerjoinAR (ActiveRecord $activeRecord, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
static	innerjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
static	leftjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
static	orderBy (string $orderBy, string $orderDirection='ASC')
static	dateFormat (string $date_format='d.m.Y - H:i:s')
static	limit (int $start, int $end)
static	affectedRows ()
static	count ()
static	get ()
static	debug ()
static	first ()
static	getCollection ()
static	last ()
static	getFirstFromLastQuery ()
static	connector (arConnector $arConnector)
static	raw (bool $set_raw=true)
static	getArray (?string $key=null, string|array|null $values=null)
static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Protected Attributes
string	$path = ''
	true true true text 64 More...
string	$component_directory = ''
	true text 256 More...
string	$checking_class = ''
	true text 256 More...
bool	$in_sec_folder = false
	true integer 1 More...
bool	$has_checking_instance = false
Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true
string	$connector_container_name = ''
bool	$is_new = true

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	installDatabase ()
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
	Returns an instance of the instatiated calling active record (needs to be done in static methods) : This should be cached somehow More...
static	fromCamelCase (string $str)

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 ilWACSecurePath

Author

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

Version

1.0.0

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

Member Function Documentation

getCheckingClass()

ilWACSecurePath::getCheckingClass

(

)

Definition at line 139 of file class.ilWACSecurePath.php.

References $checking_class.

                                      : string
    {
        return $this->checking_class;
    }

getComponentDirectory()

ilWACSecurePath::getComponentDirectory

(

)

Definition at line 127 of file class.ilWACSecurePath.php.

                                           : string
    {
        preg_match("/[\\\|\\/](Services|Modules|Customizing)[\\\|\\/].*/u", $this->component_directory, $matches);

        return '.' . $matches[0];
    }

getPath()

ilWACSecurePath::getPath

(

)

Definition at line 117 of file class.ilWACSecurePath.php.

References $path.

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

hasCheckingInstance()

ilWACSecurePath::hasCheckingInstance

(

)

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

References $has_checking_instance.

                                         : bool
    {
        return $this->has_checking_instance;
    }

hasCheckingInstanceRegistered()

static ilWACSecurePath::hasCheckingInstanceRegistered ( ilWACPath  $ilWACPath )

static

Searches a checking instance for the given wac path.

Parameters

ilWACPath

$ilWACPath

The wac path which should be used to search the checking instance.

Returns

bool true if a checking instance is found otherwise false.

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

References ilWACPath\getModuleType().

Referenced by ilWebAccessChecker\check().

                                                                              : bool
    {
        $obj = self::find($ilWACPath->getModuleType());
        return !is_null($obj);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

returnDbTableName()

static ilWACSecurePath::returnDbTableName ( )

static

Return the Name of your Database Table

Deprecated:

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

References ilWACException\CODE_NO_PATH, ilWACPath\getModuleType(), ilWACPath\getSecurePathId(), and null.

                                              : string
    {
        return 'il_wac_secure_path';
    }

Here is the call graph for this function:

setCheckingClass()

ilWACSecurePath::setCheckingClass

(

string

$checking_class

)

Definition at line 144 of file class.ilWACSecurePath.php.

References $checking_class.

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

setComponentDirectory()

ilWACSecurePath::setComponentDirectory

(

string

$component_directory

)

Definition at line 134 of file class.ilWACSecurePath.php.

References $component_directory.

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

setHasCheckingInstance()

ilWACSecurePath::setHasCheckingInstance

(

bool

$has_checking_instance

)

Definition at line 149 of file class.ilWACSecurePath.php.

References $has_checking_instance.

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

setInSecFolder()

ilWACSecurePath::setInSecFolder

(

bool

$in_sec_folder

)

Definition at line 154 of file class.ilWACSecurePath.php.

References $in_sec_folder.

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

setPath()

ilWACSecurePath::setPath

(

string

$path

)

Definition at line 122 of file class.ilWACSecurePath.php.

References $path.

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

Field Documentation

$checking_class

string ilWACSecurePath::$checking_class = ''

protected

true text 256

Definition at line 108 of file class.ilWACSecurePath.php.

Referenced by getCheckingClass(), and setCheckingClass().

$component_directory

string ilWACSecurePath::$component_directory = ''

protected

true text 256

Definition at line 102 of file class.ilWACSecurePath.php.

Referenced by setComponentDirectory().

$has_checking_instance

bool ilWACSecurePath::$has_checking_instance = false

protected

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

Referenced by hasCheckingInstance(), and setHasCheckingInstance().

$in_sec_folder

bool ilWACSecurePath::$in_sec_folder = false

protected

true integer 1

Definition at line 114 of file class.ilWACSecurePath.php.

Referenced by setInSecFolder().

$path

string ilWACSecurePath::$path = ''

protected

true true true text 64

Definition at line 96 of file class.ilWACSecurePath.php.

Referenced by getPath(), and setPath().

---

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

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