ilCtrlContext Class Reference

Class ilCtrlContext is responsible for holding the current context information. More...

Inheritance diagram for ilCtrlContext:

Collaboration diagram for ilCtrlContext:

Public Member Functions
	__construct (ilCtrlPathFactory $path_factory, RequestWrapper $request_wrapper, Refinery $refinery)
	ilCtrlContext Constructor More...
	isAsync ()
	getRedirectSource ()
	getPath ()
	setCmdMode (string $mode)
	getCmdMode ()
	setBaseClass (string $base_class)
	getBaseClass ()
	setTargetScript (string $target_script)
	getTargetScript ()
	setCmdClass (?string $cmd_class)
	getCmdClass ()
	setCmd (?string $cmd)
	getCmd ()
	setObjType (string $obj_type)
	getObjType ()
	setObjId (int $obj_id)
	getObjId ()

Protected Member Functions
	adoptRequestParameters ()
	Adopts context properties from the according ones delivered by the current request. More...
	getQueryParam (string $parameter_name)
	Helper function to retrieve request parameter values by name. More...

Protected Attributes
ilCtrlPathFactory	$path_factory
RequestWrapper	$request_wrapper
Refinery	$refinery
ilCtrlPathInterface	$path
bool	$is_async = false
string	$target_script = 'ilias.php'
string	$cmd_mode = null
string	$redirect = null
string	$base_class = null
string	$cmd_class = null
string	$cmd = null
string	$obj_type = null
int	$obj_id = null

Detailed Description

Class ilCtrlContext is responsible for holding the current context information.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch AutoloadingIssuesInspection

Definition at line 31 of file class.ilCtrlContext.php.

Constructor & Destructor Documentation

__construct()

ilCtrlContext::__construct	(	ilCtrlPathFactory	$path_factory,
		RequestWrapper	$request_wrapper,
		Refinery	$refinery
	)

ilCtrlContext Constructor

Parameters

ilCtrlPathFactory	$path_factory
RequestWrapper	$request_wrapper
Refinery	$refinery

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

References $path_factory, $refinery, $request_wrapper, adoptRequestParameters(), ilCtrlPathFactory\null(), and ILIAS\Repository\refinery().

    {
        $this->path_factory = $path_factory;
        $this->path = $path_factory->null();
        $this->request_wrapper = $request_wrapper;
        $this->refinery = $refinery;

        $this->adoptRequestParameters();
    }

Here is the call graph for this function:

Member Function Documentation

adoptRequestParameters()

ilCtrlContext::adoptRequestParameters ( )

protected

Adopts context properties from the according ones delivered by the current request.

Note that this method should only be called when initializing ilCtrl, as methods may override delivered values on purpose later on.

Definition at line 286 of file class.ilCtrlContext.php.

References ilCtrlInterface\CMD_MODE_ASYNC, getQueryParam(), null, ilCtrlInterface\PARAM_BASE_CLASS, ilCtrlInterface\PARAM_CID_PATH, ilCtrlInterface\PARAM_CMD, ilCtrlInterface\PARAM_CMD_CLASS, ilCtrlInterface\PARAM_CMD_MODE, ilCtrlInterface\PARAM_REDIRECT, setBaseClass(), and setCmdClass().

