ILIAS  trunk Revision v11.0_alpha-1749-g1a06bdef097
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
LSLocatorBuilder Class Reference
+ Inheritance diagram for LSLocatorBuilder:
+ Collaboration diagram for LSLocatorBuilder:

Public Member Functions

 __construct (string $command, ControlBuilder $control_builder)
 
 getItems ()
 
 end ()
 Finish building the locator. More...
 
 item (string $label, int $parameter)
 Build an entry in the locator.The parameter will be appended to the command when updating state. More...
 

Protected Attributes

array $items
 
string $command
 
ControlBuilder $control_builder
 

Detailed Description

Definition at line 24 of file LSLocatorBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

LSLocatorBuilder::__construct ( string  $command,
ControlBuilder  $control_builder 
)

Definition at line 34 of file LSLocatorBuilder.php.

References $command, and $control_builder.

35  {
36  $this->command = $command;
37  $this->control_builder = $control_builder;
38  }
ControlBuilder $control_builder

Member Function Documentation

◆ end()

LSLocatorBuilder::end ( )

Finish building the locator.

Implements ILIAS\KioskMode\LocatorBuilder.

Definition at line 51 of file LSLocatorBuilder.php.

References $control_builder.

52  {
54  }
ControlBuilder $control_builder
Build controls for the view.

◆ getItems()

LSLocatorBuilder::getItems ( )
Returns
int[][]|string[][]

Definition at line 43 of file LSLocatorBuilder.php.

References $items.

43  : array
44  {
45  return $this->items;
46  }

◆ item()

LSLocatorBuilder::item ( string  $label,
int  $parameter 
)

Build an entry in the locator.The parameter will be appended to the command when updating state.

Implements ILIAS\KioskMode\LocatorBuilder.

Definition at line 59 of file LSLocatorBuilder.php.

References $command.

60  {
61  $this->items[] = [
62  'label' => $label,
63  'command' => $this->command,
64  'parameter' => $parameter
65  ];
66  return $this;
67  }
Build a locator for the view.

Field Documentation

◆ $command

string LSLocatorBuilder::$command
protected

Definition at line 31 of file LSLocatorBuilder.php.

Referenced by __construct(), and item().

◆ $control_builder

ControlBuilder LSLocatorBuilder::$control_builder
protected

Definition at line 32 of file LSLocatorBuilder.php.

Referenced by __construct(), and end().

◆ $items

array LSLocatorBuilder::$items
protected

Definition at line 29 of file LSLocatorBuilder.php.

Referenced by getItems().


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