Inheritance diagram for BasePage:

Public Member Functions
	applyDefaultValues ()

	__construct ()

	getId ()

	getName ()

	getIdentifier ()

	getPageType ()

	getTemplateName ()

	getIsInactive ()

	getIsFolder ()

	getIsHidden ()

	getIsProtected ()

	getCanonicalId ()

	getTreeLeft ()

	getTreeRight ()

	getTreeLevel ()

	getCreatedAt ($format= 'Y-m-d H:i:s')

	getUpdatedAt ($format= 'Y-m-d H:i:s')

	getCreatedBy ()

	getUpdatedBy ()

	setId ($v)

	setName ($v)

	setIdentifier ($v)

	setPageType ($v)

	setTemplateName ($v)

	setIsInactive ($v)

	setIsFolder ($v)

	setIsHidden ($v)

	setIsProtected ($v)

	setCanonicalId ($v)

	setTreeLeft ($v)

	setTreeRight ($v)

	setTreeLevel ($v)

	setCreatedAt ($v)

	setUpdatedAt ($v)

	setCreatedBy ($v)

	setUpdatedBy ($v)

	hasOnlyDefaultValues ()

	hydrate ($row, $startcol=0, $rehydrate=false)

	ensureConsistency ()

	reload ($deep=false, PropelPDO $con=null)

	delete (PropelPDO $con=null)

	save (PropelPDO $con=null)

	getValidationFailures ()

	validate ($columns=null)

	getByName ($name, $type=BasePeer::TYPE_PHPNAME)

	getByPosition ($pos)

	toArray ($keyType=BasePeer::TYPE_PHPNAME, $includeLazyLoadColumns=true, $alreadyDumpedObjects=array(), $includeForeignObjects=false)

	setByName ($name, $value, $type=BasePeer::TYPE_PHPNAME)

	setByPosition ($pos, $value)

	fromArray ($arr, $keyType=BasePeer::TYPE_PHPNAME)

	buildCriteria ()

	buildPkeyCriteria ()

	getPrimaryKey ()

	setPrimaryKey ($key)

	isPrimaryKeyNull ()

	copyInto ($copyObj, $deepCopy=false, $makeNew=true)

	copy ($deepCopy=false)

	getPeer ()

	setPageRelatedByCanonicalId (Page $v=null)

	getPageRelatedByCanonicalId (PropelPDO $con=null, $doQuery=true)

	setUserRelatedByCreatedBy (User $v=null)

	getUserRelatedByCreatedBy (PropelPDO $con=null, $doQuery=true)

	setUserRelatedByUpdatedBy (User $v=null)

	getUserRelatedByUpdatedBy (PropelPDO $con=null, $doQuery=true)

	initRelation ($relationName)

	clearPagesRelatedById ()

	resetPartialPagesRelatedById ($v=true)

	initPagesRelatedById ($overrideExisting=true)

	getPagesRelatedById ($criteria=null, PropelPDO $con=null)

	setPagesRelatedById (PropelCollection $pagesRelatedById, PropelPDO $con=null)

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

	addPageRelatedById (Page $l)

	removePageRelatedById ($pageRelatedById)

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

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

	clearPagePropertys ()

	resetPartialPagePropertys ($v=true)

	initPagePropertys ($overrideExisting=true)

	getPagePropertys ($criteria=null, PropelPDO $con=null)

	setPagePropertys (PropelCollection $pagePropertys, PropelPDO $con=null)

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

	addPageProperty (PageProperty $l)

	removePageProperty ($pageProperty)

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

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

	clearPageStrings ()

	resetPartialPageStrings ($v=true)

	initPageStrings ($overrideExisting=true)

	getPageStrings ($criteria=null, PropelPDO $con=null)

	setPageStrings (PropelCollection $pageStrings, PropelPDO $con=null)

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

	addPageString (PageString $l)

	removePageString ($pageString)

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

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

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

	clearContentObjects ()

	resetPartialContentObjects ($v=true)

	initContentObjects ($overrideExisting=true)

	getContentObjects ($criteria=null, PropelPDO $con=null)

	setContentObjects (PropelCollection $contentObjects, PropelPDO $con=null)

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

	addContentObject (ContentObject $l)

	removeContentObject ($contentObject)

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

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

	clearRights ()

	resetPartialRights ($v=true)

	initRights ($overrideExisting=true)

	getRights ($criteria=null, PropelPDO $con=null)

	setRights (PropelCollection $rights, PropelPDO $con=null)

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

	addRight (Right $l)

	removeRight ($right)

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

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

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

	clear ()

	clearAllReferences ($deep=false)

	__toString ()

	isAlreadyInSave ()

	getReferees ()

	addTag ($mTag)

	removeTag ($mTag)

	removeAllTags ()

	tags ($sReturn= 'tag')

	getTags ()

	mayOperate ($sOperation, $oUser=false)

	mayBeInserted ($oUser=false)

	mayBeUpdated ($oUser=false)

	mayBeDeleted ($oUser=false)

	getLeftValue ()

	getRightValue ()

	getLevel ()

	setLeftValue ($v)

	setRightValue ($v)

	setLevel ($v)

	makeRoot ()

	isInTree ()

	isRoot ()

	isLeaf ()

	isDescendantOf ($parent)

	isAncestorOf ($child)

	hasParent (PropelPDO $con=null)

	setParent ($parent=null)

	getParent (PropelPDO $con=null)

	hasPrevSibling (PropelPDO $con=null)

	getPrevSibling (PropelPDO $con=null)

	hasNextSibling (PropelPDO $con=null)

	getNextSibling (PropelPDO $con=null)

	clearNestedSetChildren ()

	initNestedSetChildren ()

	addNestedSetChild ($page)

	hasChildren ()

	getChildren ($criteria=null, PropelPDO $con=null)

	countChildren ($criteria=null, PropelPDO $con=null)

	getFirstChild ($query=null, PropelPDO $con=null)

	getLastChild ($query=null, PropelPDO $con=null)

	getSiblings ($includeNode=false, $query=null, PropelPDO $con=null)

	getDescendants ($query=null, PropelPDO $con=null)

	countDescendants ($query=null, PropelPDO $con=null)

	getBranch ($query=null, PropelPDO $con=null)

	getAncestors ($query=null, PropelPDO $con=null)

	addChild (Page $child)

	insertAsFirstChildOf ($parent)

	insertAsLastChildOf ($parent)

	insertAsPrevSiblingOf ($sibling)

	insertAsNextSiblingOf ($sibling)

	moveToFirstChildOf ($parent, PropelPDO $con=null)

	moveToLastChildOf ($parent, PropelPDO $con=null)

	moveToPrevSiblingOf ($sibling, PropelPDO $con=null)

	moveToNextSiblingOf ($sibling, PropelPDO $con=null)

	deleteDescendants (PropelPDO $con=null)

	getIterator ()

	keepUpdateDateUnchanged ()

	getCreatedAtTimestamp ()

	getCreatedAtFormatted ($sLanguageId=null, $sFormatString= 'x')

	getUpdatedAtTimestamp ()

	getUpdatedAtFormatted ($sLanguageId=null, $sFormatString= 'x')

	keepUpdateUserUnchanged ()

	getPKArray ()

	getPKString ()

