Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
NativeXmlUserGroupFilter Class Reference
Inheritance diagram for NativeXmlUserGroupFilter:
NativeImportFilter NativeImportExportFilter PersistableFilter Filter DataObject

Public Member Functions

 getClassName ()
 
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleElement ($node)
 
 NativeXmlUserGroupFilter ($filterGroup)
 
- Public Member Functions inherited from NativeImportFilter
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleElement ($node)
 
 NativeImportFilter ($filterGroup)
 
 parseLocalizedContent ($element)
 
process (&$document)
 
- Public Member Functions inherited from NativeImportExportFilter
 getDeployment ()
 
 NativeImportExportFilter ($filterGroup)
 
 setDeployment ($deployment)
 
- Public Member Functions inherited from PersistableFilter
 addSetting (&$setting)
 
 getClassName ()
 
getFilterGroup ()
 
 getInternalSettings ()
 
 getIsTemplate ()
 
 getLocalizedSettingNames ()
 
 getParentFilterId ()
 
getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 hasSetting ($settingName)
 
 hasSettings ()
 
 PersistableFilter ($filterGroup)
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
- Public Member Functions inherited from Filter
 addError ($message)
 
 clearErrors ()
 
execute (&$input)
 
 Filter ($inputType, $outputType)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSeq ()
 
 hasErrors ()
 
 isCompatibleWithRuntimeEnvironment ()
 
process (&$input)
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSeq ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Static Public Member Functions inherited from PersistableFilter
static tempGroup ($inputType, $outputType)
 
- Static Public Member Functions inherited from Filter
static supportedRuntimeEnvironmentSettings ()
 
- Public Attributes inherited from PersistableFilter
 $_settings = array()
 
- Public Attributes inherited from Filter
 $_errors = array()
 
 $_runtimeEnvironment = false
 
- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Base class that converts a Native XML document to a set of user groups.

Definition at line 18 of file NativeXmlUserGroupFilter.inc.php.

Member Function Documentation

NativeXmlUserGroupFilter::getClassName ( )

Return the fully qualified class name of the filter class. This information must be persisted when saving a filter so that the filter can later be reconstructed from the information in the database.

(This must be hard coded by sub-classes for PHP4 compatibility. PHP4 always returns class names lowercase which we cannot tolerate as we need this path to find the class on case sensitive file systems.)

Definition at line 53 of file NativeXmlUserGroupFilter.inc.php.

NativeXmlUserGroupFilter::getPluralElementName ( )

Return the plural element name

Returns
string

Definition at line 35 of file NativeXmlUserGroupFilter.inc.php.

NativeXmlUserGroupFilter::getSingularElementName ( )

Get the singular element name

Returns
string

Definition at line 43 of file NativeXmlUserGroupFilter.inc.php.

NativeXmlUserGroupFilter::handleElement (   $node)

Handle a user_group element

Parameters
$nodeDOMElement
Returns
array Array of UserGroup objects

Definition at line 63 of file NativeXmlUserGroupFilter.inc.php.

References DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), and NativeImportFilter\parseLocalizedContent().

NativeXmlUserGroupFilter::NativeXmlUserGroupFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Definition at line 23 of file NativeXmlUserGroupFilter.inc.php.

References Filter\setDisplayName().


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