TemplateRender class

package phpLDAPadmin
subpackage Templates

 Methods

__call()

__call($method, $args) 
Inherited

inherited_from \Visitor::__call()
inherited_from \PageRender::__call()

Parameters

$method

$args

__construct()

__construct($server_id, $template_id) 
Inherited

inherited_from \PageRender::__construct()

Parameters

$server_id

$template_id

Initialise and Render the TemplateRender

accept($norender) 

Parameters

$norender

drawFormEnd()

drawFormEnd() 

FORM METHODS *

drawFormStart() 

drawFormSubmitButton()

drawFormSubmitButton() 

Draw all hidden attributes

drawHiddenAttributes() 
Inherited

inherited_from \PageRender::drawHiddenAttributes()

drawSubTitle()

drawSubTitle($subtitle) 

Parameters

$subtitle

drawTitle()

drawTitle($title) 

Parameters

$title

Return the LDAP server ID

getServerID() : int
Inherited

inherited_from \Visitor::getServerID()
inherited_from \PageRender::getServerID()

Returns

intServer ID

getTemplate()

getTemplate() 
Inherited

inherited_from \PageRender::getTemplate()

getTemplateID()

getTemplateID() 
Inherited

inherited_from \PageRender::getTemplateID()

setContainer()

setContainer($dn) 
Inherited

inherited_from \PageRender::setContainer()

Parameters

$dn

setDN()

setDN($dn) 
Inherited

inherited_from \PageRender::setDN()

Parameters

$dn

drawBlurJavascriptAttribute()

drawBlurJavascriptAttribute($attribute, $component) 

Parameters

$attribute

$component

drawCheckLinkPasswordAttribute()

drawCheckLinkPasswordAttribute($attribute, $component_id) 

Parameters

$attribute

$component_id

Container Chooser

drawContainerChooser($default_container) 

Parameters

$default_container

Draw the current specific value of an attribute

drawCurrentValueAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawCurrentValueAttribute()

Parameters

$attribute

$i

drawCurrentValueBinaryAttribute()

drawCurrentValueBinaryAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawCurrentValueBinaryAttribute()

Parameters

$attribute

$i

Draw a Jpeg Attribute

drawCurrentValueJpegAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawCurrentValueJpegAttribute()

Parameters

$attribute

$i

drawCurrentValuePasswordAttribute()

drawCurrentValuePasswordAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawCurrentValuePasswordAttribute()

Parameters

$attribute

$i

DRAW DISPLAYED CURRENT VALUES *

drawCurrentValuesAttribute($attribute) 
Inherited

inherited_from \PageRender::drawCurrentValuesAttribute()

Parameters

$attribute

drawDefaultHelperPasswordAttribute()

drawDefaultHelperPasswordAttribute($attribute, $i) 

Parameters

$attribute

$i

drawDefaultHelperSambaPasswordAttribute()

drawDefaultHelperSambaPasswordAttribute($attribute, $i) 

Parameters

$attribute

$i

drawDnValueIconAttribute()

drawDnValueIconAttribute($attribute, $val) 

Parameters

$attribute

$val

drawEndValueLineAttribute()

drawEndValueLineAttribute($attribute) 

Parameters

$attribute

drawFillJavascriptAttribute()

drawFillJavascriptAttribute($attribute, $component_id, $component_value) 

Parameters

$attribute

$component_id

$component_value

drawFocusJavascriptAttribute()

drawFocusJavascriptAttribute($attribute, $component) 

Parameters

$attribute

$component

drawForm()

drawForm($nosubmit) 

Parameters

$nosubmit

drawFormReadOnlyValueAttribute()

drawFormReadOnlyValueAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadOnlyValueAttribute()

Parameters

$attribute

$i

drawFormReadOnlyValueBinaryAttribute()

drawFormReadOnlyValueBinaryAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadOnlyValueBinaryAttribute()

Parameters

$attribute

$i

drawFormReadOnlyValueJpegAttribute()

drawFormReadOnlyValueJpegAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadOnlyValueJpegAttribute()

Parameters

$attribute

$i

drawFormReadOnlyValueMultiLineAttribute()

drawFormReadOnlyValueMultiLineAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadOnlyValueMultiLineAttribute()

Parameters

$attribute

$i

