eZ Publish  [trunk]
Public Member Functions | Protected Attributes
eZAuthor Class Reference

eZAuthor handles author lists More...

List of all members.

Public Member Functions

 addAuthor ($id, $name, $email)
 Add an author.
 attribute ($name)
 attributes ()
 decodeXML ($xmlString)
 eZAuthor ()
 hasAttribute ($name)
 metaData ()
 name ()
 removeAuthors ($removeList)
 Remove authors.
 setName ($name)
 xmlString ()

Protected Attributes

 $AuthorCount
 Contains the author counter value.
 $Authors
 Contains the Authors.
 $Name

Detailed Description

eZAuthor handles author lists 

  $author = new eZAuthor( "Colour" );
  $author->addValue( "Red" );
  $author->addValue( "Green" );

  // Serialize the class to an XML document
  $xmlString = $author->xmlString();

Definition at line 28 of file ezauthor.php.

Member Function Documentation

eZAuthor::addAuthor ( $  id,
$  name,
$  email 
)

Add an author.

Parameters:
int$id
string$name
string$email

Definition at line 59 of file ezauthor.php.

Referenced by decodeXML().

eZAuthor::attribute ( $  name)

Definition at line 111 of file ezauthor.php.

eZAuthor::attributes ( )

Definition at line 98 of file ezauthor.php.

Referenced by hasAttribute().

eZAuthor::decodeXML ( $  xmlString)

Will decode an xml string and initialize the eZ author object

Definition at line 162 of file ezauthor.php.

eZAuthor::eZAuthor ( )

Definition at line 30 of file ezauthor.php.

eZAuthor::hasAttribute ( $  name)

Definition at line 106 of file ezauthor.php.

eZAuthor::metaData ( )
Returns:
a string which contains all the interesting meta data.

The result of this method can passed to the search engine or other parts which work on meta data.

The string will contain all the authors with their name and email.

Example: 

     'John Doe john@doe.com'

Definition at line 149 of file ezauthor.php.

eZAuthor::name ( )

Returns the name of the author set.

Definition at line 47 of file ezauthor.php.

eZAuthor::removeAuthors ( $  removeList)

Remove authors.

Parameters:
array$removeListList of id's of authors to remove

Definition at line 82 of file ezauthor.php.

eZAuthor::setName ( $  name)

Sets the name of the author set.

Definition at line 39 of file ezauthor.php.

eZAuthor::xmlString ( )

Will return the XML string for this author set.

Definition at line 180 of file ezauthor.php.

Member Data Documentation

eZAuthor::$AuthorCount [protected]

Contains the author counter value.

Definition at line 211 of file ezauthor.php.

eZAuthor::$Authors [protected]

Contains the Authors.

Definition at line 208 of file ezauthor.php.

eZAuthor::$Name [protected]

Definition at line 214 of file ezauthor.php.

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