COBAuthorBlock Class Reference

Defines Author information about the COB. More...

Inheritance diagram for COBAuthorBlock:

Collaboration diagram for COBAuthorBlock:

List of all members.

Public Member Functions
	COBAuthorBlock ($authorName, $authorEmail, $authorURL, $authorComments, $creationTime, $version, $revision)
	Creates a new COBAuthorBlock.
	GetAuthorName ()
	Gets the name of the author.
	GetAuthorEmail ()
	Gets the author's email address.
	GetAuthorURL ()
	Gets the author's web address.
	GetAuthorComments ()
	Gets comments from the author.
	GetCreationTime ()
	Gets the time this COB was created.
	GetVersion ()
	Gets the COB's version number.
	GetRevision ()
	Gets the COB's revision number.
	GetType ()
	Gets the type of this COB block.
	Compile ()
	Compiles this COB Block and returns COB file as a binary string.
Related Functions
(Note that these are not member functions.)
Cob Block Types
enum	COB_BLOCK_AGENT
	Agent Block - 'agnt'. More...
enum	COB_BLOCK_FILE
	File Block - 'file'. More...
enum	COB_BLOCK_AUTHOR
	Author Block - 'auth'. More...

---

Detailed Description

Defines Author information about the COB.

Definition at line 5 of file AuthorBlock.php.

---

Member Function Documentation

COBAuthorBlock::COBAuthorBlock	(	$	authorName,
		$	authorEmail,
		$	authorURL,
		$	authorComments,
		$	creationTime,
		$	version,
		$	revision
	)

Creates a new COBAuthorBlock.

Parameters:

$authorName	the name of the author of this COB
$authorEmail	the author's email address
$authorURL	The author's website address
$authorComments	Any comments the author had about this COB
$creationTime	the time this COB was compiled as a UNIX timestamp
$version	The version number of this COB (integer)
$revision	the COB's revision number (integer)

Definition at line 30 of file AuthorBlock.php.

COBBlock::Compile

(

)

[abstract, inherited]

Compiles this COB Block and returns COB file as a binary string.

Returns:

string

COBAuthorBlock::GetAuthorComments

(

)

Gets comments from the author.

Returns:

string

Definition at line 69 of file AuthorBlock.php.

COBAuthorBlock::GetAuthorEmail

(

)

Gets the author's email address.

Returns:

string

Definition at line 53 of file AuthorBlock.php.

COBAuthorBlock::GetAuthorName

(

)

Gets the name of the author.

Returns:

Author's name

Definition at line 45 of file AuthorBlock.php.

COBAuthorBlock::GetAuthorURL

(

)

Gets the author's web address.

Returns:

string

Definition at line 61 of file AuthorBlock.php.

COBAuthorBlock::GetCreationTime

(

)

Gets the time this COB was created.

Returns:

A UNIX timestamp representing the time this COB was created.

Definition at line 77 of file AuthorBlock.php.

COBAuthorBlock::GetRevision

(

)

Gets the COB's revision number.

The revision number is less significant than the version number.

Returns:

An integer

Definition at line 96 of file AuthorBlock.php.

COBBlock::GetType

(

)

[inherited]

Gets the type of this COB block.

Returns:

string One of the COB_BLOCK_* defines.

Definition at line 37 of file COBBlock.php.

COBAuthorBlock::GetVersion

(

)

Gets the COB's version number.

See also:

GetRevision()

Returns:

An integer

Definition at line 86 of file AuthorBlock.php.

---

Friends And Related Function Documentation

enum COB_BLOCK_AGENT [related, inherited]

Agent Block - 'agnt'.

Definition at line 8 of file COBBlock.php.

enum COB_BLOCK_AUTHOR [related, inherited]

Author Block - 'auth'.

Definition at line 12 of file COBBlock.php.

enum COB_BLOCK_FILE [related, inherited]

File Block - 'file'.

Definition at line 10 of file COBBlock.php.

---

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

• agents/COB/AuthorBlock.php