OXID eShop CE  4.9.6
 All Classes Files Functions Variables Pages
oxDelivery Class Reference
+ Inheritance diagram for oxDelivery:
+ Collaboration diagram for oxDelivery:

Public Member Functions

 __construct ()
 setDelVatOnTop ($blOnTop)
 getArticles ()
 getCategories ()
 hasArticles ()
 hasCategories ()
 getDeliveryAmount ($oBasketItem)
 setDeliveryPrice ($oPrice)
 getDeliveryPrice ($dVat=null)
 delete ($sOxId=null)
 isForBasket ($oBasket)
 getIdByName ($sTitle)
 getCountriesISO ()
 getConditionType ()
 getConditionFrom ()
 getConditionTo ()
 getCalculationRule ()
 getAddSum ()
 getAddSumType ()
- Public Member Functions inherited from oxI18n
 setLanguage ($iLang=null)
 getLanguage ()
 setEnableMultilang ($blEmployMultilanguage)
 isMultilingualField ($sFieldName)
 isMultilang ()
 loadInLang ($iLanguage, $sOxid)
 modifyCacheKey ($sCacheKey, $blOverride=false)
 getAvailableInLangs ()
 getUpdateSqlFieldName ($sField)
- Public Member Functions inherited from oxBase
 getUseSkipSaveFields ()
 setUseSkipSaveFields ($blUseSkipSaveFields)
 __set ($sName, $sValue)
 __get ($sName)
 __isset ($mVar)
 __clone ()
 oxClone ($oObject)
 getUpdateSeo ()
 setUpdateSeo ($blUpdateSeo)
 init ($sTableName=null, $blForceAllFields=false)
 assign ($dbRecord)
 getClassName ()
 getCoreTableName ()
 getId ()
 setId ($sOXID=null)
 setShopId ($iShopId)
 getShopId ()
 getViewName ($blForceCoreTableUsage=null)
 disableLazyLoading ()
 isDerived ()
 setIsDerived ($blVal)
 load ($sOXID)
 isLoaded ()
 buildSelectString ($aWhere=null)
 assignRecord ($sSelect)
 getFieldData ($sFieldName)
 getSelectFields ($blForceCoreTableUsage=null)
 save ()
 allowDerivedUpdate ()
 allowDerivedDelete ()
 exists ($sOXID=null)
 getSqlActiveSnippet ($blForceCoreTable=null)
 beforeUpdate ($sOXID=null)
 onChange ($iAction=null, $sOXID=null)
 setInList ()
 isOx ()
 isReadOnly ()
 setReadOnly ($blReadOnly)
 getFieldNames ()
 addFieldName ($sName)
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Public Attributes

const CALCULATION_RULE_ONCE_PER_CART = 0
const CALCULATION_RULE_FOR_EACH_DIFFERENT_PRODUCT = 1
const CALCULATION_RULE_FOR_EACH_PRODUCT = 2
const CONDITION_TYPE_PRICE = 'p'
const CONDITION_TYPE_AMOUNT = 'a'
const CONDITION_TYPE_SIZE = 's'
const CONDITION_TYPE_WEIGHT = 'w'

Protected Member Functions

 _isForArticle ($oContent, $iArtAmount)
 _checkDeliveryAmount ($iAmount)
 _getMultiplier ()
 _getCostSum ()
- Protected Member Functions inherited from oxI18n
 _getFieldStatus ($sFieldName)
 _getNonCachedFieldNames ($blForceFullStructure=false)
 _getFieldLang ($sFieldName)
 _setUpdateSeoOnFieldChange ($sField)
 _getUpdateFieldsForTable ($sTable, $blUseSkipSaveFields=true)
 _getUpdateFields ($blUseSkipSaveFields=true)
 _update ()
 _getLanguageSetTables ($sCoreTableName=null)
 _insert ()
 _getObjectViewName ($sTable, $sShopID=null)
 _getAllFields ($blReturnSimple=false)
 _addField ($sName, $sStatus, $sType=null, $sLength=null)
 _canFieldBeNull ($sFieldName)