drawFormReadOnlyValuePasswordAttribute()

drawFormReadOnlyValuePasswordAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadOnlyValuePasswordAttribute()

Parameters

$attribute

$i

drawFormReadOnlyValueShadowAttribute()

drawFormReadOnlyValueShadowAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadOnlyValueShadowAttribute()

Parameters

$attribute

$i

drawFormReadWriteValueAttribute()

drawFormReadWriteValueAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadWriteValueAttribute()

Parameters

$attribute

$i

drawFormReadWriteValueBinaryAttribute()

drawFormReadWriteValueBinaryAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadWriteValueBinaryAttribute()

Parameters

$attribute

$i

drawFormReadWriteValueDateAttribute()

drawFormReadWriteValueDateAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadWriteValueDateAttribute()

Parameters

$attribute

$i

drawFormReadWriteValueDnAttribute()

drawFormReadWriteValueDnAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadWriteValueDnAttribute()

Parameters

$attribute

$i

drawFormReadWriteValueGidAttribute()

drawFormReadWriteValueGidAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadWriteValueGidAttribute()

Parameters

$attribute

$i

drawFormReadWriteValueMultiLineAttribute()

drawFormReadWriteValueMultiLineAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadWriteValueMultiLineAttribute()

Parameters

$attribute

$i

drawFormReadWriteValuePasswordAttribute()

drawFormReadWriteValuePasswordAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadWriteValuePasswordAttribute()

Parameters

$attribute

$i

drawFormReadWriteValueSelectionAttribute()

drawFormReadWriteValueSelectionAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadWriteValueSelectionAttribute()

Parameters

$attribute

$i

drawFormReadWriteValueShadowAttribute()

drawFormReadWriteValueShadowAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormReadWriteValueShadowAttribute()

Parameters

$attribute

$i

Draw a input value for an attribute - used in a form.

drawFormValueAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormValueAttribute()

Parameters

$attribute

$i

drawFormValueObjectClassAttribute()

drawFormValueObjectClassAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawFormValueObjectClassAttribute()

Parameters

$attribute

$i

drawHelperAttribute()

drawHelperAttribute($attribute, $i) 

Parameters

$attribute

$i

Draw specific hidden attribute

drawHiddenValueAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawHiddenValueAttribute()

Parameters

$attribute

$i

Draw specific hidden binary attribute

drawHiddenValueBinaryAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawHiddenValueBinaryAttribute()

Parameters

$attribute

$i

DRAW ICONS FOR ATTRIBUTES VALUES *

drawIconAttribute($attribute, $val) 

Parameters

$attribute

$val

DN ATTRIBUTES *

drawIconDnAttribute($attribute, $val) 

Parameters

$attribute

$val

OBJECT CLASS ATTRIBUTE *

drawIconObjectClassAttribute($attribute, $val) 

Parameters

$attribute

$val

SELECTION ATTRIBUTE RENDERING *

drawIconSelectionAttribute($attribute, $val) 

Parameters

$attribute

$val

drawInternalAttribute()

drawInternalAttribute($attribute) 

Parameters

$attribute

INTERNAL ATTRIBUTES *

drawInternalAttributes() 

DATE ATTRIBUTE RENDERING *

drawJavaScriptDateAttribute($attribute) 

Parameters

$attribute

DRAW PAGE JAVACRIPT

drawJavascript() 

javacript

drawJavascriptAttribute($attribute) 

Parameters

$attribute

drawJavascriptBinaryAttribute()

drawJavascriptBinaryAttribute($attribute) 

Parameters

$attribute

PASSWORD ATTRIBUTES *

drawJavascriptPasswordAttribute($attribute) 

Parameters

$attribute

This will draw the javascript that displays to the user the random password generated

drawJavascriptRandomPasswordAttribute($attribute) 

todo This function doesnt work well if there are more than 1 RandomPasswordAttributes on the form for the same attribute (unlikely situation)

Parameters

$attribute

drawMailValueIconAttribute()

drawMailValueIconAttribute($attribute, $val) 

Parameters

$attribute

$val

ATTRIBUTE MENU *

drawMenuAttribute($attribute) 

Parameters

$attribute

DRAW ATTRIBUTE NAME *

drawNameAttribute($attribute) 
Inherited

