class SaleProduct extends SaleProduct

Constants

TABLE_MAP

TableMap class name

Methods

__construct()

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

boolean
isModified()

Returns whether the object has been modified.

boolean
isColumnModified( string $col)

Has specified column been modified?

array
getModifiedColumns()

Get the columns that have been modified in this object.

boolean
isNew()

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

setNew( boolean $b)

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

boolean
isDeleted()

Whether this object has been deleted.

void
setDeleted( boolean $b)

Specify whether this object has been deleted.

void
resetModified( string $col = null)

Sets the modified state for the object to be false.

boolean
equals( mixed $obj)

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

int
hashCode()

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

array
getVirtualColumns()

Get the associative array of the virtual columns in this object

boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

importFrom( mixed $parser, string $data)

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

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

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

__sleep()

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

int
getId()

Get the [id] column value.

int
getSaleId()

Get the [sale_id] column value.

int
getProductId()

Get the [product_id] column value.

int
getAttributeAvId()

Get the [attributeavid] column value.

setId( int $v)

Set the value of [id] column.

setSaleId( int $v)

Set the value of [sale_id] column.

setProductId( int $v)

Set the value of [product_id] column.

setAttributeAvId( int $v)

Set the value of [attributeavid] column.

boolean
hasOnlyDefaultValues()

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

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

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

ensureConsistency()

Checks and repairs the internal consistency of the object.

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

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

void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

void
setByPosition( int $pos, mixed $value)

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

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

Populates the object using an array.

Criteria
buildCriteria()

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

Criteria
buildPkeyCriteria()

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

int
getPrimaryKey()

Returns the primary key for this object (row).

void
setPrimaryKey( int $key)

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

boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

copy( boolean $deepCopy = false)

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

setSale( Sale $v = null)

Declares an association between this object and a ChildSale object.

getSale( ConnectionInterface $con = null)

Get the associated ChildSale object

setProduct( Product $v = null)

Declares an association between this object and a ChildProduct object.

getProduct( ConnectionInterface $con = null)

Get the associated ChildProduct object

setAttributeAv( AttributeAv $v = null)

Declares an association between this object and a ChildAttributeAv object.

getAttributeAv( ConnectionInterface $con = null)

Get the associated ChildAttributeAv object

clear()

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

clearAllReferences( boolean $deep = false)

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

string
__toString()

Return the string representation of this object

boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

boolean
preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

boolean
preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

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

Derived method to catches calls to undefined methods.

Details

in SaleProduct at line 110
__construct()

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

in SaleProduct at line 119
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in SaleProduct at line 130
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 SaleProduct at line 139
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 SaleProduct at line 151
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 SaleProduct at line 162
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 SaleProduct at line 171
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in SaleProduct at line 181
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in SaleProduct at line 191
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 SaleProduct at line 210
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in SaleProduct at line 235
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 SaleProduct at line 249
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in SaleProduct at line 260
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 SaleProduct at line 273
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 SaleProduct at line 290
SaleProduct 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

SaleProduct The current object, for fluid interface

in SaleProduct at line 322
SaleProduct 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

SaleProduct The current object, for fluid interface

in SaleProduct at line 345
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 SaleProduct at line 358
__sleep()

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

in SaleProduct at line 370
int getId()

Get the [id] column value.

Return Value

int

in SaleProduct at line 381
int getSaleId()

Get the [sale_id] column value.

Return Value

int

in SaleProduct at line 392
int getProductId()

Get the [product_id] column value.

Return Value

int

in SaleProduct at line 403
int getAttributeAvId()

Get the [attributeavid] column value.

Return Value

int

in SaleProduct at line 415
SaleProduct setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

SaleProduct The current object (for fluent API support)

in SaleProduct at line 436
SaleProduct setSaleId( int $v)

Set the value of [sale_id] column.

Parameters

int $v new value

Return Value

SaleProduct The current object (for fluent API support)

in SaleProduct at line 461
SaleProduct setProductId( int $v)

Set the value of [product_id] column.

Parameters

int $v new value

Return Value

SaleProduct The current object (for fluent API support)

in SaleProduct at line 486
SaleProduct setAttributeAvId( int $v)

Set the value of [attributeavid] column.

Parameters

int $v new value

Return Value

SaleProduct The current object (for fluent API support)

in SaleProduct at line 513
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 SaleProduct at line 537
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 SaleProduct at line 581
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 SaleProduct at line 604
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 SaleProduct at line 646
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

SaleProduct::setDeleted()
SaleProduct::isDeleted()

in SaleProduct at line 688
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 SaleProduct at line 887
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 SaleProduct at line 902
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 SaleProduct at line 938
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 SaleProduct at line 982
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 SaleProduct at line 997
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 SaleProduct at line 1032
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 SaleProduct at line 1047
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 SaleProduct at line 1067
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 SaleProduct at line 1079
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in SaleProduct at line 1090
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in SaleProduct at line 1099
boolean isPrimaryKeyNull()

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

Return Value

boolean

in SaleProduct at line 1116
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\SaleProduct (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 SaleProduct at line 1139
SaleProduct 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

SaleProduct Clone of current object.

Exceptions

PropelException

in SaleProduct at line 1156
SaleProduct setSale( Sale $v = null)

Declares an association between this object and a ChildSale object.

Parameters

Sale $v

Return Value

SaleProduct The current object (for fluent API support)

Exceptions

PropelException

in SaleProduct at line 1184
Sale getSale( ConnectionInterface $con = null)

Get the associated ChildSale object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Sale The associated ChildSale object.

Exceptions

PropelException

in SaleProduct at line 1207
SaleProduct setProduct( Product $v = null)

Declares an association between this object and a ChildProduct object.

Parameters

Product $v

Return Value

SaleProduct The current object (for fluent API support)

Exceptions

PropelException

in SaleProduct at line 1235
Product getProduct( ConnectionInterface $con = null)

Get the associated ChildProduct object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Product The associated ChildProduct object.

Exceptions

PropelException

in SaleProduct at line 1258
SaleProduct setAttributeAv( AttributeAv $v = null)

Declares an association between this object and a ChildAttributeAv object.

Parameters

AttributeAv $v

Return Value

SaleProduct The current object (for fluent API support)

Exceptions

PropelException

in SaleProduct at line 1286
AttributeAv getAttributeAv( ConnectionInterface $con = null)

Get the associated ChildAttributeAv object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

AttributeAv The associated ChildAttributeAv object.

Exceptions

PropelException

in SaleProduct at line 1305
clear()

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

in SaleProduct at line 1327
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 SaleProduct at line 1342
string __toString()

Return the string representation of this object

Return Value

string

in SaleProduct at line 1352
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in SaleProduct at line 1361
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

in SaleProduct at line 1371
boolean preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

in SaleProduct at line 1380
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

in SaleProduct at line 1390
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in SaleProduct at line 1399
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

in SaleProduct at line 1409
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in SaleProduct at line 1418
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in SaleProduct at line 1435
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