ModuleHook
class ModuleHook extends ModuleHook
Traits
Constants
TABLE_MAP |
TableMap class name |
MAX_POSITION |
|
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 ModuleHook
instance. If
obj
is an instance of ModuleHook
, delegates to
equals(ModuleHook)
. 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}');
Sets the value of the [active] column.
Sets the value of the [hook_active] column.
Sets the value of the [module_active] column.
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.
Declares an association between this object and a ChildModule object.
Get the associated ChildModule object
Declares an association between this object and a ChildHook object.
Resets all references to other model objects or collections of model objects.
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
Details
in
ModuleHook at line 139
__construct()
Initializes internal state of Thelia\Model\Base\ModuleHook object.
in
ModuleHook at line 148
boolean
isModified()
Returns whether the object has been modified.
in
ModuleHook at line 159
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
ModuleHook at line 168
array
getModifiedColumns()
Get the columns that have been modified in this object.
in
ModuleHook at line 180
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
ModuleHook at line 191
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
ModuleHook at line 200
boolean
isDeleted()
Whether this object has been deleted.
in
ModuleHook at line 210
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
ModuleHook at line 220
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
in
ModuleHook at line 239
boolean
equals(
mixed $obj)
Compares this with another ModuleHook
instance. If
obj
is an instance of ModuleHook
, delegates to
equals(ModuleHook)
. Otherwise, returns false
.
in
ModuleHook at line 264
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
ModuleHook at line 278
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
ModuleHook at line 289
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
ModuleHook at line 302
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
ModuleHook at line 319
ModuleHook
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
in
ModuleHook at line 351
ModuleHook
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
ModuleHook at line 374
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
ModuleHook at line 399
int
getId()
Get the [id] column value.
in
ModuleHook at line 410
int
getModuleId()
Get the [module_id] column value.
in
ModuleHook at line 421
int
getHookId()
Get the [hook_id] column value.
in
ModuleHook at line 432
string
getClassname()
Get the [classname] column value.
in
ModuleHook at line 443
string
getMethod()
Get the [method] column value.
in
ModuleHook at line 454
boolean
getActive()
Get the [active] column value.
in
ModuleHook at line 465
boolean
getHookActive()
Get the [hook_active] column value.
in
ModuleHook at line 476
boolean
getModuleActive()
Get the [module_active] column value.
in
ModuleHook at line 487
int
getPosition()
Get the [position] column value.
in
ModuleHook at line 498
string
getTemplates()
Get the [templates] column value.
in
ModuleHook at line 510
ModuleHook
setId(
int $v)
Set the value of [id] column.
in
ModuleHook at line 531
ModuleHook
setModuleId(
int $v)
Set the value of [module_id] column.
in
ModuleHook at line 556
ModuleHook
setHookId(
int $v)
Set the value of [hook_id] column.
in
ModuleHook at line 581
ModuleHook
setClassname(
string $v)
Set the value of [classname] column.
in
ModuleHook at line 602
ModuleHook
setMethod(
string $v)
Set the value of [method] column.
in
ModuleHook at line 627
ModuleHook
setActive(
boolean|integer|string $v)
Sets the value of the [active] column.
Non-boolean arguments are converted using the following rules: * 1, '1', 'true', 'on', and 'yes' are converted to boolean true * 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').
in
ModuleHook at line 656
ModuleHook
setHookActive(
boolean|integer|string $v)
Sets the value of the [hook_active] column.
Non-boolean arguments are converted using the following rules: * 1, '1', 'true', 'on', and 'yes' are converted to boolean true * 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').
in
ModuleHook at line 685
ModuleHook
setModuleActive(
boolean|integer|string $v)
Sets the value of the [module_active] column.
Non-boolean arguments are converted using the following rules: * 1, '1', 'true', 'on', and 'yes' are converted to boolean true * 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').
in
ModuleHook at line 710
ModuleHook
setPosition(
int $v)
Set the value of [position] column.
in
ModuleHook at line 731
ModuleHook
setTemplates(
string $v)
Set the value of [templates] column.
in
ModuleHook at line 754
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
ModuleHook at line 778
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
ModuleHook at line 840
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
ModuleHook at line 860
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
ModuleHook at line 901
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
in
ModuleHook at line 943
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
ModuleHook at line 1171
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
in
ModuleHook at line 1186
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
in
ModuleHook at line 1240
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
ModuleHook at line 1287
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
ModuleHook at line 1302
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
in
ModuleHook at line 1355
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
ModuleHook at line 1376
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
in
ModuleHook at line 1402
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
ModuleHook at line 1414
int
getPrimaryKey()
Returns the primary key for this object (row).
in
ModuleHook at line 1425
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
ModuleHook at line 1434
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
in
ModuleHook at line 1451
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
ModuleHook at line 1480
ModuleHook
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
ModuleHook at line 1497
ModuleHook
setModule(
Module $v = null)
Declares an association between this object and a ChildModule object.
in
ModuleHook at line 1525
Module
getModule(
ConnectionInterface $con = null)
Get the associated ChildModule object
in
ModuleHook at line 1548
ModuleHook
setHook(
Hook $v = null)
Declares an association between this object and a ChildHook object.
in
ModuleHook at line 1576
Hook
getHook(
ConnectionInterface $con = null)
Get the associated ChildHook object
in
ModuleHook at line 1595
clear()
Clears the current object and sets all attributes to their default values
in
ModuleHook at line 1623
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
ModuleHook at line 1637
string
__toString()
Return the string representation of this object
in
ModuleHook at line 1647
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
ModuleHook at line 1656
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
in
ModuleHook at line 1666
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
in
ModuleHook at line 1675
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
in
ModuleHook at line 1685
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
in
ModuleHook at line 1694
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
in
ModuleHook at line 1704
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
in
ModuleHook at line 1713
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
in
ModuleHook at line 1730
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