class Cart extends Cart

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

from  Cart
__construct()

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

from  Cart
boolean
isModified()

Returns whether the object has been modified.

from  Cart
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Cart
array
getModifiedColumns()

Get the columns that have been modified in this object.

from  Cart
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  Cart
setNew( boolean $b)

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

from  Cart
boolean
isDeleted()

Whether this object has been deleted.

from  Cart
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Cart
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Cart
boolean
equals( mixed $obj)

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

from  Cart
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  Cart
array
getVirtualColumns()

Get the associative array of the virtual columns in this object

from  Cart
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Cart
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

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

Set the value of a virtual column in this object

from  Cart
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  Cart
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  Cart
__sleep()

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

from  Cart
int
getId()

Get the [id] column value.

from  Cart
string
getToken()

Get the [token] column value.

from  Cart
int
getCustomerId()

Get the [customer_id] column value.

from  Cart
int
getAddressDeliveryId()

Get the [addressdeliveryid] column value.

from  Cart
int
getAddressInvoiceId()

Get the [addressinvoiceid] column value.

from  Cart
int
getCurrencyId()

Get the [currency_id] column value.

from  Cart
string
getDiscount()

Get the [discount] column value.

from  Cart
mixed
getCreatedAt( string $format = NULL)

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

from  Cart
mixed
getUpdatedAt( string $format = NULL)

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

from  Cart
setId( int $v)

Set the value of [id] column.

from  Cart
setToken( string $v)

Set the value of [token] column.

from  Cart
setCustomerId( int $v)

Set the value of [customer_id] column.

from  Cart
setAddressDeliveryId( int $v)

Set the value of [addressdeliveryid] column.

from  Cart
setAddressInvoiceId( int $v)

Set the value of [addressinvoiceid] column.

from  Cart
setCurrencyId( int $v)

Set the value of [currency_id] column.

from  Cart
setDiscount( string $v)

Set the value of [discount] column.

from  Cart
setCreatedAt( mixed $v)

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

from  Cart
setUpdatedAt( mixed $v)

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

from  Cart
boolean
hasOnlyDefaultValues()

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

from  Cart
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  Cart
ensureConsistency()

Checks and repairs the internal consistency of the object.

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

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

from  Cart
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Cart
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  Cart
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

from  Cart
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  Cart
void
setByPosition( int $pos, mixed $value)

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

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

Populates the object using an array.

from  Cart
Criteria
buildCriteria()

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

from  Cart
Criteria
buildPkeyCriteria()

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

from  Cart
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Cart
void
setPrimaryKey( int $key)

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

from  Cart
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  Cart
copy( boolean $deepCopy = false)

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

from  Cart
setCustomer( Customer $v = null)

Declares an association between this object and a ChildCustomer object.

from  Cart
getCustomer( ConnectionInterface $con = null)

Get the associated ChildCustomer object

from  Cart
setAddressRelatedByAddressDeliveryId( Address $v = null)

Declares an association between this object and a ChildAddress object.

from  Cart
getAddressRelatedByAddressDeliveryId( ConnectionInterface $con = null)

Get the associated ChildAddress object

from  Cart
setAddressRelatedByAddressInvoiceId( Address $v = null)

Declares an association between this object and a ChildAddress object.

from  Cart
getAddressRelatedByAddressInvoiceId( ConnectionInterface $con = null)

Get the associated ChildAddress object

from  Cart
setCurrency( Currency $v = null)

Declares an association between this object and a ChildCurrency object.

from  Cart
getCurrency( ConnectionInterface $con = null)

Get the associated ChildCurrency object

from  Cart
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  Cart
void
clearCartItems()

Clears out the collCartItems collection

from  Cart
resetPartialCartItems($v = true)

Reset is the collCartItems collection loaded partially.

from  Cart
void
initCartItems( boolean $overrideExisting = true)

Initializes the collCartItems collection.

