dmBridge PHP API
DMTemplateSet Class Reference
Inheritance diagram for DMTemplateSet:

Public Member Functions


Detailed Description


Constructor & Destructor Documentation

DMTemplateSet::__construct ( id = null)

If $id is supplied and is a valid template set ID from the data store, automatically populates the set's properties from the data store.

Otherwise instantiates an empty DMTemplateSet object.

Parameters:
intid
Exceptions:
DMUnavailableModelException
Since:
0.1

Definition at line 46 of file DMTemplateSet.php.


Member Function Documentation

DMTemplateSet::__toString ( )

Equivalent to calling getName().

The return value of this method is not stable and should not be relied upon.

Returns:
The template set's name
Since:
0.3

Definition at line 60 of file DMTemplateSet.php.

DMTemplateSet::addAuthorizedCollection ( DMCollection c)
Parameters:
DMCollectionc
Since:
0.3

Definition at line 68 of file DMTemplateSet.php.

Referenced by DMConfigXML::loadTemplateSet().

DMTemplateSet::addGridViewField ( DMDCElement f)
Parameters:
DMDCElementf

Definition at line 172 of file DMTemplateSet.php.

Referenced by DMConfigXML::loadTemplateSet().

DMTemplateSet::delete ( )

Deletes the DMTemplateSet object from the data store and unsets the DMTemplateSet object.

Returns:
void
Exceptions:
DMDataStoreException
Deprecated:

Definition at line 122 of file DMTemplateSet.php.

DMTemplateSet::getAuthorizedCollections ( )
Returns:
array of DMCollection objects
Since:
0.3

Definition at line 84 of file DMTemplateSet.php.

Referenced by isAuthorizedToViewCollection(), and DMConfigXML::saveTemplateSet().

DMTemplateSet::getDefaultCollection ( )
Returns:
DMCollection
Since:
0.3

Definition at line 138 of file DMTemplateSet.php.

Referenced by DMConfigXML::saveTemplateSet().

DMTemplateSet::getErrorTemplate ( )

Returns the template-specific error DMTemplate, or the default dmBridge error DMTemplate if that doesn't exist.

Returns:
DMTemplate
Since:
2.0

Definition at line 161 of file DMTemplateSet.php.

DMTemplateSet::getGridViewFields ( )
Returns:
array array of DMDCElement objects

Definition at line 179 of file DMTemplateSet.php.

Referenced by DMConfigXML::saveTemplateSet().

DMTemplateSet::getID ( )
Returns:
int
Since:
0.3

Definition at line 194 of file DMTemplateSet.php.

Referenced by DMConfigXML::deleteTemplateSet(), DMConfigXML::loadTemplateSet(), and DMConfigXML::saveTemplateSet().

DMTemplateSet::getName ( )
Returns:
string
Since:
0.3

Definition at line 210 of file DMTemplateSet.php.

Referenced by __toString(), getPath(), and DMConfigXML::saveTemplateSet().

DMTemplateSet::getNumResultsPerPage ( )
Returns:
int The number of results that are to appear in results view.

Definition at line 225 of file DMTemplateSet.php.

Referenced by DMConfigXML::saveTemplateSet().

DMTemplateSet::getNumTileViewColumns ( )
Returns:
int

Definition at line 239 of file DMTemplateSet.php.

Referenced by DMConfigXML::saveTemplateSet().

DMTemplateSet::getPath ( )
Returns:
string The path to the template set, relative to the web server's document root.

Definition at line 261 of file DMTemplateSet.php.

Referenced by getErrorTemplate().

DMTemplateSet::getTemplateAtPathname ( pathname)
Parameters:
stringpathname Pathname relative to the root of the template set folder
Returns:
DMTemplate
Since:
2.0

Definition at line 312 of file DMTemplateSet.php.

DMTemplateSet::getTemplates ( )
Returns:
array Array of DMTemplate objects
Since:
2.0

Definition at line 285 of file DMTemplateSet.php.

Referenced by getTemplateAtPathname().

DMTemplateSet::isAuthorizedToViewCollection ( DMCollection c)
Parameters:
DMCollectionc
Returns:
Boolean
Since:
0.3
See also:
DMCollection::isAccessibleByTemplateSet()

Definition at line 102 of file DMTemplateSet.php.

DMTemplateSet::setDefaultCollection ( DMCollection col)
Parameters:
DMCollectioncol
Since:
0.3

Definition at line 146 of file DMTemplateSet.php.

Referenced by DMConfigXML::loadTemplateSet().

DMTemplateSet::setID ( id)
Parameters:
intid
Since:
0.3

Definition at line 202 of file DMTemplateSet.php.

Referenced by __construct(), and DMConfigXML::saveTemplateSet().

DMTemplateSet::setName ( str)
Parameters:
stringstr
Since:
0.3

Definition at line 218 of file DMTemplateSet.php.

Referenced by DMConfigXML::loadTemplateSet().

DMTemplateSet::setNumResultsPerPage ( rpp)
Parameters:
intrpp The number of results that are to appear in results view.

Definition at line 232 of file DMTemplateSet.php.

Referenced by DMConfigXML::loadTemplateSet().

DMTemplateSet::setNumTileViewColumns ( int)
Parameters:
intint

Definition at line 246 of file DMTemplateSet.php.

Referenced by DMConfigXML::loadTemplateSet().

DMTemplateSet::setPath ( path)

Overrides the template set's pathname.

Parameters:
stringpath

Definition at line 277 of file DMTemplateSet.php.

DMTemplateSet::unsetAuthorizedCollections ( )
Returns:
void
Since:
0.3

Definition at line 92 of file DMTemplateSet.php.

DMTemplateSet::unsetGridViewFields ( )
Returns:
void

Definition at line 186 of file DMTemplateSet.php.

DMTemplateSet::unsetNumTileViewColumns ( )
Returns:
void

Definition at line 253 of file DMTemplateSet.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables