root/trunk/lib/model/om/BaseSnippetComment.php

<?php

require_once 'propel/om/BaseObject.php';

require_once 'propel/om/Persistent.php';


include_once 'propel/util/Criteria.php';

include_once 'model/SnippetCommentPeer.php';

/**
 * Base class that represents a row from the 'sn_comment' table.
 *
 * 
 *
 * @package model.om
 */
abstract class BaseSnippetComment extends BaseObject  implements Persistent {


    /**
     * The Peer class.
     * Instance provides a convenient way of calling static methods on a class
     * that calling code may not be able to identify.
     * @var SnippetCommentPeer
     */
    protected static $peer;


    /**
     * The value for the id field.
     * @var int
     */
    protected $id;


    /**
     * The value for the user_id field.
     * @var int
     */
    protected $user_id;


    /**
     * The value for the snippet_id field.
     * @var int
     */
    protected $snippet_id;


    /**
     * The value for the body field.
     * @var string
     */
    protected $body;


    /**
     * The value for the html_body field.
     * @var string
     */
    protected $html_body;


    /**
     * The value for the created_at field.
     * @var int
     */
    protected $created_at;

    /**
     * @var SnippetUser
     */
    protected $aSnippetUser;

    /**
     * @var SnippetSnippet
     */
    protected $aSnippetSnippet;

    /**
     * Flag to prevent endless save loop, if this object is referenced
     * by another object which falls in this transaction.
     * @var boolean
     */
    protected $alreadyInSave = false;

    /**
     * Flag to prevent endless validation loop, if this object is referenced
     * by another object which falls in this transaction.
     * @var boolean
     */
    protected $alreadyInValidation = false;

    /**
     * Get the [id] column value.
     * 
     * @return int
     */
    public function getId()
    {

        return $this->id;
    }

    /**
     * Get the [user_id] column value.
     * 
     * @return int
     */
    public function getUserId()
    {

        return $this->user_id;
    }

    /**
     * Get the [snippet_id] column value.
     * 
     * @return int
     */
    public function getSnippetId()
    {

        return $this->snippet_id;
    }

    /**
     * Get the [body] column value.
     * 
     * @return string
     */
    public function getBody()
    {

        return $this->body;
    }

    /**
     * Get the [html_body] column value.
     * 
     * @return string
     */
    public function getHtmlBody()
    {

        return $this->html_body;
    }

    /**
     * Get the [optionally formatted] [created_at] column value.
     * 
     * @param string $format The date/time format string (either date()-style or strftime()-style).
     *                            If format is NULL, then the integer unix timestamp will be returned.
     * @return mixed Formatted date/time value as string or integer unix timestamp (if format is NULL).
     * @throws PropelException - if unable to convert the date/time to timestamp.
     */
    public function getCreatedAt($format = 'Y-m-d H:i:s')
    {

        if ($this->created_at === null || $this->created_at === '') {
            return null;
        } elseif (!is_int($this->created_at)) {
            // a non-timestamp value was set externally, so we convert it
            $ts = strtotime($this->created_at);
            if ($ts === -1 || $ts === false) { // in PHP 5.1 return value changes to FALSE
                throw new PropelException("Unable to parse value of [created_at] as date/time value: " . var_export($this->created_at, true));
            }
        } else {
            $ts = $this->created_at;
        }
        if ($format === null) {
            return $ts;
        } elseif (strpos($format, '%') !== false) {
            return strftime($format, $ts);
        } else {
            return date($format, $ts);
        }
    }

    /**
     * Set the value of [id] column.
     * 
     * @param int $v new value
     * @return void
     */
    public function setId($v)
    {

        if ($this->id !== $v) {
            $this->id = $v;
            $this->modifiedColumns[] = SnippetCommentPeer::ID;
        }

    } // setId()

    /**
     * Set the value of [user_id] column.
     * 
     * @param int $v new value
     * @return void
     */
    public function setUserId($v)
    {

        if ($this->user_id !== $v) {
            $this->user_id = $v;
            $this->modifiedColumns[] = SnippetCommentPeer::USER_ID;
        }

        if ($this->aSnippetUser !== null && $this->aSnippetUser->getId() !== $v) {
            $this->aSnippetUser = null;
        }        

    } // setUserId()

    /**
     * Set the value of [snippet_id] column.
     * 
     * @param int $v new value
     * @return void
     */
    public function setSnippetId($v)
    {

        if ($this->snippet_id !== $v) {
            $this->snippet_id = $v;
            $this->modifiedColumns[] = SnippetCommentPeer::SNIPPET_ID;
        }

        if ($this->aSnippetSnippet !== null && $this->aSnippetSnippet->getId() !== $v) {
            $this->aSnippetSnippet = null;
        }        

    } // setSnippetId()

    /**
     * Set the value of [body] column.
     * 
     * @param string $v new value
     * @return void
     */
    public function setBody($v)
    {

        if ($this->body !== $v) {
            $this->body = $v;
            $this->modifiedColumns[] = SnippetCommentPeer::BODY;
        }

    } // setBody()

    /**
     * Set the value of [html_body] column.
     * 
     * @param string $v new value
     * @return void
     */
    public function setHtmlBody($v)
    {

        if ($this->html_body !== $v) {
            $this->html_body = $v;
            $this->modifiedColumns[] = SnippetCommentPeer::HTML_BODY;
        }

    } // setHtmlBody()

    /**
     * Set the value of [created_at] column.
     * 
     * @param int $v new value
     * @return void
     */
    public function setCreatedAt($v)
    {

        if ($v !== null && !is_int($v)) {
            $ts = strtotime($v);
            if ($ts === -1 || $ts === false) { // in PHP 5.1 return value changes to FALSE
                throw new PropelException("Unable to parse date/time value for [created_at] from input: " . var_export($v, true));
            }
        } else {
            $ts = $v;
        }
        if ($this->created_at !== $ts) {
            $this->created_at = $ts;
            $this->modifiedColumns[] = SnippetCommentPeer::CREATED_AT;
        }

    } // setCreatedAt()

    /**
     * Hydrates (populates) the object variables with values from the database resultset.
     *
     * An offset (1-based "start column") is specified so that objects can be hydrated
     * with a subset of the columns in the resultset rows.  This is needed, for example,
     * for results of JOIN queries where the resultset row includes columns from two or
     * more tables.
     *
     * @param ResultSet $rs The ResultSet class with cursor advanced to desired record pos.
     * @param int $startcol 1-based offset column which indicates which restultset column to start with.
     * @return int next starting column
     * @throws PropelException  - Any caught Exception will be rewrapped as a PropelException.
     */
    public function hydrate(ResultSet $rs, $startcol = 1)
    {
        try {

            $this->id = $rs->getInt($startcol + 0);

            $this->user_id = $rs->getInt($startcol + 1);

            $this->snippet_id = $rs->getInt($startcol + 2);

            $this->body = $rs->getString($startcol + 3);

            $this->html_body = $rs->getString($startcol + 4);

            $this->created_at = $rs->getTimestamp($startcol + 5, null);

            $this->resetModified();

            $this->setNew(false);

            // FIXME - using NUM_COLUMNS may be clearer.
            return $startcol + 6; // 6 = SnippetCommentPeer::NUM_COLUMNS - SnippetCommentPeer::NUM_LAZY_LOAD_COLUMNS).

        } catch (Exception $e) {
            throw new PropelException("Error populating SnippetComment object", $e);
        }
    }

    /**
     * Removes this object from datastore and sets delete attribute.
     *
     * @param Connection $con
     * @return void
     * @throws PropelException
     * @see BaseObject::setDeleted()
     * @see BaseObject::isDeleted()
     */
    public function delete($con = null)
    {
        if ($this->isDeleted()) {
            throw new PropelException("This object has already been deleted.");
        }

        if ($con === null) {
            $con = Propel::getConnection(SnippetCommentPeer::DATABASE_NAME);
        }

        try {
            $con->begin();
            SnippetCommentPeer::doDelete($this, $con);
            $this->setDeleted(true);
            $con->commit();
        } catch (PropelException $e) {
            $con->rollback();
            throw $e;
        }
    }

