COBAuthorBlock

Complexity

Total Complexity

10

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	COBAuthorBlock()	0	10	1
A	Compile()	0	4	1
A	GetAuthorName()	0	3	1
A	GetAuthorEmail()	0	3	1
A	GetAuthorURL()	0	3	1
A	GetAuthorComments()	0	3	1
A	GetCreationTime()	0	3	1
A	GetVersion()	0	3	1
A	GetRevision()	0	3	1
A	CreateFromReader()	0	14	1

<?php
require_once(dirname(__FILE__).'/COBBlock.php');

/// @brief Defines Author information about the COB
class COBAuthorBlock extends COBBlock {

    /// @cond INTERNAL_DOCS
    
    private $creationTime;
    private $version;
    private $revision;
    private $authorName;
    private $authorEmail;
    private $authorURL;
    private $authorComments;

    /// @endcond

    /// @brief Creates a new COBAuthorBlock

    /**
     * @param $authorName the name of the author of this COB
     * @param $authorEmail the author's email address
     * @param $authorURL The author's website address
     * @param $authorComments Any comments the author had about this COB
     * @param $creationTime the time this COB was compiled as a UNIX timestamp
     * @param $version The version number of this COB (integer)
     * @param $revision the COB's revision number (integer)
     */
    public function COBAuthorBlock($authorName, $authorEmail, $authorURL, $authorComments, $creationTime, $version, $revision) {
        parent::COBBlock(COB_BLOCK_AUTHOR);

It seems like you call parent on a different method (COBBlock() instead of COBAuthorBlock()). Are you sure this is correct? If so, you might want to change this to $this->COBBlock().

        $this->authorName = $authorName;
        $this->authorEmail = $authorEmail;
        $this->authorURL = $authorURL;
        $this->authorComments = $authorComments;
        $this->creationTime = $creationTime;
        $this->version = $version;
        $this->revision = $revision;
    }

    /// @brief Supposedly compiles the block into binary. Throws an error to say it's not implemented.
    /** @return string
     */
    public function Compile() {
        // TODO: implement
        throw new Exception("COBAgentBlock::Compile not implemented");
    }

    /// @brief Gets the name of the author
    /**
     *  @return Author's name

The doc-type Author's could not be parsed: Unknown type name "Author's" at position 0. (view supported doc-types)

     */
    public function GetAuthorName() {
        return $this->authorName;
    }

    /// @brief Gets the author's email address
    /**
     *  @return string
     */
    public function GetAuthorEmail() {
        return $this->authorEmail;
    }

    /// @brief Gets the author's web address
    /**
     * @return string
     */
    public function GetAuthorURL() {
        return $this->authorURL;
    }

    /// @brief Gets comments from the author
    /**
     * @return string
     */
    public function GetAuthorComments() {
        return $this->authorComments;
    }

    /// @brief Gets the time this COB was created
    /**
     *  @return A UNIX timestamp representing the time this COB was created.
     */
    public function GetCreationTime() {
        return $this->creationTime;
    }

    /// @brief Gets the COB's version number
    /**
     * @see GetRevision()
     * @return An integer
     */
    public function GetVersion() {
        return $this->version;
    }

    /// @brief Gets the COB's revision number
    /**
     * The revision number is less significant than the version 
     * number.
     * @return An integer
     */
    public function GetRevision() {
        return $this->revision;
    }

    /// @cond INTERNAL_DOCS

    /// @brief Creates the COBAuthorBlock from an IReader.
    /**
     * @param $reader The IReader, currently at the position of the author block  
     * @return COBAuthorBlock
     */
    public static function CreateFromReader(IReader $reader) {
        $creationDay = $reader->ReadInt(1);
        $creationMonth = $reader->ReadInt(1);
        $creationYear = $reader->ReadInt(2);
        $timestamp = mktime(0, 0, 0, $creationMonth, $creationDay, $creationYear);

$timestamp is not used, you could remove the assignment.

        $version = $reader->ReadInt(1);

$version is not used, you could remove the assignment.

        $revision = $reader->ReadInt(1);

$revision is not used, you could remove the assignment.

        $authorName = $reader->ReadCString();

$authorName is not used, you could remove the assignment.

        $authorEmail = $reader->ReadCString();

$authorEmail is not used, you could remove the assignment.

        $authorURL = $reader->ReadCString();

$authorURL is not used, you could remove the assignment.

        $authorComments = $reader->ReadCString();

$authorComments is not used, you could remove the assignment.

		
        return $readerData;

The variable $readerData does not exist. Did you mean $reader?

    }
    /// @endcond
}
?>

It is not recommended to use PHP's closing tag ?> in files other than templates.