Documentation

Shop_Cart_Controller_Show extends Core_Controller
in package

HostCMS

Shop

Показ корзины магазина.

Доступные методы:

itemsProperties(TRUE|FALSE|array()) выводить значения дополнительных свойств товаров, по умолчанию FALSE. Может принимать массив с идентификаторами дополнительных свойств, значения которых необходимо вывести.
sortPropertiesValues(TRUE|FALSE) сортировать значения дополнительных свойств, по умолчанию TRUE.
itemsPropertiesList(TRUE|FALSE|array()) выводить список дополнительных свойств товаров, по умолчанию TRUE
orderProperties(TRUE|FALSE|array()) выводить список дополнительных свойств заказа, по умолчанию FALSE.
itemsForbiddenTags(array('description')) массив тегов товаров, запрещенных к передаче в генерируемый XML
warehousesItems(TRUE|FALSE) выводить остаток на каждом складе для товара, по умолчанию TRUE
taxes(TRUE|FALSE) выводить список налогов, по умолчанию FALSE
specialprices(TRUE|FALSE) показывать специальные цены для выбранных товаров, по умолчанию FALSE
associatedItems(TRUE|FALSE) показывать сопутствующие товары для выбранных товаров, по умолчанию FALSE
calculateCounts(TRUE|FALSE) вычислять общее количество товаров и групп в корневой группе, по умолчанию FALSE
applyDiscounts(TRUE|FALSE) применять скидки от суммы заказа, по умолчанию TRUE
applyDiscountCards(TRUE|FALSE) применять дисконтные карты, по умолчанию TRUE
addAllowedTags('/node/path', array('description')) массив тегов для элементов, указанных в первом аргументе, разрешенных к передаче в генерируемый XML
addForbiddenTags('/node/path', array('description')) массив тегов для элементов, указанных в первом аргументе, запрещенных к передаче в генерируемый XML

Доступные свойства:

amount сумма заказа с учетом скидок
tax сумма налога
quantity количество товаров в корзине
weight вес товаров в корзине

Доступные пути для методов addAllowedTags/addForbiddenTags:

'/' или '/shop' Магазин
'/shop/shop_order_properties/property' Свойство в списке свойств заказов
'/shop/shop_order_properties/property_dir' Раздел свойств в списке свойств заказов
'/shop/shop_item_properties/property' Свойство в списке свойств товара
'/shop/shop_item_properties/property_dir' Раздел свойств в списке свойств товара
'/shop/shop_cart' Корзина магазина


$Shop_Cart_Controller_Show = new Shop_Cart_Controller_Show(
		Core_Entity::factory('Shop', 1)
	);
$Shop_Cart_Controller_Show
	->xsl(
		Core_Entity::factory('Xsl')->getByName('МагазинКорзина')
	)
	->show();

$_aDiscountPrices


    protected
        array<string|int, mixed>
    $_aDiscountPrices
     = array()

$_aItem_Properties

List of properties for item


    protected
        array<string|int, mixed>
    $_aItem_Properties
     = array()

$_aItem_Property_Dirs

List of property directories for item


    protected
        array<string|int, mixed>
    $_aItem_Property_Dirs
     = array()

$_allowedProperties

Allowed object properties


    protected
        array<string|int, mixed>
    $_allowedProperties
     = array('couponText', 'itemsProperties', 'itemsPropertiesList', 'sortPropertiesValues', 'orderProperties', 'itemsForbiddenTags', 'warehousesItems', 'taxes', 'specialprices', 'associatedItems', 'cartUrl', 'amount', 'tax', 'quantity', 'weight', 'calculateCounts', 'applyDiscounts', 'applyDiscountCards')

$_allowedTags

Allowed tags for specified elements


    protected
        array<string|int, mixed>
    $_allowedTags
     = array()

$_aOrder_Properties

List of properties for order


    protected
        array<string|int, mixed>
    $_aOrder_Properties
     = array()

$_aOrder_Property_Dirs

List of property directories for order


    protected
        array<string|int, mixed>
    $_aOrder_Property_Dirs
     = array()

$_attributePrefix

Attribute's prefix


    protected
        string
    $_attributePrefix
     = '_'

$_cacheApplyForbiddenAllowedTags

Cache for applyForbiddenAllowedTags


    protected
        array<string|int, mixed>
    $_cacheApplyForbiddenAllowedTags
     = array()

$_cacheTags

Cache tags


    protected
        array<string|int, mixed>
    $_cacheTags
     = array()

$_entities

List of children entities


    protected
        array<string|int, mixed>
    $_entities
     = array()

$_entity

Entity


    protected
        Core_Entity
    $_entity
     = \NULL

