Inheritance diagram for BasePageProperty:

Public Member Functions
	getId ()

	getPageId ()

	getName ()

	getValue ()

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

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

	getCreatedBy ()

	getUpdatedBy ()

	setId ($v)

	setPageId ($v)

	setName ($v)

	setValue ($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 ()

	setPage (Page $v=null)

	getPage (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)

	clear ()

	clearAllReferences ($deep=false)

	__toString ()

	isAlreadyInSave ()

	mayOperate ($sOperation, $oUser=false)

	mayBeInserted ($oUser=false)

	mayBeUpdated ($oUser=false)

	mayBeDeleted ($oUser=false)

	keepUpdateDateUnchanged ()

	getCreatedAtTimestamp ()

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

	getUpdatedAtTimestamp ()

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

	keepUpdateUserUnchanged ()

	getPKArray ()

	getPKString ()

Public Attributes
const	PEER = 'PagePropertyPeer'

Protected Member Functions
	doSave (PropelPDO $con)

	doInsert (PropelPDO $con)

	doUpdate (PropelPDO $con)

	doValidate ($columns=null)

Protected Attributes
	$startCopy = false

	$id

	$page_id

	$name

	$value

	$created_at

	$updated_at

	$created_by

	$updated_by

	$aPage

	$aUserRelatedByCreatedBy

	$aUserRelatedByUpdatedBy

	$alreadyInSave = false

	$alreadyInValidation = false

	$alreadyInClearAllReferencesDeep = false

	$validationFailures = array()

Static Protected Attributes
static	$peer

Member Function Documentation

BasePageProperty::__toString ( )

return the string representation of this object

Returns: string

BasePageProperty::buildCriteria ( )

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

Returns: Criteria The Criteria object containing all modified values.

BasePageProperty::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).

BasePageProperty::clear ( )

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

BasePageProperty::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.

BasePageProperty::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: PageProperty Clone of current object.

Exceptions

PropelException

BasePageProperty::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 PageProperty (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

BasePageProperty::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()

BasePageProperty::doInsert ( PropelPDO $con )

protected

Insert the row in the database.

Parameters

PropelPDO $con

Exceptions

PropelException

See also: doSave()

BasePageProperty::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()

BasePageProperty::doUpdate ( PropelPDO $con )

protected

Update the row in the database.

Parameters

PropelPDO $con

See also: doSave()

BasePageProperty::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.

BasePageProperty::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

BasePageProperty::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

BasePageProperty::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.

BasePageProperty::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

BasePageProperty::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.

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

Returns: created_at formatted to the current locale

BasePageProperty::getCreatedAtTimestamp ( )

Returns: created_at as int (timestamp)

BasePageProperty::getCreatedBy ( )

Get the [created_by] column value.

Returns: int

BasePageProperty::getId ( )

Get the [id] column value.

Returns: int

BasePageProperty::getName ( )

Get the [name] column value.

Returns: string

BasePageProperty::getPage	(	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

BasePageProperty::getPageId ( )

Get the [page_id] column value.

Returns: int

BasePageProperty::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: PagePropertyPeer

BasePageProperty::getPKArray ( )

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

BasePageProperty::getPKString ( )

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

BasePageProperty::getPrimaryKey ( )

Returns the primary key for this object (row).

Returns: int

BasePageProperty::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.

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

Returns: updated_at formatted to the current locale

BasePageProperty::getUpdatedAtTimestamp ( )

Returns: updated_at as int (timestamp)

BasePageProperty::getUpdatedBy ( )

Get the [updated_by] column value.

Returns: int

BasePageProperty::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

BasePageProperty::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

BasePageProperty::getValidationFailures ( )

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

Returns: array ValidationFailed[]

See also: validate()

BasePageProperty::getValue ( )

Get the [value] column value.

Returns: string

BasePageProperty::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.

BasePageProperty::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.

BasePageProperty::isAlreadyInSave ( )

return true is the object is in saving state

Returns: boolean

BasePageProperty::isPrimaryKeyNull ( )

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

Returns: boolean

BasePageProperty::keepUpdateDateUnchanged ( )

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

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

BasePageProperty::keepUpdateUserUnchanged ( )

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

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

BasePageProperty::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

BasePageProperty::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()

BasePageProperty::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

BasePageProperty::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

BasePageProperty::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: PageProperty The current object (for fluent API support)

BasePageProperty::setCreatedBy ( $v )

Set the value of [created_by] column.

Parameters

int $v new value

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

BasePageProperty::setId ( $v )

Set the value of [id] column.

Parameters

int $v new value

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

BasePageProperty::setName ( $v )

Set the value of [name] column.

Parameters

string $v new value

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

BasePageProperty::setPage ( Page $v = null )

Declares an association between this object and a Page object.

Parameters

Page $v

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

Exceptions

PropelException

BasePageProperty::setPageId ( $v )

Set the value of [page_id] column.

Parameters

int $v new value

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

BasePageProperty::setPrimaryKey ( $key )

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

Parameters

int $key Primary key.

Returns: void

BasePageProperty::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: PageProperty The current object (for fluent API support)

BasePageProperty::setUpdatedBy ( $v )

Set the value of [updated_by] column.

Parameters

int $v new value

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

BasePageProperty::setUserRelatedByCreatedBy ( User $v = null )

Declares an association between this object and a User object.

Parameters

User $v

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

Exceptions

PropelException

BasePageProperty::setUserRelatedByUpdatedBy ( User $v = null )

Declares an association between this object and a User object.

Parameters

User $v

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

Exceptions

PropelException

BasePageProperty::setValue ( $v )

Set the value of [value] column.

Parameters

string $v new value

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

BasePageProperty::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

BasePageProperty::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 BasePageProperty::PEER = 'PagePropertyPeer'

Peer class name

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Function Documentation

Member Data Documentation