CategoryDocument
class CategoryDocument extends CategoryDocument implements BreadcrumbInterface, FileModelInterface
Traits
Constants
TABLE_MAP |
TableMap class name |
Methods
Initializes internal state of Thelia\Model\Base\CategoryDocument object.
Get the columns that have been modified in this object.
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 CategoryDocument
instance. If
obj
is an instance of CategoryDocument
, delegates to
equals(CategoryDocument)
. 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.
Set the value of [category_id] column.
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.
Indicates whether the columns in this object are only set to default values.
Hydrates (populates) the object variables with values from the database resultset.
Checks and repairs the internal consistency of the object.
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
Removes this object from datastore and sets delete attribute.
Persists this object to the database.
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.
Generic method to set the primary key (id column).
Returns true if the primary key for this object is null.
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.
Declares an association between this object and a ChildCategory object.
Get the associated ChildCategory object
Initializes a collection based on the name of a relation.
Clears out the collCategoryDocumentI18ns collection
Reset is the collCategoryDocumentI18ns collection loaded partially.
Initializes the collCategoryDocumentI18ns collection.
Gets an array of ChildCategoryDocumentI18n objects which contain a foreign key that references this object.
Sets a collection of CategoryDocumentI18n objects related by a one-to-many relationship to the current object.
Returns the number of related CategoryDocumentI18n objects.
Method called to associate a ChildCategoryDocumentI18n object to this object through the ChildCategoryDocumentI18n foreign key attribute.
Clears the current object and sets all attributes to their default values
Resets all references to other model objects or collections of model objects.
Mark the current object so that the update date doesn't get updated during next save
Sets the locale for translations
Returns the current translation for a given locale
Remove the translation for a given locale
Returns the current translation
Set the value of [description] column.
Set the value of [postscriptum] column.
Code to be run before persisting the object
Code to be run after 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
No description
No description
No description
No description
No description
No description
No description
Get the ID of the form used to change this object information
No description
No description
Get the Query instance for this object
Details
in
CategoryDocument at line 150
applyDefaultValues()
Applies default values to this object.
This method should be called from the object's constructor (or equivalent initialization method).
in
CategoryDocument at line 159
__construct()
Initializes internal state of Thelia\Model\Base\CategoryDocument object.
in
CategoryDocument at line 169
boolean
isModified()
Returns whether the object has been modified.
in
CategoryDocument at line 180
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
CategoryDocument at line 189
array
getModifiedColumns()
Get the columns that have been modified in this object.
in
CategoryDocument at line 201
boolean
isNew()
Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.
in
CategoryDocument at line 212
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
CategoryDocument at line 221
boolean
isDeleted()
Whether this object has been deleted.
in
CategoryDocument at line 231
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
CategoryDocument at line 241
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
in
CategoryDocument at line 260
boolean
equals(
mixed $obj)
Compares this with another CategoryDocument
instance. If
obj
is an instance of CategoryDocument
, delegates to
equals(CategoryDocument)
. Otherwise, returns false
.
in
CategoryDocument at line 285
int
hashCode()
If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.
in
CategoryDocument at line 299
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
CategoryDocument at line 310
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
CategoryDocument at line 323
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
CategoryDocument at line 340
CategoryDocument
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
in
CategoryDocument at line 372
CategoryDocument
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
CategoryDocument at line 395
string
exportTo(
mixed $parser,
boolean $includeLazyLoadColumns = true)
Export the current object properties to a string, using a given parser format
$book = BookQuery::create()->findPk(9012);
echo $book->exportTo('JSON');
=> {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
in
ModelEventDispatcherTrait at line 57
__sleep()
in
CategoryDocument at line 420
int
getId()
Get the [id] column value.
in
CategoryDocument at line 431
int
getCategoryId()
Get the [category_id] column value.
in
CategoryDocument at line 442
string
getFile()
Get the [file] column value.
in
CategoryDocument at line 453
int
getVisible()
Get the [visible] column value.
in
CategoryDocument at line 464
int
getPosition()
Get the [position] column value.
in
CategoryDocument at line 481
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
in
CategoryDocument at line 501
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
in
CategoryDocument at line 516
CategoryDocument
setId(
int $v)
Set the value of [id] column.
in
CategoryDocument at line 537
CategoryDocument
setCategoryId(
int $v)
Set the value of [category_id] column.
in
CategoryDocument at line 562
CategoryDocument
setFile(
string $v)
Set the value of [file] column.
in
CategoryDocument at line 583
CategoryDocument
setVisible(
int $v)
Set the value of [visible] column.
in
CategoryDocument at line 604
CategoryDocument
setPosition(
int $v)
Set the value of [position] column.
in
CategoryDocument at line 626
CategoryDocument
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
in
CategoryDocument at line 647
CategoryDocument
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
in
CategoryDocument at line 669
boolean
hasOnlyDefaultValues()
Indicates whether the columns in this object are only set to default values.
This method can be used in conjunction with isModified() to indicate whether an object is both modified and has some values set which are non-default.
in
CategoryDocument at line 697
int
hydrate(
array $row,
int $startcol,
boolean $rehydrate = false,
string $indexType = TableMap::TYPE_NUM)
Hydrates (populates) the object variables with values from the database resultset.
An offset (0-based "start column") is specified so that objects can be hydrated with a subset of the columns in the resultset rows. This is needed, for example, for results of JOIN queries where the resultset row includes columns from two or more tables.
in
CategoryDocument at line 756
ensureConsistency()
Checks and repairs the internal consistency of the object.
This method is executed after an already-instantiated object is re-hydrated from the database. It exists to check any foreign keys to make sure that the objects related to the current object are correct based on foreign key.
You can override this method in the stub class, but you should always invoke the base method from the overridden method (i.e. parent::ensureConsistency()), in case your model changes.
in
CategoryDocument at line 773
void
reload(
boolean $deep = false,
ConnectionInterface $con = null)
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
This will only work if the object has been saved and has a valid primary key set.
in
CategoryDocument at line 815
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
in
CategoryDocument at line 857
int
save(
ConnectionInterface $con = null)
Persists this object to the database.
If the object is new, it inserts it; otherwise an update is performed. All modified related objects will also be persisted in the doSave() method. This method wraps all precipitate database operations in a single transaction.
in
CategoryDocument at line 1088
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
in
CategoryDocument at line 1103
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
in
CategoryDocument at line 1148
array
toArray(
string $keyType = TableMap::TYPE_PHPNAME,
boolean $includeLazyLoadColumns = true,
array $alreadyDumpedObjects = array(),
boolean $includeForeignObjects = false)
Exports the object as an array.
You can specify the key type of the array by passing one of the class type constants.
in
CategoryDocument at line 1192
void
setByName(
string $name,
mixed $value,
string $type = TableMap::TYPE_PHPNAME)
Sets a field from the object by name passed in as a string.
in
CategoryDocument at line 1207
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
in
CategoryDocument at line 1251
void
fromArray(
array $arr,
string $keyType = TableMap::TYPE_PHPNAME)
Populates the object using an array.
This is particularly useful when populating an object from one of the request arrays (e.g. $_POST). This method goes through the column names, checking to see whether a matching key exists in populated array. If so the setByName() method is called for that column.
You can specify the key type of the array by additionally passing one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME, TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. The default key type is the column's TableMap::TYPEPHPNAME.
in
CategoryDocument at line 1269
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
in
CategoryDocument at line 1292
Criteria
buildPkeyCriteria()
Builds a Criteria object containing the primary key for this object.
Unlike buildCriteria() this method includes the primary key values regardless of whether or not they have been modified.
in
CategoryDocument at line 1304
int
getPrimaryKey()
Returns the primary key for this object (row).
in
CategoryDocument at line 1315
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
CategoryDocument at line 1324
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
in
CategoryDocument at line 1341
copyInto(
object $copyObj,
boolean $deepCopy = false,
boolean $makeNew = true)
Sets contents of passed object to values from current object.
If desired, this method can also make copies of all associated (fkey referrers) objects.
in
CategoryDocument at line 1381
CategoryDocument
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
CategoryDocument at line 1398
CategoryDocument
setCategory(
Category $v = null)
Declares an association between this object and a ChildCategory object.
in
CategoryDocument at line 1426
Category
getCategory(
ConnectionInterface $con = null)
Get the associated ChildCategory object
in
CategoryDocument at line 1451
void
initRelation(
string $relationName)
Initializes a collection based on the name of a relation.
Avoids crafting an 'init[$relationName]s' method name that wouldn't work when StandardEnglishPluralizer is used.
in
CategoryDocument at line 1467
void
clearCategoryDocumentI18ns()
Clears out the collCategoryDocumentI18ns 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
CategoryDocument at line 1475
resetPartialCategoryDocumentI18ns($v = true)
Reset is the collCategoryDocumentI18ns collection loaded partially.
in
CategoryDocument at line 1492
void
initCategoryDocumentI18ns(
boolean $overrideExisting = true)
Initializes the collCategoryDocumentI18ns collection.
By default this just sets the collCategoryDocumentI18ns collection to an empty array (like clearcollCategoryDocumentI18ns()); 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
CategoryDocument at line 1515
Collection|CategoryDocumentI18n[]
getCategoryDocumentI18ns(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildCategoryDocumentI18n 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 ChildCategoryDocument is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
in
CategoryDocument at line 1571
CategoryDocument
setCategoryDocumentI18ns(
Collection $categoryDocumentI18ns,
ConnectionInterface $con = null)
Sets a collection of CategoryDocumentI18n 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
CategoryDocument at line 1605
int
countCategoryDocumentI18ns(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related CategoryDocumentI18n objects.
in
CategoryDocument at line 1637
CategoryDocument
addCategoryDocumentI18n(
CategoryDocumentI18n $l)
Method called to associate a ChildCategoryDocumentI18n object to this object through the ChildCategoryDocumentI18n foreign key attribute.
in
CategoryDocument at line 1668
CategoryDocument
removeCategoryDocumentI18n(
CategoryDocumentI18n $categoryDocumentI18n)
in
CategoryDocument at line 1686
clear()
Clears the current object and sets all attributes to their default values
in
CategoryDocument at line 1712
clearAllReferences(
boolean $deep = false)
Resets all references to other model objects or collections of model objects.
This method is a user-space workaround for PHP's inability to garbage collect objects with circular references (even in PHP 5.3). This is currently necessary when using Propel in certain daemon or large-volume/high-memory operations.
in
CategoryDocument at line 1735
string
__toString()
Return the string representation of this object
in
CategoryDocument at line 1747
CategoryDocument
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
in
CategoryDocument at line 1763
CategoryDocument
setLocale(
string $locale = 'en_US')
Sets the locale for translations
in
CategoryDocument at line 1775
string
getLocale()
Gets the locale for translations
in
CategoryDocument at line 1787
CategoryDocumentI18n
getTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Returns the current translation for a given locale
in
CategoryDocument at line 1822
CategoryDocument
removeTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Remove the translation for a given locale
in
CategoryDocument at line 1848
CategoryDocumentI18n
getCurrentTranslation(
ConnectionInterface $con = null)
Returns the current translation
in
CategoryDocument at line 1859
string
getTitle()
Get the [title] column value.
in
CategoryDocument at line 1871
CategoryDocumentI18n
setTitle(
string $v)
Set the value of [title] column.
in
CategoryDocument at line 1883
string
getDescription()
Get the [description] column value.
in
CategoryDocument at line 1895
CategoryDocumentI18n
setDescription(
string $v)
Set the value of [description] column.
in
CategoryDocument at line 1907
string
getChapo()
Get the [chapo] column value.
in
CategoryDocument at line 1919
CategoryDocumentI18n
setChapo(
string $v)
Set the value of [chapo] column.
in
CategoryDocument at line 1931
string
getPostscriptum()
Get the [postscriptum] column value.
in
CategoryDocument at line 1943
CategoryDocumentI18n
setPostscriptum(
string $v)
Set the value of [postscriptum] column.
in
CategoryDocument at line 1954
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
CategoryDocument at line 1963
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 40
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
in
CategoryDocument at line 1982
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
in
CategoryDocument at line 1992
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
in
CategoryDocument at line 2001
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 65
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
in
CategoryDocument at line 2020
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
in
CategoryDocument at line 2037
array|string
__call(
string $name,
mixed $params)
Derived method to catches calls to undefined methods.
Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.). Allows to define default __call() behavior if you overwrite __call()
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
in
CatalogBreadcrumbTrait at line 22
getBaseBreadcrumb(
Router $router,
ContainerInterface $container, $categoryId)
in
CatalogBreadcrumbTrait at line 46
getProductBreadcrumb(
Router $router,
ContainerInterface $container, $tab, $locale)
in
CatalogBreadcrumbTrait at line 65
getCategoryBreadcrumb(
Router $router,
ContainerInterface $container, $tab, $locale)
at line 50
$this
setParentId(
int $parentId)
at line 60
int
getParentId()
at line 79
array
getBreadcrumb(
Router $router,
ContainerInterface $container,
string $tab,
string $locale)
at line 87
FileModelParentInterface
getParentFileModel()
at line 97
BaseForm
getUpdateFormId()
Get the ID of the form used to change this object information
at line 105
string
getUploadDir()
at line 122
string
getRedirectionUrl()
at line 132
ModelCriteria
getQueryInstance()
Get the Query instance for this object