inherited_from \PageRender::drawNameAttribute()

Parameters

$attribute

ATTRIBUTE NOTES

drawNotesAttribute($attribute) 
Inherited

inherited_from \PageRender::drawNotesAttribute()

Parameters

$attribute

Object Class Chooser

drawObjectClassChooser() 

drawOldValueAttribute()

drawOldValueAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawOldValueAttribute()

Parameters

$attribute

$i

drawOldValueBinaryAttribute()

drawOldValueBinaryAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawOldValueBinaryAttribute()

Parameters

$attribute

$i

Draw a Jpeg Attribute

drawOldValueJpegAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawOldValueJpegAttribute()

Parameters

$attribute

$i

drawOldValuePasswordAttribute()

drawOldValuePasswordAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::drawOldValuePasswordAttribute()

Parameters

$attribute

$i

DRAW DISPLAYED OLD VALUES *

drawOldValuesAttribute($attribute) 
Inherited

inherited_from \PageRender::drawOldValuesAttribute()

Parameters

$attribute

RDN Chooser

drawRDNChooser() 

drawRequiredSymbolAttribute()

drawRequiredSymbolAttribute($attribute) 

Parameters

$attribute

Draws an HTML date selector button which, when clicked, pops up a date selector dialog.

drawSelectorPopupDateAttribute($attribute, $i) 

Parameters

$attribute

$i

drawShadowDateShadowAttribute()

drawShadowDateShadowAttribute($attribute) 
Inherited

inherited_from \PageRender::drawShadowDateShadowAttribute()

Parameters

$attribute

ATTRIBUTE LINE *

drawStartValueLineAttribute($attribute) 

Parameters

$attribute

drawStepForm()

drawStepForm($page) 

Parameters

$page

drawTemplateAttribute()

drawTemplateAttribute($attribute) 

Parameters

$attribute

Present a list of available templates for creating and editing LDAP entries

drawTemplateChoice() 

drawTemplateValuesAttribute()

drawTemplateValuesAttribute($attribute) 

Parameters

$attribute

ATTRIBUTE TITLE *

drawTitleAttribute($attribute) 

Parameters

$attribute

drawUrlValueIconAttribute()

drawUrlValueIconAttribute($attribute, $val) 

Parameters

$attribute

$val

drawValidateJavascriptAttribute()

drawValidateJavascriptAttribute($attribute, $component, $silence, $var_valid) 

Parameters

$attribute

$component

$silence

$var_valid

values *

drawValueAttribute($attribute, $i) 

Parameters

$attribute

$i

getAddValueMenuItemAttribute()

getAddValueMenuItemAttribute($attribute) 

Parameters

$attribute

getAddValueMenuItemObjectClassAttribute()

getAddValueMenuItemObjectClassAttribute($attribute) 

Parameters

$attribute

getAutoPostPasswordAttribute()

getAutoPostPasswordAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::getAutoPostPasswordAttribute()

Parameters

$attribute

$i

getBlurJavascriptAttribute()

getBlurJavascriptAttribute($attribute, $component) 

Parameters

$attribute

$component

getDefaultAttribute()

getDefaultAttribute($attribute, $container, $type) 

Parameters

$attribute

$container

$type

getDeleteAttributeMessage()

getDeleteAttributeMessage() 

getFocusJavascriptAttribute()

getFocusJavascriptAttribute($attribute, $component) 

Parameters

$attribute

$component

getMenuItemAddAttribute()

getMenuItemAddAttribute() 

getMenuItemAttribute()

getMenuItemAttribute($attribute, $action) 

Parameters

$attribute

$action

getMenuItemCompare()

getMenuItemCompare() 

getMenuItemCreate()

getMenuItemCreate() 

getMenuItemExportBase()

getMenuItemExportBase() 

getMenuItemExportSub()

getMenuItemExportSub() 

getMenuItemInternalAttributes()

getMenuItemInternalAttributes() 

getMenuItemRename()

getMenuItemRename() 

getMenuItemSelectionAttribute()

getMenuItemSelectionAttribute($attribute, $i) 

Parameters

$attribute

$i

getMenuItemShowChildren()

getMenuItemShowChildren($children_count) 

Parameters

$children_count

getMenuItemSwitchTemplate()