Static Public Member Functions
static	addTagTo ($sPageId, $mTag)

static	removeTagFrom ($sPageId, $mTag)

static	removeAllTagsFrom ($sPageId)

static	tagsFor ($sPageId=null, $sReturn= 'tag')

Public Attributes
const	PEER = 'PagePeer'

const	TAG_MODEL_NAME = 'Tag'

const	TAG_INSTANCE_MODEL_NAME = 'TagInstance'

Protected Member Functions
	doSave (PropelPDO $con)

	doInsert (PropelPDO $con)

	doUpdate (PropelPDO $con)

	doValidate ($columns=null)

	doAddPageRelatedById ($pageRelatedById)

	doAddPageProperty ($pageProperty)

	doAddPageString ($pageString)

	doAddContentObject ($contentObject)

	doAddRight ($right)

	processNestedSetQueries ($con)

	moveSubtreeTo ($destLeft, $levelDelta, PropelPDO $con=null)

Protected Attributes
	$startCopy = false

	$id

	$name

	$identifier

	$page_type

	$template_name

	$is_inactive

	$is_folder

	$is_hidden

	$is_protected

	$canonical_id

	$tree_left

	$tree_right

	$tree_level

	$created_at

	$updated_at

	$created_by

	$updated_by

	$aPageRelatedByCanonicalId

	$aUserRelatedByCreatedBy

	$aUserRelatedByUpdatedBy

	$collPagesRelatedById

	$collPagesRelatedByIdPartial

	$collPagePropertys

	$collPagePropertysPartial

	$collPageStrings

	$collPageStringsPartial

	$collContentObjects

	$collContentObjectsPartial

	$collRights

	$collRightsPartial

	$alreadyInSave = false

	$alreadyInValidation = false

	$alreadyInClearAllReferencesDeep = false

	$nestedSetQueries = array()

	$collNestedSetChildren = null

	$aNestedSetParent = null

	$pagesRelatedByIdScheduledForDeletion = null

	$pagePropertysScheduledForDeletion = null

	$pageStringsScheduledForDeletion = null

	$contentObjectsScheduledForDeletion = null

	$rightsScheduledForDeletion = null

	$validationFailures = array()

Static Protected Attributes
static	$peer

Constructor & Destructor Documentation

BasePage::__construct ( )

Initializes internal state of BasePage object.

See also: applyDefaults()

Member Function Documentation

BasePage::__toString ( )

return the string representation of this object

Returns: string

BasePage::addChild ( Page $child )

Inserts the given $child node as first child of current The modifications in the current object and the tree are not persisted until the child object is saved.

Parameters

Page $child Propel object for child node

Returns: Page The current Propel object

BasePage::addContentObject ( ContentObject $l )

Method called to associate a ContentObject object to this object through the ContentObject foreign key attribute.

Parameters

ContentObject $l ContentObject

Returns: Page The current object (for fluent API support)

BasePage::addNestedSetChild ( $page )

Adds an element to the internal $collNestedSetChildren collection. Beware that this doesn't insert a node in the tree. This method is only used to facilitate children hydration.

Parameters

Page $page

Returns: void

BasePage::addPageProperty ( PageProperty $l )

Method called to associate a PageProperty object to this object through the PageProperty foreign key attribute.

Parameters

PageProperty $l PageProperty

Returns: Page The current object (for fluent API support)

BasePage::addPageRelatedById ( Page $l )

Method called to associate a Page object to this object through the Page foreign key attribute.

Parameters

Page $l Page

Returns: Page The current object (for fluent API support)

BasePage::addPageString ( PageString $l )

Method called to associate a PageString object to this object through the PageString foreign key attribute.

Parameters

PageString $l PageString

Returns: Page The current object (for fluent API support)

BasePage::addRight ( Right $l )

Method called to associate a Right object to this object through the Right foreign key attribute.

Parameters

Right $l Right

Returns: Page The current object (for fluent API support)

BasePage::addTag ( $mTag )

Add a tag to the current Page

static BasePage::addTagTo	(	$sPageId,
		$mTag
	)

static

Add a tag to the Page given by the id

BasePage::applyDefaultValues ( )

Applies default values to this object. This method should be called from the object's constructor (or equivalent initialization method).

See also: __construct()

BasePage::buildCriteria ( )

Build a Criteria object containing the values of all modified columns in this object.

Returns: Criteria The Criteria object containing all modified values.

BasePage::buildPkeyCriteria ( )

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.

Returns: Criteria The Criteria object containing value(s) for primary key(s).

BasePage::clear ( )

Clears the current object and sets all attributes to their default values

BasePage::clearAllReferences ( $deep = false )

Resets all references to other model objects or collections of model objects.