    /**
     * Stores the object in the database.  If the object is new,
     * it inserts it; otherwise an update is performed.  This method
     * wraps the doSave() worker method in a transaction.
     *
     * @param Connection $con
     * @return int The number of rows affected by this insert/update and any referring fk objects' save() operations.
     * @throws PropelException
     * @see doSave()
     */
    public function save($con = null)
    {
    if ($this->isNew() && !$this->isColumnModified('created_at'))
    {
      $this->setCreatedAt(time());
    }

        if ($this->isDeleted()) {
            throw new PropelException("You cannot save an object that has been deleted.");
        }

        if ($con === null) {
            $con = Propel::getConnection(SnippetCommentPeer::DATABASE_NAME);
        }
        
        try {
            $con->begin();
            $affectedRows = $this->doSave($con);
            $con->commit();
            return $affectedRows;
        } catch (PropelException $e) {
            $con->rollback();
            throw $e;
        }
    }

    /**
     * Stores the object in the database.
     * 
     * If the object is new, it inserts it; otherwise an update is performed.
     * All related objects are also updated in this method.
     *
     * @param Connection $con
     * @return int The number of rows affected by this insert/update and any referring fk objects' save() operations.
     * @throws PropelException
     * @see save()
     */
    protected function doSave($con)
    {
        $affectedRows = 0; // initialize var to track total num of affected rows    
        if (!$this->alreadyInSave) {
            $this->alreadyInSave = true;


            // We call the save method on the following object(s) if they
            // were passed to this object by their coresponding set
            // method.  This object relates to these object(s) by a
            // foreign key reference.

            if ($this->aSnippetUser !== null) {
                if ($this->aSnippetUser->isModified()) {
                    $affectedRows += $this->aSnippetUser->save($con);
                }
                $this->setSnippetUser($this->aSnippetUser);
            }

            if ($this->aSnippetSnippet !== null) {
                if ($this->aSnippetSnippet->isModified()) {
                    $affectedRows += $this->aSnippetSnippet->save($con);
                }
                $this->setSnippetSnippet($this->aSnippetSnippet);
            }
    

            // If this object has been modified, then save it to the database.
            if ($this->isModified()) {
                if ($this->isNew()) {
                    $pk = SnippetCommentPeer::doInsert($this, $con);
                    $affectedRows += 1; // we are assuming that there is only 1 row per doInsert() which 
                                         // should always be true here (even though technically 
                                         // BasePeer::doInsert() can insert multiple rows).

                    $this->setId($pk);  //[IMV] update autoincrement primary key

                    $this->setNew(false);
                } else {
                    $affectedRows += SnippetCommentPeer::doUpdate($this, $con);
                }
                $this->resetModified(); // [HL] After being saved an object is no longer 'modified'
            }

            $this->alreadyInSave = false;
        }
        return $affectedRows;
    } // doSave()

    /**
     * Array of ValidationFailed objects.
     * @var array ValidationFailed[]
     */
    protected $validationFailures = array();

    /**
     * Gets any ValidationFailed objects that resulted from last call to validate().
     *
     *
     * @return array ValidationFailed[]
     * @see validate()
     */
    public function getValidationFailures()
    {
        return $this->validationFailures;
    }

    /**
     * Validates the objects modified field values and all objects related to this table.
     *
     * If $columns is either a column name or an array of column names
     * only those columns are validated.
     *
     * @param mixed $columns Column name or an array of column names.
     * @return boolean Whether all columns pass validation.
     * @see doValidate()
     * @see getValidationFailures()
     */
    public function validate($columns = null)
    {
        $res = $this->doValidate($columns);
        if ($res === true) {
            $this->validationFailures = array();
            return true;
        } else {
            $this->validationFailures = $res;
            return false;
        }
    }