getMenuItemSwitchTemplate() 

Set the mode of the TemplateRender Applicable modes are "create" or "edit"

getMode() 

Return the container for this mode

getModeContainer() 

getModifiedAttributesMessage()

getModifiedAttributesMessage($modified_attributes) 

Parameters

$modified_attributes

getModifyMemberMenuItemAttribute()

getModifyMemberMenuItemAttribute($attribute) 

Parameters

$attribute

getNoteAliasAttribute()

getNoteAliasAttribute($attribute) 
Inherited

inherited_from \PageRender::getNoteAliasAttribute()

Parameters

$attribute

getNoteHintAttribute()

getNoteHintAttribute($attribute) 
Inherited

inherited_from \PageRender::getNoteHintAttribute()

Parameters

$attribute

getNoteRDNAttribute()

getNoteRDNAttribute($attribute) 
Inherited

inherited_from \PageRender::getNoteRDNAttribute()

Parameters

$attribute

getNoteROAttribute()

getNoteROAttribute($attribute) 
Inherited

inherited_from \PageRender::getNoteROAttribute()

Parameters

$attribute

getNoteRequiredAttribute()

getNoteRequiredAttribute($attribute) 
Inherited

inherited_from \PageRender::getNoteRequiredAttribute()

Parameters

$attribute

Process our <post> arguments from the templates

getPostAttribute($attribute, $i) 
Inherited

inherited_from \PageRender::getPostAttribute()

Parameters

$attribute

$i

getReadOnlyMessage()

getReadOnlyMessage() 

getRenameMenuItemAttribute()

getRenameMenuItemAttribute($attribute) 

Parameters

$attribute

Return this LDAP Server object

getServer() : object
Inherited

inherited_from \Visitor::getServer()
inherited_from \PageRender::getServer()

Returns

objectDataStore Server

This function is invoked if we dont know which template we should be using.

getTemplateChoice() : string
Inherited

inherited_from \PageRender::getTemplateChoice()

Returns

stringTemplate ID to be used or null if the user was presented with a list.

Get our templates applicable for this object

getTemplates() 
Inherited

inherited_from \PageRender::getTemplates()

getViewSchemaMessage()

getViewSchemaMessage() 

Is the default template enabled?

haveDefaultTemplate() 

Dummy method.

visitAttribute() 
Inherited

..

inherited_from \PageRender::visitAttribute()

PAGE DRAWING METHODS *

drawHeader() 

PAGE ENTRY MENU *

drawMenu() 

DRAW ATTRIBUTES *

drawShownAttributes() 

Given our known objectClass in the template, this will render the required MAY and optional MUST attributes

drawStepFormDefaultAttributes() 

drawStepFormEnd()

drawStepFormEnd() 

drawStepFormStart()

drawStepFormStart($page) 

Parameters

$page

drawStepFormSubmitButton()

drawStepFormSubmitButton($page) 

Parameters

$page

STEP FORM METHODS *

drawStepTitle($page) 

Parameters

$page

Javascript Functions

drawTemplateJavascript() 

PAGE ENTRY MENU ITEMS *

getMenuItem($i) 

Parameters

$i

getMenuItemDelete()

getMenuItemDelete() 

getMenuItemMove()

getMenuItemMove() 

PAGE ENTRY MENU ITEMS DETAILS *

getMenuItemRefresh() 

Takes a shadow* attribute and returns the date as an integer.

shadow_date(array $attribute) 
Inherited

inherited_from \PageRender::shadow_date()

Parameters

$attribute

array

Attribute objects

visitEnd()

visitEnd() 

This function will setup our template object (read LDAP for current values, read $_REQUEST for new values, etc) so that it can be rendered.

visitStart() 

 Properties

 

$container

$container 
Inherited

inherited_from \PageRender::$$container
 

$dn

$dn 
Inherited

inherited_from \PageRender::$$dn
 

$page

$page 
Inherited

inherited_from \PageRender::$$page
 

$server_id

$server_id 
Inherited

inherited_from \Visitor::$$server_id
inherited_from \PageRender::$$server_id
 

$template

$template 
Inherited

inherited_from \PageRender::$$template
 

$template_id

$template_id 
Inherited

inherited_from \PageRender::$$template_id
 

$pagelast

$pagelast