This method is a user-space workaround for PHP's inability to garbage collect objects with circular references (even in PHP 5.3). This is currently necessary when using Propel in certain daemon or large-volume/high-memory operations.

Parameters

boolean $deep Whether to also clear the references on all referrer objects.

BasePage::clearContentObjects ( )

Clears out the collContentObjects collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Returns: Page The current object (for fluent API support)

See also: addContentObjects()

BasePage::clearNestedSetChildren ( )

Clears out the $collNestedSetChildren collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Returns: void

BasePage::clearPagePropertys ( )

Clears out the collPagePropertys collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Returns: Page The current object (for fluent API support)

See also: addPagePropertys()

BasePage::clearPagesRelatedById ( )

Clears out the collPagesRelatedById collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Returns: Page The current object (for fluent API support)

See also: addPagesRelatedById()

BasePage::clearPageStrings ( )

Clears out the collPageStrings collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Returns: Page The current object (for fluent API support)

See also: addPageStrings()

BasePage::clearRights ( )

Clears out the collRights collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Returns: Page The current object (for fluent API support)

See also: addRights()

BasePage::copy ( $deepCopy = false )

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.

Parameters

boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.

Returns: Page Clone of current object.

Exceptions

PropelException

BasePage::copyInto	(	$copyObj,
		$deepCopy = `false`,
		$makeNew = `true`
	)

Sets contents of passed object to values from current object.

If desired, this method can also make copies of all associated (fkey referrers) objects.

Parameters

object	$copyObj	An object of Page (or compatible) type.
boolean	$deepCopy	Whether to also copy all rows that refer (by fkey) to the current row.
boolean	$makeNew	Whether to reset autoincrement PKs and make the object new.

Exceptions

PropelException

BasePage::countChildren	(		$criteria = `null`,
		PropelPDO	$con = `null`
	)

Gets number of children for the given node

Parameters

Criteria	$criteria	Criteria to filter results.
PropelPDO	$con	Connection to use.

Returns: int Number of children

BasePage::countContentObjects	(	Criteria	$criteria = `null`,
			$distinct = `false`,
		PropelPDO	$con = `null`
	)

Returns the number of related ContentObject objects.

Parameters

Criteria	$criteria
boolean	$distinct
PropelPDO	$con

Returns: int Count of related ContentObject objects.

Exceptions

PropelException

BasePage::countDescendants	(		$query = `null`,
		PropelPDO	$con = `null`
	)

Gets number of descendants for the given node

Parameters

Criteria	$query	Criteria to filter results.
PropelPDO	$con	Connection to use.

Returns: int Number of descendants

BasePage::countPagePropertys	(	Criteria	$criteria = `null`,
			$distinct = `false`,
		PropelPDO	$con = `null`
	)

Returns the number of related PageProperty objects.

Parameters

Criteria	$criteria
boolean	$distinct
PropelPDO	$con

Returns: int Count of related PageProperty objects.

Exceptions

PropelException

BasePage::countPagesRelatedById	(	Criteria	$criteria = `null`,
			$distinct = `false`,
		PropelPDO	$con = `null`
	)

Returns the number of related Page objects.

Parameters

Criteria	$criteria
boolean	$distinct
PropelPDO	$con

Returns: int Count of related Page objects.

Exceptions

PropelException

BasePage::countPageStrings	(	Criteria	$criteria = `null`,
			$distinct = `false`,
		PropelPDO	$con = `null`
	)

Returns the number of related PageString objects.

Parameters

Criteria	$criteria
boolean	$distinct
PropelPDO	$con

Returns: int Count of related PageString objects.

Exceptions

PropelException

BasePage::countRights	(	Criteria	$criteria = `null`,
			$distinct = `false`,
		PropelPDO	$con = `null`
	)

Returns the number of related Right objects.

Parameters

Criteria	$criteria
boolean	$distinct
PropelPDO	$con

Returns: int Count of related Right objects.

Exceptions

PropelException

BasePage::delete ( PropelPDO $con = null )

Removes this object from datastore and sets delete attribute.

Parameters

PropelPDO $con

Returns: void

Exceptions

PropelException
Exception

See also: BaseObject::setDeleted(); BaseObject::isDeleted()

BasePage::deleteDescendants ( PropelPDO $con = null )

Deletes all descendants for the given node Instance pooling is wiped out by this command, so existing Page instances are probably invalid (except for the current one)

Parameters

PropelPDO $con Connection to use.

Returns: int number of deleted nodes

BasePage::doAddContentObject ( $contentObject )

protected

Parameters

ContentObject $contentObject The contentObject object to add.

BasePage::doAddPageProperty ( $pageProperty )

protected

Parameters

PageProperty $pageProperty The pageProperty object to add.

BasePage::doAddPageRelatedById ( $pageRelatedById )

protected

Parameters

PageRelatedById $pageRelatedById The pageRelatedById object to add.

BasePage::doAddPageString ( $pageString )

protected

Parameters

PageString $pageString The pageString object to add.

BasePage::doAddRight ( $right )

protected

Parameters

Right $right The right object to add.

BasePage::doInsert ( PropelPDO $con )

protected

Insert the row in the database.

Parameters

PropelPDO $con

Exceptions

PropelException

See also: doSave()

BasePage::doSave ( PropelPDO $con )

protected

Performs the work of inserting or updating the row 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.

Parameters

PropelPDO $con

Returns: int The number of rows affected by this insert/update and any referring fk objects' save() operations.

Exceptions

PropelException

See also: save()

BasePage::doUpdate ( PropelPDO $con )

protected

Update the row in the database.

Parameters

PropelPDO $con

See also: doSave()

BasePage::doValidate ( $columns = null )

protected

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 aggregated array of ValidationFailed objects will be returned.

Parameters

array $columns Array of column names to validate.

Returns: mixed true if all validations pass; array of ValidationFailed objects otherwise.

BasePage::ensureConsistency ( )

Checks and repairs the internal consistency of the object.

