class Category implements ActiveRecordInterface

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

__construct()

Initializes internal state of Thelia\Model\Base\Category 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 Category instance. If obj is an instance of Category, delegates to equals(Category). 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()

Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing

int
getId()

Get the [id] column value.

int
getParent()

Get the [parent] column value.

int
getVisible()

Get the [visible] column value.

int
getPosition()

Get the [position] column value.

int
getDefaultTemplateId()

Get the [defaulttemplateid] 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.

int
getVersion()

Get the [version] column value.

mixed
getVersionCreatedAt( string $format = NULL)

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

string
getVersionCreatedBy()

Get the [versioncreatedby] column value.

setId( int $v)

Set the value of [id] column.

setParent( int $v)

Set the value of [parent] column.

setVisible( int $v)

Set the value of [visible] column.

setPosition( int $v)

Set the value of [position] column.

setDefaultTemplateId( int $v)

Set the value of [defaulttemplateid] 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.

setVersion( int $v)

Set the value of [version] column.

setVersionCreatedAt( mixed $v)

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

setVersionCreatedBy( string $v)

Set the value of [versioncreatedby] column.

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.

void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

void
clearProductCategories()

Clears out the collProductCategories collection

resetPartialProductCategories($v = true)

Reset is the collProductCategories collection loaded partially.

void
initProductCategories( boolean $overrideExisting = true)

Initializes the collProductCategories collection.

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

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

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

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

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

Returns the number of related ProductCategory objects.

addProductCategory( ProductCategory $l)

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

removeProductCategory( ProductCategory $productCategory)

No description

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.

void
clearCategoryImages()

Clears out the collCategoryImages collection

resetPartialCategoryImages($v = true)

Reset is the collCategoryImages collection loaded partially.

void
initCategoryImages( boolean $overrideExisting = true)

Initializes the collCategoryImages collection.

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

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

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

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

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

Returns the number of related CategoryImage objects.

addCategoryImage( CategoryImage $l)

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

removeCategoryImage( CategoryImage $categoryImage)

No description

void
clearCategoryDocuments()

Clears out the collCategoryDocuments collection

resetPartialCategoryDocuments($v = true)

Reset is the collCategoryDocuments collection loaded partially.

void
initCategoryDocuments( boolean $overrideExisting = true)

Initializes the collCategoryDocuments collection.

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

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

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

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

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

Returns the number of related CategoryDocument objects.

addCategoryDocument( CategoryDocument $l)

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

removeCategoryDocument( CategoryDocument $categoryDocument)

No description

void
clearCategoryAssociatedContents()

Clears out the collCategoryAssociatedContents collection

resetPartialCategoryAssociatedContents($v = true)

Reset is the collCategoryAssociatedContents collection loaded partially.

void
initCategoryAssociatedContents( boolean $overrideExisting = true)

Initializes the collCategoryAssociatedContents collection.

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

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

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

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

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

Returns the number of related CategoryAssociatedContent objects.

addCategoryAssociatedContent( CategoryAssociatedContent $l)

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

removeCategoryAssociatedContent( CategoryAssociatedContent $categoryAssociatedContent)

No description

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.

void
clearCategoryI18ns()

Clears out the collCategoryI18ns collection

resetPartialCategoryI18ns($v = true)

Reset is the collCategoryI18ns collection loaded partially.

void
initCategoryI18ns( boolean $overrideExisting = true)

Initializes the collCategoryI18ns collection.

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

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

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

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

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

Returns the number of related CategoryI18n objects.

addCategoryI18n( CategoryI18n $l)

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

removeCategoryI18n( CategoryI18n $categoryI18n)

No description

void
clearCategoryVersions()

Clears out the collCategoryVersions collection

resetPartialCategoryVersions($v = true)

Reset is the collCategoryVersions collection loaded partially.

void
initCategoryVersions( boolean $overrideExisting = true)

Initializes the collCategoryVersions collection.

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

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

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

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

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

Returns the number of related CategoryVersion objects.

addCategoryVersion( CategoryVersion $l)

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

removeCategoryVersion( CategoryVersion $categoryVersion)

No description

void
clearProducts()

Clears out the collProducts collection

void
initProducts()

Initializes the collProducts collection.

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.

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.

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.

addProduct( Product $product)

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

removeProduct( Product $product)

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

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

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.

string
getMetaTitle()

Get the [meta_title] column value.

setMetaTitle( string $v)

Set the value of [meta_title] column.