    /**
     * This function performs the validation work for complex object models.
     *
     * In addition to checking the current object, all related objects will
     * also be validated.  If all pass then <code>true</code> is returned; otherwise
     * an aggreagated array of ValidationFailed objects will be returned.
     *
     * @param array $columns Array of column names to validate.
     * @return mixed <code>true</code> if all validations pass; array of <code>ValidationFailed</code> objets otherwise.
     */
    protected function doValidate($columns = null)
    {
        if (!$this->alreadyInValidation) {
            $this->alreadyInValidation = true;
            $retval = null;

            $failureMap = array();


            // We call the validate method on the following object(s) if they
            // were passed to this object by their coresponding set
            // method.  This object relates to these object(s) by a
            // foreign key reference.

            if ($this->aSnippetUser !== null) {
                if (!$this->aSnippetUser->validate($columns)) {
                    $failureMap = array_merge($failureMap, $this->aSnippetUser->getValidationFailures());
                }
            }

            if ($this->aSnippetSnippet !== null) {
                if (!$this->aSnippetSnippet->validate($columns)) {
                    $failureMap = array_merge($failureMap, $this->aSnippetSnippet->getValidationFailures());
                }
            }


            if (($retval = SnippetCommentPeer::doValidate($this, $columns)) !== true) {
                $failureMap = array_merge($failureMap, $retval);
            }



            $this->alreadyInValidation = false;
        }

        return (!empty($failureMap) ? $failureMap : true);
    }

    /**
     * Retrieves a field from the object by name passed in as a string.
     *
     * @param string $name name
     * @param string $type The type of fieldname the $name is of:
     *                     one of the class type constants TYPE_PHPNAME,
     *                     TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
     * @return mixed Value of field.
     */
    public function getByName($name, $type = BasePeer::TYPE_PHPNAME)
    {
        $pos = SnippetCommentPeer::translateFieldName($name, $type, BasePeer::TYPE_NUM);
        return $this->getByPosition($pos);
    }

    /**
     * Retrieves a field from the object by Position as specified in the xml schema.
     * Zero-based.
     *
     * @param int $pos position in xml schema
     * @return mixed Value of field at $pos
     */
    public function getByPosition($pos)
    {
        switch($pos) {
            case 0:
                return $this->getId();
                break;
            case 1:
                return $this->getUserId();
                break;
            case 2:
                return $this->getSnippetId();
                break;
            case 3:
                return $this->getBody();
                break;
            case 4:
                return $this->getHtmlBody();
                break;
            case 5:
                return $this->getCreatedAt();
                break;
            default:
                return null;
                break;
        } // switch()
    }

    /**
     * Exports the object as an array.
     *
     * You can specify the key type of the array by passing one of the class
     * type constants.
     *
     * @param string $keyType One of the class type constants TYPE_PHPNAME,
     *                        TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
     * @return an associative array containing the field names (as keys) and field values
     */
    public function toArray($keyType = BasePeer::TYPE_PHPNAME)
    {
        $keys = SnippetCommentPeer::getFieldNames($keyType);
        $result = array(
            $keys[0] => $this->getId(),
            $keys[1] => $this->getUserId(),
            $keys[2] => $this->getSnippetId(),
            $keys[3] => $this->getBody(),
            $keys[4] => $this->getHtmlBody(),
            $keys[5] => $this->getCreatedAt(),
        );
        return $result;
    }

    /**
     * Sets a field from the object by name passed in as a string.
     *
     * @param string $name peer name
     * @param mixed $value field value
     * @param string $type The type of fieldname the $name is of:
     *                     one of the class type constants TYPE_PHPNAME,
     *                     TYPE_COLNAME, TYPE_FIELDNAME, TYPE_NUM
     * @return void
     */
    public function setByName($name, $value, $type = BasePeer::TYPE_PHPNAME)
    {
        $pos = SnippetCommentPeer::translateFieldName($name, $type, BasePeer::TYPE_NUM);
        return $this->setByPosition($pos, $value);
    }

    /**
     * Sets a field from the object by Position as specified in the xml schema.
     * Zero-based.
     *
     * @param int $pos position in xml schema
     * @param mixed $value field value
     * @return void
     */
    public function setByPosition($pos, $value)
    {
        switch($pos) {
            case 0:
                $this->setId($value);
                break;
            case 1:
                $this->setUserId($value);
                break;
            case 2:
                $this->setSnippetId($value);
                break;
            case 3:
                $this->setBody($value);
                break;
            case 4:
                $this->setHtmlBody($value);
                break;
            case 5:
                $this->setCreatedAt($value);
                break;
        } // switch()
    }

