dmBridge PHP API
DMConfigXML Class Reference

Manages all configuration operations involving the config.xml file. More...

Public Member Functions

Static Public Member Functions

Protected Member Functions


Detailed Description

Manages all configuration operations involving the config.xml file.

Author:
Alex Dolski <alex.dolski@unlv.edu> http://www.opensource.org/licenses/mit-license.php

Definition at line 15 of file DMConfigXML.php.


Constructor & Destructor Documentation

DMConfigXML::__construct ( xml_file_pathname) [protected]
Parameters:
stringxml_file_pathname

Definition at line 68 of file DMConfigXML.php.


Member Function Documentation

DMConfigXML::deleteTemplateSet ( DMTemplateSet set)
Parameters:
DMTemplateSetset
Returns:
Boolean
Exceptions:
DMConstraintException

Definition at line 747 of file DMConfigXML.php.

static DMConfigXML::destroyInstance ( DMConfigXML instance) [static]
Parameters:
DMConfigXMLinstance
Returns:
void

Definition at line 56 of file DMConfigXML.php.

DMConfigXML::getAllTemplateSets ( )
Returns:
Indexed array of dmTemplate objects, sorted by name
Since:
0.3

Definition at line 84 of file DMConfigXML.php.

DMConfigXML::getCommentNotificationEmail ( )
Returns:
string
Since:
0.1

Definition at line 423 of file DMConfigXML.php.

DMConfigXML::getDataDir ( )
Returns:
string Absolute path of the data directory, with no trailing slash.
Since:
0.2

Definition at line 454 of file DMConfigXML.php.

DMConfigXML::getDomDocument ( ) [protected]
Parameters:
stringrel_path Path to the data file's subdirectory, relative to the dmbridgedata directory
Exceptions:
DMIOException
Returns:
DOMDocument

Definition at line 983 of file DMConfigXML.php.

Referenced by deleteTemplateSet(), getAllTemplateSets(), isValid(), loadTemplateSet(), save(), saveCollection(), saveTemplateSet(), and setModuleEnabled().

DMConfigXML::getFeedCopyright ( )
Returns:
string
Since:
0.1

Definition at line 470 of file DMConfigXML.php.

DMConfigXML::getFeedLanguage ( )
Returns:
string
Since:
0.1

Definition at line 485 of file DMConfigXML.php.

DMConfigXML::getFeedManagingEditorEmail ( )
Returns:
string
Since:
0.1

Definition at line 500 of file DMConfigXML.php.

DMConfigXML::getFeedManagingEditorName ( )
Returns:
string
Since:
0.1

Definition at line 515 of file DMConfigXML.php.

DMConfigXML::getFeedSubtitle ( )
Returns:
string
Since:
0.1

Definition at line 545 of file DMConfigXML.php.

DMConfigXML::getFeedTitle ( )
Returns:
string
Since:
0.1

Definition at line 530 of file DMConfigXML.php.

DMConfigXML::getFeedWebMasterEmail ( )
Returns:
string
Since:
0.1

Definition at line 560 of file DMConfigXML.php.

DMConfigXML::getFeedWebMasterName ( )
Returns:
string
Since:
0.1

Definition at line 575 of file DMConfigXML.php.

DMConfigXML::getFullPath ( )
Returns:
string

Definition at line 589 of file DMConfigXML.php.

DMConfigXML::getInstitutionName ( )
Returns:
string
Since:
0.1

Definition at line 597 of file DMConfigXML.php.

DMConfigXML::getTemplateSetForCollection ( DMCollection col)
Parameters:
DMCollectioncol
Returns:
DMTemplateSet, or null
Since:
0.4

Definition at line 928 of file DMConfigXML.php.

DMConfigXML::getVersion ( )

Pulls the version from VERSION.txt, which is created automatically by the packaging tool.

Returns:
string
Since:
0.1

Definition at line 961 of file DMConfigXML.php.

DMConfigXML::getVersionSequence ( )

Will increment by 1 with each subsequent release.

Returns:
int
Since:
0.1

Definition at line 972 of file DMConfigXML.php.

DMConfigXML::isCommentingEnabled ( )
Returns:
bool
Since:
2.0

Definition at line 392 of file DMConfigXML.php.

DMConfigXML::isCommentModerationEnabled ( )
Returns:
bool
Since:
0.1

Definition at line 408 of file DMConfigXML.php.

DMConfigXML::isCommentNotificationEnabled ( )
Returns:
bool
Since:
0.1

Definition at line 438 of file DMConfigXML.php.

DMConfigXML::isLoggingEnabled ( )
Returns:
bool
Since:
0.1

Definition at line 613 of file DMConfigXML.php.

DMConfigXML::isModuleEnabled ( module)
Parameters:
mixedmodule A DMBridgeModule object, or the name of a module.
Returns:
bool
Since:
2.0

Definition at line 631 of file DMConfigXML.php.

DMConfigXML::isModuleOfSameNameAndVersionInstalled ( DMBridgeModule module)

Used to check whether a module is installed with the same name and version as the given module.