$_forbiddenTags

Forbidden tags for specified elements


    protected
        array<string|int, mixed>
    $_forbiddenTags
     = array()

$_mode

Controller's mode


    protected
        string
    $_mode
     = 'json'

$_oSiteuser

Current Siteuser


    protected
        Siteuser_Model|null
    $_oSiteuser
     = \NULL

$_propertiesValues

Properties values


    protected
        array<string|int, mixed>
    $_propertiesValues
     = array()

$_shownIDs

Shown IDs


    protected
        array<string|int, mixed>
    $_shownIDs
     = array()

$_tpl

TPL


    protected
        Tpl_Model
    $_tpl
     = \NULL

$_unlimitedProperties

Object has unlimited number of properties


    protected
        bool
    $_unlimitedProperties
     = \FALSE

$_vars

Variables/objects to the TPL-template


    protected
        array<string|int, mixed>
    $_vars
     = array()

$_xsl

XSL


    protected
        Xsl_Model
    $_xsl
     = \NULL

__construct()

Constructor.


    public
                    __construct(Shop_Model $oShop) : mixed

Parameters

$oShop : Shop_Model: shop

Return values

mixed —

addAllowedProperties()

Add additional allowed properties


    public
                    addAllowedProperties(array<string|int, mixed> $array) : self

Parameters

$array : array<string|int, mixed>: array of properties' names

Return values

self —

addAllowedProperty()

Add additional allowed property


    public
                    addAllowedProperty(string $property) : self

Parameters

$property : string: property name

Return values

self —

addAllowedTag()

Add tag to allowed tags list


    public
                    addAllowedTag(string $path, string $tag) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

self —

addAllowedTags()

Add tags to allowed tags list


    public
                    addAllowedTags(string $path[, array<string|int, mixed> $aTags = array() ]) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$aTags : array<string|int, mixed> = array(): array of tags

Return values

self —

addCacheSignature()

Add additional signature for cache name


    public
                    addCacheSignature(string $name) : self

Parameters

$name : string: name

Return values

self —

addCacheTag()

Add Cache Tag


    public
                    addCacheTag(string $tagName) : self

Parameters

$tagName : string

Return values

self —

addEntities()

Add enities


    public
                    addEntities(array<string|int, mixed> $aChildrenEntities) : self

Parameters

$aChildrenEntities : array<string|int, mixed>: entities

Return values

self —

addEntity()

Add a children entity


    public
                    addEntity(Core_Entity $oChildrenEntity) : self

Parameters

$oChildrenEntity : Core_Entity

Return values

self —

addForbiddenTag()

Add tag to forbidden tags list


    public
                    addForbiddenTag(string $path, string $tag) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

self —

addForbiddenTags()

Add tags to forbidden tags list


    public
                    addForbiddenTags(string $path[, array<string|int, mixed> $aTags = array() ]) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$aTags : array<string|int, mixed> = array(): array of tags

Return values

self —

append()

Append an element to an assigned array


    public
                    append(mixed $varname, mixed $var) : self

Parameters

$varname : mixed
$var : mixed

Return values

self —

applyForbiddenAllowedTags()

Apply Forbidden-Allowed Tags for Entity


    public
                    applyForbiddenAllowedTags(string $path, Core_Entity|array<string|int, mixed> $mEntity) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$mEntity : Core_Entity|array<string|int, mixed>

Return values

self —

assign()

Assign variables/objects to the TPL-template


    public
                    assign(mixed $varname, mixed $var) : self

Parameters

$varname : mixed
$var : mixed

Return values

self —

clearCacheTag()

Clear Cache Tag


    public
                    clearCacheTag() : self

Return values

self —

clearEntities()

Clear enities


    public
                    clearEntities() : self

Return values

self —

clearVars()

Clear vars


    public
                    clearVars() : self

Return values

self —

get()

Get HTML based by entities tree, use XSL $this->_xsl


    public
                    get() : string

Return values

string —

getAllowedTags()

Get allowed tags list


    public
                    getAllowedTags() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getCacheTags()

Get Cache Tags


    public
                    getCacheTags() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getEntities()

Get enities


    public
                    getEntities() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getEntity()

Get entity


    public
                    getEntity() : object

Return values

object —

getForbiddenTags()

Get forbidden tags list


    public
                    getForbiddenTags() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getItemProperties()

Get _aItem_Properties set


    public
                    getItemProperties() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getItemPropertyDirs()

Get _aItem_Property_Dirs set


    public
                    getItemPropertyDirs() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getShownIDs()

Get shown IDs


    public
                    getShownIDs() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getStdObject()

Get ARRAY for entity and children entities


    public
                    getStdObject() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getTpl()

