Apache Zeta Components Manual :: File Source for module.php
Source for file module.php
Documentation is available at module.php
* File containing the ezcFeedModule class.
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* @version //autogentag//
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* Container for feed module data.
* Currently implemented by these feed modules:
* - Content ({@link ezcFeedContentModule}) -
* {@link http://purl.org/rss/1.0/modules/content/ Specifications}
* - DublinCore ({@link ezcFeedDublinCoreModule}) -
* {@link http://dublincore.org/documents/dces/ Specifications}
* - iTunes ({@link ezcFeedITunesModule}) -
* {@link http://www.apple.com/itunes/store/podcaststechspecs.html Specifications}
* - Geo ({@link ezcFeedGeoModule}) -
* {@link http://www.w3.org/2003/01/geo/ Specifications}
* - GeoRss ({@link ezcFeedGeoModule}) -
* {@link http://www.georss.org/georss/ Specifications}
* - CreativeCommons ({@link ezcFeedCreativeCommonsModule}) -
* {@link http://backend.userland.com/creativeCommonsRssModule Specifications}
* The child classes must implement these static methods:
* - isElementAllowed() - Returns true if an element can be added to the module.
* - add() - Adds an element to the module.
* - getModuleName() - Returns the module name (eg. 'DublinCore')
* - getNamespace() - Returns the namespace for the module
* (eg. 'http://purl.org/dc/elements/1.1/').
* - getNamespacePrefix() - Returns the namespace prefix for the module (eg. 'dc').
* @version //autogentag//
* The level of the module data container. Possible values are 'feed' or 'item'.
* Holds the properties of this class.
* @var array(string=>mixed)
* Constructs a new ezcFeedModule object.
* @param string $level The level of the data container ('feed' or 'item')
* Sets the property $name to $value.
* @throws ezcBasePropertyNotFoundException
* if the property $name is not defined
* @param string $name The property name
* @param mixed $value The property value
public function __set( $name, $value )
* Returns the value of property $name.
* @throws ezcBasePropertyNotFoundException
* if the property $name is not defined
* @param string $name The property name
public function __get( $name )
* Returns if the property $name is set.
* @param string $name The property name
public function __isset( $name )
* Returns a new instance of the $name module with data container level $level.
* @param string $name The name of the module to create
* @param string $level The level of the data container ('feed' or 'item')
public static function create( $name, $level =
'feed' )
if ( !isset
( $supportedModules[$name] ) )
return new $supportedModules[$name]( $level );
* Adds an attribute to the XML node $node.
* @param DOMDocument $xml The XML document where the node is stored
* @param DOMNode $node The node to add the attribute to
* @param string $attribute The name of the attribute to add
* @param mixed $value The value of the attribute
protected function addAttribute( DOMDocument $xml, DOMNode $node, $attribute, $value )
$attr =
$xml->createAttribute( $attribute );
$val =
$xml->createTextNode( $value );
$attr->appendChild( $val );
$node->appendChild( $attr );
* Returns true if the element $name is allowed in the current module at the
* current level (feed or item), and false otherwise.
* @param string $name The element name to check if allowed in the current module and level (feed or item)
* Adds a new ezcFeedElement element with name $name to this module and
* @throws ezcFeedUnsupportedElementException
* if trying to add an element which is not supported.
* @param string $name The element name
abstract public function add( $name );
* Adds the module elements to the $xml XML document, in the container $root.
* @param DOMDocument $xml The XML document in which to add the module elements
* @param DOMNode $root The parent node which will contain the module elements
abstract public function generate( DOMDocument $xml, DOMNode $root );
* Parses the XML element $node and creates a feed element in the current
* module with name $name.
* @param string $name The name of the element belonging to the module
* @param DOMElement $node The XML child from which to take the values for $name
abstract public function parse( $name, DOMElement $node );