A module is installed the first time it is activated, and remains installed forever, even if deactivated.

Parameters:
DMBridgeModulemodule
Returns:
boolean
See also:
isModuleOfSameNameInstalled

Definition at line 663 of file DMConfigXML.php.

DMConfigXML::isModuleOfSameNameInstalled ( DMBridgeModule module)

Used to check whether a module is installed with the same name as the given module.

A module is installed the first time it is activated, and remains installed forever, even if deactivated.

Parameters:
DMBridgeModulemodule
Returns:
boolean
See also:
isModuleOfSameNameAndVersionInstalled

Definition at line 648 of file DMConfigXML.php.

DMConfigXML::isRatingEnabled ( )
Returns:
bool
Since:
2.0

Definition at line 699 of file DMConfigXML.php.

DMConfigXML::isTaggingEnabled ( )
Returns:
bool
Since:
2.0

Definition at line 715 of file DMConfigXML.php.

DMConfigXML::isTagModerationEnabled ( )
Returns:
bool
Since:
0.3

Definition at line 731 of file DMConfigXML.php.

DMConfigXML::isValid ( )
Returns:
Boolean

Definition at line 948 of file DMConfigXML.php.

DMConfigXML::loadCollection ( DMCollection col)

Modifies $col by reference.

Parameters:
DMCollectioncol
Returns:
void

Definition at line 100 of file DMConfigXML.php.

DMConfigXML::loadTemplateSet ( DMTemplateSet set)

Modifies $set by reference.

Parameters:
DMTemplateSetset
Returns:
void
Exceptions:
DMUnavailableModelException
Since:
0.3

Definition at line 781 of file DMConfigXML.php.

DMConfigXML::save ( )
Parameters:
stringrel_path Path to the XML file's directory, relative to the dmbridgedata directory
Exceptions:
DMIOException

Definition at line 1123 of file DMConfigXML.php.

Referenced by deleteTemplateSet(), saveCollection(), and saveTemplateSet().

DMConfigXML::saveCollection ( DMCollection col)
Parameters:
DMCollectioncol
Exceptions:
DMIOException
Returns:
void

Definition at line 226 of file DMConfigXML.php.

Referenced by getDomDocument().

DMConfigXML::saveTemplateSet ( DMTemplateSet set)
Parameters:
DMTemplateSetset
Returns:
Boolean
Exceptions:
DMExceptionIf name or path are not unique
DMIOException

Definition at line 842 of file DMConfigXML.php.

DMConfigXML::setCommentingEnabled ( bool)
Parameters:
Booleanbool
Since:
2.0

Definition at line 400 of file DMConfigXML.php.

DMConfigXML::setCommentModerationEnabled ( bool)
Parameters:
Booleanbool

Definition at line 415 of file DMConfigXML.php.

DMConfigXML::setCommentNotificationEmail ( str)
Parameters:
stringstr Email to which comment notifications should be sent

Definition at line 430 of file DMConfigXML.php.

DMConfigXML::setCommentNotificationEnabled ( bool)
Parameters:
Booleanbool

Definition at line 445 of file DMConfigXML.php.

DMConfigXML::setFeedCopyright ( str)
Parameters:
stringstr

Definition at line 477 of file DMConfigXML.php.

DMConfigXML::setFeedLanguage ( str)
Parameters:
stringstr

Definition at line 492 of file DMConfigXML.php.

DMConfigXML::setFeedManagingEditorEmail ( str)
Parameters:
stringstr

Definition at line 507 of file DMConfigXML.php.

DMConfigXML::setFeedManagingEditorName ( str)
Parameters:
stringstr

Definition at line 522 of file DMConfigXML.php.

DMConfigXML::setFeedSubtitle ( str)
Parameters:
stringstr

Definition at line 552 of file DMConfigXML.php.

DMConfigXML::setFeedTitle ( str)
Parameters:
stringstr

Definition at line 537 of file DMConfigXML.php.

DMConfigXML::setFeedWebMasterEmail ( str)
Parameters:
stringstr

Definition at line 567 of file DMConfigXML.php.

DMConfigXML::setFeedWebMasterName ( str)
Parameters:
stringstr

Definition at line 582 of file DMConfigXML.php.

DMConfigXML::setInstitutionName ( str)
Parameters:
stringstr
Returns:
void

Definition at line 605 of file DMConfigXML.php.

DMConfigXML::setModuleEnabled ( DMBridgeModule module,
enabled 
)
Parameters:
DMBridgeModulemodule
boolenabled
Returns:
void

Definition at line 675 of file DMConfigXML.php.

DMConfigXML::setRatingEnabled ( bool)
Parameters:
Booleanbool
Since:
2.0

Definition at line 707 of file DMConfigXML.php.

DMConfigXML::setTaggingEnabled ( bool)
Parameters:
Booleanbool
Since:
2.0

Definition at line 723 of file DMConfigXML.php.

DMConfigXML::setTagModerationEnabled ( bool)
Parameters:
Booleanbool

Definition at line 738 of file DMConfigXML.php.


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