    /**
     * Populates the object using an array.
     *
     * This is particularly useful when populating an object from one of the
     * request arrays (e.g. $_POST).  This method goes through the column
     * names, checking to see whether a matching key exists in populated
     * array. If so the setByName() method is called for that column.
     *
     * You can specify the key type of the array by additionally passing one
     * of the class type constants TYPE_PHPNAME, TYPE_COLNAME, TYPE_FIELDNAME,
     * TYPE_NUM. The default key type is the column's phpname (e.g. 'authorId')
     *
     * @param array  $arr     An array to populate the object from.
     * @param string $keyType The type of keys the array uses.
     * @return void
     */
    public function fromArray($arr, $keyType = BasePeer::TYPE_PHPNAME)
    {
        $keys = SnippetCommentPeer::getFieldNames($keyType);

        if (array_key_exists($keys[0], $arr)) $this->setId($arr[$keys[0]]);
        if (array_key_exists($keys[1], $arr)) $this->setUserId($arr[$keys[1]]);
        if (array_key_exists($keys[2], $arr)) $this->setSnippetId($arr[$keys[2]]);
        if (array_key_exists($keys[3], $arr)) $this->setBody($arr[$keys[3]]);
        if (array_key_exists($keys[4], $arr)) $this->setHtmlBody($arr[$keys[4]]);
        if (array_key_exists($keys[5], $arr)) $this->setCreatedAt($arr[$keys[5]]);
    }

    /**
     * Build a Criteria object containing the values of all modified columns in this object.
     *
     * @return Criteria The Criteria object containing all modified values.
     */
    public function buildCriteria()
    {
        $criteria = new Criteria(SnippetCommentPeer::DATABASE_NAME);

        if ($this->isColumnModified(SnippetCommentPeer::ID)) $criteria->add(SnippetCommentPeer::ID, $this->id);
        if ($this->isColumnModified(SnippetCommentPeer::USER_ID)) $criteria->add(SnippetCommentPeer::USER_ID, $this->user_id);
        if ($this->isColumnModified(SnippetCommentPeer::SNIPPET_ID)) $criteria->add(SnippetCommentPeer::SNIPPET_ID, $this->snippet_id);
        if ($this->isColumnModified(SnippetCommentPeer::BODY)) $criteria->add(SnippetCommentPeer::BODY, $this->body);
        if ($this->isColumnModified(SnippetCommentPeer::HTML_BODY)) $criteria->add(SnippetCommentPeer::HTML_BODY, $this->html_body);
        if ($this->isColumnModified(SnippetCommentPeer::CREATED_AT)) $criteria->add(SnippetCommentPeer::CREATED_AT, $this->created_at);

        return $criteria;
    }

    /**
     * Builds a Criteria object containing the primary key for this object.
     *
     * Unlike buildCriteria() this method includes the primary key values regardless
     * of whether or not they have been modified.
     *
     * @return Criteria The Criteria object containing value(s) for primary key(s).
     */
    public function buildPkeyCriteria()
    {
        $criteria = new Criteria(SnippetCommentPeer::DATABASE_NAME);

        $criteria->add(SnippetCommentPeer::ID, $this->id);

        return $criteria;
    }

    /**
     * Returns the primary key for this object (row).
     * @return int
     */
    public function getPrimaryKey()
    {
        return $this->getId();
    }

    /**
     * Generic method to set the primary key (id column).
     *
     * @param int $key Primary key.
     * @return void
     */
    public function setPrimaryKey($key)
    {
        $this->setId($key);
    }

