1. class
  2. Thelia
  3. Model
  4. Hook

Hook

class Hook extends Hook

Constants

TABLE_MAP

TableMap class name

Methods

__construct()

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

from  Hook
boolean
isModified()

Returns whether the object has been modified.

from  Hook
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Hook
array
getModifiedColumns()

Get the columns that have been modified in this object.

from  Hook
boolean
isNew()

Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.

from  Hook
setNew( boolean $b)

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

from  Hook
boolean
isDeleted()

Whether this object has been deleted.

from  Hook
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Hook
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Hook
boolean
equals( mixed $obj)

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

from  Hook
int
hashCode()

If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.

from  Hook
array
getVirtualColumns()

Get the associative array of the virtual columns in this object

from  Hook
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Hook
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

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

Set the value of a virtual column in this object

from  Hook
Hook
importFrom( mixed $parser, string $data)

Populate the current object from a string, using a given parser format $book = new Book(); $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

from  Hook
string
exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)

Export the current object properties to a string, using a given parser format $book = BookQuery::create()->findPk(9012); echo $book->exportTo('JSON'); => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

from  Hook
__sleep()

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

from  Hook
int
getId()

Get the [id] column value.

from  Hook
string
getCode()

Get the [code] column value.

from  Hook
int
getType()

Get the [type] column value.

from  Hook
boolean
getByModule()

Get the [by_module] column value.

from  Hook
boolean
getNative()

Get the [native] column value.

from  Hook
boolean
getActivate()

Get the [activate] column value.

from  Hook
boolean
getBlock()

Get the [block] column value.

from  Hook
int
getPosition()

Get the [position] column value.

from  Hook
mixed
getCreatedAt( string $format = NULL)

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

from  Hook
mixed
getUpdatedAt( string $format = NULL)

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

from  Hook
Hook
setId( int $v)

Set the value of [id] column.

from  Hook
Hook
setCode( string $v)

Set the value of [code] column.

from  Hook
Hook
setType( int $v)

Set the value of [type] column.

from  Hook
Hook
setByModule( boolean|integer|string $v)

Sets the value of the [by_module] column.

from  Hook
Hook
setNative( boolean|integer|string $v)

Sets the value of the [native] column.

from  Hook
Hook
setActivate( boolean|integer|string $v)

Sets the value of the [activate] column.

from  Hook
Hook
setBlock( boolean|integer|string $v)

Sets the value of the [block] column.

from  Hook
Hook
setPosition( int $v)

Set the value of [position] column.

from  Hook
Hook
setCreatedAt( mixed $v)

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

from  Hook
Hook
setUpdatedAt( mixed $v)

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

from  Hook
boolean
hasOnlyDefaultValues()

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

from  Hook
int
hydrate( array $row, int $startcol, boolean $rehydrate = false, string $indexType = TableMap::TYPE_NUM)

Hydrates (populates) the object variables with values from the database resultset.

from  Hook
ensureConsistency()

Checks and repairs the internal consistency of the object.

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

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

from  Hook
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Hook
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  Hook
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

from  Hook
void
setByName( string $name, mixed $value, string $type = TableMap::TYPE_PHPNAME)

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

from  Hook
void
setByPosition( int $pos, mixed $value)

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

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

Populates the object using an array.

from  Hook
Criteria
buildCriteria()

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

from  Hook
Criteria
buildPkeyCriteria()

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

from  Hook
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Hook
void
setPrimaryKey( int $key)

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

from  Hook
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  Hook
Hook
copy( boolean $deepCopy = false)

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

from  Hook
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  Hook
void
clearModuleHooks()

Clears out the collModuleHooks collection

from  Hook
resetPartialModuleHooks($v = true)

Reset is the collModuleHooks collection loaded partially.

from  Hook
void
initModuleHooks( boolean $overrideExisting = true)

Initializes the collModuleHooks collection.

