Category
class Category extends Category implements FileModelParentInterface
Traits
Constants
TABLE_MAP |
TableMap class name |
Methods
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.
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
Sets the modified state for the object to be false.
Compares this with another Category
instance. If
obj
is an instance of Category
, delegates to
equals(Category)
. Otherwise, returns false
.
If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.
Get the associative array of the virtual columns in this object
Checks the existence of a virtual column in this object
Get the value of a virtual column in this object
Set the value of a virtual column in this object
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}');
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}');
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
Get the [optionally formatted] temporal [versioncreatedat] column value.
Sets the value of [created_at] column to a normalized version of the date/time value specified.
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
Sets the value of [versioncreatedat] column to a normalized version of the date/time value specified.
Indicates whether the columns in this object are only set to default values.
Hydrates (populates) the object variables with values from the database resultset.
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
Removes this object from datastore and sets delete attribute.
Retrieves a field from the object by name passed in as a string.
Retrieves a field from the object by Position as specified in the xml schema.
Exports the object as an array.
Sets a field from the object by name passed in as a string.
Sets a field from the object by Position as specified in the xml schema.
Populates the object using an array.
Build a Criteria object containing the values of all modified columns in this object.
Builds a Criteria object containing the primary key for this object.
Sets contents of passed object to values from current object.
Makes a copy of this object that will be inserted as a new row in table when saved.
Initializes a collection based on the name of a relation.
Reset is the collProductCategories collection loaded partially.
Initializes the collProductCategories collection.
Gets an array of ChildProductCategory objects which contain a foreign key that references this object.
Sets a collection of ProductCategory objects related by a one-to-many relationship to the current object.
Returns the number of related ProductCategory objects.
Method called to associate a ChildProductCategory object to this object through the ChildProductCategory foreign key attribute.
If this collection has already been initialized with an identical criteria, it returns the collection.
Reset is the collCategoryImages collection loaded partially.
Initializes the collCategoryImages collection.
Gets an array of ChildCategoryImage objects which contain a foreign key that references this object.
Sets a collection of CategoryImage objects related by a one-to-many relationship to the current object.
Returns the number of related CategoryImage objects.
Method called to associate a ChildCategoryImage object to this object through the ChildCategoryImage foreign key attribute.
Reset is the collCategoryDocuments collection loaded partially.
Initializes the collCategoryDocuments collection.
Gets an array of ChildCategoryDocument objects which contain a foreign key that references this object.
Sets a collection of CategoryDocument objects related by a one-to-many relationship to the current object.
Returns the number of related CategoryDocument objects.
Method called to associate a ChildCategoryDocument object to this object through the ChildCategoryDocument foreign key attribute.
Clears out the collCategoryAssociatedContents collection
Reset is the collCategoryAssociatedContents collection loaded partially.
Initializes the collCategoryAssociatedContents collection.
Gets an array of ChildCategoryAssociatedContent objects which contain a foreign key that references this object.
Sets a collection of CategoryAssociatedContent objects related by a one-to-many relationship to the current object.
Returns the number of related CategoryAssociatedContent objects.
Method called to associate a ChildCategoryAssociatedContent object to this object through the ChildCategoryAssociatedContent foreign key attribute.
No description
If this collection has already been initialized with an identical criteria, it returns the collection.
Reset is the collCategoryI18ns collection loaded partially.
Initializes the collCategoryI18ns collection.
Gets an array of ChildCategoryI18n objects which contain a foreign key that references this object.
Sets a collection of CategoryI18n objects related by a one-to-many relationship to the current object.
Returns the number of related CategoryI18n objects.
Method called to associate a ChildCategoryI18n object to this object through the ChildCategoryI18n foreign key attribute.
Reset is the collCategoryVersions collection loaded partially.
Initializes the collCategoryVersions collection.
Gets an array of ChildCategoryVersion objects which contain a foreign key that references this object.
Sets a collection of CategoryVersion objects related by a one-to-many relationship to the current object.
Returns the number of related CategoryVersion objects.
Method called to associate a ChildCategoryVersion object to this object through the ChildCategoryVersion foreign key attribute.
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.
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.
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.
Associate a ChildProduct object to this object through the product_category cross reference table.
Remove a ChildProduct object to this object through the product_category cross reference table.
Resets all references to other model objects or collections of model objects.
Returns the current translation for a given locale
Remove the translation for a given locale
Returns the current translation
Set the value of [meta_description] column.
Checks whether the current state must be recorded as a version
Creates a version of the current object and saves it.
Sets the properties of the current object to the value they had at a specific version
Sets the properties of the current object to the value they had at a specific version
Gets the latest persisted version number for the current object
Checks whether the current object is the latest one
Retrieves a version object for this entity and a version number
Gets all the versions of this object, in incremental order
Compares the current object with another of its version.
Compares two versions of the current object.
retrieve the last $number versions.
Mark the current object so that the update date doesn't get updated during next save
Code to be run before persisting the object
Code to be run before inserting to database
Code to be run after inserting to database
Code to be run before updating the object in database
Code to be run after updating the object in database
Code to be run before deleting the object in database
Code to be run after deleting the object in database
Derived method to catches calls to undefined methods.
No description
Changes object position
{@inheritDoc}
Get the object URL for the given locale, rewritten if rewriting is enabled.
Generate a rewritten URL from the object title, and store it in the rewriting table
return the rewritten URL for the given locale
Set the rewritten URL for the given locale
No description
count all products for current category and sub categories
Get the root category
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).
in
Category at line 264
__construct()
Initializes internal state of Thelia\Model\Base\Category object.
in
Category at line 274
boolean
isModified()
Returns whether the object has been modified.
in
Category at line 285
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
Category at line 294
array
getModifiedColumns()
Get the columns that have been modified in 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.
in
Category at line 317
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
Category at line 326
boolean
isDeleted()
Whether this object has been deleted.
in
Category at line 336
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
Category at line 346
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
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
.
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.
in
Category at line 404
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
Category at line 415
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
Category at line 428
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
Category at line 445
Category
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
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}');
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}');
in
ModelEventDispatcherTrait at line 57
__sleep()
in
Category at line 525
int
getId()
Get the [id] column value.
in
Category at line 536
int
getParent()
Get the [parent] column value.
in
Category at line 547
int
getVisible()
Get the [visible] column value.
in
Category at line 558
int
getPosition()
Get the [position] column value.
in
Category at line 569
int
getDefaultTemplateId()
Get the [defaulttemplateid] column value.
in
Category at line 586
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
in
Category at line 606
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
in
Category at line 620
int
getVersion()
Get the [version] column value.
in
Category at line 637
mixed
getVersionCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [versioncreatedat] column value.
in
Category at line 651
string
getVersionCreatedBy()
Get the [versioncreatedby] column value.
in
Category at line 747
Category
setDefaultTemplateId(
int $v)
Set the value of [defaulttemplateid] column.
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.
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.
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.
in
Category at line 852
Category
setVersionCreatedBy(
string $v)
Set the value of [versioncreatedby] column.
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.
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.
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.
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.
in
Category at line 1044
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
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.
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.
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.
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.
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.
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.
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.
in
Category at line 1664
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
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.
in
Category at line 1702
int
getPrimaryKey()
Returns the primary key for this object (row).
in
Category at line 1713
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
Category at line 1722
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
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.
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.
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.
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.
in
Category at line 1870
resetPartialProductCategories($v = true)
Reset is the collProductCategories collection loaded partially.
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.
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.
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.
in
Category at line 2000
int
countProductCategories(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related ProductCategory objects.
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.
in
Category at line 2059
Category
removeProductCategory(
ProductCategory $productCategory)
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.
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.
in
Category at line 2116
resetPartialCategoryImages($v = true)
Reset is the collCategoryImages collection loaded partially.
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.
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.
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.
in
Category at line 2243
int
countCategoryImages(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related CategoryImage objects.
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.
in
Category at line 2302
Category
removeCategoryImage(
CategoryImage $categoryImage)
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.
in
Category at line 2334
resetPartialCategoryDocuments($v = true)
Reset is the collCategoryDocuments collection loaded partially.
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.
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.
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.
in
Category at line 2461
int
countCategoryDocuments(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related CategoryDocument objects.
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.
in
Category at line 2520
Category
removeCategoryDocument(
CategoryDocument $categoryDocument)
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.
in
Category at line 2552
resetPartialCategoryAssociatedContents($v = true)
Reset is the collCategoryAssociatedContents collection loaded partially.
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.
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.
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.
in
Category at line 2679
int
countCategoryAssociatedContents(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related CategoryAssociatedContent objects.
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.
in
Category at line 2738
Category
removeCategoryAssociatedContent(
CategoryAssociatedContent $categoryAssociatedContent)
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.
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.
in
Category at line 2795
resetPartialCategoryI18ns($v = true)
Reset is the collCategoryI18ns collection loaded partially.
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.
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.
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.
in
Category at line 2925
int
countCategoryI18ns(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related CategoryI18n objects.
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.
in
Category at line 2988
Category
removeCategoryI18n(
CategoryI18n $categoryI18n)
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.
in
Category at line 3020
resetPartialCategoryVersions($v = true)
Reset is the collCategoryVersions collection loaded partially.
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.
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.
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.
in
Category at line 3150
int
countCategoryVersions(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related CategoryVersion objects.
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.
in
Category at line 3209
Category
removeCategoryVersion(
CategoryVersion $categoryVersion)
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.
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.
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.
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.
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.
in
Category at line 3354
Category
addProduct(
Product $product)
Associate a ChildProduct object to this object through the product_category cross reference table.
in
Category at line 3391
Category
removeProduct(
Product $product)
Remove a ChildProduct object to this object through the product_category cross reference table.
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.
in
Category at line 3497
string
__toString()
Return the string representation of this object
in
Category at line 3511
Category
setLocale(
string $locale = 'en_US')
Sets the locale for translations
in
Category at line 3523
string
getLocale()
Gets the locale for translations
in
Category at line 3535
CategoryI18n
getTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Returns the current translation for a given locale
in
Category at line 3570
Category
removeTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Remove the translation for a given locale
in
Category at line 3596
CategoryI18n
getCurrentTranslation(
ConnectionInterface $con = null)
Returns the current translation
in
Category at line 3607
string
getTitle()
Get the [title] column value.
in
Category at line 3619
CategoryI18n
setTitle(
string $v)
Set the value of [title] column.
in
Category at line 3631
string
getDescription()
Get the [description] column value.
in
Category at line 3643
CategoryI18n
setDescription(
string $v)
Set the value of [description] column.
in
Category at line 3655
string
getChapo()
Get the [chapo] column value.
in
Category at line 3667
CategoryI18n
setChapo(
string $v)
Set the value of [chapo] column.
in
Category at line 3679
string
getPostscriptum()
Get the [postscriptum] column value.
in
Category at line 3691
CategoryI18n
setPostscriptum(
string $v)
Set the value of [postscriptum] column.
in
Category at line 3703
string
getMetaTitle()
Get the [meta_title] column value.
in
Category at line 3715
CategoryI18n
setMetaTitle(
string $v)
Set the value of [meta_title] column.
in
Category at line 3727
string
getMetaDescription()
Get the [meta_description] column value.
in
Category at line 3739
CategoryI18n
setMetaDescription(
string $v)
Set the value of [meta_description] column.
in
Category at line 3751
string
getMetaKeywords()
Get the [meta_keywords] column value.
in
Category at line 3763
CategoryI18n
setMetaKeywords(
string $v)
Set the value of [meta_keywords] column.
in
Category at line 3776
Category
enforceVersioning()
Enforce a new Version of this object upon next save.
in
Category at line 3788
boolean
isVersioningNecessary($con = null)
Checks whether the current state must be recorded as a version
in
Category at line 3812
CategoryVersion
addVersion(
ConnectionInterface $con = null)
Creates a version of the current object and saves it.
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
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
in
Category at line 3885
integer
getLastVersionNumber(
ConnectionInterface $con = null)
Gets the latest persisted version number for the current object
in
Category at line 3905
Boolean
isLastVersion(
ConnectionInterface $con = null)
Checks whether the current object is the latest one
in
Category at line 3918
CategoryVersion
getOneVersion(
integer $versionNumber,
ConnectionInterface $con = null)
Retrieves a version object for this entity and a version number
in
Category at line 3933
ObjectCollection
getAllVersions(
ConnectionInterface $con = null)
Gets all the versions of this object, in incremental order
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')
);
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')
);
in
Category at line 4047
PropelCollection|array
getLastVersions($number = 10, $criteria = null, $con = null)
retrieve the last $number versions.
in
Category at line 4062
Category
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
in
Category at line 4074
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
Category at line 4083
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 111
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
at line 123
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
at line 131
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
at line 141
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 149
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 165
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
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()
in
ModelEventDispatcherTrait at line 33
$this
setDispatcher(
EventDispatcherInterface $dispatcher)
in
ModelEventDispatcherTrait at line 40
getDispatcher()
in
ModelEventDispatcherTrait at line 45
clearDispatcher()
in
PositionManagementTrait at line 44
getNextPosition()
Get the position of the next inserted object
in
PositionManagementTrait at line 60
movePositionUp()
Move up a object
in
PositionManagementTrait at line 68
movePositionDown()
Move down a object
in
PositionManagementTrait at line 141
changeAbsolutePosition(
newPosition $newPosition)
Changes object position
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.
in
UrlRewritingTrait at line 55
generateRewrittenUrl(
string $locale)
Generate a rewritten URL from the object title, and store it in the rewriting table
in
UrlRewritingTrait at line 110
null
getRewrittenUrl(
string $locale)
return the rewritten URL for the given locale
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
at line 26
int
countChild()
at line 47
int
countAllProducts()
count all products for current category and sub categories
/!\ the number of queries is exponential, use it with caution
at line 68
mixed
getRoot(
int $categoryId)
Get the root category