Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcFeedCreativeCommonsModule

Feed::ezcFeedCreativeCommonsModule

Class ezcFeedCreativeCommonsModule

Support for the CreativeCommons module: data container, generator, parser.

Specifications: http://backend.userland.com/creativeCommonsRssModule.

Create example:

<?php
// $feed is an ezcFeed object
$item = $feed->add( 'item' );
$module = $item->addModule( 'CreativeCommons' );
$module->license = 'text content';
?>

Parse example:

<?php
// $item is an ezcFeedEntryElement object
$text = $item->CreativeCommons->license;
?>

Source for this file: /Feed/src/modules/creativecommons_module.php

ezcFeedModule
   |
   --ezcFeedCreativeCommonsModule

Version:

//autogentag//

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 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 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 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

getModuleName

static string getModuleName( )

Returns the module name ('CreativeCommons').

getNamespace

static string getNamespace( )

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

getNamespacePrefix

static string getNamespacePrefix( )

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

__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

Exceptions:

Type	Description
`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.

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.

Documentation generated by phpDocumentor 1.4.3