Contentserv PHP API

CSGuiEditorLayout extends CSGuiEditorLevel
in package

This class represents the structure of a CSGuiEditor to be able to relayout it It is possible to use the following javascript methods (if the editor supports them): - save(boolean dontCheckPatterns) - checkin() - checkout() - undocheckout() - update() - doAction(workflowActionID)

The CSGuiEditorLayout should be created like this:

...
$editor->activateEditorLayoutMode();
$editor->makeHtml();
$layout = $editor->getEditorLayout();
...
echo $layout->getFormHeader();
...
[ADD INPUTS]
...
echo '</form>';
Tags
since
5.2

Table of Contents

getAllInputs()  : array<string|int, mixed>
Returns recursivly all contained inputs for this level and all its sublevels
getFormHeader()  : string
Returns the opening tag of the form including all required javascripts, hidden inputs, .
getInputs()  : array<string|int, mixed>
Returns all directly contained inputs for this level
getJSLinks()  : array<string|int, mixed>
Returns all included javascript links
getName()  : mixed
getSubLevels()  : array<string|int, mixed>
Returns all contained sublevels for this level

Methods

getAllInputs()

Returns recursivly all contained inputs for this level and all its sublevels

public getAllInputs() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

of CSGuiEditorInput elements

getFormHeader()

Returns the opening tag of the form including all required javascripts, hidden inputs, .

public getFormHeader([bool $addJSLinks = true ]) : string

..

Parameters
$addJSLinks : bool = true

whether the javascript links should be included in the header. If not they must be included seperately using the method.

Tags
Return values
string

the html code of the form start tag

getInputs()

Returns all directly contained inputs for this level

public getInputs() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

of CSGuiEditorInput elements

Returns all included javascript links

public getJSLinks() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

the included javascript links

getSubLevels()

Returns all contained sublevels for this level

public getSubLevels() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

of CSGuiEditorLevel elements


        

Search results