from  Hook
Collection|ModuleHook[]
getModuleHooks( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Hook
Hook
setModuleHooks( Collection $moduleHooks, ConnectionInterface $con = null)

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

from  Hook
int
countModuleHooks( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related ModuleHook objects.

from  Hook
Hook
addModuleHook( ModuleHook $l)

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

from  Hook
Hook
removeModuleHook( ModuleHook $moduleHook)

No description

from  Hook
Collection|ModuleHook[]
getModuleHooksJoinModule( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  Hook
void
clearIgnoredModuleHooks()

Clears out the collIgnoredModuleHooks collection

from  Hook
resetPartialIgnoredModuleHooks($v = true)

Reset is the collIgnoredModuleHooks collection loaded partially.

from  Hook
void
initIgnoredModuleHooks( boolean $overrideExisting = true)

Initializes the collIgnoredModuleHooks collection.

from  Hook
Collection|IgnoredModuleHook[]
getIgnoredModuleHooks( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Hook
Hook
setIgnoredModuleHooks( Collection $ignoredModuleHooks, ConnectionInterface $con = null)

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

from  Hook
int
countIgnoredModuleHooks( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related IgnoredModuleHook objects.

from  Hook
Hook
addIgnoredModuleHook( IgnoredModuleHook $l)

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

from  Hook
Hook
removeIgnoredModuleHook( IgnoredModuleHook $ignoredModuleHook)

No description

from  Hook
Collection|IgnoredModuleHook[]
getIgnoredModuleHooksJoinModule( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  Hook
void
clearHookI18ns()

Clears out the collHookI18ns collection

from  Hook
resetPartialHookI18ns($v = true)

Reset is the collHookI18ns collection loaded partially.

from  Hook
void
initHookI18ns( boolean $overrideExisting = true)

Initializes the collHookI18ns collection.

from  Hook
Collection|HookI18n[]
getHookI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Hook
Hook
setHookI18ns( Collection $hookI18ns, ConnectionInterface $con = null)

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

from  Hook
int
countHookI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related HookI18n objects.

from  Hook
Hook
addHookI18n( HookI18n $l)

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

from  Hook
Hook
removeHookI18n( HookI18n $hookI18n)

No description

from  Hook
void
clearModules()

Clears out the collModules collection

from  Hook
void
initModules()

Initializes the collModules collection.

from  Hook
ObjectCollection|Module[]
getModules( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Hook
Hook
setModules( Collection $modules, ConnectionInterface $con = null)

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

from  Hook
int
countModules( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

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

from  Hook
Hook
addModule( Module $module)

Associate a ChildModule object to this object through the ignoredmodulehook cross reference table.

from  Hook
Hook
removeModule( Module $module)

Remove a ChildModule object to this object through the ignoredmodulehook cross reference table.

from  Hook
clear()

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

from  Hook
clearAllReferences( boolean $deep = false)

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

from  Hook
string
__toString()

Return the string representation of this object

from  Hook
Hook
keepUpdateDateUnchanged()

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

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

Sets the locale for translations

from  Hook
string
getLocale()

Gets the locale for translations

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

Returns the current translation for a given locale

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

Remove the translation for a given locale

from  Hook
HookI18n
getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

from  Hook
string
getTitle()

Get the [title] column value.

from  Hook
HookI18n
setTitle( string $v)

Set the value of [title] column.

from  Hook
string
getDescription()

Get the [description] column value.

from  Hook
HookI18n
setDescription( string $v)

Set the value of [description] column.

from  Hook
string
getChapo()

Get the [chapo] column value.

from  Hook
HookI18n
setChapo( string $v)

Set the value of [chapo] column.

from  Hook
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  Hook
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

from  Hook
boolean
preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

from  Hook
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

from  Hook
boolean
preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

from  Hook
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

from  Hook
boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

from  Hook
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

from  Hook
array|string
__call( string $name, mixed $params)

Derived method to catches calls to undefined methods.

from  Hook

Details

in Hook at line 198
__construct()

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

in Hook at line 207
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Hook at line 218
boolean isColumnModified( string $col)

Has specified column been modified?

Parameters

string $col column fully qualified name (TableMap::TYPECOLNAME), e.g. Book::AUTHORID

Return Value

boolean True if $col has been modified.

in Hook at line 227
array getModifiedColumns()

Get the columns that have been modified in this object.

Return Value

array A unique list of the modified column names for this object.

in Hook at line 239
boolean isNew()

Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.

Return Value

boolean true, if the object has never been persisted.

in Hook at line 250
setNew( boolean $b)

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

Parameters

boolean $b the state of the object.

in Hook at line 259
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Hook at line 269
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Hook at line 279
void resetModified( string $col = null)

Sets the modified state for the object to be false.

Parameters

string $col If supplied, only the specified column is reset.

Return Value

void

in Hook at line 298
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Hook at line 323
int hashCode()

If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.

Return Value

int Hashcode

in Hook at line 337
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Hook at line 348
boolean hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

Parameters

string $name The virtual column name

Return Value

boolean

in Hook at line 361
mixed getVirtualColumn( string $name)

Get the value of a virtual column in this object

Parameters

string $name The virtual column name

Return Value

mixed

Exceptions

PropelException

in Hook at line 378
Hook 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

Hook The current object, for fluid interface

in Hook at line 410
Hook 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

Hook The current object, for fluid interface

in Hook at line 433
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

in Hook at line 446
__sleep()

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

in Hook at line 458
int getId()

Get the [id] column value.

Return Value

int

in Hook at line 469
string getCode()

Get the [code] column value.

Return Value

string

in Hook at line 480
int getType()

Get the [type] column value.

Return Value

int

in Hook at line 491
boolean getByModule()

Get the [by_module] column value.

Return Value

boolean

in Hook at line 502
boolean getNative()

Get the [native] column value.

Return Value

boolean

in Hook at line 513
boolean getActivate()

Get the [activate] column value.

Return Value

boolean

in Hook at line 524
boolean getBlock()

Get the [block] column value.

Return Value

boolean

in Hook at line 535
int getPosition()

Get the [position] column value.

Return Value

int

in Hook at line 552
mixed getCreatedAt( string $format = NULL)

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

Parameters

string $format The date/time format string (either date()-style or strftime()-style). If format is NULL, then the raw \DateTime object will be returned.

Return Value

mixed Formatted date/time value as string or \DateTime object (if format is NULL), NULL if column is NULL, and 0 if column value is 0000-00-00 00:00:00

Exceptions

PropelException
  • if unable to parse/validate the date/time value.

in Hook at line 572
mixed getUpdatedAt( string $format = NULL)

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

Parameters

string $format The date/time format string (either date()-style or strftime()-style). If format is NULL, then the raw \DateTime object will be returned.

Return Value

mixed Formatted date/time value as string or \DateTime object (if format is NULL), NULL if column is NULL, and 0 if column value is 0000-00-00 00:00:00

Exceptions

PropelException
  • if unable to parse/validate the date/time value.

in Hook at line 587
Hook setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Hook The current object (for fluent API support)

in Hook at line 608
Hook setCode( string $v)

Set the value of [code] column.

Parameters

string $v new value

Return Value

Hook The current object (for fluent API support)

in Hook at line 629
Hook setType( int $v)

Set the value of [type] column.

Parameters

int $v new value

Return Value

Hook The current object (for fluent API support)

in Hook at line 654
Hook setByModule( boolean|integer|string $v)

Sets the value of the [by_module] 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').

Parameters

boolean|integer|string $v The new value

Return Value

Hook The current object (for fluent API support)

in Hook at line 683
Hook setNative( boolean|integer|string $v)

Sets the value of the [native] 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').

Parameters

boolean|integer|string $v The new value

Return Value

Hook The current object (for fluent API support)

in Hook at line 712
Hook setActivate( boolean|integer|string $v)

Sets the value of the [activate] 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').

Parameters

boolean|integer|string $v The new value

Return Value

Hook The current object (for fluent API support)

in Hook at line 741
Hook setBlock( boolean|integer|string $v)

Sets the value of the [block] 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').

Parameters

boolean|integer|string $v The new value

Return Value

Hook The current object (for fluent API support)

in Hook at line 766
Hook setPosition( int $v)

Set the value of [position] column.

Parameters

int $v new value

Return Value

Hook The current object (for fluent API support)

in Hook at line 788
Hook 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

Hook The current object (for fluent API support)

in Hook at line 809
Hook 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

Hook The current object (for fluent API support)

in Hook at line 831
boolean hasOnlyDefaultValues()

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

This method can be used in conjunction with isModified() to indicate whether an object is both modified and has some values set which are non-default.

Return Value

boolean Whether the columns in this object are only been set with default values.

in Hook at line 855
int hydrate( array $row, int $startcol, boolean $rehydrate = false, string $indexType = TableMap::TYPE_NUM)

Hydrates (populates) the object variables with values from the database resultset.

An offset (0-based "start column") is specified so that objects can be hydrated with a subset of the columns in the resultset rows. This is needed, for example, for results of JOIN queries where the resultset row includes columns from two or more tables.

Parameters

array $row The row returned by DataFetcher->fetch().
int $startcol 0-based offset column which indicates which restultset column to start with.
boolean $rehydrate Whether this object is being re-hydrated from the database.
string $indexType The index type of $row. Mostly DataFetcher->getIndexType(). One of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPE_NUM.

Return Value

int next starting column

Exceptions

PropelException
  • Any caught Exception will be rewrapped as a PropelException.

in Hook at line 923
ensureConsistency()

Checks and repairs the internal consistency of the object.

This method is executed after an already-instantiated object is re-hydrated from the database. It exists to check any foreign keys to make sure that the objects related to the current object are correct based on foreign key.

You can override this method in the stub class, but you should always invoke the base method from the overridden method (i.e. parent::ensureConsistency()), in case your model changes.

Exceptions

PropelException

in Hook at line 937
void reload( boolean $deep = false, ConnectionInterface $con = null)

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

This will only work if the object has been saved and has a valid primary key set.

Parameters

boolean $deep (optional) Whether to also de-associated any related objects.
ConnectionInterface $con (optional) The ConnectionInterface connection to use.

Return Value

void

Exceptions

PropelException
  • if this object is deleted, unsaved or doesn't have pk match in db

in Hook at line 983
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Hook::setDeleted()
Hook::isDeleted()

in Hook at line 1025
int save( ConnectionInterface $con = null)

Persists this object to the database.

If the object is new, it inserts it; otherwise an update is performed. All modified related objects will also be persisted in the doSave() method. This method wraps all precipitate database operations in a single transaction.

Parameters

ConnectionInterface $con

Return Value

int The number of rows affected by this insert/update and any referring fk objects' save() operations.

Exceptions

PropelException

See also

doSave()

in Hook at line 1323
mixed getByName( string $name, string $type = TableMap::TYPE_PHPNAME)

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

Parameters

string $name name
string $type The type of fieldname the $name is of: one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.

Return Value

mixed Value of field.

in Hook at line 1338
mixed getByPosition( int $pos)

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

Zero-based.

Parameters

int $pos position in xml schema

Return Value

mixed Value of field at $pos

in Hook at line 1392
array toArray( string $keyType = TableMap::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array(), boolean $includeForeignObjects = false)

Exports the object as an array.

You can specify the key type of the array by passing one of the class type constants.

Parameters

string $keyType (optional) One of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME, TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.
boolean $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to TRUE.
array $alreadyDumpedObjects List of objects to skip to avoid recursion
boolean $includeForeignObjects (optional) Whether to include hydrated related objects. Default to FALSE.

Return Value

array an associative array containing the field names (as keys) and field values

in Hook at line 1442
void setByName( string $name, mixed $value, string $type = TableMap::TYPE_PHPNAME)

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

Parameters

string $name
mixed $value field value
string $type The type of fieldname the $name is of: one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.

Return Value

void

in Hook at line 1457
void setByPosition( int $pos, mixed $value)

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

Zero-based.

Parameters

int $pos position in xml schema
mixed $value field value

Return Value

void

in Hook at line 1510
void fromArray( array $arr, string $keyType = TableMap::TYPE_PHPNAME)

Populates the object using an array.

This is particularly useful when populating an object from one of the request arrays (e.g. $_POST). This method goes through the column names, checking to see whether a matching key exists in populated array. If so the setByName() method is called for that column.

You can specify the key type of the array by additionally passing one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME, TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. The default key type is the column's TableMap::TYPEPHPNAME.

Parameters

array $arr An array to populate the object from.
string $keyType The type of keys the array uses.

Return Value

void

in Hook at line 1531
Criteria buildCriteria()

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

Return Value

Criteria The Criteria object containing all modified values.

in Hook at line 1557
Criteria buildPkeyCriteria()

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

Unlike buildCriteria() this method includes the primary key values regardless of whether or not they have been modified.

Return Value

Criteria The Criteria object containing value(s) for primary key(s).

in Hook at line 1569
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Hook at line 1580
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Hook at line 1589
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Hook at line 1606
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\Hook (or compatible) type.
boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
boolean $makeNew Whether to reset autoincrement PKs and make the object new.

Exceptions

PropelException

in Hook at line 1661
Hook 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

Hook Clone of current object.

Exceptions

PropelException

in Hook at line 1680
void initRelation( string $relationName)

Initializes a collection based on the name of a relation.

Avoids crafting an 'init[$relationName]s' method name that wouldn't work when StandardEnglishPluralizer is used.

Parameters

string $relationName The name of the relation to initialize

Return Value

void

in Hook at line 1702
void clearModuleHooks()

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

addModuleHooks()

in Hook at line 1710
resetPartialModuleHooks($v = true)

Reset is the collModuleHooks collection loaded partially.

Parameters

$v

in Hook at line 1727
void initModuleHooks( boolean $overrideExisting = true)

Initializes the collModuleHooks collection.

By default this just sets the collModuleHooks collection to an empty array (like clearcollModuleHooks()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Return Value

void

in Hook at line 1750
Collection|ModuleHook[] getModuleHooks( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildModuleHook 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 ChildHook 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|ModuleHook[] List of ChildModuleHook objects

Exceptions

PropelException

in Hook at line 1806
Hook setModuleHooks( Collection $moduleHooks, ConnectionInterface $con = null)

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

Return Value

Hook The current object (for fluent API support)

in Hook at line 1837
int countModuleHooks( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related ModuleHook objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related ModuleHook objects.

Exceptions

PropelException

in Hook at line 1869
Hook addModuleHook( ModuleHook $l)

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

Parameters

ModuleHook $l ChildModuleHook

Return Value

Hook The current object (for fluent API support)

in Hook at line 1896
Hook removeModuleHook( ModuleHook $moduleHook)

Parameters

ModuleHook $moduleHook The moduleHook object to remove.

Return Value

Hook The current object (for fluent API support)

in Hook at line 1928
Collection|ModuleHook[] getModuleHooksJoinModule( 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 Hook is new, it will return an empty collection; or if this Hook has previously been saved, it will retrieve related ModuleHooks 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 Hook.

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|ModuleHook[] List of ChildModuleHook objects

in Hook at line 1945
void clearIgnoredModuleHooks()

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

addIgnoredModuleHooks()

in Hook at line 1953
resetPartialIgnoredModuleHooks($v = true)

Reset is the collIgnoredModuleHooks collection loaded partially.

Parameters

$v

in Hook at line 1970
void initIgnoredModuleHooks( boolean $overrideExisting = true)

Initializes the collIgnoredModuleHooks collection.

By default this just sets the collIgnoredModuleHooks collection to an empty array (like clearcollIgnoredModuleHooks()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Return Value

void

in Hook at line 1993
Collection|IgnoredModuleHook[] getIgnoredModuleHooks( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildIgnoredModuleHook 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 ChildHook 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|IgnoredModuleHook[] List of ChildIgnoredModuleHook objects

Exceptions

PropelException

in Hook at line 2049
Hook setIgnoredModuleHooks( Collection $ignoredModuleHooks, ConnectionInterface $con = null)

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

Return Value

Hook The current object (for fluent API support)

in Hook at line 2083
int countIgnoredModuleHooks( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related IgnoredModuleHook objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related IgnoredModuleHook objects.

Exceptions

PropelException

in Hook at line 2115
Hook addIgnoredModuleHook( IgnoredModuleHook $l)

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

Parameters

IgnoredModuleHook $l ChildIgnoredModuleHook

Return Value

Hook The current object (for fluent API support)

in Hook at line 2142
Hook removeIgnoredModuleHook( IgnoredModuleHook $ignoredModuleHook)

Parameters

IgnoredModuleHook $ignoredModuleHook The ignoredModuleHook object to remove.

Return Value

Hook The current object (for fluent API support)

in Hook at line 2174
Collection|IgnoredModuleHook[] getIgnoredModuleHooksJoinModule( 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 Hook is new, it will return an empty collection; or if this Hook has previously been saved, it will retrieve related IgnoredModuleHooks 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 Hook.

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|IgnoredModuleHook[] List of ChildIgnoredModuleHook objects

in Hook at line 2191
void clearHookI18ns()

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

addHookI18ns()

in Hook at line 2199
resetPartialHookI18ns($v = true)

Reset is the collHookI18ns collection loaded partially.

Parameters

$v

in Hook at line 2216
void initHookI18ns( boolean $overrideExisting = true)

Initializes the collHookI18ns collection.

By default this just sets the collHookI18ns collection to an empty array (like clearcollHookI18ns()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Return Value

void

in Hook at line 2239
Collection|HookI18n[] getHookI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildHookI18n 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 ChildHook 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|HookI18n[] List of ChildHookI18n objects

Exceptions

PropelException

in Hook at line 2295
Hook setHookI18ns( Collection $hookI18ns, ConnectionInterface $con = null)

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

Return Value

Hook The current object (for fluent API support)

in Hook at line 2329
int countHookI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related HookI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related HookI18n objects.

Exceptions

PropelException

in Hook at line 2361
Hook addHookI18n( HookI18n $l)

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

Parameters

HookI18n $l ChildHookI18n

Return Value

Hook The current object (for fluent API support)

in Hook at line 2392
Hook removeHookI18n( HookI18n $hookI18n)

Parameters

HookI18n $hookI18n The hookI18n object to remove.

Return Value

Hook The current object (for fluent API support)

in Hook at line 2416
void clearModules()

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

addModules()

in Hook at line 2431
void initModules()

Initializes the collModules collection.

By default this just sets the collModules collection to an empty collection (like clearModules()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.

Return Value

void

in Hook at line 2452
ObjectCollection|Module[] getModules( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildModule objects related by a many-to-many relationship to the current object by way of the ignoredmodulehook 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 ChildHook 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|Module[] List of ChildModule objects

in Hook at line 2482
Hook setModules( Collection $modules, ConnectionInterface $con = null)

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

Return Value

Hook The current object (for fluent API support)

in Hook at line 2510
int countModules( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

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

in Hook at line 2537
Hook addModule( Module $module)

Associate a ChildModule object to this object through the ignoredmodulehook cross reference table.

Parameters

Module $module The ChildIgnoredModuleHook object to relate

Return Value

Hook The current object (for fluent API support)

in Hook at line 2574
Hook removeModule( Module $module)

Remove a ChildModule object to this object through the ignoredmodulehook cross reference table.

Parameters

Module $module The ChildIgnoredModuleHook object to relate

Return Value

Hook The current object (for fluent API support)

in Hook at line 2593
clear()

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

in Hook at line 2621
clearAllReferences( boolean $deep = false)

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

This method is a user-space workaround for PHP's inability to garbage collect objects with circular references (even in PHP 5.3). This is currently necessary when using Propel in certain daemon or large-volume/high-memory operations.

Parameters

boolean $deep Whether to also clear the references on all referrer objects.

in Hook at line 2661
string __toString()

Return the string representation of this object

Return Value

string

in Hook at line 2673
Hook keepUpdateDateUnchanged()

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

Return Value

Hook The current object (for fluent API support)

in Hook at line 2689
Hook 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

Hook The current object (for fluent API support)

in Hook at line 2701
string getLocale()

Gets the locale for translations

Return Value

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

in Hook at line 2713
HookI18n 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

HookI18n

in Hook at line 2748
Hook 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

Hook The current object (for fluent API support)

in Hook at line 2774
HookI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

HookI18n

in Hook at line 2785
string getTitle()

Get the [title] column value.

Return Value

string

in Hook at line 2797
HookI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

HookI18n The current object (for fluent API support)

in Hook at line 2809
string getDescription()

Get the [description] column value.

Return Value

string

in Hook at line 2821
HookI18n setDescription( string $v)

Set the value of [description] column.

Parameters

string $v new value

Return Value

HookI18n The current object (for fluent API support)

in Hook at line 2833
string getChapo()

Get the [chapo] column value.

Return Value

string

in Hook at line 2845
HookI18n setChapo( string $v)

Set the value of [chapo] column.

Parameters

string $v new value

Return Value

HookI18n The current object (for fluent API support)

in Hook at line 2856
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Hook at line 2865
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

in Hook at line 2875
boolean preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

in Hook at line 2884
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

in Hook at line 2894
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in Hook at line 2903
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

in Hook at line 2913
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in Hook at line 2922
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in Hook at line 2939
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