Get TPL


    public
                    getTpl() : Tpl_Model

Return values

Tpl_Model —

getXml()

Get XML for entity and children entities


    public
                    getXml() : string

Return values

string —

getXsl()

Get XSL


    public
                    getXsl() : Xsl_Model

Return values

Xsl_Model —

isAllowedTag()

Check if a tag is allowed


    public
                    isAllowedTag(string $path, string $tag) : bool

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

bool —

isForbiddenTag()

Check if a tag is forbidden


    public
                    isForbiddenTag(string $path, string $tag) : bool

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

bool —

mode()

Set mode


    public
                    mode(string $mode) : self

Parameters

$mode : string

Return values

self —

refreshLittleCart()

AJAX refresh little cart


    public
                    refreshLittleCart() : self

Return values

self —

removeAllowedTag()

Remove tag from allowed tags list


    public
                    removeAllowedTag(string $path, string $tag) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

self —

removeForbiddenTag()

Remove tag from forbidden tags list


    public
                    removeForbiddenTag(string $path, string $tag) : self

Parameters

$path : string: Path to item, e.g. /shop/shop_item
$tag : string: tag

Return values

self —

set()

Run when writing data to inaccessible properties


    public
                    set(string $property, string $value) : self

Parameters

$property : string: property name
$value : string: property value

Return values

self —

setAttributePrefix()

Change attributePrefix


    public
                    setAttributePrefix(string $attributePrefix) : self

Parameters

$attributePrefix : string

Return values

self —

setEntity()

Set entity


    public
                    setEntity(Core_Entity $entity) : self

Parameters

$entity : Core_Entity: entity

Return values

self —

setUnlimitedProperties()

Set unlimitedProperties


    public
                    setUnlimitedProperties([bool $value = TRUE ]) : self

Parameters

$value : bool = TRUE: default TRUR

Return values

self —

show()

Show built data


    public
                    show() : self

Return values

self —

tpl()

Set TPL


    public
                    tpl(Tpl_Model|string $tpl) : self

Parameters

$tpl : Tpl_Model|string

Return values

self —

xsl()

Set XSL


    public
                    xsl(Xsl_Model|string $xsl) : self

Parameters

$xsl : Xsl_Model|string

Return values

self —

_addItemsPropertiesList()

Add items properties to XML


    protected
                    _addItemsPropertiesList(int $parent_id, object $parentObject) : self

Parameters

$parent_id : int
$parentObject : object

Return values

self —

_addOrdersPropertiesList()

Add order's properties to XML


    protected
                    _addOrdersPropertiesList(int $parent_id, object $parentObject) : self

Parameters

$parent_id : int
$parentObject : object

Return values

self —

_getCartController()

Get Shop_Cart_Controller


    protected
                    _getCartController() : Shop_Cart_Controller

Return values

Shop_Cart_Controller —

_getDiscoutAmount()

Get Discount Amount


    protected
                    _getDiscoutAmount(mixed $quantityPurchaseDiscount, mixed $amountPurchaseDiscount) : decimal

Parameters

$quantityPurchaseDiscount : mixed
$amountPurchaseDiscount : mixed

Return values

decimal —

Shop_Cart_Controller_Show extends Core_Controller in package HostCMS Shop

Tags

Table of Contents

Properties

$_aDiscountPrices

$_aItem_Properties

$_aItem_Property_Dirs

$_allowedProperties

$_allowedTags

$_aOrder_Properties

$_aOrder_Property_Dirs

$_attributePrefix

$_cacheApplyForbiddenAllowedTags

$_cacheTags

$_entities

$_entity

$_forbiddenTags

$_mode

$_oSiteuser

$_propertiesValues

$_shownIDs

$_tpl

$_unlimitedProperties

$_vars

$_xsl

Methods

__construct()

Parameters

Return values

addAllowedProperties()

Parameters

Return values

addAllowedProperty()

Parameters

Return values

addAllowedTag()

Parameters

Return values

addAllowedTags()

Parameters

Return values

addCacheSignature()

Parameters

Return values

addCacheTag()

Parameters

Return values

addEntities()

Parameters

Return values

addEntity()

Parameters

Return values

addForbiddenTag()

Parameters

Return values

addForbiddenTags()

Parameters

Return values

append()

Parameters

Return values

applyForbiddenAllowedTags()

Parameters

Return values

assign()

Parameters

Return values

clearCacheTag()

Return values

clearEntities()

Return values

clearVars()

Return values

get()

Tags

Return values

getAllowedTags()

Return values

getCacheTags()

Shop_Cart_Controller_Show extends Core_Controller
in package

HostCMS

Shop