MindFlow Documentation
\
mf
core

\pages

Summary

Methods
Properties
Constants
prepareData()
render()
createPage()
editPage()
deletePage()
listPages()
parsePages()
showPageRow()
processMicrotemplates()
processMicrotemplate()
processTemplate()
addFrontendHook()
getType()
$pageOutput
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$moduleKey
$pluginVersion
$moduleType
$dependencies
$pageFrontendHooks
$action
N/A

Properties

$pageOutput

$pageOutput :

Type

$moduleKey

$moduleKey :

Type

$pluginVersion

$pluginVersion :

Type

$moduleType

$moduleType :

Type

$dependencies

$dependencies :

Type

$pageFrontendHooks

$pageFrontendHooks :

Type

$action

$action :

Type

Methods

prepareData()

prepareData() : mixed

Launches the data processing step of all modules, executing their own prepareData() function

Returns

mixed

render()

render(  $mainTemplate) : mixed

Launches the rendering step of all modules, executing their own render() function

Parameters

$mainTemplate

Returns

mixed

createPage()

createPage()

editPage()

editPage(  $uid)

Parameters

$uid

deletePage()

deletePage(  $uid)

Parameters

$uid

listPages()

listPages()

parsePages()

parsePages(  $page,   $html,   $l10n,   $keysList,   $moduleName,   $subModuleName)

Parameters

$page
$html
$l10n
$keysList
$moduleName
$subModuleName

showPageRow()

showPageRow(\page  $page, array  $html, \l10nManager  $l10n, array  $keysList, string  $moduleName, string  $subModuleName)

Processes display of a single page in the nestedSortable based page list of module pages

Parameters

\page $page

the page data
array $html

the html currently being edited
\l10nManager $l10n

the l10nManager object used for accessing translations
array $keysList

record field keys for which value should be display in the page title area
string $moduleName

current module key
string $subModuleName

current submodule key

processMicrotemplates()

processMicrotemplates(  $microtemplates,   $page)

Parameters

$microtemplates
$page

processMicrotemplate()

processMicrotemplate(  $microtemplate,   $page)

Parameters

$microtemplate
$page

processTemplate()

processTemplate(  $templateDataStructure,   $templateValues,   $templateHTML,   $page)

Parameters

$templateDataStructure
$templateValues
$templateHTML
$page

addFrontendHook()

addFrontendHook(  $hookValue)

Adds an external function to be called on page load, such as statItem::createStatEntry()

Parameters

$hookValue

getType()

getType() : string

must return one or several plugin types separated by comas current possible values are "backend, frontend, authentification"

Returns

string —

coma separated list of current module execution context types