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

  //include_once( "kernel/classes/datatypes/ezauthor/ezauthor.php" );

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

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

Definition at line 50 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 81 of file ezauthor.php.

Referenced by decodeXML().

eZAuthor::attribute

(

$

name

)

Definition at line 128 of file ezauthor.php.

eZAuthor::attributes

(

)

Definition at line 115 of file ezauthor.php.

Referenced by hasAttribute().

eZAuthor::decodeXML

(

$

xmlString

)

Will decode an xml string and initialize the eZ author object

Definition at line 179 of file ezauthor.php.

eZAuthor::eZAuthor

(

)

Definition at line 52 of file ezauthor.php.

eZAuthor::hasAttribute

(

$

name

)

Definition at line 123 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 166 of file ezauthor.php.

eZAuthor::name

(

)

Returns the name of the author set.

Definition at line 69 of file ezauthor.php.

eZAuthor::removeAuthors

(

$

removeList

)

Remove authors.

Parameters:

array

$removeList

List of id's of authors to remove

Definition at line 99 of file ezauthor.php.

eZAuthor::setName

(

$

name

)

Sets the name of the author set.

Definition at line 61 of file ezauthor.php.

eZAuthor::xmlString

(

)

Will return the XML string for this author set.

Definition at line 197 of file ezauthor.php.

---

Member Data Documentation

eZAuthor::$AuthorCount [protected]

Contains the author counter value.

Definition at line 228 of file ezauthor.php.

eZAuthor::$Authors [protected]

Contains the Authors.

Definition at line 225 of file ezauthor.php.

eZAuthor::$Name [protected]

Definition at line 231 of file ezauthor.php.

---

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

• ezauthor.php