    /**
     * Sets contents of passed object to values from current object.
     * 
     * If desired, this method can also make copies of all associated (fkey referrers)
     * objects.
     *
     * @param object $copyObj An object of SnippetComment (or compatible) type.
     * @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
     * @throws PropelException
     */
    public function copyInto($copyObj, $deepCopy = false)
    {

        $copyObj->setUserId($this->user_id);

        $copyObj->setSnippetId($this->snippet_id);

        $copyObj->setBody($this->body);

        $copyObj->setHtmlBody($this->html_body);

        $copyObj->setCreatedAt($this->created_at);


        $copyObj->setNew(true);

        $copyObj->setId(NULL); // this is a pkey column, so set to default value

    }

    /**
     * Makes a copy of this object that will be inserted as a new row in table when saved.
     * It creates a new object filling in the simple attributes, but skipping any primary
     * keys that are defined for the table.
     * 
     * If desired, this method can also make copies of all associated (fkey referrers)
     * objects.
     *
     * @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
     * @return SnippetComment Clone of current object.
     * @throws PropelException
     */
    public function copy($deepCopy = false)
    {
        // we use get_class(), because this might be a subclass
        $clazz = get_class($this);
        $copyObj = new $clazz();
        $this->copyInto($copyObj, $deepCopy);
        return $copyObj;
    }

    /**
     * Returns a peer instance associated with this om.
     *
     * Since Peer classes are not to have any instance attributes, this method returns the
     * same instance for all member of this class. The method could therefore
     * be static, but this would prevent one from overriding the behavior.
     *
     * @return SnippetCommentPeer
     */
    public function getPeer()
    {
        if (self::$peer === null) {
            self::$peer = new SnippetCommentPeer();
        }
        return self::$peer;
    }

    /**
     * Declares an association between this object and a SnippetUser object.
     *
     * @param SnippetUser $v
     * @return void
     * @throws PropelException
     */
    public function setSnippetUser($v)
    {


        if ($v === null) {
            $this->setUserId(NULL);
        } else {
            $this->setUserId($v->getId());
        }


        $this->aSnippetUser = $v;
    }


    /**
     * Get the associated SnippetUser object
     *
     * @param Connection Optional Connection object.
     * @return SnippetUser The associated SnippetUser object.
     * @throws PropelException
     */
    public function getSnippetUser($con = null)
    {
        // include the related Peer class
        include_once 'model/om/BaseSnippetUserPeer.php';

        if ($this->aSnippetUser === null && ($this->user_id !== null)) {

            $this->aSnippetUser = SnippetUserPeer::retrieveByPK($this->user_id, $con);
                    
            /* The following can be used instead of the line above to
               guarantee the related object contains a reference
               to this object, but this level of coupling
               may be undesirable in many circumstances.
               As it can lead to a db query with many results that may
               never be used.
               $obj = SnippetUserPeer::retrieveByPK($this->user_id, $con);
               $obj->addSnippetUsers($this);
             */
        }
        return $this->aSnippetUser;
    }

    /**
     * Declares an association between this object and a SnippetSnippet object.
     *
     * @param SnippetSnippet $v
     * @return void
     * @throws PropelException
     */
    public function setSnippetSnippet($v)
    {


        if ($v === null) {
            $this->setSnippetId(NULL);
        } else {
            $this->setSnippetId($v->getId());
        }


        $this->aSnippetSnippet = $v;
    }


    /**
     * Get the associated SnippetSnippet object
     *
     * @param Connection Optional Connection object.
     * @return SnippetSnippet The associated SnippetSnippet object.
     * @throws PropelException
     */
    public function getSnippetSnippet($con = null)
    {
        // include the related Peer class
        include_once 'model/om/BaseSnippetSnippetPeer.php';

        if ($this->aSnippetSnippet === null && ($this->snippet_id !== null)) {

            $this->aSnippetSnippet = SnippetSnippetPeer::retrieveByPK($this->snippet_id, $con);
                    
            /* The following can be used instead of the line above to
               guarantee the related object contains a reference
               to this object, but this level of coupling
               may be undesirable in many circumstances.
               As it can lead to a db query with many results that may
               never be used.
               $obj = SnippetSnippetPeer::retrieveByPK($this->snippet_id, $con);
               $obj->addSnippetSnippets($this);
             */
        }
        return $this->aSnippetSnippet;
    }

} // BaseSnippetComment