templates/3rdParty/pla/lib/TemplateRender.php
Properties
Description
This class will render the creation or editing of an LDAP entry.
Classes
TemplateRender
Properties
No
No
Description
TemplateRender class
Methods
accept,
drawBlurJavascriptAttribute,
drawCheckLinkPasswordAttribute,
drawContainerChooser,
drawDefaultHelperPasswordAttribute,
drawDefaultHelperSambaPasswordAttribute,
drawDnValueIconAttribute,
drawEndValueLineAttribute,
drawFillJavascriptAttribute,
drawFocusJavascriptAttribute,
drawForm,
drawFormEnd,
drawFormStart,
drawFormSubmitButton,
drawHeader,
drawHelperAttribute,
drawIconAttribute,
drawIconDnAttribute,
drawIconObjectClassAttribute,
drawIconSelectionAttribute,
drawInternalAttribute,
drawInternalAttributes,
drawJavaScriptDateAttribute,
drawJavascript,
drawJavascriptAttribute,
drawJavascriptBinaryAttribute,
drawJavascriptPasswordAttribute,
drawJavascriptRandomPasswordAttribute,
drawMailValueIconAttribute,
drawMenu,
drawMenuAttribute,
drawObjectClassChooser,
drawRDNChooser,
drawRequiredSymbolAttribute,
drawSelectorPopupDateAttribute,
drawShownAttributes,
drawStartValueLineAttribute,
drawStepForm,
drawStepFormDefaultAttributes,
drawStepFormEnd,
drawStepFormStart,
drawStepFormSubmitButton,
drawStepTitle,
drawSubTitle,
drawTemplateAttribute,
drawTemplateChoice,
drawTemplateJavascript,
drawTemplateValuesAttribute,
drawTitle,
drawTitleAttribute,
drawUrlValueIconAttribute,
drawValidateJavascriptAttribute,
drawValueAttribute,
getAddValueMenuItemAttribute,
getAddValueMenuItemObjectClassAttribute,
getBlurJavascriptAttribute,
getDefaultAttribute,
getDeleteAttributeMessage,
getFocusJavascriptAttribute,
getMenuItem,
getMenuItemAddAttribute,
getMenuItemAttribute,
getMenuItemCompare,
getMenuItemCreate,
getMenuItemDelete,
getMenuItemExportBase,
getMenuItemExportSub,
getMenuItemInternalAttributes,
getMenuItemMove,
getMenuItemRefresh,
getMenuItemRename,
getMenuItemSelectionAttribute,
getMenuItemShowChildren,
getMenuItemSwitchTemplate,
getMode,
getModeContainer,
getModifiedAttributesMessage,
getModifyMemberMenuItemAttribute,
getReadOnlyMessage,
getRenameMenuItemAttribute,
getViewSchemaMessage,
haveDefaultTemplate,
visitEnd,
visitStart,
accept(
$norender
= false,
)
:
n/a
Description
Initialise and Render the TemplateRenderArguments
Name |
Type |
Description |
Default |
$norender |
n/a |
|
false |
Return value
drawBlurJavascriptAttribute(
$attribute,
$component,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$component |
n/a |
|
|
Return value
drawCheckLinkPasswordAttribute(
$attribute,
$component_id,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$component_id |
n/a |
|
|
Return value
drawContainerChooser(
$default_container,
)
:
n/a
Description
Container ChooserArguments
Name |
Type |
Description |
Default |
$default_container |
n/a |
|
|
Return value
drawDefaultHelperPasswordAttribute(
$attribute,
$i,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$i |
n/a |
|
|
Return value
drawDefaultHelperSambaPasswordAttribute(
$attribute,
$i,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$i |
n/a |
|
|
Return value
drawDnValueIconAttribute(
$attribute,
$val,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$val |
n/a |
|
|
Return value
drawEndValueLineAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawFillJavascriptAttribute(
$attribute,
$component_id,
$component_value,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$component_id |
n/a |
|
|
$component_value |
n/a |
|
|
Return value
drawFocusJavascriptAttribute(
$attribute,
$component,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$component |
n/a |
|
|
Return value
drawForm(
$nosubmit
= false,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$nosubmit |
n/a |
|
false |
Return value
drawFormEnd(
)
:
n/a
Return value
drawFormStart(
)
:
n/a
Description
FORM METHODS *Return value
drawFormSubmitButton(
)
:
n/a
Return value
drawHeader(
)
:
n/a
Description
PAGE DRAWING METHODS *Return value
drawHelperAttribute(
$attribute,
$i,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$i |
n/a |
|
|
Return value
drawIconAttribute(
$attribute,
$val,
)
:
n/a
Description
DRAW ICONS FOR ATTRIBUTES VALUES *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$val |
n/a |
|
|
Return value
drawIconDnAttribute(
$attribute,
$val,
)
:
n/a
Description
DN ATTRIBUTES *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$val |
n/a |
|
|
Return value
drawIconObjectClassAttribute(
$attribute,
$val,
)
:
n/a
Description
OBJECT CLASS ATTRIBUTE *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$val |
n/a |
|
|
Return value
drawIconSelectionAttribute(
$attribute,
$val,
)
:
n/a
Description
SELECTION ATTRIBUTE RENDERING *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$val |
n/a |
|
|
Return value
drawInternalAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawInternalAttributes(
)
:
n/a
Description
INTERNAL ATTRIBUTES *Return value
drawJavaScriptDateAttribute(
$attribute,
)
:
n/a
Description
DATE ATTRIBUTE RENDERING *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawJavascript(
)
:
n/a
Description
DRAW PAGE JAVACRIPTReturn value
drawJavascriptAttribute(
$attribute,
)
:
n/a
Description
javacriptArguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawJavascriptBinaryAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawJavascriptPasswordAttribute(
$attribute,
)
:
n/a
Description
PASSWORD ATTRIBUTES *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawJavascriptRandomPasswordAttribute(
$attribute,
)
:
n/a
Description
This will draw the javascript that displays to the user the random password generatedArguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
Tags
Name |
Description |
todo |
This function doesnt work well if there are more than 1 RandomPasswordAttributes on the form for the same attribute (unlikely situation) |
drawMailValueIconAttribute(
$attribute,
$val,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$val |
n/a |
|
|
Return value
drawMenu(
)
:
n/a
Description
PAGE ENTRY MENU *Return value
drawMenuAttribute(
$attribute,
)
:
n/a
Description
ATTRIBUTE MENU *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawObjectClassChooser(
)
:
n/a
Description
Object Class ChooserReturn value
drawRDNChooser(
)
:
n/a
Description
RDN ChooserReturn value
drawRequiredSymbolAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawSelectorPopupDateAttribute(
$attribute,
$i,
)
:
n/a
Description
Draws an HTML date selector button which, when clicked, pops up a date selector dialog.Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$i |
n/a |
|
|
Return value
drawShownAttributes(
)
:
n/a
Description
DRAW ATTRIBUTES *Return value
drawStartValueLineAttribute(
$attribute,
)
:
n/a
Description
ATTRIBUTE LINE *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawStepForm(
$page,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$page |
n/a |
|
|
Return value
drawStepFormDefaultAttributes(
)
:
n/a
Description
Given our known objectClass in the template, this will render the required MAY and optional MUST attributesReturn value
drawStepFormEnd(
)
:
n/a
Return value
drawStepFormStart(
$page,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$page |
n/a |
|
|
Return value
drawStepFormSubmitButton(
$page,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$page |
n/a |
|
|
Return value
drawStepTitle(
$page,
)
:
n/a
Description
STEP FORM METHODS *Arguments
Name |
Type |
Description |
Default |
$page |
n/a |
|
|
Return value
drawSubTitle(
$subtitle
= null,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$subtitle |
n/a |
|
null |
Return value
drawTemplateAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawTemplateChoice(
)
:
n/a
Description
Present a list of available templates for creating and editing LDAP entriesReturn value
drawTemplateJavascript(
)
:
n/a
Description
Javascript FunctionsReturn value
drawTemplateValuesAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawTitle(
$title
= null,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$title |
n/a |
|
null |
Return value
drawTitleAttribute(
$attribute,
)
:
n/a
Description
ATTRIBUTE TITLE *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
drawUrlValueIconAttribute(
$attribute,
$val,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$val |
n/a |
|
|
Return value
drawValidateJavascriptAttribute(
$attribute,
$component,
$silence,
$var_valid,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$component |
n/a |
|
|
$silence |
n/a |
|
|
$var_valid |
n/a |
|
|
Return value
drawValueAttribute(
$attribute,
$i,
)
:
n/a
Description
values *Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$i |
n/a |
|
|
Return value
getAddValueMenuItemAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
getAddValueMenuItemObjectClassAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
getBlurJavascriptAttribute(
$attribute,
$component,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$component |
n/a |
|
|
Return value
getDefaultAttribute(
$attribute,
$container,
$type,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$container |
n/a |
|
|
$type |
n/a |
|
|
Return value
getDeleteAttributeMessage(
)
:
n/a
Return value
getFocusJavascriptAttribute(
$attribute,
$component,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$component |
n/a |
|
|
Return value
getMenuItem(
$i,
)
:
n/a
Description
PAGE ENTRY MENU ITEMS *Arguments
Name |
Type |
Description |
Default |
$i |
n/a |
|
|
Return value
getMenuItemAddAttribute(
)
:
n/a
Return value
getMenuItemAttribute(
$attribute,
$action,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$action |
n/a |
|
|
Return value
getMenuItemCompare(
)
:
n/a
Return value
getMenuItemCreate(
)
:
n/a
Return value
getMenuItemDelete(
)
:
n/a
Return value
getMenuItemExportBase(
)
:
n/a
Return value
getMenuItemExportSub(
)
:
n/a
Return value
getMenuItemInternalAttributes(
)
:
n/a
Return value
getMenuItemMove(
)
:
n/a
Return value
getMenuItemRefresh(
)
:
n/a
Description
PAGE ENTRY MENU ITEMS DETAILS *Return value
getMenuItemRename(
)
:
n/a
Return value
getMenuItemSelectionAttribute(
$attribute,
$i,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
$i |
n/a |
|
|
Return value
getMenuItemShowChildren(
$children_count,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$children_count |
n/a |
|
|
Return value
getMenuItemSwitchTemplate(
)
:
n/a
Return value
getMode(
)
:
n/a
Description
Set the mode of the TemplateRender
Applicable modes are "create" or "edit"Return value
getModeContainer(
)
:
n/a
Description
Return the container for this modeReturn value
getModifiedAttributesMessage(
$modified_attributes,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$modified_attributes |
n/a |
|
|
Return value
getModifyMemberMenuItemAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
getReadOnlyMessage(
)
:
n/a
Return value
getRenameMenuItemAttribute(
$attribute,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$attribute |
n/a |
|
|
Return value
getViewSchemaMessage(
)
:
n/a
Return value
haveDefaultTemplate(
)
:
n/a
Description
Is the default template enabled?Return value
visitEnd(
)
:
n/a
Return value
visitStart(
)
:
n/a
Description
This function will setup our template object (read LDAP for current values, read $_REQUEST for new values, etc)
so that it can be rendered.Return value