rapila
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Page Class Reference
Inheritance diagram for Page:
BasePage

Public Member Functions

 setName ($sName)
 
 getChildByName ($sName)
 
 getActivePageString ($sLanguageId=null)
 
 getDescription ($sLanguageId=null)
 
 getConsolidatedKeywords ($sLanguageId=null, $bReturnArray=false)
 
 getPageStringByLanguage ($sLanguageId)
 
 hasPageStringByLanguage ($sLanguageId, $bOnlyActive=true)
 
 getPageProperties ()
 
 getPagePropertyQuery ()
 
 getPagePropertyByName ($sPropertyName)
 
 getPagePropertyValue ($sPropertyName, $sDefaultValue=null)
 
 updatePageProperty ($sPropertyName, $sPropertyValue)
 
 addTempPageProperty ($sName, $sValue)
 
 getChildren ($oCriteria=null, PropelPDO $oConnection=null)
 
 getChildrenWith ($sLanguageId=null, $bIncludeDisabled=false, $bIncludeInvisible=false)
 
 countChildrenWith ($sLanguageId=null, $bIncludeDisabled=false, $bIncludeInvisible=false)
 
 hasChildrenWith ($sLanguageId=null, $bIncludeDisabled=false, $bIncludeInvisible=false)
 
 isFolder ()
 
 isLoginPage ()
 
 isOfType ($sType)
 
 getLoginPage ()
 
 getPageOfType ($sPageType)
 
 getPageOfName ($sName)
 
 getLinkText ($sLanguageId=null)
 
 getPageTitle ($sLanguageId=null)
 
 getTemplateNameUsed ()
 
 getTemplate ($bDirectOutput=false)
 
 getObjectsForContainerCriteria ($sContainerName)
 
 getObjectsForContainer ($sContainerName, $mEqualHigherSort=null, $bSortAsc=false)
 
 countObjectsForContainer ($sContainerName)
 
 getFirstEnabledChild ($sLanguageId=null, $iLevel=0)
 
 shouldBeIncludedInList ($sLanguageId, $oPage)
 
 renderListItem ($oTemplate)
 
 getFullPathArray (array $aSubpages=array())
 
 getLink ()
 
 getLinkArray ()
 
 getCanonical ()
 
 deletePageAndDescendants ()
 
 getOldParent ()
 
- Public Member Functions inherited from BasePage
 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 ()
 

Public Attributes

const DELETE_NOT_ALLOWED_CODE = 11
 
const REFERENCE_EXISTS_CODE = 44
 
- Public Attributes inherited from BasePage
const PEER = 'PagePeer'
 
const TAG_MODEL_NAME = 'Tag'
 
const TAG_INSTANCE_MODEL_NAME = 'TagInstance'
 

Protected Member Functions

 moveSubtreeTo ($destLeft, $levelDelta, PropelPDO $con=null)
 Override moveSubtreeTo to store the old parent.
 
- Protected Member Functions inherited from BasePage
 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)
 

Additional Inherited Members

- Static Public Member Functions inherited from BasePage
static addTagTo ($sPageId, $mTag)
 
static removeTagFrom ($sPageId, $mTag)
 
static removeAllTagsFrom ($sPageId)
 
static tagsFor ($sPageId=null, $sReturn= 'tag')
 
- Protected Attributes inherited from BasePage
 $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 inherited from BasePage
static $peer
 

Member Function Documentation

Page::addTempPageProperty (   $sName,
  $sValue 
)

Add a temporary page property to the page for the duration of the request.

Page::getFullPathArray ( array  $aSubpages = array())

Returns the path leading to this page.

Parameters
array$aSubpagesAn array to append to the output
Page::getLink ( )
Page::getLinkArray ( )

Exploded alias of getFullPathArray(). All params given to this method will be passed as the first parameter of getFullPathArray.

Page::getPageProperties ( )
Deprecated:
use getPagePropertyQuery() instead
Page::updatePageProperty (   $sPropertyName,
  $sPropertyValue 
)

Updated page properties: changes them if they exist and creates them otherwise.

Parameters
$sPropertyNamethe property name
$sPropertyValuethe new value. Set null if you wish to remove the property

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