class FolderDocument extends FolderDocument implements BreadcrumbInterface, FileModelInterface

Traits

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

__construct()

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

boolean
isModified()

Returns whether the object has been modified.

boolean
isColumnModified( string $col)

Has specified column been modified?

array
getModifiedColumns()

Get the columns that have been modified in this object.

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.

setNew( boolean $b)

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

boolean
isDeleted()

Whether this object has been deleted.

void
setDeleted( boolean $b)

Specify whether this object has been deleted.

void
resetModified( string $col = null)

Sets the modified state for the object to be false.

boolean
equals( mixed $obj)

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

int
hashCode()

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

array
getVirtualColumns()

Get the associative array of the virtual columns in this object

boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

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}');

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}');

__sleep()

No description

int
getId()

Get the [id] column value.

int
getFolderId()

Get the [folder_id] column value.

string
getFile()

Get the [file] column value.

int
getVisible()

Get the [visible] column value.

int
getPosition()

Get the [position] column value.

mixed
getCreatedAt( string $format = NULL)

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

mixed
getUpdatedAt( string $format = NULL)

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

setId( int $v)

Set the value of [id] column.

setFolderId( int $v)

Set the value of [folder_id] column.

setFile( string $v)

Set the value of [file] column.

setVisible( int $v)

Set the value of [visible] column.

setPosition( int $v)

Set the value of [position] column.

setCreatedAt( mixed $v)

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

setUpdatedAt( mixed $v)

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

boolean
hasOnlyDefaultValues()

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

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.

ensureConsistency()

Checks and repairs the internal consistency of the object.

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

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

void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

void
setByPosition( int $pos, mixed $value)

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

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

Populates the object using an array.

Criteria
buildCriteria()

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

Criteria
buildPkeyCriteria()

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

int
getPrimaryKey()

Returns the primary key for this object (row).

void
setPrimaryKey( int $key)

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

boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

copy( boolean $deepCopy = false)

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

setFolder( Folder $v = null)

Declares an association between this object and a ChildFolder object.

getFolder( ConnectionInterface $con = null)

Get the associated ChildFolder object

void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

void
clearFolderDocumentI18ns()

Clears out the collFolderDocumentI18ns collection

resetPartialFolderDocumentI18ns($v = true)

Reset is the collFolderDocumentI18ns collection loaded partially.

void
initFolderDocumentI18ns( boolean $overrideExisting = true)

Initializes the collFolderDocumentI18ns collection.

Collection|FolderDocumentI18n[]
getFolderDocumentI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

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

setFolderDocumentI18ns( Collection $folderDocumentI18ns, ConnectionInterface $con = null)

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

int
countFolderDocumentI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderDocumentI18n objects.

addFolderDocumentI18n( FolderDocumentI18n $l)

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

removeFolderDocumentI18n( FolderDocumentI18n $folderDocumentI18n)

No description

clear()

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

clearAllReferences( boolean $deep = false)

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

string
__toString()

Return the string representation of this object

keepUpdateDateUnchanged()

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

setLocale( string $locale = 'en_US')

Sets the locale for translations

string
getLocale()

Gets the locale for translations

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

Returns the current translation for a given locale

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

Remove the translation for a given locale

getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

string
getTitle()

Get the [title] column value.

setTitle( string $v)

Set the value of [title] column.

string
getDescription()

Get the [description] column value.

setDescription( string $v)

Set the value of [description] column.

string
getChapo()

Get the [chapo] column value.

setChapo( string $v)

Set the value of [chapo] column.

string
getPostscriptum()

Get the [postscriptum] column value.

setPostscriptum( string $v)

Set the value of [postscriptum] column.

boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

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.

$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

getBaseBreadcrumb( Router $router, ContainerInterface $container, $folderId)

No description

getFolderBreadcrumb( Router $router, $container, $tab, $locale)

No description

getContentBreadcrumb( Router $router, ContainerInterface $container, $tab, $locale)

No description

$this
setParentId( int $parentId)

No description

int
getParentId()

No description

array
getBreadcrumb( Router $router, ContainerInterface $container, string $tab, string $locale)

No description

getUpdateFormId()

Get the ID of the form used to change this object information

string
getUploadDir()

No description

string
getRedirectionUrl()

No description

ModelCriteria
getQueryInstance()

Get the Query instance for this object

Details

in FolderDocument at line 150
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 FolderDocument at line 159
__construct()

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

See also

applyDefaults()

