class Category extends Category 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  Category
__construct()

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

from  Category
boolean
isModified()

Returns whether the object has been modified.

from  Category
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Category
array
getModifiedColumns()

Get the columns that have been modified in this object.

from  Category
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  Category
setNew( boolean $b)

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

from  Category
boolean
isDeleted()

Whether this object has been deleted.

from  Category
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Category
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Category
boolean
equals( mixed $obj)

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

from  Category
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  Category
array
getVirtualColumns()

Get the associative array of the virtual columns in this object

from  Category
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Category
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

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

Set the value of a virtual column in this object

from  Category
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  Category
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  Category
__sleep()

No description

int
getId()

Get the [id] column value.

from  Category
int
getParent()

Get the [parent] column value.

from  Category
int
getVisible()

Get the [visible] column value.

from  Category
int
getPosition()

Get the [position] column value.

from  Category
int
getDefaultTemplateId()

Get the [defaulttemplateid] column value.

from  Category
mixed
getCreatedAt( string $format = NULL)

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

from  Category
mixed
getUpdatedAt( string $format = NULL)

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

from  Category
int
getVersion()

Get the [version] column value.

from  Category
mixed
getVersionCreatedAt( string $format = NULL)

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

from  Category
string
getVersionCreatedBy()

Get the [versioncreatedby] column value.

from  Category
setId( int $v)

Set the value of [id] column.

from  Category
setParent( int $v)

Set the value of [parent] column.

from  Category
setVisible( int $v)

Set the value of [visible] column.

from  Category
setPosition( int $v)

Set the value of [position] column.

from  Category
setDefaultTemplateId( int $v)

Set the value of [defaulttemplateid] column.

from  Category
setCreatedAt( mixed $v)

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

from  Category
setUpdatedAt( mixed $v)

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

from  Category
setVersion( int $v)

Set the value of [version] column.

from  Category
setVersionCreatedAt( mixed $v)

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

from  Category
setVersionCreatedBy( string $v)

Set the value of [versioncreatedby] column.

from  Category
boolean
hasOnlyDefaultValues()

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

from  Category
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  Category
ensureConsistency()

Checks and repairs the internal consistency of the object.

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

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

from  Category
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Category
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  Category
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

from  Category
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  Category
void
setByPosition( int $pos, mixed $value)

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

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

Populates the object using an array.

from  Category
Criteria
buildCriteria()

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

from  Category
Criteria
buildPkeyCriteria()

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

from  Category
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Category
void
setPrimaryKey( int $key)

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

from  Category
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  Category
copy( boolean $deepCopy = false)

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

from  Category
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  Category
void
clearProductCategories()

Clears out the collProductCategories collection

from  Category
resetPartialProductCategories($v = true)

Reset is the collProductCategories collection loaded partially.

from  Category
void
initProductCategories( boolean $overrideExisting = true)

Initializes the collProductCategories collection.

