Inheritance diagram for BaseDocumentPeer:

Static Public Member Functions
static	translateFieldName ($name, $fromType, $toType)

static	getFieldNames ($type=BasePeer::TYPE_PHPNAME)

static	alias ($alias, $column)

static	addSelectColumns (Criteria $criteria, $alias=null)

static	doCount (Criteria $criteria, $distinct=false, PropelPDO $con=null)

static	doSelectOne (Criteria $criteria, PropelPDO $con=null)

static	doSelect (Criteria $criteria, PropelPDO $con=null)

static	doSelectStmt (Criteria $criteria, PropelPDO $con=null)

static	addInstanceToPool ($obj, $key=null)

static	removeInstanceFromPool ($value)

static	getInstanceFromPool ($key)

static	clearInstancePool ($and_clear_all_references=false)

static	clearRelatedInstancePool ()

static	getPrimaryKeyHashFromRow ($row, $startcol=0)

static	getPrimaryKeyFromRow ($row, $startcol=0)

static	populateObjects (PDOStatement $stmt)

static	populateObject ($row, $startcol=0)

static	doCountJoinLanguage (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinUserRelatedByOwnerId (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinDocumentType (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinDocumentCategory (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinDocumentData (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinUserRelatedByCreatedBy (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinUserRelatedByUpdatedBy (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinLanguage (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinUserRelatedByOwnerId (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinDocumentType (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinDocumentCategory (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinDocumentData (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinUserRelatedByCreatedBy (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinUserRelatedByUpdatedBy (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinAll (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinAll (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinAllExceptLanguage (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinAllExceptUserRelatedByOwnerId (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinAllExceptDocumentType (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinAllExceptDocumentCategory (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinAllExceptDocumentData (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinAllExceptUserRelatedByCreatedBy (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doCountJoinAllExceptUserRelatedByUpdatedBy (Criteria $criteria, $distinct=false, PropelPDO $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinAllExceptLanguage (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinAllExceptUserRelatedByOwnerId (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinAllExceptDocumentType (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinAllExceptDocumentCategory (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinAllExceptDocumentData (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinAllExceptUserRelatedByCreatedBy (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	doSelectJoinAllExceptUserRelatedByUpdatedBy (Criteria $criteria, $con=null, $join_behavior=Criteria::LEFT_JOIN)

static	getTableMap ()

static	buildTableMap ()

static	getOMClass ($row=0, $colnum=0)

static	doInsert ($values, PropelPDO $con=null)

static	doUpdate ($values, PropelPDO $con=null)

static	doDeleteAll (PropelPDO $con=null)

static	doValidate ($obj, $cols=null)

static	retrieveByPK ($pk, PropelPDO $con=null)

static	retrieveByPKs ($pks, PropelPDO $con=null)

static	doDelete ($values, PropelPDO $con=null)

static	ignoreRights ($bIgnore=true)

static	isIgnoringRights ()

static	setRightsUser ($oUser=false)

static	getRightsUser ($oUser=false)

static	mayOperateOn ($oUser, $mObject, $sOperation)

static	mayOperateOnOwn ($oUser, $mObject, $sOperation)

Public Attributes
const	DATABASE_NAME = 'rapila'

const	TABLE_NAME = 'documents'

const	OM_CLASS = 'Document'

const	TM_CLASS = 'DocumentTableMap'

const	NUM_COLUMNS = 19

const	NUM_LAZY_LOAD_COLUMNS = 0

const	NUM_HYDRATE_COLUMNS = 19

const	ID = 'documents.id'

const	NAME = 'documents.name'

const	ORIGINAL_NAME = 'documents.original_name'

const	DESCRIPTION = 'documents.description'

const	CONTENT_CREATED_AT = 'documents.content_created_at'

const	LICENSE = 'documents.license'

const	AUTHOR = 'documents.author'

const	LANGUAGE_ID = 'documents.language_id'

const	OWNER_ID = 'documents.owner_id'

const	DOCUMENT_TYPE_ID = 'documents.document_type_id'

const	DOCUMENT_CATEGORY_ID = 'documents.document_category_id'

const	IS_PRIVATE = 'documents.is_private'

const	IS_PROTECTED = 'documents.is_protected'

const	SORT = 'documents.sort'

const	HASH = 'documents.hash'

const	CREATED_AT = 'documents.created_at'

const	UPDATED_AT = 'documents.updated_at'

const	CREATED_BY = 'documents.created_by'

const	UPDATED_BY = 'documents.updated_by'

const	DEFAULT_STRING_FORMAT = 'YAML'

Static Public Attributes
static	$instances = array()

Static Protected Attributes
static	$fieldNames

static	$fieldKeys

Member Function Documentation

static BaseDocumentPeer::addInstanceToPool	(	$obj,
		$key = `null`
	)

static

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.

Parameters

Document	$obj	A Document object.
string	$key	(optional) key to use for instance map (for performance boost if key was already calculated externally).

static BaseDocumentPeer::addSelectColumns	(	Criteria	$criteria,
			$alias = `null`
	)

static

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.

Parameters

Criteria	$criteria	object containing the columns to add.
string	$alias	optional table alias

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::alias	(	$alias,
		$column
	)

static

Convenience method which changes table.column to alias.column.

Using this method you can maintain SQL abstraction while using column aliases. $c->addAlias("alias1", TablePeer::TABLE_NAME); $c->addJoin(TablePeer::alias("alias1", TablePeer::PRIMARY_KEY_COLUMN), TablePeer::PRIMARY_KEY_COLUMN);

Parameters

string	$alias	The alias for the current table.
string	$column	The column name for current table. (i.e. DocumentPeer::COLUMN_NAME).

Returns: string

static BaseDocumentPeer::buildTableMap ( )

static

Add a TableMap instance to the database for this peer class.

static BaseDocumentPeer::clearInstancePool ( $and_clear_all_references = false )

static

Clear the instance pool.

Returns: void

static BaseDocumentPeer::clearRelatedInstancePool ( )

static

Method to invalidate the instance pool of all tables related to documents by a foreign key with ON DELETE CASCADE

static BaseDocumentPeer::doCount	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`
	)

static

Returns the number of rows matching criteria.

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinAll	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining all related tables

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinAllExceptDocumentCategory	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related DocumentCategory table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinAllExceptDocumentData	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related DocumentData table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinAllExceptDocumentType	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related DocumentType table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinAllExceptLanguage	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related Language table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinAllExceptUserRelatedByCreatedBy	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related UserRelatedByCreatedBy table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinAllExceptUserRelatedByOwnerId	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related UserRelatedByOwnerId table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinAllExceptUserRelatedByUpdatedBy	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related UserRelatedByUpdatedBy table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinDocumentCategory	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related DocumentCategory table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinDocumentData	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related DocumentData table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinDocumentType	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related DocumentType table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinLanguage	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related Language table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinUserRelatedByCreatedBy	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related UserRelatedByCreatedBy table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinUserRelatedByOwnerId	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related UserRelatedByOwnerId table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doCountJoinUserRelatedByUpdatedBy	(	Criteria	$criteria,
			$distinct = `false`,
		PropelPDO	$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Returns the number of rows matching criteria, joining the related UserRelatedByUpdatedBy table

Parameters

Criteria	$criteria
boolean	$distinct	Whether to select only distinct columns; deprecated: use Criteria->setDistinct() instead.
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: int Number of matching rows.

static BaseDocumentPeer::doDeleteAll ( PropelPDO $con = null )

static

Deletes all rows from the documents table.

Parameters

PropelPDO $con the connection to use

Returns: int The number of affected rows (if supported by underlying database driver).

Exceptions

PropelException

static BaseDocumentPeer::doInsert	(		$values,
		PropelPDO	$con = `null`
	)

static

Performs an INSERT on the database, given a Document or Criteria object.

Parameters

mixed	$values	Criteria or Document object containing data that is used to create the INSERT statement.
PropelPDO	$con	the PropelPDO connection to use

Returns: mixed The new primary key.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelect	(	Criteria	$criteria,
		PropelPDO	$con = `null`
	)

static

Selects several row from the DB.

Parameters

Criteria	$criteria	The Criteria object used to build the SELECT statement.
PropelPDO	$con

Returns: array Array of selected Objects

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinAll	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with all related objects.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinAllExceptDocumentCategory	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with all related objects except DocumentCategory.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinAllExceptDocumentData	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with all related objects except DocumentData.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinAllExceptDocumentType	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with all related objects except DocumentType.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinAllExceptLanguage	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with all related objects except Language.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinAllExceptUserRelatedByCreatedBy	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with all related objects except UserRelatedByCreatedBy.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinAllExceptUserRelatedByOwnerId	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with all related objects except UserRelatedByOwnerId.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinAllExceptUserRelatedByUpdatedBy	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with all related objects except UserRelatedByUpdatedBy.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinDocumentCategory	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with their DocumentCategory objects.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinDocumentData	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with their DocumentData objects.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinDocumentType	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with their DocumentType objects.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinLanguage	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with their Language objects.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinUserRelatedByCreatedBy	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with their User objects.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinUserRelatedByOwnerId	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with their User objects.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectJoinUserRelatedByUpdatedBy	(	Criteria	$criteria,
			$con = `null`,
			$join_behavior = `Criteria::LEFT_JOIN`
	)

static

Selects a collection of Document objects pre-filled with their User objects.

Parameters

Criteria	$criteria
PropelPDO	$con
String	$join_behavior	the type of joins to use, defaults to Criteria::LEFT_JOIN

Returns: array Array of Document objects.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectOne	(	Criteria	$criteria,
		PropelPDO	$con = `null`
	)

static

Selects one object from the DB.

Parameters

Criteria	$criteria	object used to create the SELECT statement.
PropelPDO	$con

Returns: Document

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doSelectStmt	(	Criteria	$criteria,
		PropelPDO	$con = `null`
	)

static

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 directly (for example to perform your own object hydration).

Parameters

Criteria	$criteria	The Criteria object used to build the SELECT statement.
PropelPDO	$con	The connection to use

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

Returns: PDOStatement The executed PDOStatement object.

See also: BasePeer::doSelect()

static BaseDocumentPeer::doUpdate	(		$values,
		PropelPDO	$con = `null`
	)

static

Performs an UPDATE on the database, given a Document or Criteria object.

Parameters

mixed	$values	Criteria or Document object containing data that is used to create the UPDATE statement.
PropelPDO	$con	The connection to use (specify PropelPDO connection object to exert more control over transactions).

Returns: int The number of affected rows (if supported by underlying database driver).

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::doValidate	(	$obj,
		$cols = `null`
	)

static

Validates all modified columns of given Document 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.

Parameters

Document	$obj	The object to validate.
mixed	$cols	Column name or array of column names.

Returns: mixed TRUE if all columns are valid or the error message of the first invalid column.

static BaseDocumentPeer::getFieldNames ( $type = BasePeer::TYPE_PHPNAME )

static

Returns an array of field names.

Parameters

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

Returns: array A list of field names

Exceptions

PropelException - if the type is not valid.

static BaseDocumentPeer::getInstanceFromPool ( $key )

static

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.

Parameters

string $key The key (

See also: getPrimaryKeyHash()) for this instance.

Returns: Document Found object or null if 1) no instance exists for specified key or 2) instance pooling has been disabled.

See also: getPrimaryKeyHash()

static BaseDocumentPeer::getOMClass	(	$row = `0`,
		$colnum = `0`
	)

static

The class that the Peer will make instances of.

Returns: string ClassName

static BaseDocumentPeer::getPrimaryKeyFromRow	(	$row,
		$startcol = `0`
	)

static

Retrieves the primary key from the DB resultset row For tables with a single-column primary key, that simple pkey value will be returned. For tables with a multi-column primary key, an array of the primary key columns will be returned.

Parameters

array	$row	PropelPDO resultset row.
int	$startcol	The 0-based offset for reading from the resultset row.

Returns: mixed The primary key of the row

static BaseDocumentPeer::getPrimaryKeyHashFromRow	(	$row,
		$startcol = `0`
	)

static

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.

Parameters

array	$row	PropelPDO resultset row.
int	$startcol	The 0-based offset for reading from the resultset row.

Returns: string A string version of PK or null if the components of primary key in result array are all null.

static BaseDocumentPeer::getTableMap ( )

static

Returns the TableMap related to this peer. This method is not needed for general use but a specific application could have a need.

Returns: TableMap

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::populateObject	(	$row,
		$startcol = `0`
	)

static

Populates an object of the default type or an object that inherit from the default.

Parameters

array	$row	PropelPDO resultset row.
int	$startcol	The 0-based offset for reading from the resultset row.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

Returns: array (Document object, last column rank)

static BaseDocumentPeer::populateObjects ( PDOStatement $stmt )

static

The returned array will contain objects of the default type or objects that inherit from the default.

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::removeInstanceFromPool ( $value )

static

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.

Parameters

mixed $value A Document object or a primary key value.

Returns: void

Exceptions

PropelException - if the value is invalid.

static BaseDocumentPeer::retrieveByPK	(		$pk,
		PropelPDO	$con = `null`
	)

static

Retrieve a single object by pkey.

Parameters

int	$pk	the primary key.
PropelPDO	$con	the connection to use

Returns: Document

static BaseDocumentPeer::retrieveByPKs	(		$pks,
		PropelPDO	$con = `null`
	)

static

Retrieve multiple objects by pkey.

Parameters

array	$pks	List of primary keys
PropelPDO	$con	the connection to use

Returns: Document[]

Exceptions

PropelException Any exceptions caught during processing will be rethrown wrapped into a PropelException.

static BaseDocumentPeer::translateFieldName	(	$name,
		$fromType,
		$toType
	)

static

Translates a fieldname to another type

Parameters

string	$name	field name
string	$fromType	One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM
string	$toType	One of the class type constants

Returns: string translated name of the field.

Exceptions

PropelException - if the specified name could not be found in the fieldname mappings.

Member Data Documentation

BaseDocumentPeer::$fieldKeys

staticprotected

Initial value:

= array (
        BasePeer::TYPE_PHPNAME => array ('Id' => 0, 'Name' => 1, 'OriginalName' => 2, 'Description' => 3, 'ContentCreatedAt' => 4, 'License' => 5, 'Author' => 6, 'LanguageId' => 7, 'OwnerId' => 8, 'DocumentTypeId' => 9, 'DocumentCategoryId' => 10, 'IsPrivate' => 11, 'IsProtected' => 12, 'Sort' => 13, 'Hash' => 14, 'CreatedAt' => 15, 'UpdatedAt' => 16, 'CreatedBy' => 17, 'UpdatedBy' => 18, ),
        BasePeer::TYPE_STUDLYPHPNAME => array ('id' => 0, 'name' => 1, 'originalName' => 2, 'description' => 3, 'contentCreatedAt' => 4, 'license' => 5, 'author' => 6, 'languageId' => 7, 'ownerId' => 8, 'documentTypeId' => 9, 'documentCategoryId' => 10, 'isPrivate' => 11, 'isProtected' => 12, 'sort' => 13, 'hash' => 14, 'createdAt' => 15, 'updatedAt' => 16, 'createdBy' => 17, 'updatedBy' => 18, ),
        BasePeer::TYPE_COLNAME => array (DocumentPeer::ID => 0, DocumentPeer::NAME => 1, DocumentPeer::ORIGINAL_NAME => 2, DocumentPeer::DESCRIPTION => 3, DocumentPeer::CONTENT_CREATED_AT => 4, DocumentPeer::LICENSE => 5, DocumentPeer::AUTHOR => 6, DocumentPeer::LANGUAGE_ID => 7, DocumentPeer::OWNER_ID => 8, DocumentPeer::DOCUMENT_TYPE_ID => 9, DocumentPeer::DOCUMENT_CATEGORY_ID => 10, DocumentPeer::IS_PRIVATE => 11, DocumentPeer::IS_PROTECTED => 12, DocumentPeer::SORT => 13, DocumentPeer::HASH => 14, DocumentPeer::CREATED_AT => 15, DocumentPeer::UPDATED_AT => 16, DocumentPeer::CREATED_BY => 17, DocumentPeer::UPDATED_BY => 18, ),
        BasePeer::TYPE_RAW_COLNAME => array ('ID' => 0, 'NAME' => 1, 'ORIGINAL_NAME' => 2, 'DESCRIPTION' => 3, 'CONTENT_CREATED_AT' => 4, 'LICENSE' => 5, 'AUTHOR' => 6, 'LANGUAGE_ID' => 7, 'OWNER_ID' => 8, 'DOCUMENT_TYPE_ID' => 9, 'DOCUMENT_CATEGORY_ID' => 10, 'IS_PRIVATE' => 11, 'IS_PROTECTED' => 12, 'SORT' => 13, 'HASH' => 14, 'CREATED_AT' => 15, 'UPDATED_AT' => 16, 'CREATED_BY' => 17, 'UPDATED_BY' => 18, ),
        BasePeer::TYPE_FIELDNAME => array ('id' => 0, 'name' => 1, 'original_name' => 2, 'description' => 3, 'content_created_at' => 4, 'license' => 5, 'author' => 6, 'language_id' => 7, 'owner_id' => 8, 'document_type_id' => 9, 'document_category_id' => 10, 'is_private' => 11, 'is_protected' => 12, 'sort' => 13, 'hash' => 14, 'created_at' => 15, 'updated_at' => 16, 'created_by' => 17, 'updated_by' => 18, ),
        BasePeer::TYPE_NUM => array (0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, )
    )

holds an array of keys for quick access to the fieldnames array

first dimension keys are the type constants e.g. DocumentPeer::$fieldNames[BasePeer::TYPE_PHPNAME]['Id'] = 0

BaseDocumentPeer::$fieldNames

staticprotected

Initial value:

= array (
        BasePeer::TYPE_PHPNAME => array ('Id', 'Name', 'OriginalName', 'Description', 'ContentCreatedAt', 'License', 'Author', 'LanguageId', 'OwnerId', 'DocumentTypeId', 'DocumentCategoryId', 'IsPrivate', 'IsProtected', 'Sort', 'Hash', 'CreatedAt', 'UpdatedAt', 'CreatedBy', 'UpdatedBy', ),
        BasePeer::TYPE_STUDLYPHPNAME => array ('id', 'name', 'originalName', 'description', 'contentCreatedAt', 'license', 'author', 'languageId', 'ownerId', 'documentTypeId', 'documentCategoryId', 'isPrivate', 'isProtected', 'sort', 'hash', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy', ),
        BasePeer::TYPE_COLNAME => array (DocumentPeer::ID, DocumentPeer::NAME, DocumentPeer::ORIGINAL_NAME, DocumentPeer::DESCRIPTION, DocumentPeer::CONTENT_CREATED_AT, DocumentPeer::LICENSE, DocumentPeer::AUTHOR, DocumentPeer::LANGUAGE_ID, DocumentPeer::OWNER_ID, DocumentPeer::DOCUMENT_TYPE_ID, DocumentPeer::DOCUMENT_CATEGORY_ID, DocumentPeer::IS_PRIVATE, DocumentPeer::IS_PROTECTED, DocumentPeer::SORT, DocumentPeer::HASH, DocumentPeer::CREATED_AT, DocumentPeer::UPDATED_AT, DocumentPeer::CREATED_BY, DocumentPeer::UPDATED_BY, ),
        BasePeer::TYPE_RAW_COLNAME => array ('ID', 'NAME', 'ORIGINAL_NAME', 'DESCRIPTION', 'CONTENT_CREATED_AT', 'LICENSE', 'AUTHOR', 'LANGUAGE_ID', 'OWNER_ID', 'DOCUMENT_TYPE_ID', 'DOCUMENT_CATEGORY_ID', 'IS_PRIVATE', 'IS_PROTECTED', 'SORT', 'HASH', 'CREATED_AT', 'UPDATED_AT', 'CREATED_BY', 'UPDATED_BY', ),
        BasePeer::TYPE_FIELDNAME => array ('id', 'name', 'original_name', 'description', 'content_created_at', 'license', 'author', 'language_id', 'owner_id', 'document_type_id', 'document_category_id', 'is_private', 'is_protected', 'sort', 'hash', 'created_at', 'updated_at', 'created_by', 'updated_by', ),
        BasePeer::TYPE_NUM => array (0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, )
    )

holds an array of fieldnames

first dimension keys are the type constants e.g. DocumentPeer::$fieldNames[DocumentPeer::TYPE_PHPNAME][0] = 'Id'

const BaseDocumentPeer::AUTHOR = 'documents.author'

the column name for the author field

const BaseDocumentPeer::CONTENT_CREATED_AT = 'documents.content_created_at'

the column name for the content_created_at field

const BaseDocumentPeer::CREATED_AT = 'documents.created_at'

the column name for the created_at field

const BaseDocumentPeer::CREATED_BY = 'documents.created_by'

the column name for the created_by field

const BaseDocumentPeer::DATABASE_NAME = 'rapila'

the default database name for this class

const BaseDocumentPeer::DEFAULT_STRING_FORMAT = 'YAML'

The default string format for model objects of the related table

const BaseDocumentPeer::DESCRIPTION = 'documents.description'

the column name for the description field

const BaseDocumentPeer::DOCUMENT_CATEGORY_ID = 'documents.document_category_id'

the column name for the document_category_id field

const BaseDocumentPeer::DOCUMENT_TYPE_ID = 'documents.document_type_id'

the column name for the document_type_id field

const BaseDocumentPeer::HASH = 'documents.hash'

the column name for the hash field

const BaseDocumentPeer::ID = 'documents.id'

the column name for the id field

const BaseDocumentPeer::IS_PRIVATE = 'documents.is_private'

the column name for the is_private field

const BaseDocumentPeer::IS_PROTECTED = 'documents.is_protected'

the column name for the is_protected field

const BaseDocumentPeer::LANGUAGE_ID = 'documents.language_id'

the column name for the language_id field

const BaseDocumentPeer::LICENSE = 'documents.license'

the column name for the license field

const BaseDocumentPeer::NAME = 'documents.name'

the column name for the name field

const BaseDocumentPeer::NUM_COLUMNS = 19

The total number of columns.

const BaseDocumentPeer::NUM_HYDRATE_COLUMNS = 19

The number of columns to hydrate (NUM_COLUMNS - NUM_LAZY_LOAD_COLUMNS)

const BaseDocumentPeer::NUM_LAZY_LOAD_COLUMNS = 0

The number of lazy-loaded columns.

const BaseDocumentPeer::OM_CLASS = 'Document'

the related Propel class for this table

const BaseDocumentPeer::ORIGINAL_NAME = 'documents.original_name'

the column name for the original_name field

const BaseDocumentPeer::OWNER_ID = 'documents.owner_id'

the column name for the owner_id field

const BaseDocumentPeer::SORT = 'documents.sort'

the column name for the sort field

const BaseDocumentPeer::TABLE_NAME = 'documents'

the table name for this class

const BaseDocumentPeer::TM_CLASS = 'DocumentTableMap'

the related TableMap class for this table

const BaseDocumentPeer::UPDATED_AT = 'documents.updated_at'

the column name for the updated_at field

const BaseDocumentPeer::UPDATED_BY = 'documents.updated_by'

the column name for the updated_by field

The documentation for this class was generated from the following file:

cms-full/base/lib/model/om/BaseDocumentPeer.php

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Attributes

Member Function Documentation

Member Data Documentation