<?php
/**
 * NoteDBO.class.php
 *
 * This file contains the definition for the NoteDBO class.
 *
 * @package DBO
 * @author John Diamond <hide@address.com>
 * @copyright John Diamond <hide@address.com>
 * @license http://www.opensource.org/licenses/gpl-license.php GNU Public License
 */

/**
 * NoteDBO
 *
 * Represent an Account Note
 *
 * @package DBO
 * @author John Diamond <hide@address.com>
 */
class NoteDBO extends DBO {
    /**
     * @var integer Note IB
     */
    var $id;

    /**
     * @var string Date (MySQL DATETIME)
     */
    var $date;

    /**
     * @var string Updated date (MySQL DATETIME)
     */
    var $updated;

    /**
     * @var integer Account ID
     */
    var $accountid;

    /**
     * @var string Solid-State user who authored this note
     */
    var $username;

    /**
     * @var string Note text
     */
    var $text;

    /**
     * Convert to a String
     *
     * @return string Note ID
     */
    function __toString() {
        return $this->getID();
    }

    /**
     * Set Note ID
     *
     * @param integer $id Note ID
     */
    function setID( $id ) {
        $this->id = $id;
    }

    /**
     * Get Note ID
     *
     * @return integer Note ID
     */
    function getID() {
        return $this->id;
    }

    /**
     * Set Date
     *
     * @param string $date Date (MySQL DATETIME)
     */
    function setDate( $date ) {
        $this->date = $date;
    }

    /**
     * Get Date
     *
     * @return string Date (MySQL DATETIME)
     */
    function getDate() {
        return $this->date;
    }

    /**
     * Set Update Date
     *
     * @param string Update date (MySQL DATETIME)
     */
    function setUpdated( $date ) {
        $this->updated = $date;
    }

    /**
     * Get Update Date
     *
     * @return string Update date (MySQL DATETIME)
     */
    function getUpdated() {
        return $this->updated;
    }

    /**
     * Set Account ID
     *
     * @param integer $accountid Account ID
     */
    function setAccountID( $accountid ) {
        $this->accountid = $accountid;
    }

    /**
     * Get Account ID
     *
     * @return integer Account ID
     */
    function getAccountID() {
        return $this->accountid;
    }

    /**
     * Set Username
     *
     * @param string $username Solid-State username
     */
    function setUsername( $username ) {
        $this->username = $username;
    }

    /**
     * Get Username
     *
     * @return string Solid-State username
     */
    function getUsername() {
        return $this->username;
    }

    /**
     * Set Note Text
     *
     * @param string $test Note text
     */
    function setText( $text ) {
        $this->text = $text;
    }

    /**
     * Get Note Text
     *
     * @return string Note text
     */
    function getText() {
        return $this->text;
    }

    /**
     * Load Member Data from Array
     *
     * @param array $data Date to load
     */
    function load( $data ) {
        $this->setID( $data['id'] );
        $this->setDate( $data['date'] );
        $this->setUpdated( $data['date'] );
        $this->setAccountID( $data['accountid'] );
        $this->setUsername( $data['username'] );
        $this->setText( $data['text'] );
    }
}

/**
 * Insert NoteDBO into Database
 *
 * @param NoteDBO &$dbo NoteDBO to add to database
 */
function add_NoteDBO( &$dbo ) {
    $DB = DBConnection::getDBConnection();

    // Build SQL
    $sql = $DB->build_insert_sql( "note",
            array( "date" => DBConnection::format_datetime( time() ),
            "updated" => DBConnection::format_datetime( time() ),
            "accountid" => $dbo->getAccountID(),
            "username" => $dbo->getUsername(),
            "text" => $dbo->getText() ) );

    // Run query
    if( !mysql_query( $sql, $DB->handle() ) ) {
        throw new DBException( mysql_error( $DB->handle() ) );
    }

    // Get auto-increment ID
    $id = mysql_insert_id( $DB->handle() );

    // Validate ID
    if( $id === false ) {
        // DB error
        throw new DBException( "Could not retrieve ID from previous INSERT!" );
    }
    if( $id == 0 ) {
        // No ID?
        throw new DBException( "Previous INSERT did not generate an ID" );
    }

    // Store ID in DBO
    $dbo->setID( $id );
}

/**
 * Update NoteDBO
 *
 * @param NoteDBO &$dbo NoteDBO to update
 */