This method is executed after an already-instantiated object is re-hydrated from the database. It exists to check any foreign keys to make sure that the objects related to the current object are correct based on foreign key.

You can override this method in the stub class, but you should always invoke the base method from the overridden method (i.e. parent::ensureConsistency()), in case your model changes.

Exceptions

PropelException

BasePage::fromArray	(	$arr,
		$keyType = `BasePeer::TYPE_PHPNAME`
	)

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 BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. The default key type is the column's BasePeer::TYPE_PHPNAME

Parameters

array	$arr	An array to populate the object from.
string	$keyType	The type of keys the array uses.

Returns: void

BasePage::getAncestors	(		$query = `null`,
		PropelPDO	$con = `null`
	)

Gets ancestors for the given node, starting with the root node Use it for breadcrumb paths for instance

Parameters

Criteria	$query	Criteria to filter results.
PropelPDO	$con	Connection to use.

Returns: array List of Page objects

BasePage::getBranch	(		$query = `null`,
		PropelPDO	$con = `null`
	)

Gets descendants for the given node, plus the current node

Parameters

Criteria	$query	Criteria to filter results.
PropelPDO	$con	Connection to use.

Returns: array List of Page objects

BasePage::getByName	(	$name,
		$type = `BasePeer::TYPE_PHPNAME`
	)

Retrieves a field from the object by name passed in as a string.

Parameters

string	$name	name
string	$type	The type of fieldname the $name is of: one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME

Returns: mixed Value of field.

BasePage::getByPosition ( $pos )

Retrieves a field from the object by Position as specified in the xml schema. Zero-based.

Parameters

int $pos position in xml schema

Returns: mixed Value of field at $pos

BasePage::getCanonicalId ( )

Get the [canonical_id] column value.

Returns: int

BasePage::getChildren	(		$criteria = `null`,
		PropelPDO	$con = `null`
	)

Gets the children of the given node

Parameters

Criteria	$criteria	Criteria to filter results.
PropelPDO	$con	Connection to use.

Returns: array List of Page objects

BasePage::getContentObjects	(		$criteria = `null`,
		PropelPDO	$con = `null`
	)

Gets an array of ContentObject objects which contain a foreign key that references this object.

If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this Page is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object

Returns: PropelObjectCollection|ContentObject[] List of ContentObject objects

Exceptions

PropelException

BasePage::getContentObjectsJoinUserRelatedByCreatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related ContentObjects 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|ContentObject[] List of ContentObject objects

BasePage::getContentObjectsJoinUserRelatedByUpdatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related ContentObjects 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|ContentObject[] List of ContentObject objects

BasePage::getCreatedAt ( $format = 'Y-m-d H:i:s' )

Get the [optionally formatted] temporal [created_at] column value.

Parameters

string $format The date/time format string (either date()-style or strftime()-style). If format is null, then the raw DateTime object will be returned.

Returns: mixed Formatted date/time value as string or DateTime object (if format is null), null if column is null, and 0 if column value is 0000-00-00 00:00:00

Exceptions

PropelException - if unable to parse/validate the date/time value.

BasePage::getCreatedAtFormatted	(	$sLanguageId = `null`,
		$sFormatString = `'x'`
	)

Returns: created_at formatted to the current locale

BasePage::getCreatedAtTimestamp ( )

Returns: created_at as int (timestamp)

BasePage::getCreatedBy ( )

Get the [created_by] column value.

Returns: int

BasePage::getDescendants	(		$query = `null`,
		PropelPDO	$con = `null`
	)

Gets descendants for the given node

Parameters

Criteria	$query	Criteria to filter results.
PropelPDO	$con	Connection to use.

Returns: array List of Page objects

BasePage::getFirstChild	(		$query = `null`,
		PropelPDO	$con = `null`
	)

Gets the first child of the given node

Parameters

Criteria	$query	Criteria to filter results.
PropelPDO	$con	Connection to use.

Returns: array List of Page objects

BasePage::getId ( )

Get the [id] column value.

Returns: int

BasePage::getIdentifier ( )

Get the [identifier] column value.

Returns: string

BasePage::getIsFolder ( )

Get the [is_folder] column value.

Returns: boolean

BasePage::getIsHidden ( )

Get the [is_hidden] column value.

Returns: boolean

BasePage::getIsInactive ( )

Get the [is_inactive] column value.

Returns: boolean

BasePage::getIsProtected ( )

Get the [is_protected] column value.

Returns: boolean

BasePage::getIterator ( )

Returns a pre-order iterator for this node and its children.

Returns: RecursiveIterator

BasePage::getLastChild	(		$query = `null`,
		PropelPDO	$con = `null`
	)

Gets the last child of the given node

Parameters

Criteria	$query	Criteria to filter results.
PropelPDO	$con	Connection to use.

Returns: array List of Page objects

BasePage::getLeftValue ( )

Proxy getter method for the left value of the nested set model. It provides a generic way to get the value, whatever the actual column name is.

Returns: int The nested set left value

BasePage::getLevel ( )

Proxy getter method for the level value of the nested set model. It provides a generic way to get the value, whatever the actual column name is.

Returns: int The nested set level value

BasePage::getName ( )

Get the [name] column value.

Returns: string

BasePage::getNextSibling ( PropelPDO $con = null )

Gets next sibling for the given node if it exists

Parameters

PropelPDO $con Connection to use.

Returns: mixed Propel object if exists else false

BasePage::getPagePropertys	(		$criteria = `null`,
		PropelPDO	$con = `null`
	)

Gets an array of PageProperty objects which contain a foreign key that references this object.

If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this Page is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object

Returns: PropelObjectCollection|PageProperty[] List of PageProperty objects

Exceptions

PropelException

BasePage::getPagePropertysJoinUserRelatedByCreatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related PagePropertys 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|PageProperty[] List of PageProperty objects

BasePage::getPagePropertysJoinUserRelatedByUpdatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related PagePropertys 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|PageProperty[] List of PageProperty objects

BasePage::getPageRelatedByCanonicalId	(	PropelPDO	$con = `null`,
			$doQuery = `true`
	)

