Path

ez components / documentation / api reference / 2008.1beta1 / feed

eZ Components 2008.1beta1

Feed: ezcFeedCreativeCommonsModule

[ Tutorial ] [ Specifications ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcFeedCreativeCommonsModule

Support for the CreativeCommons module: data container, generator, parser. [source]
Specifications: http://backend.userland.com/creativeCommonsRssModule.
Create example: 
1.  // $feed is an ezcFeed object
2.   $item = $feed->add( 'item' );
3.  $module = $item->addModule( 'CreativeCommons' );
4.  $module->license = 'text content';
Parse example: 
1.  // $item is an ezcFeedEntryElement object
2.   $text = $item->CreativeCommons->license;

Parents

ezcFeedModule
   |
   --ezcFeedCreativeCommonsModule

Properties

ezcFeedElement read/write  $license
An URL to a license description. Can appear at both feed-level and item-level. A list of possible licenses are found here http://creativecommons.org/licenses/, but other licenses can be used as well.

Inherited Member Variables

From ezcFeedModule:
protected  ezcFeedModule::$level
protected  ezcFeedModule::$properties

Method Summary

public ezcFeedCreativeCommonsModule __construct( [$level = 'feed'] )
Constructs a new ezcFeedCreativeCommonsModule object.
public ezcFeedElement add( $name )
Adds a new ezcFeedElement element with name $name to this module and returns it.
public void generate( $xml, $root )
Adds the module elements to the $xml XML document, in the container $root.
public static string getModuleName( )
Returns the module name ('CreativeCommons').
public static string getNamespace( )
Returns the namespace for this module ('http://backend.userland.com/creativeCommonsRssModule').
public static string getNamespacePrefix( )
Returns the namespace prefix for this module ('creativeCommons').
public bool isElementAllowed( $name )
Returns true if the element $name is allowed in the current module at the current level (feed or item), and false otherwise.
public void parse( $name, $node )
Parses the XML element $node and creates a feed element in the current module with name $name.

Inherited Methods

From ezcFeedModule :
public ezcFeedModule ezcFeedModule::__construct()
Constructs a new ezcFeedModule object.
public abstract ezcFeedElement ezcFeedModule::add()
Adds a new ezcFeedElement element with name $name to this module and returns it.
public static ezcFeedModule ezcFeedModule::create()
Returns a new instance of the $name module with data container level $level.
public abstract void ezcFeedModule::generate()
Adds the module elements to the $xml XML document, in the container $root.
public abstract bool ezcFeedModule::isElementAllowed()
Returns true if the element $name is allowed in the current module at the current level (feed or item), and false otherwise.
public abstract void ezcFeedModule::parse()
Parses the XML element $node and creates a feed element in the current module with name $name.

Methods

__construct

ezcFeedCreativeCommonsModule __construct( [string $level = 'feed'] )
Constructs a new ezcFeedCreativeCommonsModule object.

Parameters

Name Type Description
$level string The level of the data container ('feed' or 'item')

Redefinition of

Method Description
ezcFeedModule::__construct() Constructs a new ezcFeedModule object.

add

ezcFeedElement add( string $name )
Adds a new ezcFeedElement element with name $name to this module and returns it.

Parameters

Name Type Description
$name string The element name

Throws

ClassDescription
ezcFeedUnsupportedElementException if trying to add an element which is not supported.

Redefinition of

Method Description
ezcFeedModule::add() Adds a new ezcFeedElement element with name $name to this module and returns it.

generate

void generate( $xml, $root )
Adds the module elements to the $xml XML document, in the container $root.

Parameters

Name Type Description
$xml DOMDocument The XML document in which to add the module elements
$root DOMNode The parent node which will contain the module elements

Redefinition of

Method Description
ezcFeedModule::generate() Adds the module elements to the $xml XML document, in the container $root.

getModuleName

string getModuleName( )
Returns the module name ('CreativeCommons').

getNamespace

string getNamespace( )
Returns the namespace for this module ('http://backend.userland.com/creativeCommonsRssModule').

getNamespacePrefix

string getNamespacePrefix( )
Returns the namespace prefix for this module ('creativeCommons').

isElementAllowed

bool isElementAllowed( string $name )
Returns true if the element $name is allowed in the current module at the current level (feed or item), and false otherwise.

Parameters

Name Type Description
$name string The element name to check if allowed in the current module and level (feed or item)

Redefinition of

Method Description
ezcFeedModule::isElementAllowed() Returns true if the element $name is allowed in the current module at the current level (feed or item), and false otherwise.

parse

void parse( string $name, $node )
Parses the XML element $node and creates a feed element in the current module with name $name.

Parameters

Name Type Description
$name string The name of the element belonging to the module
$node DOMElement The XML child from which to take the values for $name

Redefinition of

Method Description
ezcFeedModule::parse() Parses the XML element $node and creates a feed element in the current module with name $name.

Last updated: Tue, 27 May 2008