dmTemplateSet Class Reference

Inheritance diagram for dmTemplateSet:
dmModel idmViewDefinition

Public Member Functions

Static Public Member Functions


Detailed Description

Definition at line 15 of file dmTemplateSet.class.php.


Constructor & Destructor Documentation

dmTemplateSet::__construct ( id = null  ) 

If 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 dmTemplate object.

Parameters:
int id
Exceptions:
dmUnavailableTemplateSetException 

Definition at line 105 of file dmTemplateSet.class.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

Definition at line 118 of file dmTemplateSet.class.php.

dmTemplateSet::addAuthorizedCollection ( dmCollection c  )  [final]
Parameters:
dmCollection c
Returns:
void

Definition at line 126 of file dmTemplateSet.class.php.

static dmTemplateSet::getAll (  )  [static, final]
Returns:
array of dmTemplate objects
Exceptions:
dmHTTPException 
Since:
0.3

Definition at line 39 of file dmTemplateSet.class.php.

dmTemplateSet::getAuthorizedCollections (  )  [final]
Returns:
array Array of dmCollection objects

Definition at line 133 of file dmTemplateSet.class.php.

Referenced by isAuthorizedToViewCollection().

static dmTemplateSet::getCurrent (  )  [static, final]
dmTemplateSet::getDateSearchBeginYear (  )  [final]
Returns:
int
Since:
0.1

Implements idmViewDefinition.

Definition at line 165 of file dmTemplateSet.class.php.

dmTemplateSet::getDateSearchEndYear (  )  [final]
Returns:
int
Since:
0.1

Implements idmViewDefinition.

Definition at line 176 of file dmTemplateSet.class.php.

dmTemplateSet::getDefaultCollection (  )  [final]
Returns:
dmCollection object
Since:
0.3

Definition at line 194 of file dmTemplateSet.class.php.

dmTemplateSet::getID (  )  [final]
Returns:
int
Since:
0.3

Definition at line 210 of file dmTemplateSet.class.php.

dmTemplateSet::getName (  )  [final]
Returns:
string
Since:
0.3

Definition at line 226 of file dmTemplateSet.class.php.

Referenced by __toString(), getPath(), and dmRoute::getViewFilename().

dmTemplateSet::getNumTileColumns (  )  [final]
Returns:
int

Implements idmViewDefinition.

Definition at line 240 of file dmTemplateSet.class.php.

dmTemplateSet::getPath (  )  [final]

Returns the path to the template set, relative to the web server's document root.

Returns:
string

Definition at line 253 of file dmTemplateSet.class.php.

dmTemplateSet::getResultsViewFields (  )  [final]

Returns an array of all dmField objects that are to be displayed in grid view.

Returns:
array Array of dmField objects

Implements idmViewDefinition.

Definition at line 268 of file dmTemplateSet.class.php.

dmTemplateSet::getViewerClassForExtension ( ext  )  [final]
Parameters:
string ext Filename extension
Returns:
string Class name

Implements idmViewDefinition.

Definition at line 293 of file dmTemplateSet.class.php.

dmTemplateSet::getViewerHeightForExtension ( ext  )  [final]
Parameters:
string ext Filename extension
Returns:
int

Implements idmViewDefinition.

Definition at line 306 of file dmTemplateSet.class.php.

dmTemplateSet::getViewerMIMEForExtension ( ext  )  [final]
Parameters:
string ext Filename extension
Returns:
string

Implements idmViewDefinition.

Definition at line 319 of file dmTemplateSet.class.php.

dmTemplateSet::getViewerWidthForExtension ( ext  )  [final]
Parameters:
string ext Filename extension
Returns:
int

Implements idmViewDefinition.

Definition at line 332 of file dmTemplateSet.class.php.

dmTemplateSet::isAuthorizedToViewCollection ( dmCollection c  )  [final]
Parameters:
dmCollection c
Returns:
Boolean
See also:
dmCollection::isAccessibleByTemplateSet()

Definition at line 149 of file dmTemplateSet.class.php.

Referenced by dmCollection::isAccessibleByTemplateSet().

dmTemplateSet::isDebugMode (  )  [final]
Returns:
Boolean

Definition at line 186 of file dmTemplateSet.class.php.

dmTemplateSet::setDefaultCollection ( dmCollection col  )  [final]
Parameters:
dmCollection col
Since:
0.3

Definition at line 202 of file dmTemplateSet.class.php.

dmTemplateSet::setID ( id  )  [final]
Parameters:
int id
Since:
0.3

Definition at line 218 of file dmTemplateSet.class.php.

Referenced by __construct().

dmTemplateSet::setName ( str  )  [final]
Parameters:
string str

Definition at line 233 of file dmTemplateSet.class.php.

dmTemplateSet::unsetAuthorizedCollections (  )  [final]
Returns:
void

Definition at line 140 of file dmTemplateSet.class.php.


The documentation for this class was generated from the following file:

Generated on Fri Aug 20 13:16:50 2010 for dmBridge PHP API by  doxygen 1.6.1