from  Category
Collection|ProductCategory[]
getProductCategories( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Category
setProductCategories( Collection $productCategories, ConnectionInterface $con = null)

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

from  Category
int
countProductCategories( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related ProductCategory objects.

from  Category
addProductCategory( ProductCategory $l)

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

from  Category
removeProductCategory( ProductCategory $productCategory)

No description

from  Category
Collection|ProductCategory[]
getProductCategoriesJoinProduct( 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  Category
void
clearCategoryImages()

Clears out the collCategoryImages collection

from  Category
resetPartialCategoryImages($v = true)

Reset is the collCategoryImages collection loaded partially.

from  Category
void
initCategoryImages( boolean $overrideExisting = true)

Initializes the collCategoryImages collection.

from  Category
Collection|CategoryImage[]
getCategoryImages( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Category
setCategoryImages( Collection $categoryImages, ConnectionInterface $con = null)

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

from  Category
int
countCategoryImages( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryImage objects.

from  Category
addCategoryImage( CategoryImage $l)

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

from  Category
removeCategoryImage( CategoryImage $categoryImage)

No description

from  Category
void
clearCategoryDocuments()

Clears out the collCategoryDocuments collection

from  Category
resetPartialCategoryDocuments($v = true)

Reset is the collCategoryDocuments collection loaded partially.

from  Category
void
initCategoryDocuments( boolean $overrideExisting = true)

Initializes the collCategoryDocuments collection.

from  Category
Collection|CategoryDocument[]
getCategoryDocuments( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Category
setCategoryDocuments( Collection $categoryDocuments, ConnectionInterface $con = null)

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

from  Category
int
countCategoryDocuments( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryDocument objects.

from  Category
addCategoryDocument( CategoryDocument $l)

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

from  Category
removeCategoryDocument( CategoryDocument $categoryDocument)

No description

from  Category
void
clearCategoryAssociatedContents()

Clears out the collCategoryAssociatedContents collection

from  Category
resetPartialCategoryAssociatedContents($v = true)

Reset is the collCategoryAssociatedContents collection loaded partially.

from  Category
void
initCategoryAssociatedContents( boolean $overrideExisting = true)

Initializes the collCategoryAssociatedContents collection.

from  Category
getCategoryAssociatedContents( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Category
setCategoryAssociatedContents( Collection $categoryAssociatedContents, ConnectionInterface $con = null)

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

from  Category
int
countCategoryAssociatedContents( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryAssociatedContent objects.

from  Category
addCategoryAssociatedContent( CategoryAssociatedContent $l)

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

from  Category
removeCategoryAssociatedContent( CategoryAssociatedContent $categoryAssociatedContent)

No description

from  Category
getCategoryAssociatedContentsJoinContent( 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  Category
void
clearCategoryI18ns()

Clears out the collCategoryI18ns collection

from  Category
resetPartialCategoryI18ns($v = true)

Reset is the collCategoryI18ns collection loaded partially.

from  Category
void
initCategoryI18ns( boolean $overrideExisting = true)

Initializes the collCategoryI18ns collection.

from  Category
Collection|CategoryI18n[]
getCategoryI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Category
setCategoryI18ns( Collection $categoryI18ns, ConnectionInterface $con = null)

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

from  Category
int
countCategoryI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryI18n objects.

from  Category
addCategoryI18n( CategoryI18n $l)

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

from  Category
removeCategoryI18n( CategoryI18n $categoryI18n)

No description

from  Category
void
clearCategoryVersions()

Clears out the collCategoryVersions collection

from  Category
resetPartialCategoryVersions($v = true)

Reset is the collCategoryVersions collection loaded partially.

from  Category
void
initCategoryVersions( boolean $overrideExisting = true)

Initializes the collCategoryVersions collection.

from  Category
Collection|CategoryVersion[]
getCategoryVersions( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Category
setCategoryVersions( Collection $categoryVersions, ConnectionInterface $con = null)

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

from  Category
int
countCategoryVersions( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryVersion objects.

from  Category
addCategoryVersion( CategoryVersion $l)

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

from  Category
removeCategoryVersion( CategoryVersion $categoryVersion)

No description

from  Category
void
clearProducts()

Clears out the collProducts collection

from  Category
void
initProducts()

Initializes the collProducts collection.

from  Category
ObjectCollection|Product[]
getProducts( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Category
setProducts( Collection $products, ConnectionInterface $con = null)

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

from  Category
int
countProducts( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

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

from  Category
addProduct( Product $product)

Associate a ChildProduct object to this object through the product_category cross reference table.

from  Category
removeProduct( Product $product)

Remove a ChildProduct object to this object through the product_category cross reference table.

from  Category
clear()

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

from  Category
clearAllReferences( boolean $deep = false)

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

from  Category
string
__toString()

Return the string representation of this object

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

Sets the locale for translations

from  Category
string
getLocale()

Gets the locale for translations

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

Returns the current translation for a given locale

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

Remove the translation for a given locale

from  Category
getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

from  Category
string
getTitle()

Get the [title] column value.

from  Category
setTitle( string $v)

Set the value of [title] column.

from  Category
string
getDescription()

Get the [description] column value.

from  Category
setDescription( string $v)

Set the value of [description] column.

from  Category
string
getChapo()

Get the [chapo] column value.

from  Category
setChapo( string $v)

Set the value of [chapo] column.

from  Category
string
getPostscriptum()

Get the [postscriptum] column value.

from  Category
setPostscriptum( string $v)

Set the value of [postscriptum] column.

from  Category
string
getMetaTitle()

Get the [meta_title] column value.

from  Category
setMetaTitle( string $v)

Set the value of [meta_title] column.

from  Category
string
getMetaDescription()

Get the [meta_description] column value.

from  Category
setMetaDescription( string $v)

Set the value of [meta_description] column.

from  Category
string
getMetaKeywords()

Get the [meta_keywords] column value.

from  Category
setMetaKeywords( string $v)

Set the value of [meta_keywords] column.

from  Category
enforceVersioning()

Enforce a new Version of this object upon next save.

from  Category
boolean
isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

from  Category
addVersion( ConnectionInterface $con = null)

Creates a version of the current object and saves it.

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

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

from  Category
populateFromVersion( CategoryVersion $version, ConnectionInterface $con = null, array $loadedObjects = array())

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

from  Category
integer
getLastVersionNumber( ConnectionInterface $con = null)

Gets the latest persisted version number for the current object

from  Category
Boolean
isLastVersion( ConnectionInterface $con = null)

Checks whether the current object is the latest one

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

Retrieves a version object for this entity and a version number

from  Category
ObjectCollection
getAllVersions( ConnectionInterface $con = null)

Gets all the versions of this object, in incremental order

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

Compares the current object with another of its version.

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

Compares two versions of the current object.

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

retrieve the last $number versions.

from  Category
keepUpdateDateUnchanged()

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

from  Category
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  Category
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

from  Category
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  Category
$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
countAllProducts()

count all products for current category and sub categories

mixed
getRoot( int $categoryId)

Get the root category

deleteProducts( ConnectionInterface $con = null)

No description

Details

in Category at line 254
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 Category at line 264
__construct()

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

See also

applyDefaults()

in Category at line 274
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Category at line 285
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 Category at line 294
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 Category at line 306
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 Category at line 317
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 Category at line 326
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Category at line 336
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Category at line 346
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 Category at line 365
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Category at line 390
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 Category at line 404
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Category at line 415
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 Category at line 428
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 Category at line 445
Category 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

Category The current object, for fluid interface

in Category at line 477
Category 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

Category The current object, for fluid interface

in Category at line 500
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 Category at line 525
int getId()

Get the [id] column value.

Return Value

int

in Category at line 536
int getParent()

Get the [parent] column value.

Return Value

int

in Category at line 547
int getVisible()

Get the [visible] column value.

Return Value

int

in Category at line 558
int getPosition()

Get the [position] column value.

Return Value

int

in Category at line 569
int getDefaultTemplateId()

Get the [defaulttemplateid] column value.

Return Value

int

in Category at line 586
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 Category at line 606
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 Category at line 620
int getVersion()

Get the [version] column value.

Return Value

int

in Category at line 637
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 Category at line 651
string getVersionCreatedBy()

Get the [versioncreatedby] column value.

Return Value

string

in Category at line 663
Category setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Category The current object (for fluent API support)

in Category at line 684
Category setParent( int $v)

Set the value of [parent] column.

Parameters

int $v new value

Return Value

Category The current object (for fluent API support)

in Category at line 705
Category setVisible( int $v)

Set the value of [visible] column.

Parameters

int $v new value

Return Value

Category The current object (for fluent API support)

in Category at line 726
Category setPosition( int $v)

Set the value of [position] column.

Parameters

int $v new value

Return Value

Category The current object (for fluent API support)

in Category at line 747
Category setDefaultTemplateId( int $v)

Set the value of [defaulttemplateid] column.

Parameters

int $v new value

Return Value

Category The current object (for fluent API support)

in Category at line 769
Category 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

Category The current object (for fluent API support)

in Category at line 790
Category 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

Category The current object (for fluent API support)

in Category at line 810
Category setVersion( int $v)

Set the value of [version] column.

Parameters

int $v new value

Return Value

Category The current object (for fluent API support)

in Category at line 832
Category 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

Category The current object (for fluent API support)

in Category at line 852
Category setVersionCreatedBy( string $v)

Set the value of [versioncreatedby] column.

Parameters

string $v new value

Return Value

Category The current object (for fluent API support)

in Category at line 875
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 Category at line 907
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 Category at line 978
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 Category at line 992
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 Category at line 1044
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Category::setDeleted()
Category::isDeleted()

in Category at line 1086
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 Category at line 1447
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 Category at line 1462
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 Category at line 1516
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 Category at line 1575
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 Category at line 1590
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 Category at line 1643
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 Category at line 1664
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 Category at line 1690
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 Category at line 1702
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Category at line 1713
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Category at line 1722
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Category at line 1739
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\Category (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 Category at line 1812
Category 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

Category Clone of current object.

Exceptions

PropelException

in Category at line 1831
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 Category at line 1862
void clearProductCategories()

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

addProductCategories()

in Category at line 1870
resetPartialProductCategories($v = true)

Reset is the collProductCategories collection loaded partially.

Parameters

$v

in Category at line 1887
void initProductCategories( boolean $overrideExisting = true)

Initializes the collProductCategories collection.

By default this just sets the collProductCategories collection to an empty array (like clearcollProductCategories()); 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 Category at line 1910
Collection|ProductCategory[] getProductCategories( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildProductCategory 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 ChildCategory 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|ProductCategory[] List of ChildProductCategory objects

Exceptions

PropelException

in Category at line 1966
Category setProductCategories( Collection $productCategories, ConnectionInterface $con = null)

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

Return Value

Category The current object (for fluent API support)

in Category at line 2000
int countProductCategories( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related ProductCategory objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related ProductCategory objects.

Exceptions

PropelException

in Category at line 2032
Category addProductCategory( ProductCategory $l)

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

Parameters

ProductCategory $l ChildProductCategory

Return Value

Category The current object (for fluent API support)

in Category at line 2059
Category removeProductCategory( ProductCategory $productCategory)

Parameters

ProductCategory $productCategory The productCategory object to remove.

Return Value

Category The current object (for fluent API support)

in Category at line 2091
Collection|ProductCategory[] getProductCategoriesJoinProduct( 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 Category is new, it will return an empty collection; or if this Category has previously been saved, it will retrieve related ProductCategories 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 Category.

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|ProductCategory[] List of ChildProductCategory objects

in Category at line 2108
void clearCategoryImages()

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

addCategoryImages()

in Category at line 2116
resetPartialCategoryImages($v = true)

Reset is the collCategoryImages collection loaded partially.

Parameters

$v

in Category at line 2133
void initCategoryImages( boolean $overrideExisting = true)

Initializes the collCategoryImages collection.

By default this just sets the collCategoryImages collection to an empty array (like clearcollCategoryImages()); 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 Category at line 2156
Collection|CategoryImage[] getCategoryImages( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildCategoryImage 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 ChildCategory 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|CategoryImage[] List of ChildCategoryImage objects

Exceptions

PropelException

in Category at line 2212
Category setCategoryImages( Collection $categoryImages, ConnectionInterface $con = null)

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

Return Value

Category The current object (for fluent API support)

in Category at line 2243
int countCategoryImages( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryImage objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related CategoryImage objects.

Exceptions

PropelException

in Category at line 2275
Category addCategoryImage( CategoryImage $l)

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

Parameters

CategoryImage $l ChildCategoryImage

Return Value

Category The current object (for fluent API support)

in Category at line 2302
Category removeCategoryImage( CategoryImage $categoryImage)

Parameters

CategoryImage $categoryImage The categoryImage object to remove.

Return Value

Category The current object (for fluent API support)

in Category at line 2326
void clearCategoryDocuments()

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

addCategoryDocuments()

in Category at line 2334
resetPartialCategoryDocuments($v = true)

Reset is the collCategoryDocuments collection loaded partially.

Parameters

$v

in Category at line 2351
void initCategoryDocuments( boolean $overrideExisting = true)

Initializes the collCategoryDocuments collection.

By default this just sets the collCategoryDocuments collection to an empty array (like clearcollCategoryDocuments()); 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 Category at line 2374
Collection|CategoryDocument[] getCategoryDocuments( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildCategoryDocument 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 ChildCategory 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|CategoryDocument[] List of ChildCategoryDocument objects

Exceptions

PropelException

in Category at line 2430
Category setCategoryDocuments( Collection $categoryDocuments, ConnectionInterface $con = null)

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

Return Value

Category The current object (for fluent API support)

in Category at line 2461
int countCategoryDocuments( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryDocument objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related CategoryDocument objects.

Exceptions

PropelException

in Category at line 2493
Category addCategoryDocument( CategoryDocument $l)

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

Parameters

CategoryDocument $l ChildCategoryDocument

Return Value

Category The current object (for fluent API support)

in Category at line 2520
Category removeCategoryDocument( CategoryDocument $categoryDocument)

Parameters

CategoryDocument $categoryDocument The categoryDocument object to remove.

Return Value

Category The current object (for fluent API support)

in Category at line 2544
void clearCategoryAssociatedContents()

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

addCategoryAssociatedContents()

in Category at line 2552
resetPartialCategoryAssociatedContents($v = true)

Reset is the collCategoryAssociatedContents collection loaded partially.

Parameters

$v

in Category at line 2569
void initCategoryAssociatedContents( boolean $overrideExisting = true)

Initializes the collCategoryAssociatedContents collection.

By default this just sets the collCategoryAssociatedContents collection to an empty array (like clearcollCategoryAssociatedContents()); 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 Category at line 2592
Collection|CategoryAssociatedContent[] getCategoryAssociatedContents( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildCategoryAssociatedContent 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 ChildCategory 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|CategoryAssociatedContent[] List of ChildCategoryAssociatedContent objects

Exceptions

PropelException

in Category at line 2648
Category setCategoryAssociatedContents( Collection $categoryAssociatedContents, ConnectionInterface $con = null)

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

Return Value

Category The current object (for fluent API support)

in Category at line 2679
int countCategoryAssociatedContents( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryAssociatedContent objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related CategoryAssociatedContent objects.

Exceptions

PropelException

in Category at line 2711
Category addCategoryAssociatedContent( CategoryAssociatedContent $l)

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

Parameters

CategoryAssociatedContent $l ChildCategoryAssociatedContent

Return Value

Category The current object (for fluent API support)

in Category at line 2738
Category removeCategoryAssociatedContent( CategoryAssociatedContent $categoryAssociatedContent)

Parameters

CategoryAssociatedContent $categoryAssociatedContent The categoryAssociatedContent object to remove.

Return Value

Category The current object (for fluent API support)

in Category at line 2770
Collection|CategoryAssociatedContent[] getCategoryAssociatedContentsJoinContent( 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 Category is new, it will return an empty collection; or if this Category has previously been saved, it will retrieve related CategoryAssociatedContents 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 Category.

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|CategoryAssociatedContent[] List of ChildCategoryAssociatedContent objects

in Category at line 2787
void clearCategoryI18ns()

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

addCategoryI18ns()

in Category at line 2795
resetPartialCategoryI18ns($v = true)

Reset is the collCategoryI18ns collection loaded partially.

Parameters

$v

in Category at line 2812
void initCategoryI18ns( boolean $overrideExisting = true)

Initializes the collCategoryI18ns collection.

By default this just sets the collCategoryI18ns collection to an empty array (like clearcollCategoryI18ns()); 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 Category at line 2835
Collection|CategoryI18n[] getCategoryI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildCategoryI18n 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 ChildCategory 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|CategoryI18n[] List of ChildCategoryI18n objects

Exceptions

PropelException

in Category at line 2891
Category setCategoryI18ns( Collection $categoryI18ns, ConnectionInterface $con = null)

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

Return Value

Category The current object (for fluent API support)

in Category at line 2925
int countCategoryI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related CategoryI18n objects.

Exceptions

PropelException

in Category at line 2957
Category addCategoryI18n( CategoryI18n $l)

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

Parameters

CategoryI18n $l ChildCategoryI18n

Return Value

Category The current object (for fluent API support)

in Category at line 2988
Category removeCategoryI18n( CategoryI18n $categoryI18n)

Parameters

CategoryI18n $categoryI18n The categoryI18n object to remove.

Return Value

Category The current object (for fluent API support)

in Category at line 3012
void clearCategoryVersions()

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

addCategoryVersions()

in Category at line 3020
resetPartialCategoryVersions($v = true)

Reset is the collCategoryVersions collection loaded partially.

Parameters

$v

in Category at line 3037
void initCategoryVersions( boolean $overrideExisting = true)

Initializes the collCategoryVersions collection.

By default this just sets the collCategoryVersions collection to an empty array (like clearcollCategoryVersions()); 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 Category at line 3060
Collection|CategoryVersion[] getCategoryVersions( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildCategoryVersion 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 ChildCategory 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|CategoryVersion[] List of ChildCategoryVersion objects

Exceptions

PropelException

in Category at line 3116
Category setCategoryVersions( Collection $categoryVersions, ConnectionInterface $con = null)

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

Return Value

Category The current object (for fluent API support)

in Category at line 3150
int countCategoryVersions( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CategoryVersion objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related CategoryVersion objects.

Exceptions

PropelException

in Category at line 3182
Category addCategoryVersion( CategoryVersion $l)

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

Parameters

CategoryVersion $l ChildCategoryVersion

Return Value

Category The current object (for fluent API support)

in Category at line 3209
Category removeCategoryVersion( CategoryVersion $categoryVersion)

Parameters

CategoryVersion $categoryVersion The categoryVersion object to remove.

Return Value

Category The current object (for fluent API support)

in Category at line 3233
void clearProducts()

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

addProducts()

in Category at line 3248
void initProducts()

Initializes the collProducts collection.

By default this just sets the collProducts collection to an empty collection (like clearProducts()); 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 Category at line 3269
ObjectCollection|Product[] getProducts( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildProduct objects related by a many-to-many relationship to the current object by way of the product_category 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 ChildCategory 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|Product[] List of ChildProduct objects

in Category at line 3299
Category setProducts( Collection $products, ConnectionInterface $con = null)

Sets a collection of Product objects related by a many-to-many relationship to the current object by way of the product_category 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 $products A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Category The current object (for fluent API support)

in Category at line 3327
int countProducts( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Gets the number of ChildProduct objects related by a many-to-many relationship to the current object by way of the product_category 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 ChildProduct objects

in Category at line 3354
Category addProduct( Product $product)

Associate a ChildProduct object to this object through the product_category cross reference table.

Parameters

Product $product The ChildProductCategory object to relate

Return Value

Category The current object (for fluent API support)

in Category at line 3391
Category removeProduct( Product $product)

Remove a ChildProduct object to this object through the product_category cross reference table.

Parameters

Product $product The ChildProductCategory object to relate

Return Value

Category The current object (for fluent API support)

in Category at line 3410
clear()

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

in Category at line 3439
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 Category at line 3497
string __toString()

Return the string representation of this object

Return Value

string

in Category at line 3511
Category 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

Category The current object (for fluent API support)

in Category at line 3523
string getLocale()

Gets the locale for translations

Return Value

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

in Category at line 3535
CategoryI18n 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

CategoryI18n

in Category at line 3570
Category 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

Category The current object (for fluent API support)

in Category at line 3596
CategoryI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

CategoryI18n

in Category at line 3607
string getTitle()

Get the [title] column value.

Return Value

string

in Category at line 3619
CategoryI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

CategoryI18n The current object (for fluent API support)

in Category at line 3631
string getDescription()

Get the [description] column value.

Return Value

string

in Category at line 3643
CategoryI18n setDescription( string $v)

Set the value of [description] column.

Parameters

string $v new value

Return Value

CategoryI18n The current object (for fluent API support)

in Category at line 3655
string getChapo()

Get the [chapo] column value.

Return Value

string

in Category at line 3667
CategoryI18n setChapo( string $v)

Set the value of [chapo] column.

Parameters

string $v new value

Return Value

CategoryI18n The current object (for fluent API support)

in Category at line 3679
string getPostscriptum()

Get the [postscriptum] column value.

Return Value

string

in Category at line 3691
CategoryI18n setPostscriptum( string $v)

Set the value of [postscriptum] column.

Parameters

string $v new value

Return Value

CategoryI18n The current object (for fluent API support)

in Category at line 3703
string getMetaTitle()

Get the [meta_title] column value.

Return Value

string

in Category at line 3715
CategoryI18n setMetaTitle( string $v)

Set the value of [meta_title] column.

Parameters

string $v new value

Return Value

CategoryI18n The current object (for fluent API support)

in Category at line 3727
string getMetaDescription()

Get the [meta_description] column value.

Return Value

string

in Category at line 3739
CategoryI18n setMetaDescription( string $v)

Set the value of [meta_description] column.

Parameters

string $v new value

Return Value

CategoryI18n The current object (for fluent API support)

in Category at line 3751
string getMetaKeywords()

Get the [meta_keywords] column value.

Return Value

string

in Category at line 3763
CategoryI18n setMetaKeywords( string $v)

Set the value of [meta_keywords] column.

Parameters

string $v new value

Return Value

CategoryI18n The current object (for fluent API support)

in Category at line 3776
Category enforceVersioning()

Enforce a new Version of this object upon next save.

Return Value

Category

in Category at line 3788
boolean isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

Parameters

$con

Return Value

boolean

in Category at line 3812
CategoryVersion addVersion( ConnectionInterface $con = null)

Creates a version of the current object and saves it.

Parameters

ConnectionInterface $con the connection to use

Return Value

CategoryVersion A version object

in Category at line 3841
Category 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

Category The current object (for fluent API support)

in Category at line 3861
Category populateFromVersion( CategoryVersion $version, ConnectionInterface $con = null, array $loadedObjects = array())

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

Parameters

CategoryVersion $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

Category The current object (for fluent API support)

in Category at line 3885
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 Category at line 3905
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 Category at line 3918
CategoryVersion 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

CategoryVersion A version object

in Category at line 3933
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 ChildCategoryVersion objects

in Category at line 3958
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 Category at line 3984
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 Category at line 4047
PropelCollection|array getLastVersions($number = 10, $criteria = null, $con = null)

retrieve the last $number versions.

Parameters

$number
$criteria
$con

Return Value

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

in Category at line 4062
Category keepUpdateDateUnchanged()

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

Return Value

Category The current object (for fluent API support)

in Category at line 4074
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Category at line 4083
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 123
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

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

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 141
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

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

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 165
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in Category at line 4157
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 34
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 26
int countChild()

Return Value

int number of child for the current category

at line 47
int countAllProducts()

count all products for current category and sub categories

/!\ the number of queries is exponential, use it with caution

Return Value

int

at line 68
mixed getRoot( int $categoryId)

Get the root category

Parameters

int $categoryId

Return Value

mixed

at line 91
deleteProducts( ConnectionInterface $con = null)

Parameters

ConnectionInterface $con