function update_NoteDBO( &$dbo ) {
    $DB = DBConnection::getDBConnection();

    // Build SQL
    $sql = $DB->build_update_sql( "note",
            "id = " . intval( $dbo->getID() ),
            array( "updated" => DBConnection::format_datetime( time() ),
            "username" => $dbo->getUsername(),
            "text" => $dbo->getText() ) );

    // Run query
    if( !mysql_query( $sql, $DB->handle() ) ) {
        throw new DBException( mysql_error( $DB->handle() ) );
    }
}

/**
 * Delete NoteDBO from Database
 *
 * @param NoteDBO &$dbo NoteDBO to delete
 * @return boolean True on success
 */
function delete_NoteDBO( &$dbo ) {
    $DB = DBConnection::getDBConnection();

    // Build SQL
    $sql = $DB->build_delete_sql( "note",
            "id = " . intval( $dbo->getID() ) );

    // Run query
    if( !mysql_query( $sql, $DB->handle() ) ) {
        throw new DBException( mysql_error( $DB->handle() ) );
    }
}

/**
 * Load NoteDBO from Database
 *
 * @param integer $id Note ID
 * @return NoteDBO Note, or null if not found
 */
function load_NoteDBO( $id ) {
    $DB = DBConnection::getDBConnection();

    // Build query
    $sql = $DB->build_select_sql( "note",
            "*",
            "id = " . intval( $id ),
            null,
            null,
            null,
            null );
    // Run query
    if( !($result = @mysql_query( $sql, $DB->handle() ) ) ) {
        // Query error
        throw new DBException( mysql_error( $DB->handle() ) );
    }

    if( mysql_num_rows( $result ) == 0 ) {
        // No rows found
        throw new DBNoRowsFoundException();
    }

    // Load a new NoteDBO
    $dbo = new NoteDBO();
    $data = mysql_fetch_array( $result );
    $dbo->load( $data );

    // Return the new AccountDBO
    return $dbo;
}

/**
 * Load multiple NoteDBO's from database
 *
 * @param string $filter A WHERE clause
 * @param string $sortby Field name to sort results by
 * @param string $sortdir Direction to sort in (ASEC or DESC)
 * @param int $limit Limit the number of results
 * @param int $start Record number to start the results at
 * @return array Array of NoteDBO's
 */
function &load_array_NoteDBO( $filter = null,
        $sortby = null,
        $sortdir = null,
        $limit = null,
        $start = null ) {
    $DB = DBConnection::getDBConnection();

    // Build query
    $sql = $DB->build_select_sql( "note",
            "*",
            $filter,
            $sortby,
            $sortdir,
            $limit,
            $start );

    // Run query
    if( !( $result = @mysql_query( $sql, $DB->handle() ) ) ) {
        // Query error
        throw new DBException( mysql_error( $DB->handle() ) );
    }

    if( mysql_num_rows( $result ) == 0 ) {
        // No rows found
        throw new DBNoRowsFoundException();
    }

    // Build an array of DBOs from the result set
    $dbo_array = array();
    while( $data = mysql_fetch_array( $result ) ) {
        // Create and initialize a new DBO with the data from the DB
        $dbo = new NoteDBO();
        $dbo->load( $data );

        // Add DomainServiceDBO to array
        $dbo_array[] = $dbo;
    }

    return $dbo_array;
}

/**
 * Count NoteDBO's
 *
 * Same as load_array_NoteDBO, except this function just COUNTs the
 * number of rows in the database.
 *
 * @param string $filter A WHERE clause
 * @param string $sortby Field name to sort results by
 * @param string $sortdir Direction to sort in (ASEC or DESC)
 * @param int $limit Limit the number of results
 * @param int $start Record number to start the results at
 * @return integer Number of Note records
 */
function count_all_NoteDBO( $filter = null ) {
    $DB = DBConnection::getDBConnection();

    // Build query
    $sql = $DB->build_select_sql( "note",
            "COUNT(*)",
            $filter,
            null,
            null,
            null,
            null );

    // Run query
    if( !( $result = @mysql_query( $sql, $DB->handle() ) ) ) {
        // SQL error
        throw new DBException( mysql_error( $DB->handle() ) );
    }

    // Make sure the number of rows returned is exactly 1
    if( mysql_num_rows( $result ) != 1 ) {
        // This must return 1 row
        throw new DBException( "Expected exactly one row from count query" );
    }

    $data = mysql_fetch_array( $result );
    return $data[0];
}


?>