- Protected Member Functions inherited from oxBase
 _removeElement2ShopRelations ($sOxId)
 _isInList ()
 _getTableFields ($sTable, $blReturnSimple=false)
 _initDataStructure ($blForceFullStructure=false)
 _getFieldLongName ($sFieldName)
 _setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
 _getFieldDefaultValue ($sFieldName)
 _getUpdateFieldValue ($sFieldName, $oField)
 _isDisabledFieldCache ()
 _addSkippedSaveFieldsForMapping ()
 _disableLazyLoadingForCaching ()

Protected Attributes

 $_sClassName = 'oxdelivery'
 $_iItemCnt = 0
 $_iProdCnt = 0
 $_dPrice = 0
 $_oPrice = null
 $_aArtIds = null
 $_aCatIds = null
 $_blFreeShipping = true
 $_blDelVatOnTop = false
 $_aCountriesISO = null
 $_aRDFaDeliverySet = null
- Protected Attributes inherited from oxI18n
 $_sClassName = 'oxI18n'
 $_iLanguage = null
 $_blEmployMultilanguage = true
- Protected Attributes inherited from oxBase
 $_sOXID = null
 $_iShopId = null
 $_blIsSimplyClonable = true
 $_sClassName = 'oxbase'
 $_sCoreTable = null
 $_sViewTable = null
 $_aFieldNames = array('oxid' => 0)
 $_sCacheKey = null
 $_blUseLazyLoading = false
 $_aSkipSaveFields = array('oxtimestamp')
 $_blUseSkipSaveFields = true
 $_sExistKey = 'oxid'
 $_blIsDerived = null
 $_blIsSeoObject = false
 $_blUpdateSeo = true
 $_blReadOnly = false
 $_blIsInList = false
 $_isLoaded = false
 $_aInnerLazyCache = null
 $_blEmployMultilanguage = false

Static Protected Attributes

static $_aProductList = array()

Detailed Description

Order delivery manager. Currently calculates price/costs.

Definition at line 8 of file oxdelivery.php.

Constructor & Destructor Documentation

oxDelivery::__construct ( )

Class constructor, initiates parent constructor (parent::oxBase()).

Reimplemented from oxI18n.

Definition at line 116 of file oxdelivery.php.

Member Function Documentation

oxDelivery::_checkDeliveryAmount (   $iAmount)
protected

checks if amount param is ok for this delivery

Parameters
double$iAmountamount
Returns
boolean

Definition at line 440 of file oxdelivery.php.

oxDelivery::_getCostSum ( )
protected

Calculate cost sum

Returns
float

Definition at line 585 of file oxdelivery.php.

oxDelivery::_getMultiplier ( )
protected

Calculate multiplier for price calculation

Returns
float|int

Definition at line 565 of file oxdelivery.php.

oxDelivery::_isForArticle (   $oContent,
  $iArtAmount 
)
protected

Checks if delivery fits for one article

Parameters
object$oContentshop basket item
integer$iArtAmountproduct amount
Returns
bool

Definition at line 421 of file oxdelivery.php.

oxDelivery::delete (   $sOxId = null)

Delete this object from the database, returns true on success.

Parameters
string$sOxIdObject ID (default null)
Returns
bool

Reimplemented from oxI18n.

Definition at line 291 of file oxdelivery.php.

oxDelivery::getAddSum ( )

Returns amount cost

Returns
float

Definition at line 545 of file oxdelivery.php.

oxDelivery::getAddSumType ( )

Returns type of cost: % - percentage; abs - absolute value

Returns
string

Definition at line 555 of file oxdelivery.php.

oxDelivery::getArticles ( )

Collects article Ids which are assigned to current delivery

Returns
array

Definition at line 138 of file oxdelivery.php.

oxDelivery::getCalculationRule ( )

Returns calculation rule: 0 - Once per Cart; 1 - Once for each different product 2 - For each product

Returns
int

Definition at line 535 of file oxdelivery.php.

oxDelivery::getCategories ( )

Collects category Ids which are assigned to current delivery

Returns
array

Definition at line 155 of file oxdelivery.php.

oxDelivery::getConditionFrom ( )

Returns condition from value (type >= from <= to)

Returns
string

Definition at line 515 of file oxdelivery.php.

oxDelivery::getConditionTo ( )

Returns condition to value (type >= from <= to)

Returns
string

Definition at line 525 of file oxdelivery.php.