string
getMetaDescription()

Get the [meta_description] column value.

setMetaDescription( string $v)

Set the value of [meta_description] column.

string
getMetaKeywords()

Get the [meta_keywords] column value.

setMetaKeywords( string $v)

Set the value of [meta_keywords] column.

enforceVersioning()

Enforce a new Version of this object upon next save.

boolean
isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

addVersion( ConnectionInterface $con = null)

Creates a version of the current object and saves it.

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

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

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

integer
getLastVersionNumber( ConnectionInterface $con = null)

Gets the latest persisted version number for the current object

Boolean
isLastVersion( ConnectionInterface $con = null)

Checks whether the current object is the latest one

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

Retrieves a version object for this entity and a version number

ObjectCollection
getAllVersions( ConnectionInterface $con = null)

Gets all the versions of this object, in incremental order

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

Compares the current object with another of its version.

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

Compares two versions of the current object.

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

retrieve the last $number versions.

keepUpdateDateUnchanged()

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

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.

Details

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

at line 264
__construct()

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

See also

applyDefaults()

at line 274
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

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.

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.

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.

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.

at line 326
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

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

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

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.

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

at line 404
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

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

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

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

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

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

at line 513
__sleep()

Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing

at line 525
int getId()

Get the [id] column value.

Return Value

int

at line 536
int getParent()

Get the [parent] column value.

Return Value

int

at line 547
int getVisible()

Get the [visible] column value.

Return Value

int

at line 558
int getPosition()

Get the [position] column value.

Return Value

int

at line 569
int getDefaultTemplateId()

Get the [defaulttemplateid] column value.

Return Value

int

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.

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.

at line 620
int getVersion()

Get the [version] column value.

Return Value

int

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.

at line 651
string getVersionCreatedBy()

Get the [versioncreatedby] column value.

Return Value

string

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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.

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.

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

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

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

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

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.

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

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

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

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

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

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.

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

at line 1702
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

at line 1713
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

at line 1722
boolean isPrimaryKeyNull()

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

Return Value

boolean

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

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

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

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

at line 1870
resetPartialProductCategories($v = true)

Reset is the collProductCategories collection loaded partially.

Parameters

$v

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

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

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)

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

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)

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)

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

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

at line 2116
resetPartialCategoryImages($v = true)

Reset is the collCategoryImages collection loaded partially.

Parameters

$v

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

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

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)

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

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)

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)

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

at line 2334
resetPartialCategoryDocuments($v = true)

Reset is the collCategoryDocuments collection loaded partially.

Parameters

$v

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

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

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)

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

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)

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)

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

at line 2552
resetPartialCategoryAssociatedContents($v = true)

Reset is the collCategoryAssociatedContents collection loaded partially.

Parameters

$v

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

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

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)

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

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)

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)

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

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

at line 2795
resetPartialCategoryI18ns($v = true)

Reset is the collCategoryI18ns collection loaded partially.

Parameters

$v

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

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

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)

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

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)

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)

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

at line 3020
resetPartialCategoryVersions($v = true)

Reset is the collCategoryVersions collection loaded partially.

Parameters

$v

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

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

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)

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

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)

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)

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

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

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

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)

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

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)

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)

at line 3410
clear()

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

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.

at line 3497
string __toString()

Return the string representation of this object

Return Value

string

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)

at line 3523
string getLocale()

Gets the locale for translations

Return Value

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

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

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)

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

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

CategoryI18n

at line 3607
string getTitle()

Get the [title] column value.

Return Value

string

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)

at line 3631
string getDescription()

Get the [description] column value.

Return Value

string

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)

at line 3655
string getChapo()

Get the [chapo] column value.

Return Value

string

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)

at line 3679
string getPostscriptum()

Get the [postscriptum] column value.

Return Value

string

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)

at line 3703
string getMetaTitle()

Get the [meta_title] column value.

Return Value

string

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)

at line 3727
string getMetaDescription()

Get the [meta_description] column value.

Return Value

string

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)

at line 3751
string getMetaKeywords()

Get the [meta_keywords] column value.

Return Value

string

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)

at line 3776
Category enforceVersioning()

Enforce a new Version of this object upon next save.

Return Value

Category

at line 3788
boolean isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

Parameters

$con

Return Value

boolean

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

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)

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)

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

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

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

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

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

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

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

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)

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

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

at line 4083
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 4102
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

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

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 4121
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

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

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 4140
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

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