in FolderDocument at line 169
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in FolderDocument at line 180
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 FolderDocument at line 189
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 FolderDocument at line 201
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 FolderDocument at line 212
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 FolderDocument at line 221
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in FolderDocument at line 231
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in FolderDocument at line 241
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 FolderDocument at line 260
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in FolderDocument at line 285
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 FolderDocument at line 299
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in FolderDocument at line 310
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 FolderDocument at line 323
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 FolderDocument at line 340
FolderDocument 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

FolderDocument The current object, for fluid interface

in FolderDocument at line 372
FolderDocument 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

FolderDocument The current object, for fluid interface

in FolderDocument at line 395
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 FolderDocument at line 420
int getId()

Get the [id] column value.

Return Value

int

in FolderDocument at line 431
int getFolderId()

Get the [folder_id] column value.

Return Value

int

in FolderDocument at line 442
string getFile()

Get the [file] column value.

Return Value

string

in FolderDocument at line 453
int getVisible()

Get the [visible] column value.

Return Value

int

in FolderDocument at line 464
int getPosition()

Get the [position] column value.

Return Value

int

in FolderDocument at line 481
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 FolderDocument at line 501
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 FolderDocument at line 516
FolderDocument setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

FolderDocument The current object (for fluent API support)

in FolderDocument at line 537
FolderDocument setFolderId( int $v)

Set the value of [folder_id] column.

Parameters

int $v new value

Return Value

FolderDocument The current object (for fluent API support)

in FolderDocument at line 562
FolderDocument setFile( string $v)

Set the value of [file] column.

Parameters

string $v new value

Return Value

FolderDocument The current object (for fluent API support)

in FolderDocument at line 583
FolderDocument setVisible( int $v)

Set the value of [visible] column.

Parameters

int $v new value

Return Value

FolderDocument The current object (for fluent API support)

in FolderDocument at line 604
FolderDocument setPosition( int $v)

Set the value of [position] column.

Parameters

int $v new value

Return Value

FolderDocument The current object (for fluent API support)

in FolderDocument at line 626
FolderDocument 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

FolderDocument The current object (for fluent API support)

in FolderDocument at line 647
FolderDocument 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

FolderDocument The current object (for fluent API support)

in FolderDocument at line 669
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 FolderDocument at line 697
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 FolderDocument at line 756
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 FolderDocument at line 773
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 FolderDocument at line 815
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

FolderDocument::setDeleted()
FolderDocument::isDeleted()

in FolderDocument at line 857
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 FolderDocument at line 1088
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 FolderDocument at line 1103
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 FolderDocument at line 1148
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 FolderDocument at line 1192
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 FolderDocument at line 1207
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 FolderDocument at line 1251
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 FolderDocument at line 1269
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 FolderDocument at line 1292
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 FolderDocument at line 1304
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in FolderDocument at line 1315
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in FolderDocument at line 1324
boolean isPrimaryKeyNull()

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

Return Value

boolean