Get the associated Page object

Parameters

PropelPDO	$con	Optional Connection object.
	$doQuery	Executes a query to get the object if required

Returns: Page The associated Page object.

Exceptions

PropelException

BasePage::getPagesRelatedById	(		$criteria = `null`,
		PropelPDO	$con = `null`
	)

Gets an array of Page objects which contain a foreign key that references this object.

If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this Page is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object

Returns: PropelObjectCollection|Page[] List of Page objects

Exceptions

PropelException

BasePage::getPagesRelatedByIdJoinUserRelatedByCreatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related PagesRelatedById 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|Page[] List of Page objects

BasePage::getPagesRelatedByIdJoinUserRelatedByUpdatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related PagesRelatedById 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|Page[] List of Page objects

BasePage::getPageStrings	(		$criteria = `null`,
		PropelPDO	$con = `null`
	)

Gets an array of PageString objects which contain a foreign key that references this object.

If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this Page is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object

Returns: PropelObjectCollection|PageString[] List of PageString objects

Exceptions

PropelException

BasePage::getPageStringsJoinLanguage	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related PageStrings 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|PageString[] List of PageString objects

BasePage::getPageStringsJoinUserRelatedByCreatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related PageStrings 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|PageString[] List of PageString objects

BasePage::getPageStringsJoinUserRelatedByUpdatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related PageStrings 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|PageString[] List of PageString objects

BasePage::getPageType ( )

Get the [page_type] column value.

Returns: string

BasePage::getParent ( PropelPDO $con = null )

Gets parent node for the current object if it exists The result is cached so further calls to the same method don't issue any queries

Parameters

PropelPDO $con Connection to use.

Returns: mixed Propel object if exists else false

BasePage::getPeer ( )

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.

Returns: PagePeer

BasePage::getPKArray ( )

Returns: the primary key as an array (even for non-composite keys)

BasePage::getPKString ( )

Returns: the composite primary key as a string, separated by _

BasePage::getPrevSibling ( PropelPDO $con = null )

Gets previous sibling for the given node if it exists

Parameters

PropelPDO $con Connection to use.

Returns: mixed Propel object if exists else false

BasePage::getPrimaryKey ( )

Returns the primary key for this object (row).

Returns: int

BasePage::getReferees ( )

Returns: A list of References (not Objects) which reference this Page

BasePage::getRights	(		$criteria = `null`,
		PropelPDO	$con = `null`
	)

Gets an array of Right objects which contain a foreign key that references this object.

If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this Page is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object

Returns: PropelObjectCollection|Right[] List of Right objects

Exceptions

PropelException

BasePage::getRightsJoinRole	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related Rights 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|Right[] List of Right objects

BasePage::getRightsJoinUserRelatedByCreatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related Rights 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|Right[] List of Right objects

BasePage::getRightsJoinUserRelatedByUpdatedBy	(	$criteria = `null`,
		$con = `null`,
		$join_behavior = `Criteria::LEFT_JOIN`
	)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Page is new, it will return an empty collection; or if this Page has previously been saved, it will retrieve related Rights 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 Page.

Parameters

Criteria	$criteria	optional Criteria object to narrow the query
PropelPDO	$con	optional connection object
string	$join_behavior	optional join type to use (defaults to Criteria::LEFT_JOIN)

Returns: PropelObjectCollection|Right[] List of Right objects

BasePage::getRightValue ( )

Proxy getter method for the right value of the nested set model. It provides a generic way to get the value, whatever the actual column name is.

Returns: int The nested set right value

BasePage::getSiblings	(		$includeNode = `false`,
			$query = `null`,
		PropelPDO	$con = `null`
	)

Gets the siblings of the given node

Parameters

bool	$includeNode	Whether to include the current node or not
Criteria	$query	Criteria to filter results.
PropelPDO	$con	Connection to use.

Returns: array List of Page objects

BasePage::getTags ( )

Returns: A list of TagInstances (not Tags) which reference this Page

Deprecated:: Use ->tags('instances')

BasePage::getTemplateName ( )

Get the [template_name] column value.

Returns: string

BasePage::getTreeLeft ( )

Get the [tree_left] column value.

Returns: int

BasePage::getTreeLevel ( )

Get the [tree_level] column value.

Returns: int

BasePage::getTreeRight ( )

Get the [tree_right] column value.

Returns: int

BasePage::getUpdatedAt ( $format = 'Y-m-d H:i:s' )

Get the [optionally formatted] temporal [updated_at] column value.

Parameters

string $format The date/time format string (either date()-style or strftime()-style). If format is null, then the raw DateTime object will be returned.

Returns: mixed Formatted date/time value as string or DateTime object (if format is null), null if column is null, and 0 if column value is 0000-00-00 00:00:00

Exceptions

PropelException - if unable to parse/validate the date/time value.

BasePage::getUpdatedAtFormatted	(	$sLanguageId = `null`,
		$sFormatString = `'x'`
	)

Returns: updated_at formatted to the current locale

BasePage::getUpdatedAtTimestamp ( )

Returns: updated_at as int (timestamp)

BasePage::getUpdatedBy ( )

Get the [updated_by] column value.

Returns: int

BasePage::getUserRelatedByCreatedBy	(	PropelPDO	$con = `null`,
			$doQuery = `true`
	)

Get the associated User object

Parameters

PropelPDO	$con	Optional Connection object.
	$doQuery	Executes a query to get the object if required

Returns: User The associated User object.

Exceptions

PropelException

BasePage::getUserRelatedByUpdatedBy	(	PropelPDO	$con = `null`,
			$doQuery = `true`
	)

Get the associated User object

Parameters

PropelPDO	$con	Optional Connection object.
	$doQuery	Executes a query to get the object if required

Returns: User The associated User object.

Exceptions

PropelException

BasePage::getValidationFailures ( )

Gets any ValidationFailed objects that resulted from last call to validate().

Returns: array ValidationFailed[]

See also: validate()

BasePage::hasChildren ( )

Tests if node has children

Returns: bool

BasePage::hasNextSibling ( PropelPDO $con = null )

Determines if the node has next sibling

Parameters

PropelPDO $con Connection to use.

Returns: bool

BasePage::hasOnlyDefaultValues ( )

Indicates whether the columns in this object are only set to default values.

This method can be used in conjunction with isModified() to indicate whether an object is both modified and has some values set which are non-default.

Returns: boolean Whether the columns in this object are only been set with default values.

BasePage::hasParent ( PropelPDO $con = null )

Tests if object has an ancestor

Parameters

PropelPDO $con Connection to use.

Returns: bool

BasePage::hasPrevSibling ( PropelPDO $con = null )

Determines if the node has previous sibling

Parameters

PropelPDO $con Connection to use.

Returns: bool

BasePage::hydrate	(	$row,
		$startcol = `0`,
		$rehydrate = `false`
	)

Hydrates (populates) the object variables with values from the database resultset.

An offset (0-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.

Parameters

array	$row	The row returned by PDOStatement->fetch(PDO::FETCH_NUM)
int	$startcol	0-based offset column which indicates which resultset column to start with.
boolean	$rehydrate	Whether this object is being re-hydrated from the database.

Returns: int next starting column

Exceptions

PropelException - Any caught Exception will be rewrapped as a PropelException.

BasePage::initContentObjects ( $overrideExisting = true )

Initializes the collContentObjects collection.

By default this just sets the collContentObjects collection to an empty array (like clearcollContentObjects()); however, you may wish to override this method in your stub class to provide setting appropriate to your application – for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Returns: void

BasePage::initNestedSetChildren ( )

Initializes the $collNestedSetChildren collection.

Returns: void

BasePage::initPagePropertys ( $overrideExisting = true )

Initializes the collPagePropertys collection.

By default this just sets the collPagePropertys collection to an empty array (like clearcollPagePropertys()); however, you may wish to override this method in your stub class to provide setting appropriate to your application – for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Returns: void

BasePage::initPagesRelatedById ( $overrideExisting = true )

Initializes the collPagesRelatedById collection.

By default this just sets the collPagesRelatedById collection to an empty array (like clearcollPagesRelatedById()); however, you may wish to override this method in your stub class to provide setting appropriate to your application – for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Returns: void

BasePage::initPageStrings ( $overrideExisting = true )

Initializes the collPageStrings collection.

By default this just sets the collPageStrings collection to an empty array (like clearcollPageStrings()); however, you may wish to override this method in your stub class to provide setting appropriate to your application – for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Returns: void

BasePage::initRelation ( $relationName )

Initializes a collection based on the name of a relation. Avoids crafting an 'init[$relationName]s' method name that wouldn't work when StandardEnglishPluralizer is used.

Parameters

string $relationName The name of the relation to initialize

Returns: void

BasePage::initRights ( $overrideExisting = true )

Initializes the collRights collection.

By default this just sets the collRights collection to an empty array (like clearcollRights()); however, you may wish to override this method in your stub class to provide setting appropriate to your application – for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Returns: void

BasePage::insertAsFirstChildOf ( $parent )

Inserts the current node as first child of given $parent node The modifications in the current object and the tree are not persisted until the current object is saved.

Parameters

Page $parent Propel object for parent node

Returns: Page The current Propel object

BasePage::insertAsLastChildOf ( $parent )

Inserts the current node as last child of given $parent node The modifications in the current object and the tree are not persisted until the current object is saved.

Parameters

Page $parent Propel object for parent node

Returns: Page The current Propel object

BasePage::insertAsNextSiblingOf ( $sibling )

Inserts the current node as next sibling given $sibling node The modifications in the current object and the tree are not persisted until the current object is saved.

Parameters

Page $sibling Propel object for parent node

Returns: Page The current Propel object

BasePage::insertAsPrevSiblingOf ( $sibling )

Inserts the current node as prev sibling given $sibling node The modifications in the current object and the tree are not persisted until the current object is saved.

Parameters

Page $sibling Propel object for parent node

Returns: Page The current Propel object

BasePage::isAlreadyInSave ( )

return true is the object is in saving state

Returns: boolean

BasePage::isAncestorOf ( $child )

Tests if node is a ancestor of another node

Parameters

Page $node Propel node object

Returns: bool

BasePage::isDescendantOf ( $parent )

Tests if node is a descendant of another node

Parameters

Page $node Propel node object

Returns: bool

BasePage::isInTree ( )

Tests if onbject is a node, i.e. if it is inserted in the tree

Returns: bool

BasePage::isLeaf ( )

Tests if node is a leaf

Returns: bool

BasePage::isPrimaryKeyNull ( )

Returns true if the primary key for this object is null.

Returns: boolean

BasePage::isRoot ( )

Tests if node is a root

Returns: bool

BasePage::keepUpdateDateUnchanged ( )

Mark the current object so that the update date doesn't get updated during next save

Returns: Page The current object (for fluent API support)

BasePage::keepUpdateUserUnchanged ( )

Mark the current object so that the updated user doesn't get updated during next save

Returns: Page The current object (for fluent API support)

BasePage::makeRoot ( )

Creates the supplied node as the root node.

Returns: Page The current object (for fluent API support)

Exceptions

PropelException

BasePage::moveSubtreeTo	(		$destLeft,
			$levelDelta,
		PropelPDO	$con = `null`
	)

protected

Move current node and its children to location $destLeft and updates rest of tree

Parameters

int	$destLeft	Destination left value
int	$levelDelta	Delta to add to the levels
PropelPDO	$con	Connection to use.

BasePage::moveToFirstChildOf	(		$parent,
		PropelPDO	$con = `null`
	)

Moves current node and its subtree to be the first child of $parent The modifications in the current object and the tree are immediate

Parameters

Page	$parent	Propel object for parent node
PropelPDO	$con	Connection to use.

Returns: Page The current Propel object

BasePage::moveToLastChildOf	(		$parent,
		PropelPDO	$con = `null`
	)

Moves current node and its subtree to be the last child of $parent The modifications in the current object and the tree are immediate

Parameters

Page	$parent	Propel object for parent node
PropelPDO	$con	Connection to use.

Returns: Page The current Propel object

BasePage::moveToNextSiblingOf	(		$sibling,
		PropelPDO	$con = `null`
	)

Moves current node and its subtree to be the next sibling of $sibling The modifications in the current object and the tree are immediate

Parameters

Page	$sibling	Propel object for sibling node
PropelPDO	$con	Connection to use.

Returns: Page The current Propel object

BasePage::moveToPrevSiblingOf	(		$sibling,
		PropelPDO	$con = `null`
	)

Moves current node and its subtree to be the previous sibling of $sibling The modifications in the current object and the tree are immediate

Parameters

Page	$sibling	Propel object for sibling node
PropelPDO	$con	Connection to use.

Returns: Page The current Propel object

BasePage::processNestedSetQueries ( $con )

protected

Execute queries that were saved to be run inside the save transaction

BasePage::reload	(		$deep = `false`,
		PropelPDO	$con = `null`
	)

Reloads this object from datastore based on primary key and (optionally) resets all associated objects.

This will only work if the object has been saved and has a valid primary key set.

Parameters

boolean	$deep	(optional) Whether to also de-associated any related objects.
PropelPDO	$con	(optional) The PropelPDO connection to use.

Returns: void

Exceptions

PropelException - if this object is deleted, unsaved or doesn't have pk match in db

BasePage::removeAllTags ( )

Remove all tags from the current Page

static BasePage::removeAllTagsFrom ( $sPageId )

static

Remove all tags from the Page given by the id

BasePage::removeContentObject ( $contentObject )

Parameters

ContentObject $contentObject The contentObject object to remove.

Returns: Page The current object (for fluent API support)

BasePage::removePageProperty ( $pageProperty )

Parameters

PageProperty $pageProperty The pageProperty object to remove.

Returns: Page The current object (for fluent API support)

BasePage::removePageRelatedById ( $pageRelatedById )

Parameters

PageRelatedById $pageRelatedById The pageRelatedById object to remove.

Returns: Page The current object (for fluent API support)

BasePage::removePageString ( $pageString )

Parameters

PageString $pageString The pageString object to remove.

Returns: Page The current object (for fluent API support)

BasePage::removeRight ( $right )

Parameters

Right $right The right object to remove.

Returns: Page The current object (for fluent API support)

BasePage::removeTag ( $mTag )

Remove tag from the current Page

static BasePage::removeTagFrom	(	$sPageId,
		$mTag
	)

static

Remove tag from the Page given by the id

BasePage::resetPartialContentObjects ( $v = true )

reset is the collContentObjects collection loaded partially

Returns: void

BasePage::resetPartialPagePropertys ( $v = true )

reset is the collPagePropertys collection loaded partially

Returns: void

BasePage::resetPartialPagesRelatedById ( $v = true )

reset is the collPagesRelatedById collection loaded partially

Returns: void

BasePage::resetPartialPageStrings ( $v = true )

reset is the collPageStrings collection loaded partially

Returns: void

BasePage::resetPartialRights ( $v = true )

reset is the collRights collection loaded partially

Returns: void

BasePage::save ( PropelPDO $con = null )

Persists this object to the database.

If the object is new, it inserts it; otherwise an update is performed. All modified related objects will also be persisted in the doSave() method. This method wraps all precipitate database operations in a single transaction.

Parameters

PropelPDO $con

Returns: int The number of rows affected by this insert/update and any referring fk objects' save() operations.

Exceptions

PropelException
Exception

See also: doSave()

BasePage::setByName	(	$name,
		$value,
		$type = `BasePeer::TYPE_PHPNAME`
	)

Sets a field from the object by name passed in as a string.

Parameters

string	$name	peer name
mixed	$value	field value
string	$type	The type of fieldname the $name is of: one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME

Returns: void

BasePage::setByPosition	(	$pos,
		$value
	)

Sets a field from the object by Position as specified in the xml schema. Zero-based.

Parameters

int	$pos	position in xml schema
mixed	$value	field value

Returns: void

BasePage::setCanonicalId ( $v )

Set the value of [canonical_id] column.

Parameters

int $v new value

Returns: Page The current object (for fluent API support)

BasePage::setContentObjects	(	PropelCollection	$contentObjects,
		PropelPDO	$con = `null`
	)

Sets a collection of ContentObject objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

PropelCollection	$contentObjects	A Propel collection.
PropelPDO	$con	Optional connection object

Returns: Page The current object (for fluent API support)

BasePage::setCreatedAt ( $v )

Sets the value of [created_at] column to a normalized version of the date/time value specified.

Parameters

mixed $v string, integer (timestamp), or DateTime value. Empty strings are treated as null.

Returns: Page The current object (for fluent API support)

BasePage::setCreatedBy ( $v )

Set the value of [created_by] column.

Parameters

int $v new value

Returns: Page The current object (for fluent API support)

BasePage::setId ( $v )

Set the value of [id] column.

Parameters

int $v new value

Returns: Page The current object (for fluent API support)

BasePage::setIdentifier ( $v )

Set the value of [identifier] column.

Parameters

string $v new value

Returns: Page The current object (for fluent API support)

BasePage::setIsFolder ( $v )

Sets the value of the [is_folder] column. Non-boolean arguments are converted using the following rules:

1, '1', 'true', 'on', and 'yes' are converted to boolean true
0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').

Parameters

boolean | integer | string $v The new value

Returns: Page The current object (for fluent API support)

BasePage::setIsHidden ( $v )

Sets the value of the [is_hidden] column. Non-boolean arguments are converted using the following rules:

1, '1', 'true', 'on', and 'yes' are converted to boolean true
0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').

Parameters

boolean | integer | string $v The new value

Returns: Page The current object (for fluent API support)

BasePage::setIsInactive ( $v )

Sets the value of the [is_inactive] column. Non-boolean arguments are converted using the following rules:

1, '1', 'true', 'on', and 'yes' are converted to boolean true
0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').

Parameters

boolean | integer | string $v The new value

Returns: Page The current object (for fluent API support)

BasePage::setIsProtected ( $v )

Sets the value of the [is_protected] column. Non-boolean arguments are converted using the following rules:

1, '1', 'true', 'on', and 'yes' are converted to boolean true
0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').

Parameters

boolean | integer | string $v The new value

Returns: Page The current object (for fluent API support)

BasePage::setLeftValue ( $v )

Proxy setter method for the left value of the nested set model. It provides a generic way to set the value, whatever the actual column name is.

Parameters

int $v The nested set left value

Returns: Page The current object (for fluent API support)

BasePage::setLevel ( $v )

Proxy setter method for the level value of the nested set model. It provides a generic way to set the value, whatever the actual column name is.

Parameters

int $v The nested set level value

Returns: Page The current object (for fluent API support)

BasePage::setName ( $v )

Set the value of [name] column.

Parameters

string $v new value

Returns: Page The current object (for fluent API support)

BasePage::setPagePropertys	(	PropelCollection	$pagePropertys,
		PropelPDO	$con = `null`
	)

Sets a collection of PageProperty objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

PropelCollection	$pagePropertys	A Propel collection.
PropelPDO	$con	Optional connection object

Returns: Page The current object (for fluent API support)

BasePage::setPageRelatedByCanonicalId ( Page $v = null )

Declares an association between this object and a Page object.

Parameters

Page $v

Returns: Page The current object (for fluent API support)

Exceptions

PropelException

BasePage::setPagesRelatedById	(	PropelCollection	$pagesRelatedById,
		PropelPDO	$con = `null`
	)

Sets a collection of PageRelatedById objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

PropelCollection	$pagesRelatedById	A Propel collection.
PropelPDO	$con	Optional connection object

Returns: Page The current object (for fluent API support)

BasePage::setPageStrings	(	PropelCollection	$pageStrings,
		PropelPDO	$con = `null`
	)

Sets a collection of PageString objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

PropelCollection	$pageStrings	A Propel collection.
PropelPDO	$con	Optional connection object

Returns: Page The current object (for fluent API support)

BasePage::setPageType ( $v )

Set the value of [page_type] column.

Parameters

string $v new value

Returns: Page The current object (for fluent API support)

BasePage::setParent ( $parent = null )

Sets the cache for parent node of the current object. Warning: this does not move the current object in the tree. Use moveTofirstChildOf() or moveToLastChildOf() for that purpose

Parameters

Page $parent

Returns: Page The current object, for fluid interface

BasePage::setPrimaryKey ( $key )

Generic method to set the primary key (id column).

Parameters

int $key Primary key.

Returns: void

BasePage::setRights	(	PropelCollection	$rights,
		PropelPDO	$con = `null`
	)

Sets a collection of Right objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

PropelCollection	$rights	A Propel collection.
PropelPDO	$con	Optional connection object

Returns: Page The current object (for fluent API support)

BasePage::setRightValue ( $v )

Proxy setter method for the right value of the nested set model. It provides a generic way to set the value, whatever the actual column name is.

Parameters

int $v The nested set right value

Returns: Page The current object (for fluent API support)

BasePage::setTemplateName ( $v )

Set the value of [template_name] column.

Parameters

string $v new value

Returns: Page The current object (for fluent API support)

BasePage::setTreeLeft ( $v )

Set the value of [tree_left] column.

Parameters

int $v new value

Returns: Page The current object (for fluent API support)

BasePage::setTreeLevel ( $v )

Set the value of [tree_level] column.

Parameters

int $v new value

Returns: Page The current object (for fluent API support)

BasePage::setTreeRight ( $v )

Set the value of [tree_right] column.

Parameters

int $v new value

Returns: Page The current object (for fluent API support)

BasePage::setUpdatedAt ( $v )

Sets the value of [updated_at] column to a normalized version of the date/time value specified.

Parameters

mixed $v string, integer (timestamp), or DateTime value. Empty strings are treated as null.

Returns: Page The current object (for fluent API support)

BasePage::setUpdatedBy ( $v )

Set the value of [updated_by] column.

Parameters

int $v new value

Returns: Page The current object (for fluent API support)

BasePage::setUserRelatedByCreatedBy ( User $v = null )

Declares an association between this object and a User object.

Parameters

User $v

Returns: Page The current object (for fluent API support)

Exceptions

PropelException

BasePage::setUserRelatedByUpdatedBy ( User $v = null )

Declares an association between this object and a User object.

Parameters

User $v

Returns: Page The current object (for fluent API support)

Exceptions

PropelException

BasePage::tags ( $sReturn = 'tag' )

Returns: All tags for the current Page

static BasePage::tagsFor	(	$sPageId = `null`,
		$sReturn = `'tag'`
	)

static

Returns: All tags for the Page given by the id

BasePage::toArray	(	$keyType = `BasePeer::TYPE_PHPNAME`,
		$includeLazyLoadColumns = `true`,
		$alreadyDumpedObjects = `array()`,
		$includeForeignObjects = `false`
	)

Exports the object as an array.

You can specify the key type of the array by passing one of the class type constants.

Parameters

string	$keyType	(optional) One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME.
boolean	$includeLazyLoadColumns	(optional) Whether to include lazy loaded columns. Defaults to true.
array	$alreadyDumpedObjects	List of objects to skip to avoid recursion
boolean	$includeForeignObjects	(optional) Whether to include hydrated related objects. Default to FALSE.

Returns: array an associative array containing the field names (as keys) and field values

BasePage::validate ( $columns = null )

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.

Parameters

mixed $columns Column name or an array of column names.

Returns: boolean Whether all columns pass validation.

See also: doValidate(); getValidationFailures()

Member Data Documentation

const BasePage::PEER = 'PagePeer'

Peer class name

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation