templates/3rdParty/pla/lib/xmlTemplates.php
Properties
 
Description
Classes and functions for XML based templates.
Classes
xmlTemplates
Properties
         
 
      
Yes 
      
No 
      
 
Description
XML Templates Class
Methods
__construct,
      
getClassVars,
      
getTemplate,
      
getTemplateFiles,
      
getTemplates,
      
__construct(
          
             
            $server_id,
          
          )
        
        :
        n/a
Arguments
| Name | Type | Description | Default | 
| $server_id | n/a |  |  | 
Return value
 
getClassVars(
          
          )
        
        :
        n/a
Description
This will return our custom class variables, used by the parent to create objects.Return value
 
getTemplate(
          
             
            $templateid,
          
          )
        
        :
        object
Description
Return a template by its IDArguments
| Name | Type | Description | Default | 
| $templateid | n/a |  |  | 
Return value
| Type | Description | 
| object | Template (or default template if the ID doesnt exist) | 
 
getTemplateFiles(
          
          )
        
        :
        n/a
Description
Get a list of template filenames.Return value
 
getTemplates(
          
             
            $type
            = null,
          
             
            $container
            = null,
          
             
            $disabled
            = false,
          
          )
        
        :
        array
Description
Return a list of templates by their type
This function should return a sorted list, as the array is built sorted.Arguments
| Name | Type | Description | Default | 
| $type | n/a |  | null | 
| $container | n/a |  | null | 
| $disabled | n/a |  | false | 
Return value
| Type | Description | 
| array | List of templates of the type | 
 
 
 
xmlTemplate
Properties
         
 
      
Yes 
      
No 
      
 
Description
XML Template Class
Methods
__construct,
      
addAttribute,
      
getAttrID,
      
getAttribute,
      
getAttributeNames,
      
getFileName,
      
getID,
      
getName,
      
getReadTime,
      
getServer,
      
getServerID,
      
getTitle,
      
getType,
      
isAdminDisabled,
      
isType,
      
__construct(
          
             
            $server_id,
          
             
            $name
            = null,
          
             
            $filename
            = null,
          
             
            $type
            = null,
          
             
            $id
            = null,
          
          )
        
        :
        n/a
Arguments
| Name | Type | Description | Default | 
| $server_id | n/a |  |  | 
| $name | n/a |  | null | 
| $filename | n/a |  | null | 
| $type | n/a |  | null | 
| $id | n/a |  | null | 
Return value
 
addAttribute(
          
             
            $name,
          
             
            $value,
          
             
            $source
            = null,
          
          )
        
        :
        int
Description
Add another attribute to this templateArguments
| Name | Type | Description | Default | 
| $name | n/a |  |  | 
| $value | n/a |  |  | 
| $source | n/a |  | null | 
Return value
| Type | Description | 
| int | Attribute ID | 
 
getAttrID(
          
             
            $attr,
          
          )
        
        :
        int
Description
Get an attribute IDArguments
| Name | Type | Description | Default | 
| $attr | n/a |  |  | 
Return value
| Type | Description | 
| int | Attribute ID in the array | 
 
getAttribute(
          
             
            $name,
          
          )
        
        :
        object
Description
Get a specific AttributeArguments
| Name | Type | Description | Default | 
| $name | n/a |  |  | 
Return value
| Type | Description | 
| object | Attribute | 
 
getAttributeNames(
          
          )
        
        :
        array
Description
Get the attribute namesReturn value
| Type | Description | 
| array | Array of attributes Names | 
 
getFileName(
          
          )
        
        :
        n/a
Description
Get the Template filename.Return value
 
getID(
          
          )
        
        :
        n/a
Description
Return the template by IDReturn value
 
getName(
          
             
            $lower
            = true,
          
          )
        
        :
        n/a
Description
Return the template nameArguments
| Name | Type | Description | Default | 
| $lower | n/a |  | true | 
Return value
 
getReadTime(
          
          )
        
        :
        n/a
Description
Get the Template read time.Return value
 
getServer(
          
          )
        
        :
        object
Description
Return this LDAP Server objectReturn value
| Type | Description | 
| object | DataStore Server | 
 
getServerID(
          
          )
        
        :
        int
Description
Return the LDAP server IDReturn value
| Type | Description | 
| int | Server ID | 
 
getTitle(
          
          )
        
        :
        n/a
Description
Get template titleReturn value
 
getType(
          
          )
        
        :
        n/a
Description
Return the template typeReturn value
 
isAdminDisabled(
          
          )
        
        :
        n/a
Description
May be overloaded in other classesReturn value
 
isType(
          
             
            $type,
          
          )
        
        :
        boolean
Description
Test if a template is of a typeArguments
| Name | Type | Description | Default | 
| $type | n/a |  |  | 
Return value