ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
LSLocatorBuilder Class Reference

Class LSTOCBuilder. More...

+ 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, $state=null)
 
- Public Member Functions inherited from ILIAS\KioskMode\LocatorBuilder
 item (string $label, int $parameter)
 Build an entry in the locator. More...
 

Protected Attributes

 $command
 
 $items
 
 $control_builder
 

Detailed Description

Class LSTOCBuilder.

Definition at line 11 of file LSLocatorBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 28 of file LSLocatorBuilder.php.

References $command, and $control_builder.

29  {
30  $this->command = $command;
31  $this->control_builder = $control_builder;
32  }

Member Function Documentation

◆ end()

LSLocatorBuilder::end ( )

Finish building the locator.

Implements ILIAS\KioskMode\LocatorBuilder.

Definition at line 42 of file LSLocatorBuilder.php.

References $control_builder.

43  {
45  }
Build controls for the view.

◆ getItems()

LSLocatorBuilder::getItems ( )

Definition at line 34 of file LSLocatorBuilder.php.

References $items.

34  : array
35  {
36  return $this->items;
37  }

◆ item()

LSLocatorBuilder::item ( string  $label,
int  $parameter,
  $state = null 
)

Definition at line 50 of file LSLocatorBuilder.php.

References $command.

51  {
52  $this->items[] = [
53  'label' => $label,
54  'command' => $this->command,
55  'parameter' => $parameter
56  ];
57  return $this;
58  }
Build a locator for the view.

Field Documentation

◆ $command

LSLocatorBuilder::$command
protected

Definition at line 16 of file LSLocatorBuilder.php.

Referenced by __construct(), and item().

◆ $control_builder

LSLocatorBuilder::$control_builder
protected

Definition at line 26 of file LSLocatorBuilder.php.

Referenced by __construct(), and end().

◆ $items

LSLocatorBuilder::$items
protected

Definition at line 21 of file LSLocatorBuilder.php.

Referenced by getItems().


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