1. trait
  2. XELOS
  3. \
  4. Framework
  5. \
  6. Module
  7. \
  8. Controller
  9. \
  10. ModulePageCollector

ModulePageCollector

trait ModulePageCollector

Methods

array
dynTreeAutocompletion(array $acceptedDyntreeParams)

Generates and returns the completed sentences for the dyn tree params field.

array
getCommandsForPage(string $searchString, string $refPage = '')

Used to fetch the methods from the page passed.

array
getDynTreeParams()

Placeholder method, that simply returns an empty array, in case the user chose a module, which isn't able to provide dynamic tree parameters.

array
getModulePages()

Defines an array containing pages, which will then be returned to the group navigation form in order to display them as entries in the select field 'ref_page'.

Details

at line 29
array dynTreeAutocompletion(array $acceptedDyntreeParams)

Generates and returns the completed sentences for the dyn tree params field.

Parameters

array $acceptedDyntreeParams

Return Value

array

at line 85
array getCommandsForPage(string $searchString, string $refPage = '')

Used to fetch the methods from the page passed.

Per default, if this method won't be overridden, this will return the methods of a page class.

Parameters

string $searchString
string $refPage

The page passed to this function: Example "show" for "page_show".

Return Value

array

Should return an array, containing at least a label to display and a description, displayed at the right side of the row as explanation for that command. ['label' => 'Label', 'example' => 'Example']

Exceptions

ReflectionException

at line 18
array getDynTreeParams()

Placeholder method, that simply returns an empty array, in case the user chose a module, which isn't able to provide dynamic tree parameters.

Return Value

array

at line 52
array getModulePages()

Defines an array containing pages, which will then be returned to the group navigation form in order to display them as entries in the select field 'ref_page'.

The user then is able to select one of these pages (of the selected instance).

Return Value

array