Blame | Letzte Änderung | Log anzeigen | RSS feed
<?php/*** Base static class for performing query and update operations on the 'category' table.**** This class was autogenerated by Propel 1.4.2 on:** Fri Aug 5 09:39:36 2011** @package lib.model.om*/abstract class BaseCategoryPeer {/** the default database name for this class */const DATABASE_NAME = 'propel';/** the table name for this class */const TABLE_NAME = 'category';/** the related Propel class for this table */const OM_CLASS = 'Category';/** A class that can be returned by this peer. */const CLASS_DEFAULT = 'lib.model.Category';/** the related TableMap class for this table */const TM_CLASS = 'CategoryTableMap';/** The total number of columns. */const NUM_COLUMNS = 2;/** The number of lazy-loaded columns. */const NUM_LAZY_LOAD_COLUMNS = 0;/** the column name for the ID field */const ID = 'category.ID';/** the column name for the NAME field */const NAME = 'category.NAME';/*** An identiy map to hold any loaded instances of Category objects.* This must be public so that other peer classes can access this when hydrating from JOIN* queries.* @var array Category[]*/public static $instances = array();// symfony behavior/*** Indicates whether the current model includes I18N.*/const IS_I18N = false;/*** holds an array of fieldnames** first dimension keys are the type constants* e.g. self::$fieldNames[self::TYPE_PHPNAME][0] = 'Id'*/private static $fieldNames = array (BasePeer::TYPE_PHPNAME => array ('Id', 'Name', ),BasePeer::TYPE_STUDLYPHPNAME => array ('id', 'name', ),BasePeer::TYPE_COLNAME => array (self::ID, self::NAME, ),BasePeer::TYPE_FIELDNAME => array ('id', 'name', ),BasePeer::TYPE_NUM => array (0, 1, ));/*** holds an array of keys for quick access to the fieldnames array** first dimension keys are the type constants* e.g. self::$fieldNames[BasePeer::TYPE_PHPNAME]['Id'] = 0*/private static $fieldKeys = array (BasePeer::TYPE_PHPNAME => array ('Id' => 0, 'Name' => 1, ),BasePeer::TYPE_STUDLYPHPNAME => array ('id' => 0, 'name' => 1, ),BasePeer::TYPE_COLNAME => array (self::ID => 0, self::NAME => 1, ),BasePeer::TYPE_FIELDNAME => array ('id' => 0, 'name' => 1, ),BasePeer::TYPE_NUM => array (0, 1, ));/*** Translates a fieldname to another type** @param string $name field name* @param string $fromType One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM* @param string $toType One of the class type constants* @return string translated name of the field.* @throws PropelException - if the specified name could not be found in the fieldname mappings.*/static public function translateFieldName($name, $fromType, $toType){$toNames = self::getFieldNames($toType);$key = isset(self::$fieldKeys[$fromType][$name]) ? self::$fieldKeys[$fromType][$name] : null;if ($key === null) {throw new PropelException("'$name' could not be found in the field names of type '$fromType'. These are: " . print_r(self::$fieldKeys[$fromType], true));}return $toNames[$key];}/*** Returns an array of field names.** @param string $type The type of fieldnames to return:* One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM* @return array A list of field names*/static public function getFieldNames($type = BasePeer::TYPE_PHPNAME){if (!array_key_exists($type, self::$fieldNames)) {throw new PropelException('Method getFieldNames() expects the parameter $type to be one of the class constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. ' . $type . ' was given.');}return self::$fieldNames[$type];}/*** Convenience method which changes table.column to alias.column.** Using this method you can maintain SQL abstraction while using column aliases.* <code>* $c->addAlias("alias1", TablePeer::TABLE_NAME);* $c->addJoin(TablePeer::alias("alias1", TablePeer::PRIMARY_KEY_COLUMN), TablePeer::PRIMARY_KEY_COLUMN);* </code>* @param string $alias The alias for the current table.* @param string $column The column name for current table. (i.e. CategoryPeer::COLUMN_NAME).* @return string*/public static function alias($alias, $column){return str_replace(CategoryPeer::TABLE_NAME.'.', $alias.'.', $column);}/*** Add all the columns needed to create a new object.** Note: any columns that were marked with lazyLoad="true" in the* XML schema will not be added to the select list and only loaded* on demand.** @param criteria object containing the columns to add.* @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.*/public static function addSelectColumns(Criteria $criteria){$criteria->addSelectColumn(CategoryPeer::ID);$criteria->addSelectColumn(CategoryPeer::NAME);}/*** Returns the number of rows matching criteria.** @param Criteria $criteria* @param boolean $distinct Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.* @param PropelPDO $con* @return int Number of matching rows.*/public static function doCount(Criteria $criteria, $distinct = false, PropelPDO $con = null){// we may modify criteria, so copy it first$criteria = clone $criteria;// We need to set the primary table name, since in the case that there are no WHERE columns// it will be impossible for the BasePeer::createSelectSql() method to determine which// tables go into the FROM clause.$criteria->setPrimaryTableName(CategoryPeer::TABLE_NAME);if ($distinct && !in_array(Criteria::DISTINCT, $criteria->getSelectModifiers())) {$criteria->setDistinct();}if (!$criteria->hasSelectClause()) {CategoryPeer::addSelectColumns($criteria);}$criteria->clearOrderByColumns(); // ORDER BY won't ever affect the count$criteria->setDbName(self::DATABASE_NAME); // Set the correct dbNameif ($con === null) {$con = Propel::getConnection(CategoryPeer::DATABASE_NAME, Propel::CONNECTION_READ);}// symfony_behaviors behaviorforeach (sfMixer::getCallables(self::getMixerPreSelectHook(__FUNCTION__)) as $sf_hook){call_user_func($sf_hook, 'BaseCategoryPeer', $criteria, $con);}// BasePeer returns a PDOStatement$stmt = BasePeer::doCount($criteria, $con);if ($row = $stmt->fetch(PDO::FETCH_NUM)) {$count = (int) $row[0];} else {$count = 0; // no rows returned; we infer that means 0 matches.}$stmt->closeCursor();return $count;}/*** Method to select one object from the DB.** @param Criteria $criteria object used to create the SELECT statement.* @param PropelPDO $con* @return Category* @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.*/public static function doSelectOne(Criteria $criteria, PropelPDO $con = null){$critcopy = clone $criteria;$critcopy->setLimit(1);$objects = CategoryPeer::doSelect($critcopy, $con);if ($objects) {return $objects[0];}return null;}/*** Method to do selects.** @param Criteria $criteria The Criteria object used to build the SELECT statement.* @param PropelPDO $con* @return array Array of selected Objects* @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.*/public static function doSelect(Criteria $criteria, PropelPDO $con = null){return CategoryPeer::populateObjects(CategoryPeer::doSelectStmt($criteria, $con));}/*** Prepares the Criteria object and uses the parent doSelect() method to execute a PDOStatement.** Use this method directly if you want to work with an executed statement durirectly (for example* to perform your own object hydration).** @param Criteria $criteria The Criteria object used to build the SELECT statement.* @param PropelPDO $con The connection to use* @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.* @return PDOStatement The executed PDOStatement object.* @see BasePeer::doSelect()*/public static function doSelectStmt(Criteria $criteria, PropelPDO $con = null){if ($con === null) {$con = Propel::getConnection(CategoryPeer::DATABASE_NAME, Propel::CONNECTION_READ);}if (!$criteria->hasSelectClause()) {$criteria = clone $criteria;CategoryPeer::addSelectColumns($criteria);}// Set the correct dbName$criteria->setDbName(self::DATABASE_NAME);// symfony_behaviors behaviorforeach (sfMixer::getCallables(self::getMixerPreSelectHook(__FUNCTION__)) as $sf_hook){call_user_func($sf_hook, 'BaseCategoryPeer', $criteria, $con);}// BasePeer returns a PDOStatementreturn BasePeer::doSelect($criteria, $con);}/*** Adds an object to the instance pool.** Propel keeps cached copies of objects in an instance pool when they are retrieved* from the database. In some cases -- especially when you override doSelect*()* methods in your stub classes -- you may need to explicitly add objects* to the cache in order to ensure that the same objects are always returned by doSelect*()* and retrieveByPK*() calls.** @param Category $value A Category object.* @param string $key (optional) key to use for instance map (for performance boost if key was already calculated externally).*/public static function addInstanceToPool(Category $obj, $key = null){if (Propel::isInstancePoolingEnabled()) {if ($key === null) {$key = (string) $obj->getId();} // if key === nullself::$instances[$key] = $obj;}}/*** Removes an object from the instance pool.** Propel keeps cached copies of objects in an instance pool when they are retrieved* from the database. In some cases -- especially when you override doDelete* methods in your stub classes -- you may need to explicitly remove objects* from the cache in order to prevent returning objects that no longer exist.** @param mixed $value A Category object or a primary key value.*/public static function removeInstanceFromPool($value){if (Propel::isInstancePoolingEnabled() && $value !== null) {if (is_object($value) && $value instanceof Category) {$key = (string) $value->getId();} elseif (is_scalar($value)) {// assume we've been passed a primary key$key = (string) $value;} else {$e = new PropelException("Invalid value passed to removeInstanceFromPool(). Expected primary key or Category object; got " . (is_object($value) ? get_class($value) . ' object.' : var_export($value,true)));throw $e;}unset(self::$instances[$key]);}} // removeInstanceFromPool()/*** Retrieves a string version of the primary key from the DB resultset row that can be used to uniquely identify a row in this table.** For tables with a single-column primary key, that simple pkey value will be returned. For tables with* a multi-column primary key, a serialize()d version of the primary key will be returned.** @param string $key The key (@see getPrimaryKeyHash()) for this instance.* @return Category Found object or NULL if 1) no instance exists for specified key or 2) instance pooling has been disabled.* @see getPrimaryKeyHash()*/public static function getInstanceFromPool($key){if (Propel::isInstancePoolingEnabled()) {if (isset(self::$instances[$key])) {return self::$instances[$key];}}return null; // just to be explicit}/*** Clear the instance pool.** @return void*/public static function clearInstancePool(){self::$instances = array();}/*** Method to invalidate the instance pool of all tables related to category* by a foreign key with ON DELETE CASCADE*/public static function clearRelatedInstancePool(){}/*** Retrieves a string version of the primary key from the DB resultset row that can be used to uniquely identify a row in this table.** For tables with a single-column primary key, that simple pkey value will be returned. For tables with* a multi-column primary key, a serialize()d version of the primary key will be returned.** @param array $row PropelPDO resultset row.* @param int $startcol The 0-based offset for reading from the resultset row.* @return string A string version of PK or NULL if the components of primary key in result array are all null.*/public static function getPrimaryKeyHashFromRow($row, $startcol = 0){// If the PK cannot be derived from the row, return NULL.if ($row[$startcol] === null) {return null;}return (string) $row[$startcol];}/*** The returned array will contain objects of the default type or* objects that inherit from the default.** @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.*/public static function populateObjects(PDOStatement $stmt){$results = array();// set the class once to avoid overhead in the loop$cls = CategoryPeer::getOMClass(false);// populate the object(s)while ($row = $stmt->fetch(PDO::FETCH_NUM)) {$key = CategoryPeer::getPrimaryKeyHashFromRow($row, 0);if (null !== ($obj = CategoryPeer::getInstanceFromPool($key))) {// We no longer rehydrate the object, since this can cause data loss.// See http://propel.phpdb.org/trac/ticket/509// $obj->hydrate($row, 0, true); // rehydrate$results[] = $obj;} else {$obj = new $cls();$obj->hydrate($row);$results[] = $obj;CategoryPeer::addInstanceToPool($obj, $key);} // if key exists}$stmt->closeCursor();return $results;}/*** Returns the TableMap related to this peer.* This method is not needed for general use but a specific application could have a need.* @return TableMap* @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.*/public static function getTableMap(){return Propel::getDatabaseMap(self::DATABASE_NAME)->getTable(self::TABLE_NAME);}/*** Add a TableMap instance to the database for this peer class.*/public static function buildTableMap(){$dbMap = Propel::getDatabaseMap(BaseCategoryPeer::DATABASE_NAME);if (!$dbMap->hasTable(BaseCategoryPeer::TABLE_NAME)){$dbMap->addTableObject(new CategoryTableMap());}}/*** The class that the Peer will make instances of.** If $withPrefix is true, the returned path* uses a dot-path notation which is tranalted into a path* relative to a location on the PHP include_path.* (e.g. path.to.MyClass -> 'path/to/MyClass.php')** @param boolean Whether or not to return the path wit hthe class name* @return string path.to.ClassName*/public static function getOMClass($withPrefix = true){return $withPrefix ? CategoryPeer::CLASS_DEFAULT : CategoryPeer::OM_CLASS;}/*** Method perform an INSERT on the database, given a Category or Criteria object.** @param mixed $values Criteria or Category object containing data that is used to create the INSERT statement.* @param PropelPDO $con the PropelPDO connection to use* @return mixed The new primary key.* @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.*/public static function doInsert($values, PropelPDO $con = null){// symfony_behaviors behaviorforeach (sfMixer::getCallables('BaseCategoryPeer:doInsert:pre') as $sf_hook){if (false !== $sf_hook_retval = call_user_func($sf_hook, 'BaseCategoryPeer', $values, $con)){return $sf_hook_retval;}}if ($con === null) {$con = Propel::getConnection(CategoryPeer::DATABASE_NAME, Propel::CONNECTION_WRITE);}if ($values instanceof Criteria) {$criteria = clone $values; // rename for clarity} else {$criteria = $values->buildCriteria(); // build Criteria from Category object}if ($criteria->containsKey(CategoryPeer::ID) && $criteria->keyContainsValue(CategoryPeer::ID) ) {throw new PropelException('Cannot insert a value for auto-increment primary key ('.CategoryPeer::ID.')');}// Set the correct dbName$criteria->setDbName(self::DATABASE_NAME);try {// use transaction because $criteria could contain info// for more than one table (I guess, conceivably)$con->beginTransaction();$pk = BasePeer::doInsert($criteria, $con);$con->commit();} catch(PropelException $e) {$con->rollBack();throw $e;}// symfony_behaviors behaviorforeach (sfMixer::getCallables('BaseCategoryPeer:doInsert:post') as $sf_hook){call_user_func($sf_hook, 'BaseCategoryPeer', $values, $con, $pk);}return $pk;}/*** Method perform an UPDATE on the database, given a Category or Criteria object.** @param mixed $values Criteria or Category object containing data that is used to create the UPDATE statement.* @param PropelPDO $con The connection to use (specify PropelPDO connection object to exert more control over transactions).* @return int The number of affected rows (if supported by underlying database driver).* @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.*/public static function doUpdate($values, PropelPDO $con = null){// symfony_behaviors behaviorforeach (sfMixer::getCallables('BaseCategoryPeer:doUpdate:pre') as $sf_hook){if (false !== $sf_hook_retval = call_user_func($sf_hook, 'BaseCategoryPeer', $values, $con)){return $sf_hook_retval;}}if ($con === null) {$con = Propel::getConnection(CategoryPeer::DATABASE_NAME, Propel::CONNECTION_WRITE);}$selectCriteria = new Criteria(self::DATABASE_NAME);if ($values instanceof Criteria) {$criteria = clone $values; // rename for clarity$comparison = $criteria->getComparison(CategoryPeer::ID);$selectCriteria->add(CategoryPeer::ID, $criteria->remove(CategoryPeer::ID), $comparison);} else { // $values is Category object$criteria = $values->buildCriteria(); // gets full criteria$selectCriteria = $values->buildPkeyCriteria(); // gets criteria w/ primary key(s)}// set the correct dbName$criteria->setDbName(self::DATABASE_NAME);$ret = BasePeer::doUpdate($selectCriteria, $criteria, $con);// symfony_behaviors behaviorforeach (sfMixer::getCallables('BaseCategoryPeer:doUpdate:post') as $sf_hook){call_user_func($sf_hook, 'BaseCategoryPeer', $values, $con, $ret);}return $ret;}/*** Method to DELETE all rows from the category table.** @return int The number of affected rows (if supported by underlying database driver).*/public static function doDeleteAll($con = null){if ($con === null) {$con = Propel::getConnection(CategoryPeer::DATABASE_NAME, Propel::CONNECTION_WRITE);}$affectedRows = 0; // initialize var to track total num of affected rowstry {// use transaction because $criteria could contain info// for more than one table or we could emulating ON DELETE CASCADE, etc.$con->beginTransaction();$affectedRows += BasePeer::doDeleteAll(CategoryPeer::TABLE_NAME, $con);// Because this db requires some delete cascade/set null emulation, we have to// clear the cached instance *after* the emulation has happened (since// instances get re-added by the select statement contained therein).CategoryPeer::clearInstancePool();CategoryPeer::clearRelatedInstancePool();$con->commit();return $affectedRows;} catch (PropelException $e) {$con->rollBack();throw $e;}}/*** Method perform a DELETE on the database, given a Category or Criteria object OR a primary key value.** @param mixed $values Criteria or Category object or primary key or array of primary keys* which is used to create the DELETE statement* @param PropelPDO $con the connection to use* @return int The number of affected rows (if supported by underlying database driver). This includes CASCADE-related rows* if supported by native driver or if emulated using Propel.* @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.*/public static function doDelete($values, PropelPDO $con = null){if ($con === null) {$con = Propel::getConnection(CategoryPeer::DATABASE_NAME, Propel::CONNECTION_WRITE);}if ($values instanceof Criteria) {// invalidate the cache for all objects of this type, since we have no// way of knowing (without running a query) what objects should be invalidated// from the cache based on this Criteria.CategoryPeer::clearInstancePool();// rename for clarity$criteria = clone $values;} elseif ($values instanceof Category) { // it's a model object// invalidate the cache for this single objectCategoryPeer::removeInstanceFromPool($values);// create criteria based on pk values$criteria = $values->buildPkeyCriteria();} else { // it's a primary key, or an array of pks$criteria = new Criteria(self::DATABASE_NAME);$criteria->add(CategoryPeer::ID, (array) $values, Criteria::IN);// invalidate the cache for this object(s)foreach ((array) $values as $singleval) {CategoryPeer::removeInstanceFromPool($singleval);}}// Set the correct dbName$criteria->setDbName(self::DATABASE_NAME);$affectedRows = 0; // initialize var to track total num of affected rowstry {// use transaction because $criteria could contain info// for more than one table or we could emulating ON DELETE CASCADE, etc.$con->beginTransaction();$affectedRows += BasePeer::doDelete($criteria, $con);CategoryPeer::clearRelatedInstancePool();$con->commit();return $affectedRows;} catch (PropelException $e) {$con->rollBack();throw $e;}}/*** Validates all modified columns of given Category object.* If parameter $columns is either a single column name or an array of column names* than only those columns are validated.** NOTICE: This does not apply to primary or foreign keys for now.** @param Category $obj The object to validate.* @param mixed $cols Column name or array of column names.** @return mixed TRUE if all columns are valid or the error message of the first invalid column.*/public static function doValidate(Category $obj, $cols = null){$columns = array();if ($cols) {$dbMap = Propel::getDatabaseMap(CategoryPeer::DATABASE_NAME);$tableMap = $dbMap->getTable(CategoryPeer::TABLE_NAME);if (! is_array($cols)) {$cols = array($cols);}foreach ($cols as $colName) {if ($tableMap->containsColumn($colName)) {$get = 'get' . $tableMap->getColumn($colName)->getPhpName();$columns[$colName] = $obj->$get();}}} else {}return BasePeer::doValidate(CategoryPeer::DATABASE_NAME, CategoryPeer::TABLE_NAME, $columns);}/*** Retrieve a single object by pkey.** @param int $pk the primary key.* @param PropelPDO $con the connection to use* @return Category*/public static function retrieveByPK($pk, PropelPDO $con = null){if (null !== ($obj = CategoryPeer::getInstanceFromPool((string) $pk))) {return $obj;}if ($con === null) {$con = Propel::getConnection(CategoryPeer::DATABASE_NAME, Propel::CONNECTION_READ);}$criteria = new Criteria(CategoryPeer::DATABASE_NAME);$criteria->add(CategoryPeer::ID, $pk);$v = CategoryPeer::doSelect($criteria, $con);return !empty($v) > 0 ? $v[0] : null;}/*** Retrieve multiple objects by pkey.** @param array $pks List of primary keys* @param PropelPDO $con the connection to use* @throws PropelException Any exceptions caught during processing will be* rethrown wrapped into a PropelException.*/public static function retrieveByPKs($pks, PropelPDO $con = null){if ($con === null) {$con = Propel::getConnection(CategoryPeer::DATABASE_NAME, Propel::CONNECTION_READ);}$objs = null;if (empty($pks)) {$objs = array();} else {$criteria = new Criteria(CategoryPeer::DATABASE_NAME);$criteria->add(CategoryPeer::ID, $pks, Criteria::IN);$objs = CategoryPeer::doSelect($criteria, $con);}return $objs;}// symfony behavior/*** Returns an array of arrays that contain columns in each unique index.** @return array*/static public function getUniqueColumnNames(){return array(array('name'));}// symfony_behaviors behavior/*** Returns the name of the hook to call from inside the supplied method.** @param string $method The calling method** @return string A hook name for {@link sfMixer}** @throws LogicException If the method name is not recognized*/static private function getMixerPreSelectHook($method){if (preg_match('/^do(Select|Count)(Join(All(Except)?)?|Stmt)?/', $method, $match)){return sprintf('BaseCategoryPeer:%s:%1$s', 'Count' == $match[1] ? 'doCount' : $match[0]);}throw new LogicException(sprintf('Unrecognized function "%s"', $method));}} // BaseCategoryPeer// This is the static code needed to register the TableMap for this table with the main Propel class.//BaseCategoryPeer::buildTableMap();