id; } /** * Get the [first_name] column value. * First Name * @return string */ public function getFirstName() { return $this->first_name; } /** * Get the [last_name] column value. * Last Name * @return string */ public function getLastName() { return $this->last_name; } /** * Get the [email] column value. * E-Mail Address * @return string */ public function getEmail() { return $this->email; } /** * Get the [age] column value. * The authors age * @return int */ public function getAge() { return $this->age; } /** * Set the value of [id] column. * Author Id * @param int $v new value * @return void */ public function setId($v) { if ($this->id !== $v) { $this->id = $v; $this->modifiedColumns[] = AuthorPeer::ID; } } // setId() /** * Set the value of [first_name] column. * First Name * @param string $v new value * @return void */ public function setFirstName($v) { if ($this->first_name !== $v) { $this->first_name = $v; $this->modifiedColumns[] = AuthorPeer::FIRST_NAME; } } // setFirstName() /** * Set the value of [last_name] column. * Last Name * @param string $v new value * @return void */ public function setLastName($v) { if ($this->last_name !== $v) { $this->last_name = $v; $this->modifiedColumns[] = AuthorPeer::LAST_NAME; } } // setLastName() /** * Set the value of [email] column. * E-Mail Address * @param string $v new value * @return void */ public function setEmail($v) { if ($this->email !== $v) { $this->email = $v; $this->modifiedColumns[] = AuthorPeer::EMAIL; } } // setEmail() /** * Set the value of [age] column. * The authors age * @param int $v new value * @return void */ public function setAge($v) { if ($this->age !== $v) { $this->age = $v; $this->modifiedColumns[] = AuthorPeer::AGE; } } // setAge() /** * 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->first_name = $rs->getString($startcol + 1); $this->last_name = $rs->getString($startcol + 2); $this->email = $rs->getString($startcol + 3); $this->age = $rs->getInt($startcol + 4); $this->resetModified(); $this->setNew(false); // FIXME - using NUM_COLUMNS may be clearer. return $startcol + 5; // 5 = AuthorPeer::NUM_COLUMNS - AuthorPeer::NUM_LAZY_LOAD_COLUMNS). } catch (Exception $e) { throw new PropelException("Error populating Author 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(AuthorPeer::DATABASE_NAME); } try { $con->begin(); AuthorPeer::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->isDeleted()) { throw new PropelException("You cannot save an object that has been deleted."); } if ($con === null) { $con = Propel::getConnection(AuthorPeer::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; // If this object has been modified, then save it to the database. if ($this->isModified()) { if ($this->isNew()) { $pk = AuthorPeer::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 += AuthorPeer::doUpdate($this, $con); } $this->resetModified(); // [HL] After being saved an object is no longer 'modified' } if ($this->collBooks !== null) { foreach($this->collBooks as $referrerFK) { if (!$referrerFK->isDeleted()) { $affectedRows += $referrerFK->save($con); } } } $this->alreadyInSave = false; } return $affectedRows; } // doSave() /** * 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 mixed true if all columns pass validation * or an array of ValidationFailed objects for columns that fail. * @see doValidate() */ public function validate($columns = null) { if ($columns) { return AuthorPeer::doValidate($this, $columns); } return $this->doValidate(); } /** * 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 true is returned; otherwise * an aggreagated array of ValidationFailed objects will be returned. * * @return mixed true if all validations pass; array of ValidationFailed objets otherwise. */ protected function doValidate() { if (!$this->alreadyInValidation) { $this->alreadyInValidation = true; $retval = null; $failureMap = array(); if (($retval = AuthorPeer::doValidate($this)) !== true) { $failureMap = array_merge($failureMap, $retval); } if ($this->collBooks !== null) { foreach($this->collBooks as $referrerFK) { if (($retval = $referrerFK->validate()) !== 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) { $names = AuthorPeer::getFieldNames($type); $pos = AuthorPeer::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->getFirstName(); break; case 2: return $this->getLastName(); break; case 3: return $this->getEmail(); break; case 4: return $this->getAge(); 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 = AuthorPeer::getFieldNames($keyType); $result = array( $keys[0] => $this->getId(), $keys[1] => $this->getFirstName(), $keys[2] => $this->getLastName(), $keys[3] => $this->getEmail(), $keys[4] => $this->getAge(), ); 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) { $names = AuthorPeer::getFieldNames($type); $pos = array_search($name, $names); 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->setFirstName($value); break; case 2: $this->setLastName($value); break; case 3: $this->setEmail($value); break; case 4: $this->setAge($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 = AuthorPeer::getFieldNames($keyType); if (array_key_exists($keys[0], $arr)) $this->setId($arr[$keys[0]]); if (array_key_exists($keys[1], $arr)) $this->setFirstName($arr[$keys[1]]); if (array_key_exists($keys[2], $arr)) $this->setLastName($arr[$keys[2]]); if (array_key_exists($keys[3], $arr)) $this->setEmail($arr[$keys[3]]); if (array_key_exists($keys[4], $arr)) $this->setAge($arr[$keys[4]]); } /** * 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(AuthorPeer::DATABASE_NAME); if ($this->isColumnModified(AuthorPeer::ID)) $criteria->add(AuthorPeer::ID, $this->id); if ($this->isColumnModified(AuthorPeer::FIRST_NAME)) $criteria->add(AuthorPeer::FIRST_NAME, $this->first_name); if ($this->isColumnModified(AuthorPeer::LAST_NAME)) $criteria->add(AuthorPeer::LAST_NAME, $this->last_name); if ($this->isColumnModified(AuthorPeer::EMAIL)) $criteria->add(AuthorPeer::EMAIL, $this->email); if ($this->isColumnModified(AuthorPeer::AGE)) $criteria->add(AuthorPeer::AGE, $this->age); 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(AuthorPeer::DATABASE_NAME); $criteria->add(AuthorPeer::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 Author (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->setFirstName($this->first_name); $copyObj->setLastName($this->last_name); $copyObj->setEmail($this->email); $copyObj->setAge($this->age); if ($deepCopy) { // important: temporarily setNew(false) because this affects the behavior of // the getter/setter methods for fkey referrer objects. $copyObj->setNew(false); foreach($this->getBooks() as $relObj) { $copyObj->addBook($relObj->copy()); } } // if ($deepCopy) $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 Author 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 AuthorPeer */ public function getPeer() { if (self::$peer === null) { self::$peer = new AuthorPeer(); } return self::$peer; } /** * Temporary storage of collBooks to save a possible db hit in * the event objects are add to the collection, but the * complete collection is never requested. * @return void */ public function initBooks() { if ($this->collBooks === null) { $this->collBooks = array(); } } /** * If this collection has already been initialized with * an identical criteria, it returns the collection. * Otherwise if this Author has previously * been saved, it will retrieve related Books from storage. * If this Author is new, it will return * an empty collection or the current collection, the criteria * is ignored on a new object. * * @param Connection $con * @param Criteria $criteria * @throws PropelException */ public function getBooks($criteria = null, $con = null) { // include the Peer class include_once 'bookstore/om/BaseBookPeer.php'; if ($criteria === null) { $criteria = new Criteria(); } elseif ($criteria instanceof Criteria) { $criteria = clone $criteria; } if ($this->collBooks === null) { if ($this->isNew()) { $this->collBooks = array(); } else { $criteria->add(BookPeer::AUTHOR_ID, $this->getId()); BookPeer::addSelectColumns($criteria); $this->collBooks = BookPeer::doSelect($criteria, $con); } } else { // criteria has no effect for a new object if (!$this->isNew()) { // the following code is to determine if a new query is // called for. If the criteria is the same as the last // one, just return the collection. $criteria->add(BookPeer::AUTHOR_ID, $this->getId()); BookPeer::addSelectColumns($criteria); if (!isset($this->lastBookCriteria) || !$this->lastBookCriteria->equals($criteria)) { $this->collBooks = BookPeer::doSelect($criteria, $con); } } } $this->lastBookCriteria = $criteria; return $this->collBooks; } /** * Returns the number of related Books. * * @param Criteria $criteria * @param Connection $con * @throws PropelException */ public function countBooks($criteria = null, $con = null) { // include the Peer class include_once 'bookstore/om/BaseBookPeer.php'; if ($criteria === null) { $criteria = new Criteria(); } elseif ($criteria instanceof Criteria) { $criteria = clone $criteria; } $criteria->add(BookPeer::AUTHOR_ID, $this->getId()); return BookPeer::doCount($criteria, $con); } /** * Method called to associate a Book object to this object * through the Book foreign key attribute * * @param Book $l Book * @return void * @throws PropelException */ public function addBook(Book $l) { $this->collBooks[] = $l; $l->setAuthor($this); } /** * If this collection has already been initialized with * an identical criteria, it returns the collection. * Otherwise if this Author is new, it will return * an empty collection; or if this Author has previously * been saved, it will retrieve related Books from storage. * * This method is protected by default in order to keep the public * api reasonable. You can provide public methods for those you * actually need in Author. */ public function getBooksJoinPublisher($criteria = null, $con = null) { // include the Peer class include_once 'bookstore/om/BaseBookPeer.php'; if ($criteria === null) { $criteria = new Criteria(); } elseif ($criteria instanceof Criteria) { $criteria = clone $criteria; } if ($this->collBooks === null) { if ($this->isNew()) { $this->collBooks = array(); } else { $criteria->add(BookPeer::AUTHOR_ID, $this->getId()); $this->collBooks = BookPeer::doSelectJoinPublisher($criteria, $con); } } else { // the following code is to determine if a new query is // called for. If the criteria is the same as the last // one, just return the collection. $criteria->add(BookPeer::AUTHOR_ID, $this->getId()); if (!isset($this->lastBookCriteria) || !$this->lastBookCriteria->equals($criteria)) { $this->collBooks = BookPeer::doSelectJoinPublisher($criteria, $con); } } $this->lastBookCriteria = $criteria; return $this->collBooks; } } // BaseAuthor