oxDelivery::getConditionType ( )

Returns condition type (type >= from <= to) : a - amount, s - size, w -weight, p - price

Returns
string

Definition at line 505 of file oxdelivery.php.

oxDelivery::getCountriesISO ( )

Returns array of country ISO's which are assigned to current delivery

Returns
array

Definition at line 477 of file oxdelivery.php.

oxDelivery::getDeliveryAmount (   $oBasketItem)

Returns amount (total net price/weight/volume/Amount) on which delivery price is applied

Parameters
oxBasketItem$oBasketItembasket item object
Returns
double

Definition at line 194 of file oxdelivery.php.

oxDelivery::getDeliveryPrice (   $dVat = null)

Returns oxPrice object for delivery costs

Parameters
double$dVatdelivery vat
Returns
oxPrice

Definition at line 265 of file oxdelivery.php.

oxDelivery::getIdByName (   $sTitle)

returns delivery id

Parameters
string$sTitledelivery name
Returns
string

Definition at line 463 of file oxdelivery.php.

oxDelivery::hasArticles ( )

Checks if delivery has assigned articles

Returns
bool

Definition at line 172 of file oxdelivery.php.

oxDelivery::hasCategories ( )

Checks if delivery has assigned categories

Returns
bool

Definition at line 182 of file oxdelivery.php.

oxDelivery::isForBasket (   $oBasket)

Checks if delivery fits for current basket

Parameters
oxBasket$oBasketshop basket
Returns
bool

Definition at line 315 of file oxdelivery.php.

oxDelivery::setDeliveryPrice (   $oPrice)

Delivery price setter

Parameters
oxPrice$oPricedelivery price to set

Definition at line 253 of file oxdelivery.php.

oxDelivery::setDelVatOnTop (   $blOnTop)

Delivery VAT config setter

Parameters
bool$blOnTopdelivery vat config

Definition at line 128 of file oxdelivery.php.

Member Data Documentation

oxDelivery::$_aArtIds = null
protected

Definition at line 69 of file oxdelivery.php.

oxDelivery::$_aCatIds = null
protected

Definition at line 76 of file oxdelivery.php.

oxDelivery::$_aCountriesISO = null
protected

Definition at line 104 of file oxdelivery.php.

oxDelivery::$_aProductList = array()
staticprotected

Definition at line 90 of file oxdelivery.php.

oxDelivery::$_aRDFaDeliverySet = null
protected

Definition at line 111 of file oxdelivery.php.

oxDelivery::$_blDelVatOnTop = false
protected

Definition at line 97 of file oxdelivery.php.

oxDelivery::$_blFreeShipping = true
protected

Definition at line 83 of file oxdelivery.php.

oxDelivery::$_dPrice = 0
protected

Definition at line 55 of file oxdelivery.php.

oxDelivery::$_iItemCnt = 0
protected

Definition at line 39 of file oxdelivery.php.

oxDelivery::$_iProdCnt = 0
protected

Definition at line 47 of file oxdelivery.php.

oxDelivery::$_oPrice = null
protected

Definition at line 62 of file oxdelivery.php.

oxDelivery::$_sClassName = 'oxdelivery'
protected

Definition at line 31 of file oxdelivery.php.

const oxDelivery::CALCULATION_RULE_FOR_EACH_DIFFERENT_PRODUCT = 1

Definition at line 15 of file oxdelivery.php.

const oxDelivery::CALCULATION_RULE_FOR_EACH_PRODUCT = 2

Definition at line 16 of file oxdelivery.php.

const oxDelivery::CALCULATION_RULE_ONCE_PER_CART = 0

Calculation rule

Definition at line 14 of file oxdelivery.php.

const oxDelivery::CONDITION_TYPE_AMOUNT = 'a'

Definition at line 22 of file oxdelivery.php.

const oxDelivery::CONDITION_TYPE_PRICE = 'p'

Condition type

Definition at line 21 of file oxdelivery.php.

const oxDelivery::CONDITION_TYPE_SIZE = 's'

Definition at line 23 of file oxdelivery.php.

const oxDelivery::CONDITION_TYPE_WEIGHT = 'w'

Definition at line 24 of file oxdelivery.php.


The documentation for this class was generated from the following file: