ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilCtrlPathFactoryInterface Interface Reference

Interface ilCtrlPathFactoryInterface describes the ilCtrl Path factory. More...

+ Inheritance diagram for ilCtrlPathFactoryInterface:
+ Collaboration diagram for ilCtrlPathFactoryInterface:

Public Member Functions

 find (ilCtrlContextInterface $context, $target)
 Returns the corresponding ilCtrlPath by the provided target type. More...
 
 existing (string $cid_path)
 Returns an instance of an existing ilCtrlPath. More...
 
 null ()
 Returns a pseudo instance of an ilCtrlPath. More...
 

Detailed Description

Interface ilCtrlPathFactoryInterface describes the ilCtrl Path factory.

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

Definition at line 11 of file interface.ilCtrlPathFactoryInterface.php.

Member Function Documentation

◆ existing()

ilCtrlPathFactoryInterface::existing ( string  $cid_path)

Returns an instance of an existing ilCtrlPath.

Parameters
string$cid_path
Returns
ilCtrlPathInterface

Implemented in ilCtrlPathFactory.

◆ find()

ilCtrlPathFactoryInterface::find ( ilCtrlContextInterface  $context,
  $target 
)

Returns the corresponding ilCtrlPath by the provided target type.

Parameters
ilCtrlContextInterface$context
string[]|string$target
Returns
ilCtrlPathInterface

Implemented in ilCtrlPathFactory.

◆ null()

ilCtrlPathFactoryInterface::null ( )

Returns a pseudo instance of an ilCtrlPath.

Returns
ilCtrlPathInterface

Implemented in ilCtrlPathFactory.


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