in FolderDocument at line 1341
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\FolderDocument (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 FolderDocument at line 1381
FolderDocument 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

FolderDocument Clone of current object.

Exceptions

PropelException

in FolderDocument at line 1398
FolderDocument setFolder( Folder $v = null)

Declares an association between this object and a ChildFolder object.

Parameters

Folder $v

Return Value

FolderDocument The current object (for fluent API support)

Exceptions

PropelException

in FolderDocument at line 1426
Folder getFolder( ConnectionInterface $con = null)

Get the associated ChildFolder object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Folder The associated ChildFolder object.

Exceptions

PropelException

in FolderDocument at line 1451
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 FolderDocument at line 1467
void clearFolderDocumentI18ns()

Clears out the collFolderDocumentI18ns 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

addFolderDocumentI18ns()

in FolderDocument at line 1475
resetPartialFolderDocumentI18ns($v = true)

Reset is the collFolderDocumentI18ns collection loaded partially.

Parameters

$v

in FolderDocument at line 1492
void initFolderDocumentI18ns( boolean $overrideExisting = true)

Initializes the collFolderDocumentI18ns collection.

By default this just sets the collFolderDocumentI18ns collection to an empty array (like clearcollFolderDocumentI18ns()); 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 FolderDocument at line 1515
Collection|FolderDocumentI18n[] getFolderDocumentI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildFolderDocumentI18n 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 ChildFolderDocument 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|FolderDocumentI18n[] List of ChildFolderDocumentI18n objects

Exceptions

PropelException

in FolderDocument at line 1571
FolderDocument setFolderDocumentI18ns( Collection $folderDocumentI18ns, ConnectionInterface $con = null)

Sets a collection of FolderDocumentI18n 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 $folderDocumentI18ns A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

FolderDocument The current object (for fluent API support)

in FolderDocument at line 1605
int countFolderDocumentI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related FolderDocumentI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related FolderDocumentI18n objects.

Exceptions

PropelException

in FolderDocument at line 1637
FolderDocument addFolderDocumentI18n( FolderDocumentI18n $l)

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

Parameters

FolderDocumentI18n $l ChildFolderDocumentI18n

Return Value

FolderDocument The current object (for fluent API support)

in FolderDocument at line 1668
FolderDocument removeFolderDocumentI18n( FolderDocumentI18n $folderDocumentI18n)

Parameters

FolderDocumentI18n $folderDocumentI18n The folderDocumentI18n object to remove.

Return Value

FolderDocument The current object (for fluent API support)

in FolderDocument at line 1686
clear()

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

in FolderDocument at line 1712
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 FolderDocument at line 1735
string __toString()

Return the string representation of this object

Return Value

string

in FolderDocument at line 1747
FolderDocument keepUpdateDateUnchanged()

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

Return Value

FolderDocument The current object (for fluent API support)

in FolderDocument at line 1763
FolderDocument 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

FolderDocument The current object (for fluent API support)

in FolderDocument at line 1775
string getLocale()

Gets the locale for translations

Return Value

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

in FolderDocument at line 1787
FolderDocumentI18n 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

FolderDocumentI18n

in FolderDocument at line 1822
FolderDocument 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

FolderDocument The current object (for fluent API support)

in FolderDocument at line 1848
FolderDocumentI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

FolderDocumentI18n

in FolderDocument at line 1859
string getTitle()

Get the [title] column value.

Return Value

string

in FolderDocument at line 1871
FolderDocumentI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

FolderDocumentI18n The current object (for fluent API support)

in FolderDocument at line 1883
string getDescription()

Get the [description] column value.

Return Value

string

in FolderDocument at line 1895
FolderDocumentI18n setDescription( string $v)

Set the value of [description] column.

Parameters

string $v new value

Return Value

FolderDocumentI18n The current object (for fluent API support)

in FolderDocument at line 1907
string getChapo()

Get the [chapo] column value.

Return Value

string

in FolderDocument at line 1919
FolderDocumentI18n setChapo( string $v)

Set the value of [chapo] column.

Parameters

string $v new value

Return Value

FolderDocumentI18n The current object (for fluent API support)

in FolderDocument at line 1931
string getPostscriptum()

Get the [postscriptum] column value.

Return Value

string

in FolderDocument at line 1943
FolderDocumentI18n setPostscriptum( string $v)

Set the value of [postscriptum] column.

Parameters

string $v new value

Return Value

FolderDocumentI18n The current object (for fluent API support)

in FolderDocument at line 1954
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in FolderDocument at line 1963
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

in FolderDocument at line 1982
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

in FolderDocument at line 1992
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in FolderDocument at line 2001
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

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

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in FolderDocument at line 2020
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in FolderDocument at line 2037
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

in FolderBreadcrumbTrait at line 22
getBaseBreadcrumb( Router $router, ContainerInterface $container, $folderId)

Parameters

Router $router
ContainerInterface $container
$folderId

in FolderBreadcrumbTrait at line 54
getFolderBreadcrumb( Router $router, $container, $tab, $locale)

Parameters

Router $router
$container
$tab
$locale

in FolderBreadcrumbTrait at line 75
getContentBreadcrumb( Router $router, ContainerInterface $container, $tab, $locale)

Parameters

Router $router
ContainerInterface $container
$tab
$locale

at line 48
$this setParentId( int $parentId)

Parameters

int $parentId parent id

Return Value

$this

at line 58
int getParentId()

Return Value

int parent id

at line 77
array getBreadcrumb( Router $router, ContainerInterface $container, string $tab, string $locale)

Parameters

Router $router the router where to find routes
ContainerInterface $container the container
string $tab the tab to return to (probably 'image' or 'document')
string $locale the current locale

Return Value

array an array of (label => URL)

at line 85
FileModelParentInterface getParentFileModel()

Return Value

FileModelParentInterface the parent file model

at line 95
BaseForm getUpdateFormId()

Get the ID of the form used to change this object information

Return Value

BaseForm the form

at line 103
string getUploadDir()

Return Value

string the path to the upload directory where files are stored, without final slash

at line 119
string getRedirectionUrl()

Return Value

string the URL to redirect to after update from the back-office

at line 129
ModelCriteria getQueryInstance()

Get the Query instance for this object

Return Value

ModelCriteria