from  Cart
Collection|CartItem[]
getCartItems( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Cart
setCartItems( Collection $cartItems, ConnectionInterface $con = null)

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

from  Cart
int
countCartItems( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CartItem objects.

from  Cart
addCartItem( CartItem $l)

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

from  Cart
removeCartItem( CartItem $cartItem)

No description

from  Cart
Collection|CartItem[]
getCartItemsJoinProduct( 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  Cart
Collection|CartItem[]
getCartItemsJoinProductSaleElements( 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  Cart
clear()

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

from  Cart
clearAllReferences( boolean $deep = false)

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

from  Cart
string
__toString()

Return the string representation of this object

from  Cart
keepUpdateDateUnchanged()

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

from  Cart
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  Cart
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

from  Cart
boolean
preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

from  Cart
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

from  Cart
boolean
preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

from  Cart
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

from  Cart
boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

from  Cart
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

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

Derived method to catches calls to undefined methods.

from  Cart
duplicate( string $token, Customer $customer = null, Currency $currency = null, EventDispatcherInterface $dispatcher = null)

Duplicate the current existing cart. Only the token is changed

getLastCartItemAdded()

Retrieve the last item added in the cart

float|int
getTaxedAmount( Country $country, $discount = true, State $state = null)

Retrieve the total taxed amount.

float|int
getTotalAmount( bool $discount = true)

No description

float|int
getTotalVAT($taxCountry, $taxState = null)

Return the VAT of all items

float|int
getWeight()

Retrieve the total weight for all products in cart

bool
isVirtual()

Tell if the cart contains only virtual products

Details

in Cart at line 167
applyDefaultValues()

Applies default values to this object.

This method should be called from the object's constructor (or equivalent initialization method).

See also

__construct()

in Cart at line 176
__construct()

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

See also

applyDefaults()

in Cart at line 186
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Cart at line 197
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 Cart at line 206
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 Cart at line 218
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 Cart at line 229
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 Cart at line 238
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Cart at line 248
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Cart at line 258
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 Cart at line 277
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Cart at line 302
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 Cart at line 316
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Cart at line 327
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 Cart at line 340
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 Cart at line 357
Cart 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

Cart The current object, for fluid interface

in Cart at line 389
Cart 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

Cart The current object, for fluid interface

in Cart at line 412
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 Cart at line 425
__sleep()

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

in Cart at line 437
int getId()

Get the [id] column value.

Return Value

int

in Cart at line 448
string getToken()

Get the [token] column value.

Return Value

string

in Cart at line 459
int getCustomerId()

Get the [customer_id] column value.

Return Value

int

in Cart at line 470
int getAddressDeliveryId()

Get the [addressdeliveryid] column value.

Return Value

int

in Cart at line 481
int getAddressInvoiceId()

Get the [addressinvoiceid] column value.

Return Value

int

in Cart at line 492
int getCurrencyId()

Get the [currency_id] column value.

Return Value

int

in Cart at line 503
string getDiscount()

Get the [discount] column value.

Return Value

string

in Cart at line 520
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 Cart at line 540
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 Cart at line 555
Cart setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Cart The current object (for fluent API support)

in Cart at line 576
Cart setToken( string $v)

Set the value of [token] column.

Parameters

string $v new value

Return Value

Cart The current object (for fluent API support)

in Cart at line 597
Cart setCustomerId( int $v)

Set the value of [customer_id] column.

Parameters

int $v new value

Return Value

Cart The current object (for fluent API support)

in Cart at line 622
Cart setAddressDeliveryId( int $v)

Set the value of [addressdeliveryid] column.

Parameters

int $v new value

Return Value

Cart The current object (for fluent API support)

in Cart at line 647
Cart setAddressInvoiceId( int $v)

Set the value of [addressinvoiceid] column.

Parameters

int $v new value

Return Value

Cart The current object (for fluent API support)

in Cart at line 672
Cart setCurrencyId( int $v)

Set the value of [currency_id] column.

Parameters

int $v new value

Return Value

Cart The current object (for fluent API support)

in Cart at line 697
Cart setDiscount( string $v)

Set the value of [discount] column.

Parameters

string $v new value

Return Value

Cart The current object (for fluent API support)

in Cart at line 719
Cart 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

Cart The current object (for fluent API support)

in Cart at line 740
Cart 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

Cart The current object (for fluent API support)

in Cart at line 762
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 Cart at line 790
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 Cart at line 855
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 Cart at line 881
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 Cart at line 926
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Cart::setDeleted()
Cart::isDeleted()

in Cart at line 968
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 Cart at line 1232
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 Cart at line 1247
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 Cart at line 1298
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 Cart at line 1353
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 Cart at line 1368
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 Cart at line 1418
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 Cart at line 1438
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 Cart at line 1463
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 Cart at line 1475
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Cart at line 1486
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Cart at line 1495
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Cart at line 1512
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\Cart (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 Cart at line 1554
Cart 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

Cart Clone of current object.

Exceptions

PropelException

in Cart at line 1571
Cart setCustomer( Customer $v = null)

Declares an association between this object and a ChildCustomer object.

Parameters

Customer $v

Return Value

Cart The current object (for fluent API support)

Exceptions

PropelException

in Cart at line 1599
Customer getCustomer( ConnectionInterface $con = null)

Get the associated ChildCustomer object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Customer The associated ChildCustomer object.

Exceptions

PropelException

in Cart at line 1622
Cart setAddressRelatedByAddressDeliveryId( Address $v = null)

Declares an association between this object and a ChildAddress object.

Parameters

Address $v

Return Value

Cart The current object (for fluent API support)

Exceptions

PropelException

in Cart at line 1650
Address getAddressRelatedByAddressDeliveryId( ConnectionInterface $con = null)

Get the associated ChildAddress object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Address The associated ChildAddress object.

Exceptions

PropelException

in Cart at line 1673
Cart setAddressRelatedByAddressInvoiceId( Address $v = null)

Declares an association between this object and a ChildAddress object.

Parameters

Address $v

Return Value

Cart The current object (for fluent API support)

Exceptions

PropelException

in Cart at line 1701
Address getAddressRelatedByAddressInvoiceId( ConnectionInterface $con = null)

Get the associated ChildAddress object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Address The associated ChildAddress object.

Exceptions

PropelException

in Cart at line 1724
Cart setCurrency( Currency $v = null)

Declares an association between this object and a ChildCurrency object.

Parameters

Currency $v

Return Value

Cart The current object (for fluent API support)

Exceptions

PropelException

in Cart at line 1752
Currency getCurrency( ConnectionInterface $con = null)

Get the associated ChildCurrency object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Currency The associated ChildCurrency object.

Exceptions

PropelException

in Cart at line 1777
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 Cart at line 1793
void clearCartItems()

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

addCartItems()

in Cart at line 1801
resetPartialCartItems($v = true)

Reset is the collCartItems collection loaded partially.

Parameters

$v

in Cart at line 1818
void initCartItems( boolean $overrideExisting = true)

Initializes the collCartItems collection.

By default this just sets the collCartItems collection to an empty array (like clearcollCartItems()); 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 Cart at line 1841
Collection|CartItem[] getCartItems( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildCartItem 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 ChildCart 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|CartItem[] List of ChildCartItem objects

Exceptions

PropelException

in Cart at line 1897
Cart setCartItems( Collection $cartItems, ConnectionInterface $con = null)

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

Return Value

Cart The current object (for fluent API support)

in Cart at line 1928
int countCartItems( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CartItem objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related CartItem objects.

Exceptions

PropelException

in Cart at line 1960
Cart addCartItem( CartItem $l)

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

Parameters

CartItem $l ChildCartItem

Return Value

Cart The current object (for fluent API support)

in Cart at line 1987
Cart removeCartItem( CartItem $cartItem)

Parameters

CartItem $cartItem The cartItem object to remove.

Return Value

Cart The current object (for fluent API support)

in Cart at line 2019
Collection|CartItem[] getCartItemsJoinProduct( 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 Cart is new, it will return an empty collection; or if this Cart has previously been saved, it will retrieve related CartItems 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 Cart.

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|CartItem[] List of ChildCartItem objects

in Cart at line 2044
Collection|CartItem[] getCartItemsJoinProductSaleElements( 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 Cart is new, it will return an empty collection; or if this Cart has previously been saved, it will retrieve related CartItems 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 Cart.

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|CartItem[] List of ChildCartItem objects

in Cart at line 2055
clear()

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

in Cart at line 2083
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 Cart at line 2105
string __toString()

Return the string representation of this object

Return Value

string

in Cart at line 2117
Cart keepUpdateDateUnchanged()

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

Return Value

Cart The current object (for fluent API support)

in Cart at line 2129
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Cart at line 2138
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

in Cart at line 2148
boolean preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

in Cart at line 2157
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

in Cart at line 2167
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in Cart at line 2176
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

in Cart at line 2186
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in Cart at line 2195
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in Cart at line 2212
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

at line 25
Cart duplicate( string $token, Customer $customer = null, Currency $currency = null, EventDispatcherInterface $dispatcher = null)

Duplicate the current existing cart. Only the token is changed

Parameters

string $token
Customer $customer
Currency $currency
EventDispatcherInterface $dispatcher

Return Value

Cart

Exceptions

Exception
PropelException

at line 96
CartItem getLastCartItemAdded()

Retrieve the last item added in the cart

Return Value

CartItem

at line 117
float|int getTaxedAmount( Country $country, $discount = true, State $state = null)

Retrieve the total taxed amount.

By default, the total include the discount

/!\ The postage amount is not available so it's the total with or without discount an without postage

Parameters

Country $country
$discount
State $state

Return Value

float|int

at line 141
float|int getTotalAmount( bool $discount = true)

Parameters

bool $discount

Return Value

float|int

See also

getTaxedAmount same as this method but the amount is without taxes

at line 163
float|int getTotalVAT($taxCountry, $taxState = null)

Return the VAT of all items

Parameters

$taxCountry
$taxState

Return Value

float|int

at line 173
float|int getWeight()

Retrieve the total weight for all products in cart

Return Value

float|int

at line 192
bool isVirtual()

Tell if the cart contains only virtual products

Return Value

bool