class Folder extends Folder implements FileModelParentInterface

Traits

A trait to provide event dispatching mechanism to Model objects
A trait for managing Rewritten URLs from model classes

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

from  Folder
__construct()

Initializes internal state of Thelia\Model\Base\Folder object.

from  Folder
boolean
isModified()

Returns whether the object has been modified.

from  Folder
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Folder
array
getModifiedColumns()

Get the columns that have been modified in this object.

from  Folder
boolean
isNew()

Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.

from  Folder
setNew( boolean $b)

Setter for the isNew attribute. This method will be called by Propel-generated children and objects.

from  Folder
boolean
isDeleted()

Whether this object has been deleted.

from  Folder
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Folder
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Folder
boolean
equals( mixed $obj)

Compares this with another Folder instance. If obj is an instance of Folder, delegates to equals(Folder). Otherwise, returns false.

from  Folder
int
hashCode()

If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.

from  Folder
array
getVirtualColumns()

Get the associative array of the virtual columns in this object

from  Folder
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Folder
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

from  Folder
setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

from  Folder
importFrom( mixed $parser, string $data)

Populate the current object from a string, using a given parser format $book = new Book(); $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

from  Folder
string
exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)

Export the current object properties to a string, using a given parser format $book = BookQuery::create()->findPk(9012); echo $book->exportTo('JSON'); => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

from  Folder
__sleep()

No description

int
getId()

Get the [id] column value.

from  Folder
int
getParent()

Get the [parent] column value.

from  Folder
int
getVisible()

Get the [visible] column value.

from  Folder
int
getPosition()

Get the [position] column value.

from  Folder
mixed
getCreatedAt( string $format = NULL)

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

from  Folder
mixed
getUpdatedAt( string $format = NULL)

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

from  Folder
int
getVersion()

Get the [version] column value.

from  Folder
mixed
getVersionCreatedAt( string $format = NULL)

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

from  Folder
string
getVersionCreatedBy()

Get the [versioncreatedby] column value.

from  Folder
setId( int $v)

Set the value of [id] column.

from  Folder
setParent( int $v)

Set the value of [parent] column.

from  Folder
setVisible( int $v)

Set the value of [visible] column.

from  Folder
setPosition( int $v)

Set the value of [position] column.

from  Folder
setCreatedAt( mixed $v)

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

from  Folder
setUpdatedAt( mixed $v)

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

from  Folder
setVersion( int $v)

Set the value of [version] column.

from  Folder
setVersionCreatedAt( mixed $v)

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

from  Folder
setVersionCreatedBy( string $v)

Set the value of [versioncreatedby] column.

from  Folder
boolean
hasOnlyDefaultValues()

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

from  Folder
int
hydrate( array $row, int $startcol, boolean $rehydrate = false, string $indexType = TableMap::TYPE_NUM)

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

from  Folder
ensureConsistency()

Checks and repairs the internal consistency of the object.

from  Folder
void
reload( boolean $deep = false, ConnectionInterface $con = null)

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

from  Folder
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Folder
int
save( ConnectionInterface $con = null)

Persists this object to the database.

from  Folder
mixed
getByName( string $name, string $type = TableMap::TYPE_PHPNAME)

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

from  Folder
mixed
getByPosition( int $pos)

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

from  Folder
array
toArray( string $keyType = TableMap::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array(), boolean $includeForeignObjects = false)

Exports the object as an array.

from  Folder
void
setByName( string $name, mixed $value, string $type = TableMap::TYPE_PHPNAME)

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

from  Folder
void
setByPosition( int $pos, mixed $value)

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

from  Folder
void
fromArray( array $arr, string $keyType = TableMap::TYPE_PHPNAME)

Populates the object using an array.

from  Folder
Criteria
buildCriteria()

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

from  Folder
Criteria
buildPkeyCriteria()

Builds a Criteria object containing the primary key for this object.

from  Folder
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Folder
void
setPrimaryKey( int $key)

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

from  Folder
boolean
isPrimaryKeyNull()

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

from  Folder
copyInto( object $copyObj, boolean $deepCopy = false, boolean $makeNew = true)

Sets contents of passed object to values from current object.

from  Folder
copy( boolean $deepCopy = false)

Makes a copy of this object that will be inserted as a new row in table when saved.

from  Folder
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  Folder
void
clearContentFolders()

Clears out the collContentFolders collection

from  Folder
resetPartialContentFolders($v = true)

Reset is the collContentFolders collection loaded partially.

from  Folder
void
initContentFolders( boolean $overrideExisting = true)

Initializes the collContentFolders collection.

from  Folder
Collection|ContentFolder[]
getContentFolders( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Folder
setContentFolders( Collection $contentFolders, ConnectionInterface $con = null)

Sets a collection of ContentFolder objects related by a one-to-many relationship to the current object.

from  Folder
int
countContentFolders( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related ContentFolder objects.

from  Folder
addContentFolder( ContentFolder $l)

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

from  Folder
removeContentFolder( ContentFolder $contentFolder)

No description

from  Folder
Collection|ContentFolder[]
getContentFoldersJoinContent( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  Folder
void
clearFolderImages()

Clears out the collFolderImages collection

from  Folder
resetPartialFolderImages($v = true)

Reset is the collFolderImages collection loaded partially.

from  Folder
void
initFolderImages( boolean $overrideExisting = true)

Initializes the collFolderImages collection.

from  Folder
Collection|FolderImage[]
getFolderImages( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Folder
setFolderImages( Collection $folderImages, ConnectionInterface $con = null)

Sets a collection of FolderImage objects related by a one-to-many relationship to the current object.

from  Folder
int
countFolderImages( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderImage objects.

from  Folder
addFolderImage( FolderImage $l)

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

from  Folder
removeFolderImage( FolderImage $folderImage)

No description

from  Folder
void
clearFolderDocuments()

Clears out the collFolderDocuments collection

from  Folder
resetPartialFolderDocuments($v = true)

Reset is the collFolderDocuments collection loaded partially.

from  Folder
void
initFolderDocuments( boolean $overrideExisting = true)

Initializes the collFolderDocuments collection.

from  Folder
Collection|FolderDocument[]
getFolderDocuments( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Folder
setFolderDocuments( Collection $folderDocuments, ConnectionInterface $con = null)

Sets a collection of FolderDocument objects related by a one-to-many relationship to the current object.

from  Folder
int
countFolderDocuments( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderDocument objects.

from  Folder
addFolderDocument( FolderDocument $l)

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

from  Folder
removeFolderDocument( FolderDocument $folderDocument)

No description

from  Folder
void
clearFolderI18ns()

Clears out the collFolderI18ns collection

from  Folder
resetPartialFolderI18ns($v = true)

Reset is the collFolderI18ns collection loaded partially.

from  Folder
void
initFolderI18ns( boolean $overrideExisting = true)

Initializes the collFolderI18ns collection.

from  Folder
Collection|FolderI18n[]
getFolderI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Folder
setFolderI18ns( Collection $folderI18ns, ConnectionInterface $con = null)

Sets a collection of FolderI18n objects related by a one-to-many relationship to the current object.

from  Folder
int
countFolderI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderI18n objects.

from  Folder
addFolderI18n( FolderI18n $l)

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

from  Folder
removeFolderI18n( FolderI18n $folderI18n)

No description

from  Folder
void
clearFolderVersions()

Clears out the collFolderVersions collection

from  Folder
resetPartialFolderVersions($v = true)

Reset is the collFolderVersions collection loaded partially.

from  Folder
void
initFolderVersions( boolean $overrideExisting = true)

Initializes the collFolderVersions collection.

from  Folder
Collection|FolderVersion[]
getFolderVersions( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Folder
setFolderVersions( Collection $folderVersions, ConnectionInterface $con = null)

Sets a collection of FolderVersion objects related by a one-to-many relationship to the current object.

from  Folder
int
countFolderVersions( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderVersion objects.

from  Folder
addFolderVersion( FolderVersion $l)

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

from  Folder
removeFolderVersion( FolderVersion $folderVersion)

No description

from  Folder
void
clearContents()

Clears out the collContents collection

from  Folder
void
initContents()

Initializes the collContents collection.

from  Folder
ObjectCollection|Content[]
getContents( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildContent objects related by a many-to-many relationship to the current object by way of the content_folder cross-reference table.

from  Folder
setContents( Collection $contents, ConnectionInterface $con = null)

Sets a collection of Content objects related by a many-to-many relationship to the current object by way of the content_folder cross-reference table.

from  Folder
int
countContents( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Gets the number of ChildContent objects related by a many-to-many relationship to the current object by way of the content_folder cross-reference table.

from  Folder
addContent( Content $content)

Associate a ChildContent object to this object through the content_folder cross reference table.

from  Folder
removeContent( Content $content)

Remove a ChildContent object to this object through the content_folder cross reference table.

from  Folder
clear()

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

from  Folder
clearAllReferences( boolean $deep = false)

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

from  Folder
string
__toString()

Return the string representation of this object

from  Folder
keepUpdateDateUnchanged()

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

from  Folder
setLocale( string $locale = 'en_US')

Sets the locale for translations

from  Folder
string
getLocale()

Gets the locale for translations

from  Folder
getTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Returns the current translation for a given locale

from  Folder
removeTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Remove the translation for a given locale

from  Folder
getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

from  Folder
string
getTitle()

Get the [title] column value.

from  Folder
setTitle( string $v)

Set the value of [title] column.

from  Folder
string
getDescription()

Get the [description] column value.

from  Folder
setDescription( string $v)

Set the value of [description] column.

from  Folder
string
getChapo()

Get the [chapo] column value.

from  Folder
setChapo( string $v)

Set the value of [chapo] column.

from  Folder
string
getPostscriptum()

Get the [postscriptum] column value.

from  Folder
setPostscriptum( string $v)

Set the value of [postscriptum] column.

from  Folder
string
getMetaTitle()

Get the [meta_title] column value.

from  Folder
setMetaTitle( string $v)

Set the value of [meta_title] column.

from  Folder
string
getMetaDescription()

Get the [meta_description] column value.

from  Folder
setMetaDescription( string $v)

Set the value of [meta_description] column.

from  Folder
string
getMetaKeywords()

Get the [meta_keywords] column value.

from  Folder
setMetaKeywords( string $v)

Set the value of [meta_keywords] column.

from  Folder
enforceVersioning()

Enforce a new Version of this object upon next save.

from  Folder
boolean
isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

from  Folder
addVersion( ConnectionInterface $con = null)

Creates a version of the current object and saves it.

from  Folder
toVersion( integer $versionNumber, ConnectionInterface $con = null)

Sets the properties of the current object to the value they had at a specific version

from  Folder
populateFromVersion( FolderVersion $version, ConnectionInterface $con = null, array $loadedObjects = array())

Sets the properties of the current object to the value they had at a specific version

from  Folder
integer
getLastVersionNumber( ConnectionInterface $con = null)

Gets the latest persisted version number for the current object

from  Folder
Boolean
isLastVersion( ConnectionInterface $con = null)

Checks whether the current object is the latest one

from  Folder
getOneVersion( integer $versionNumber, ConnectionInterface $con = null)

Retrieves a version object for this entity and a version number

from  Folder
ObjectCollection
getAllVersions( ConnectionInterface $con = null)

Gets all the versions of this object, in incremental order

from  Folder
array
compareVersion( integer $versionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares the current object with another of its version.

from  Folder
array
compareVersions( integer $fromVersionNumber, integer $toVersionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares two versions of the current object.

from  Folder
PropelCollection|array
getLastVersions($number = 10, $criteria = null, $con = null)

retrieve the last $number versions.

from  Folder
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  Folder
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

from  Folder
boolean
preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

boolean
preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

array|string
__call( string $name, mixed $params)

Derived method to catches calls to undefined methods.

from  Folder
$this
setDispatcher( EventDispatcherInterface $dispatcher)

No description

getDispatcher()

No description

clearDispatcher()

No description

getNextPosition()

Get the position of the next inserted object

movePositionUp()

Move up a object

movePositionDown()

Move down a object

changeAbsolutePosition( newPosition $newPosition)

Changes object position

getRewrittenUrlViewName()

{@inheritDoc}

getUrl( string $locale = null)

Get the object URL for the given locale, rewritten if rewriting is enabled.

generateRewrittenUrl( string $locale)

Generate a rewritten URL from the object title, and store it in the rewriting table

null
getRewrittenUrl( string $locale)

return the rewritten URL for the given locale

markRewrittenUrlObsolete()

Mark the current URL as obseolete

$this
setRewrittenUrl( string $locale, $url)

Set the rewritten URL for the given locale

int
countChild()

No description

int
countAllContents()

count all products for current category and sub categories

mixed
getRoot( int $folderId)

Get the root folder

Details

in Folder at line 234
applyDefaultValues()

Applies default values to this object.

This method should be called from the object's constructor (or equivalent initialization method).

See also

__construct()

in Folder at line 244
__construct()

Initializes internal state of Thelia\Model\Base\Folder object.

See also

applyDefaults()

in Folder at line 254
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Folder at line 265
boolean isColumnModified( string $col)

Has specified column been modified?

Parameters

string $col column fully qualified name (TableMap::TYPECOLNAME), e.g. Book::AUTHORID

Return Value

boolean True if $col has been modified.

in Folder at line 274
array getModifiedColumns()

Get the columns that have been modified in this object.

Return Value

array A unique list of the modified column names for this object.

in Folder at line 286
boolean isNew()

Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.

Return Value

boolean true, if the object has never been persisted.

in Folder at line 297
setNew( boolean $b)

Setter for the isNew attribute. This method will be called by Propel-generated children and objects.

Parameters

boolean $b the state of the object.

in Folder at line 306
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Folder at line 316
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Folder at line 326
void resetModified( string $col = null)

Sets the modified state for the object to be false.

Parameters

string $col If supplied, only the specified column is reset.

Return Value

void

in Folder at line 345
boolean equals( mixed $obj)

Compares this with another Folder instance. If obj is an instance of Folder, delegates to equals(Folder). Otherwise, returns false.

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Folder at line 370
int hashCode()

If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.

Return Value

int Hashcode

in Folder at line 384
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Folder at line 395
boolean hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

Parameters

string $name The virtual column name

Return Value

boolean

in Folder at line 408
mixed getVirtualColumn( string $name)

Get the value of a virtual column in this object

Parameters

string $name The virtual column name

Return Value

mixed

Exceptions

PropelException

in Folder at line 425
Folder setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

Parameters

string $name The virtual column name
mixed $value The value to give to the virtual column

Return Value

Folder The current object, for fluid interface

in Folder at line 457
Folder importFrom( mixed $parser, string $data)

Populate the current object from a string, using a given parser format $book = new Book(); $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

Parameters

mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
string $data The source data to import from

Return Value

Folder The current object, for fluid interface

in Folder at line 480
string exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)

Export the current object properties to a string, using a given parser format $book = BookQuery::create()->findPk(9012); echo $book->exportTo('JSON'); => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

Parameters

mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
boolean $includeLazyLoadColumns (optional) Whether to include lazy load(ed) columns. Defaults to TRUE.

Return Value

string The exported data

__sleep()

in Folder at line 505
int getId()

Get the [id] column value.

Return Value

int

in Folder at line 516
int getParent()

Get the [parent] column value.

Return Value

int

in Folder at line 527
int getVisible()

Get the [visible] column value.

Return Value

int

in Folder at line 538
int getPosition()

Get the [position] column value.

Return Value

int

in Folder at line 555
mixed getCreatedAt( string $format = NULL)

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.

Return Value

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.

in Folder at line 575
mixed getUpdatedAt( string $format = NULL)

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.

Return Value

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.

in Folder at line 589
int getVersion()

Get the [version] column value.

Return Value

int

in Folder at line 606
mixed getVersionCreatedAt( string $format = NULL)

Get the [optionally formatted] temporal [versioncreatedat] 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.

Return Value

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.

in Folder at line 620
string getVersionCreatedBy()

Get the [versioncreatedby] column value.

Return Value

string

in Folder at line 632
Folder setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Folder The current object (for fluent API support)

in Folder at line 653
Folder setParent( int $v)

Set the value of [parent] column.

Parameters

int $v new value

Return Value

Folder The current object (for fluent API support)

in Folder at line 674
Folder setVisible( int $v)

Set the value of [visible] column.

Parameters

int $v new value

Return Value

Folder The current object (for fluent API support)

in Folder at line 695
Folder setPosition( int $v)

Set the value of [position] column.

Parameters

int $v new value

Return Value

Folder The current object (for fluent API support)

in Folder at line 717
Folder setCreatedAt( mixed $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.

Return Value

Folder The current object (for fluent API support)

in Folder at line 738
Folder setUpdatedAt( mixed $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.

Return Value

Folder The current object (for fluent API support)

in Folder at line 758
Folder setVersion( int $v)

Set the value of [version] column.

Parameters

int $v new value

Return Value

Folder The current object (for fluent API support)

in Folder at line 780
Folder setVersionCreatedAt( mixed $v)

Sets the value of [versioncreatedat] 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.

Return Value

Folder The current object (for fluent API support)

in Folder at line 800
Folder setVersionCreatedBy( string $v)

Set the value of [versioncreatedby] column.

Parameters

string $v new value

Return Value

Folder The current object (for fluent API support)

in Folder at line 823
boolean 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.

Return Value

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

in Folder at line 855
int hydrate( array $row, int $startcol, boolean $rehydrate = false, string $indexType = TableMap::TYPE_NUM)

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 DataFetcher->fetch().
int $startcol 0-based offset column which indicates which restultset column to start with.
boolean $rehydrate Whether this object is being re-hydrated from the database.
string $indexType The index type of $row. Mostly DataFetcher->getIndexType(). One of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPE_NUM.

Return Value

int next starting column

Exceptions

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

in Folder at line 923
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

in Folder at line 937
void reload( boolean $deep = false, ConnectionInterface $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.
ConnectionInterface $con (optional) The ConnectionInterface connection to use.

Return Value

void

Exceptions

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

in Folder at line 987
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Folder::setDeleted()
Folder::isDeleted()

in Folder at line 1029
int save( ConnectionInterface $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

ConnectionInterface $con

Return Value

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

Exceptions

PropelException

See also

doSave()

in Folder at line 1367
mixed getByName( string $name, string $type = TableMap::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 TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.

Return Value

mixed Value of field.

in Folder at line 1382
mixed getByPosition( int $pos)

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

Zero-based.

Parameters

int $pos position in xml schema

Return Value

mixed Value of field at $pos

in Folder at line 1433
array toArray( string $keyType = TableMap::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array(), boolean $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 TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME, TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.
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.

Return Value

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

in Folder at line 1488
void setByName( string $name, mixed $value, string $type = TableMap::TYPE_PHPNAME)

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

Parameters

string $name
mixed $value field value
string $type The type of fieldname the $name is of: one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.

Return Value

void

in Folder at line 1503
void setByPosition( int $pos, mixed $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

Return Value

void

in Folder at line 1553
void fromArray( array $arr, string $keyType = TableMap::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 TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME, TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. The default key type is the column's TableMap::TYPEPHPNAME.

Parameters

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

Return Value

void

in Folder at line 1573
Criteria buildCriteria()

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

Return Value

Criteria The Criteria object containing all modified values.

in Folder at line 1598
Criteria 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.

Return Value

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

in Folder at line 1610
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Folder at line 1621
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Folder at line 1630
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Folder at line 1647
copyInto( object $copyObj, boolean $deepCopy = false, boolean $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 \Thelia\Model\Folder (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

in Folder at line 1713
Folder copy( boolean $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.

Return Value

Folder Clone of current object.

Exceptions

PropelException

in Folder at line 1732
void initRelation( string $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

Return Value

void

in Folder at line 1760
void clearContentFolders()

Clears out the collContentFolders 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.

Return Value

void

See also

addContentFolders()

in Folder at line 1768
resetPartialContentFolders($v = true)

Reset is the collContentFolders collection loaded partially.

Parameters

$v

in Folder at line 1785
void initContentFolders( boolean $overrideExisting = true)

Initializes the collContentFolders collection.

By default this just sets the collContentFolders collection to an empty array (like clearcollContentFolders()); 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

Return Value

void

in Folder at line 1808
Collection|ContentFolder[] getContentFolders( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildContentFolder 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 ChildFolder 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
ConnectionInterface $con optional connection object

Return Value

Collection|ContentFolder[] List of ChildContentFolder objects

Exceptions

PropelException

in Folder at line 1864
Folder setContentFolders( Collection $contentFolders, ConnectionInterface $con = null)

Sets a collection of ContentFolder 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

Collection $contentFolders A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Folder The current object (for fluent API support)

in Folder at line 1898
int countContentFolders( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related ContentFolder objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related ContentFolder objects.

Exceptions

PropelException

in Folder at line 1930
Folder addContentFolder( ContentFolder $l)

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

Parameters

ContentFolder $l ChildContentFolder

Return Value

Folder The current object (for fluent API support)

in Folder at line 1957
Folder removeContentFolder( ContentFolder $contentFolder)

Parameters

ContentFolder $contentFolder The contentFolder object to remove.

Return Value

Folder The current object (for fluent API support)

in Folder at line 1989
Collection|ContentFolder[] getContentFoldersJoinContent( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this Folder is new, it will return an empty collection; or if this Folder has previously been saved, it will retrieve related ContentFolders 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 Folder.

Parameters

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

Return Value

Collection|ContentFolder[] List of ChildContentFolder objects

in Folder at line 2006
void clearFolderImages()

Clears out the collFolderImages 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.

Return Value

void

See also

addFolderImages()

in Folder at line 2014
resetPartialFolderImages($v = true)

Reset is the collFolderImages collection loaded partially.

Parameters

$v

in Folder at line 2031
void initFolderImages( boolean $overrideExisting = true)

Initializes the collFolderImages collection.

By default this just sets the collFolderImages collection to an empty array (like clearcollFolderImages()); 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

Return Value

void

in Folder at line 2054
Collection|FolderImage[] getFolderImages( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildFolderImage 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 ChildFolder 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
ConnectionInterface $con optional connection object

Return Value

Collection|FolderImage[] List of ChildFolderImage objects

Exceptions

PropelException

in Folder at line 2110
Folder setFolderImages( Collection $folderImages, ConnectionInterface $con = null)

Sets a collection of FolderImage 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

Collection $folderImages A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Folder The current object (for fluent API support)

in Folder at line 2141
int countFolderImages( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderImage objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related FolderImage objects.

Exceptions

PropelException

in Folder at line 2173
Folder addFolderImage( FolderImage $l)

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

Parameters

FolderImage $l ChildFolderImage

Return Value

Folder The current object (for fluent API support)

in Folder at line 2200
Folder removeFolderImage( FolderImage $folderImage)

Parameters

FolderImage $folderImage The folderImage object to remove.

Return Value

Folder The current object (for fluent API support)

in Folder at line 2224
void clearFolderDocuments()

Clears out the collFolderDocuments 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.

Return Value

void

See also

addFolderDocuments()

in Folder at line 2232
resetPartialFolderDocuments($v = true)

Reset is the collFolderDocuments collection loaded partially.

Parameters

$v

in Folder at line 2249
void initFolderDocuments( boolean $overrideExisting = true)

Initializes the collFolderDocuments collection.

By default this just sets the collFolderDocuments collection to an empty array (like clearcollFolderDocuments()); 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

Return Value

void

in Folder at line 2272
Collection|FolderDocument[] getFolderDocuments( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildFolderDocument 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 ChildFolder 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
ConnectionInterface $con optional connection object

Return Value

Collection|FolderDocument[] List of ChildFolderDocument objects

Exceptions

PropelException

in Folder at line 2328
Folder setFolderDocuments( Collection $folderDocuments, ConnectionInterface $con = null)

Sets a collection of FolderDocument 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

Collection $folderDocuments A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Folder The current object (for fluent API support)

in Folder at line 2359
int countFolderDocuments( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderDocument objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related FolderDocument objects.

Exceptions

PropelException

in Folder at line 2391
Folder addFolderDocument( FolderDocument $l)

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

Parameters

FolderDocument $l ChildFolderDocument

Return Value

Folder The current object (for fluent API support)

in Folder at line 2418
Folder removeFolderDocument( FolderDocument $folderDocument)

Parameters

FolderDocument $folderDocument The folderDocument object to remove.

Return Value

Folder The current object (for fluent API support)

in Folder at line 2442
void clearFolderI18ns()

Clears out the collFolderI18ns 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.

Return Value

void

See also

addFolderI18ns()

in Folder at line 2450
resetPartialFolderI18ns($v = true)

Reset is the collFolderI18ns collection loaded partially.

Parameters

$v

in Folder at line 2467
void initFolderI18ns( boolean $overrideExisting = true)

Initializes the collFolderI18ns collection.

By default this just sets the collFolderI18ns collection to an empty array (like clearcollFolderI18ns()); 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

Return Value

void

in Folder at line 2490
Collection|FolderI18n[] getFolderI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildFolderI18n 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 ChildFolder 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
ConnectionInterface $con optional connection object

Return Value

Collection|FolderI18n[] List of ChildFolderI18n objects

Exceptions

PropelException

in Folder at line 2546
Folder setFolderI18ns( Collection $folderI18ns, ConnectionInterface $con = null)

Sets a collection of FolderI18n 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

Collection $folderI18ns A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Folder The current object (for fluent API support)

in Folder at line 2580
int countFolderI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related FolderI18n objects.

Exceptions

PropelException

in Folder at line 2612
Folder addFolderI18n( FolderI18n $l)

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

Parameters

FolderI18n $l ChildFolderI18n

Return Value

Folder The current object (for fluent API support)

in Folder at line 2643
Folder removeFolderI18n( FolderI18n $folderI18n)

Parameters

FolderI18n $folderI18n The folderI18n object to remove.

Return Value

Folder The current object (for fluent API support)

in Folder at line 2667
void clearFolderVersions()

Clears out the collFolderVersions 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.

Return Value

void

See also

addFolderVersions()

in Folder at line 2675
resetPartialFolderVersions($v = true)

Reset is the collFolderVersions collection loaded partially.

Parameters

$v

in Folder at line 2692
void initFolderVersions( boolean $overrideExisting = true)

Initializes the collFolderVersions collection.

By default this just sets the collFolderVersions collection to an empty array (like clearcollFolderVersions()); 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

Return Value

void

in Folder at line 2715
Collection|FolderVersion[] getFolderVersions( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildFolderVersion 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 ChildFolder 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
ConnectionInterface $con optional connection object

Return Value

Collection|FolderVersion[] List of ChildFolderVersion objects

Exceptions

PropelException

in Folder at line 2771
Folder setFolderVersions( Collection $folderVersions, ConnectionInterface $con = null)

Sets a collection of FolderVersion 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

Collection $folderVersions A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Folder The current object (for fluent API support)

in Folder at line 2805
int countFolderVersions( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderVersion objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related FolderVersion objects.

Exceptions

PropelException

in Folder at line 2837
Folder addFolderVersion( FolderVersion $l)

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

Parameters

FolderVersion $l ChildFolderVersion

Return Value

Folder The current object (for fluent API support)

in Folder at line 2864
Folder removeFolderVersion( FolderVersion $folderVersion)

Parameters

FolderVersion $folderVersion The folderVersion object to remove.

Return Value

Folder The current object (for fluent API support)

in Folder at line 2888
void clearContents()

Clears out the collContents 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.

Return Value

void

See also

addContents()

in Folder at line 2903
void initContents()

Initializes the collContents collection.

By default this just sets the collContents collection to an empty collection (like clearContents()); 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.

Return Value

void

in Folder at line 2924
ObjectCollection|Content[] getContents( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildContent objects related by a many-to-many relationship to the current object by way of the content_folder cross-reference table.

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 ChildFolder is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria $criteria Optional query object to filter the query
ConnectionInterface $con Optional connection object

Return Value

ObjectCollection|Content[] List of ChildContent objects

in Folder at line 2954
Folder setContents( Collection $contents, ConnectionInterface $con = null)

Sets a collection of Content objects related by a many-to-many relationship to the current object by way of the content_folder cross-reference table.

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

Collection $contents A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Folder The current object (for fluent API support)

in Folder at line 2982
int countContents( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Gets the number of ChildContent objects related by a many-to-many relationship to the current object by way of the content_folder cross-reference table.

Parameters

Criteria $criteria Optional query object to filter the query
boolean $distinct Set to true to force count distinct
ConnectionInterface $con Optional connection object

Return Value

int the number of related ChildContent objects

in Folder at line 3009
Folder addContent( Content $content)

Associate a ChildContent object to this object through the content_folder cross reference table.

Parameters

Content $content The ChildContentFolder object to relate

Return Value

Folder The current object (for fluent API support)

in Folder at line 3046
Folder removeContent( Content $content)

Remove a ChildContent object to this object through the content_folder cross reference table.

Parameters

Content $content The ChildContentFolder object to relate

Return Value

Folder The current object (for fluent API support)

in Folder at line 3065
clear()

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

in Folder at line 3093
clearAllReferences( boolean $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.

in Folder at line 3145
string __toString()

Return the string representation of this object

Return Value

string

in Folder at line 3157
Folder keepUpdateDateUnchanged()

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

Return Value

Folder The current object (for fluent API support)

in Folder at line 3173
Folder setLocale( string $locale = 'en_US')

Sets the locale for translations

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'

Return Value

Folder The current object (for fluent API support)

in Folder at line 3185
string getLocale()

Gets the locale for translations

Return Value

string $locale Locale to use for the translation, e.g. 'fr_FR'

in Folder at line 3197
FolderI18n getTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Returns the current translation for a given locale

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'
ConnectionInterface $con an optional connection object

Return Value

FolderI18n

in Folder at line 3232
Folder removeTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Remove the translation for a given locale

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'
ConnectionInterface $con an optional connection object

Return Value

Folder The current object (for fluent API support)

in Folder at line 3258
FolderI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

FolderI18n

in Folder at line 3269
string getTitle()

Get the [title] column value.

Return Value

string

in Folder at line 3281
FolderI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

FolderI18n The current object (for fluent API support)

in Folder at line 3293
string getDescription()

Get the [description] column value.

Return Value

string

in Folder at line 3305
FolderI18n setDescription( string $v)

Set the value of [description] column.

Parameters

string $v new value

Return Value

FolderI18n The current object (for fluent API support)

in Folder at line 3317
string getChapo()

Get the [chapo] column value.

Return Value

string

in Folder at line 3329
FolderI18n setChapo( string $v)

Set the value of [chapo] column.

Parameters

string $v new value

Return Value

FolderI18n The current object (for fluent API support)

in Folder at line 3341
string getPostscriptum()

Get the [postscriptum] column value.

Return Value

string

in Folder at line 3353
FolderI18n setPostscriptum( string $v)

Set the value of [postscriptum] column.

Parameters

string $v new value

Return Value

FolderI18n The current object (for fluent API support)

in Folder at line 3365
string getMetaTitle()

Get the [meta_title] column value.

Return Value

string

in Folder at line 3377
FolderI18n setMetaTitle( string $v)

Set the value of [meta_title] column.

Parameters

string $v new value

Return Value

FolderI18n The current object (for fluent API support)

in Folder at line 3389
string getMetaDescription()

Get the [meta_description] column value.

Return Value

string

in Folder at line 3401
FolderI18n setMetaDescription( string $v)

Set the value of [meta_description] column.

Parameters

string $v new value

Return Value

FolderI18n The current object (for fluent API support)

in Folder at line 3413
string getMetaKeywords()

Get the [meta_keywords] column value.

Return Value

string

in Folder at line 3425
FolderI18n setMetaKeywords( string $v)

Set the value of [meta_keywords] column.

Parameters

string $v new value

Return Value

FolderI18n The current object (for fluent API support)

in Folder at line 3438
Folder enforceVersioning()

Enforce a new Version of this object upon next save.

Return Value

Folder

in Folder at line 3450
boolean isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

Parameters

$con

Return Value

boolean

in Folder at line 3474
FolderVersion addVersion( ConnectionInterface $con = null)

Creates a version of the current object and saves it.

Parameters

ConnectionInterface $con the connection to use

Return Value

FolderVersion A version object

in Folder at line 3502
Folder toVersion( integer $versionNumber, ConnectionInterface $con = null)

Sets the properties of the current object to the value they had at a specific version

Parameters

integer $versionNumber The version number to read
ConnectionInterface $con The connection to use

Return Value

Folder The current object (for fluent API support)

in Folder at line 3522
Folder populateFromVersion( FolderVersion $version, ConnectionInterface $con = null, array $loadedObjects = array())

Sets the properties of the current object to the value they had at a specific version

Parameters

FolderVersion $version The version object to use
ConnectionInterface $con the connection to use
array $loadedObjects objects that been loaded in a chain of populateFromVersion calls on referrer or fk objects.

Return Value

Folder The current object (for fluent API support)

in Folder at line 3545
integer getLastVersionNumber( ConnectionInterface $con = null)

Gets the latest persisted version number for the current object

Parameters

ConnectionInterface $con the connection to use

Return Value

integer

in Folder at line 3565
Boolean isLastVersion( ConnectionInterface $con = null)

Checks whether the current object is the latest one

Parameters

ConnectionInterface $con the connection to use

Return Value

Boolean

in Folder at line 3578
FolderVersion getOneVersion( integer $versionNumber, ConnectionInterface $con = null)

Retrieves a version object for this entity and a version number

Parameters

integer $versionNumber The version number to read
ConnectionInterface $con the connection to use

Return Value

FolderVersion A version object

in Folder at line 3593
ObjectCollection getAllVersions( ConnectionInterface $con = null)

Gets all the versions of this object, in incremental order

Parameters

ConnectionInterface $con the connection to use

Return Value

ObjectCollection A list of ChildFolderVersion objects

in Folder at line 3618
array compareVersion( integer $versionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares the current object with another of its version.

print_r($book->compareVersion(1)); => array( '1' => array('Title' => 'Book title at version 1'), '2' => array('Title' => 'Book title at version 2') );

Parameters

integer $versionNumber
string $keys Main key used for the result diff (versions|columns)
ConnectionInterface $con the connection to use
array $ignoredColumns The columns to exclude from the diff.

Return Value

array A list of differences

in Folder at line 3644
array compareVersions( integer $fromVersionNumber, integer $toVersionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares two versions of the current object.

print_r($book->compareVersions(1, 2)); => array( '1' => array('Title' => 'Book title at version 1'), '2' => array('Title' => 'Book title at version 2') );

Parameters

integer $fromVersionNumber
integer $toVersionNumber
string $keys Main key used for the result diff (versions|columns)
ConnectionInterface $con the connection to use
array $ignoredColumns The columns to exclude from the diff.

Return Value

array A list of differences

in Folder at line 3707
PropelCollection|array getLastVersions($number = 10, $criteria = null, $con = null)

retrieve the last $number versions.

Parameters

$number
$criteria
$con

Return Value

PropelCollection|array \Thelia\Model\FolderVersion[] List of \Thelia\Model\FolderVersion objects

in Folder at line 3720
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Folder at line 3729
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

at line 89
boolean preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 98
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

at line 103
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 110
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

at line 115
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 127
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in Folder at line 3803
array|string __call( string $name, mixed $params)

Derived method to catches calls to undefined methods.

Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.). Allows to define default __call() behavior if you overwrite __call()

Parameters

string $name
mixed $params

Return Value

array|string

$this setDispatcher( EventDispatcherInterface $dispatcher)

Parameters

EventDispatcherInterface $dispatcher

Return Value

$this

getDispatcher()

clearDispatcher()

getNextPosition()

Get the position of the next inserted object

movePositionUp()

Move up a object

movePositionDown()

Move down a object

changeAbsolutePosition( newPosition $newPosition)

Changes object position

Parameters

newPosition $newPosition

at line 23
getRewrittenUrlViewName()

{@inheritDoc}

in UrlRewritingTrait at line 41
getUrl( string $locale = null)

Get the object URL for the given locale, rewritten if rewriting is enabled.

Parameters

string $locale a valid locale (e.g. en_US)

in UrlRewritingTrait at line 55
generateRewrittenUrl( string $locale)

Generate a rewritten URL from the object title, and store it in the rewriting table

Parameters

string $locale a valid locale (e.g. en_US)

in UrlRewritingTrait at line 110
null getRewrittenUrl( string $locale)

return the rewritten URL for the given locale

Parameters

string $locale a valid locale (e.g. en_US)

Return Value

null

in UrlRewritingTrait at line 132
markRewrittenUrlObsolete()

Mark the current URL as obseolete

in UrlRewritingTrait at line 151
$this setRewrittenUrl( string $locale, $url)

Set the rewritten URL for the given locale

Parameters

string $locale a valid locale (e.g. en_US)
$url

Return Value

$this

Exceptions

UrlRewritingException
UrlRewritingException

at line 31
int countChild()

Return Value

int number of contents for the folder

at line 42
int countAllContents()

count all products for current category and sub categories

Return Value

int

at line 63
mixed getRoot( int $folderId)

Get the root folder

Parameters

int $folderId

Return Value

mixed