Referenced by __construct().

                                               : void
    {
        $this->redirect = $this->getQueryParam(ilCtrlInterface::PARAM_REDIRECT);
        $this->cmd_mode = $this->getQueryParam(ilCtrlInterface::PARAM_CMD_MODE);
        $this->cmd = $this->getQueryParam(ilCtrlInterface::PARAM_CMD);

        // the context is considered asynchronous if
        // the command mode is 'async'.
        if (ilCtrlInterface::CMD_MODE_ASYNC === $this->cmd_mode) {
            $this->is_async = true;
        }

        // if an existing path is provided use it by default.
        $existing_path = $this->getQueryParam(ilCtrlInterface::PARAM_CID_PATH);
        if (null !== $existing_path) {
            $this->path = $this->path_factory->existing($existing_path);
        }

        // set the provided baseclass, which might override the
        // previously set existing path.
        $base_class = $this->getQueryParam(ilCtrlInterface::PARAM_BASE_CLASS);
        if (null !== $base_class) {
            $this->setBaseClass($base_class);
        }

        // set or append the provided command class, which might
        // override the previously set path again.
        $cmd_class = $this->getQueryParam(ilCtrlInterface::PARAM_CMD_CLASS);
        if (null !== $cmd_class) {
            $this->setCmdClass($cmd_class);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBaseClass()

ilCtrlContext::getBaseClass

(

)

Implements ilCtrlContextInterface.

Definition at line 178 of file class.ilCtrlContext.php.

References $base_class.

                                  : ?string
    {
        return $this->base_class;
    }

getCmd()

ilCtrlContext::getCmd

(

)

Implements ilCtrlContextInterface.

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

References $cmd.

                            : ?string
    {
        return $this->cmd;
    }

getCmdClass()

ilCtrlContext::getCmdClass

(

)

Implements ilCtrlContextInterface.

Definition at line 219 of file class.ilCtrlContext.php.

References $base_class.

                                 : ?string
    {
        // if no cmd_class is set yet, the baseclass
        // value can be returned.
        return $this->cmd_class ?? $this->base_class;
    }

getCmdMode()

ilCtrlContext::getCmdMode

(

)

Implements ilCtrlContextInterface.

Definition at line 151 of file class.ilCtrlContext.php.

References $cmd_mode.

                                : ?string
    {
        return $this->cmd_mode;
    }

getObjId()

ilCtrlContext::getObjId

(

)

Implements ilCtrlContextInterface.

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

References $obj_id.

                              : ?int
    {
        return $this->obj_id;
    }

getObjType()

ilCtrlContext::getObjType

(

)

Implements ilCtrlContextInterface.

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

References $obj_type.

                                : ?string
    {
        return $this->obj_type;
    }

getPath()

ilCtrlContext::getPath

(

)

Implements ilCtrlContextInterface.

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

References $path.

                             : ilCtrlPathInterface
    {
        return $this->path;
    }

getQueryParam()

ilCtrlContext::getQueryParam ( string  $parameter_name )

protected

Helper function to retrieve request parameter values by name.

Parameters

string

$parameter_name

Returns

string|null

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

References null, and ILIAS\Repository\refinery().

Referenced by adoptRequestParameters().

                                                            : ?string
    {
        if ($this->request_wrapper->has($parameter_name)) {
            return $this->request_wrapper->retrieve(
                $parameter_name,
                $this->refinery->to()->string()
            );
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRedirectSource()

ilCtrlContext::getRedirectSource

(

)

Implements ilCtrlContextInterface.

Definition at line 126 of file class.ilCtrlContext.php.

References $redirect.

                                       : ?string
    {
        return $this->redirect;
    }

getTargetScript()

ilCtrlContext::getTargetScript

(

)

Implements ilCtrlContextInterface.

Definition at line 195 of file class.ilCtrlContext.php.

References $target_script.

                                     : string
    {
        return $this->target_script;
    }

isAsync()

ilCtrlContext::isAsync

(

)

Implements ilCtrlContextInterface.

Definition at line 118 of file class.ilCtrlContext.php.

References $is_async.

                             : bool
    {
        return $this->is_async;
    }

setBaseClass()

ilCtrlContext::setBaseClass

(

string

$base_class

)

Implements ilCtrlContextInterface.

Definition at line 159 of file class.ilCtrlContext.php.

References $base_class, $path, ilCtrlPathInterface\getCidPath(), and null.

Referenced by adoptRequestParameters().

                                                    : ilCtrlContextInterface
    {
        $path = $this->path_factory->find($this, $base_class);

        // only set baseclass if it's a valid target.
        if (null !== $path->getCidPath()) {
            $this->base_class = $base_class;
            // only update the path if the current one is null.
            if (null === $this->path->getCidPath()) {
                $this->path = $path;
            }
        }

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCmd()

ilCtrlContext::setCmd

(

?string

$cmd

)

Implements ilCtrlContextInterface.

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

References $cmd.

                                        : ilCtrlContextInterface
    {
        $this->cmd = $cmd;

        return $this;
    }

setCmdClass()

ilCtrlContext::setCmdClass

(

?string

$cmd_class

)

Implements ilCtrlContextInterface.

Definition at line 203 of file class.ilCtrlContext.php.

References $cmd_class, $path, ilCtrlPathInterface\getCidPath(), and null.

Referenced by adoptRequestParameters().

                                                   : ilCtrlContextInterface
    {
        $path = $this->path_factory->find($this, $cmd_class);

        // only set command class if it's a valid target.
        if (null !== $path->getCidPath()) {
            $this->cmd_class = $cmd_class;
            $this->path = $path;
        }

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCmdMode()

ilCtrlContext::setCmdMode

(

string

$mode

)

Implements ilCtrlContextInterface.

Definition at line 142 of file class.ilCtrlContext.php.

                                            : ilCtrlContextInterface
    {
        $this->cmd_mode = $mode;
        return $this;
    }

setObjId()

ilCtrlContext::setObjId

(

int

$obj_id

)

Implements ilCtrlContextInterface.

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

References $obj_id.

                                         : ilCtrlContextInterface
    {
        $this->obj_id = $obj_id;
        return $this;
    }

setObjType()

ilCtrlContext::setObjType

(

string

$obj_type

)

Implements ilCtrlContextInterface.

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

References $obj_type.

                                                : ilCtrlContextInterface
    {
        $this->obj_type = $obj_type;
        return $this;
    }

setTargetScript()

ilCtrlContext::setTargetScript

(

string

$target_script

)

Implements ilCtrlContextInterface.

Definition at line 186 of file class.ilCtrlContext.php.

References $target_script.

                                                          : ilCtrlContextInterface
    {
        $this->target_script = $target_script;
        return $this;
    }

Field Documentation

$base_class

string ilCtrlContext::$base_class = null

protected

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

Referenced by getBaseClass(), getCmdClass(), and setBaseClass().

$cmd

string ilCtrlContext::$cmd = null

protected

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

Referenced by getCmd(), and setCmd().

$cmd_class

string ilCtrlContext::$cmd_class = null

protected

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

Referenced by setCmdClass().

$cmd_mode

string ilCtrlContext::$cmd_mode = null

protected

Definition at line 66 of file class.ilCtrlContext.php.

Referenced by getCmdMode().

$is_async

bool ilCtrlContext::$is_async = false

protected

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

Referenced by isAsync().

$obj_id

int ilCtrlContext::$obj_id = null

protected

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

Referenced by getObjId(), and setObjId().

$obj_type

string ilCtrlContext::$obj_type = null

protected

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

Referenced by getObjType(), and setObjType().

$path

ilCtrlPathInterface ilCtrlContext::$path

protected

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

Referenced by getPath(), setBaseClass(), and setCmdClass().

$path_factory

ilCtrlPathFactory ilCtrlContext::$path_factory

protected

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

Referenced by __construct().

$redirect

string ilCtrlContext::$redirect = null

protected

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

Referenced by getRedirectSource().

$refinery

Refinery ilCtrlContext::$refinery

protected

Definition at line 46 of file class.ilCtrlContext.php.

Referenced by __construct().

$request_wrapper

RequestWrapper ilCtrlContext::$request_wrapper

protected

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

Referenced by __construct().

$target_script

string ilCtrlContext::$target_script = 'ilias.php'

protected

Definition at line 61 of file class.ilCtrlContext.php.

Referenced by getTargetScript(), and setTargetScript().

---

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

• components/ILIAS/UICore/classes/class.ilCtrlContext.php