Documentation

Mage_Wishlist_Model_Wishlist extends Mage_Core_Model_Abstract
in package

Mage

Wishlist

Wishlist model

Properties

$_cacheTag : string|bool|array<string|int, mixed>: Entity cache tag
$_data : array<string|int, mixed>|null: Object attributes
$_dataSaveAllowed : bool: Flag which can stop data saving after before save Can be used for next sequence: we check data in _beforeSave, if data are not valid - we can set this flag to false value and save process will be stopped
$_dirty : array<string|int, mixed>
$_eventObject : string: Parameter name in event
$_eventPrefix : string: Prefix of model events names
$_hasDataChanges : bool: Data changes flag (true after setData|unsetData call)
$_idFieldName : string: Name of object id field
$_isDeleted : bool: Object delete flag
$_isObjectNew : bool|null: Flag which allow detect object state: is it new object (without id) or existing one (with id)
$_itemCollection : Mage_Wishlist_Model_Resource_Item_Collection|null: Wishlist item collection
$_oldFieldsMap : array<string|int, mixed>: Map short fields names to its full names
$_origData : array<string|int, mixed>|null: Original data that was loaded
$_resource : Mage_Core_Model_Resource_Db_Abstract: Resource model instance
$_resourceCollectionName : string: Name of the resource collection model
$_resourceName : string: Name of the resource model
$_store : Mage_Core_Model_Store|null: Store filter for wishlist
$_storeIds : array<string|int, mixed>|null: Shared store ids (website stores)
$_syncFieldsMap : mixed: Map of fields to sync to other fields upon changing their data
$_underscoreCache : array<string|int, mixed>: Setter/Getter underscore transformation cache

Methods

__call() : mixed: Set/Get attribute wrapper
__construct() : mixed: Constructor
__get() : mixed: Attribute getter (deprecated)
__set() : mixed: Attribute setter (deprecated)
__toArray() : array<string|int, mixed>: Convert object attributes to array
_getResource() : Mage_Wishlist_Model_Resource_Wishlist: Get resource instance
addData() : $this: Add data to the object.
addItem() : $this: Adding item to wishlist
addNewItem() : Mage_Wishlist_Model_Item|string: Adds new product to wishlist.
afterCommitCallback() : $this: Callback function which called after transaction commit in resource model
afterLoad() : $this: Object after load processing. Implemented as public interface for supporting objects after load in collections
cleanModelCache() : $this: Remove model object related cache
clearInstance() : $this: Clearing object for correct deleting by garbage collector
dataHasChangedFor() : bool: Compare object data with original data
debug() : string|array<string|int, mixed>: Present object data as string in debug mode
delete() : $this: Delete object from database
flagDirty() : $this
generateSharingCode() : $this: Set random sharing code
getAllItems() : array<string|int, Mage_Wishlist_Model_Item>: Retrieve wishlist items array
getBillingAddress() : Mage_Customer_Model_Address_Abstract|null
getCacheIdTags() : array<string|int, mixed>|false: Get cache tags associated with object id
getCacheTags() : array<string|int, mixed>|false: Get list of cache tags applied to model object.
getCollection() : Mage_Wishlist_Model_Resource_Wishlist_Collection
getCreatedAt() : string|null
getCustomerId() : int: Retrieve customer id
getData() : mixed: Object data getter
getDataByKey() : mixed: Get object data by particular key
getDataByPath() : mixed: Get object data by path
getDataForSave() : array<string|int, mixed>: Retrieve data for save
getDataSetDefault() : mixed: Fast get data or set default if value is not available
getDataUsingMethod() : mixed: Get object data by key with calling getter method
getEntityId() : int
getId() : int|string|null: Retrieve model object identifier
getIdFieldName() : string: Retrieve identifier field name for model
getItemById() : Mage_Wishlist_Model_Item|null: Retrieve item model object by item identifier
getItemByProduct() : Mage_Wishlist_Model_Item|false: Retrieve wishlist item by product id
getItemsCollection() : Mage_Wishlist_Model_Resource_Item_Collection: Retrieve wishlist item collection
getItemsCount() : int: Retrieve wishlist items count
getName() : string: Retrieve wishlist name
getOrigData() : mixed: Get object loaded data (original data)
getResource() : Mage_Wishlist_Model_Resource_Wishlist: Retrieve model resource
getResourceCollection() : Mage_Core_Model_Resource_Db_Collection_Abstract: Get collection instance
getResourceName() : string: Retrieve model resource name
getShared() : bool|null
getSharedStoreIds() : array<string|int, mixed>: Get all available store ids for wishlist
getSharingCode() : string|null
getShippingAddress() : Mage_Customer_Model_Address_Abstract|null
getStore() : Mage_Core_Model_Store: Get wishlist store model object
getStoreId() : int: Get wishlist store identifier
getUpdatedAt() : string|null
getVisibility() : string|null
hasData() : bool: If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.
hasDataChanges() : bool: Get data change status
hasErrors() : bool
hasItems() : bool: Checking items availability
isDeleted() : bool: Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value
isDirty() : bool
isEmpty() : bool: checks whether the object is empty
isModuleEnabled() : bool
isObjectNew() : bool: Check object state (true - if it is object without id on object just created) This method can help detect if object just created in _afterSave method problem is what in after save object has id and we can't detect what object was created in this transaction
isOwner() : bool: Check customer is owner this wishlist
isSalable() : bool: Retrieve wishlist has salable item(s)
jsonSerialize() : array<string|int, mixed>: Implementation of JsonSerializable::jsonSerialize()
load() : $this: Load object data
loadByCode() : $this: Load by sharing code
loadByCustomer() : $this: Load wishlist by customer
offsetExists() : bool: Implementation of ArrayAccess::offsetExists()
offsetGet() : mixed: Implementation of ArrayAccess::offsetGet()
offsetSet() : void: Implementation of ArrayAccess::offsetSet()
offsetUnset() : void: Implementation of ArrayAccess::offsetUnset()
removeAllItems() : $this: Mark all wishlist items as deleted (empty wishlist)
removeItem() : self: Remove wishlist item by item identifier
save() : $this: Save object data
serialize() : string: serialize object attributes
setAttribute() : $this
setCreatedAt() : static
setCustomerId() : $this: Set customer id
setData() : $this: Overwrite data in the object.
setDataChanges() : $this: Clears data changes status
setDataUsingMethod() : $this: Set object data with calling setter method
setId() : $this: Declare model object identifier value
setIdFieldName() : $this: set name of object id field
setOrigData() : $this: Initialize object original data
setShared() : static
setSharingCode() : static
setStore() : $this: Declare wishlist store model
setUpdatedAt() : static
toArray() : array<string|int, mixed>: Public wrapper for __toArray
toJson() : string: Public wrapper for __toJson
toString() : string: Public wrapper for __toString
toXml() : string: Public wrapper for __toXml
unsetData() : $this: Unset data from the object.
unsetOldData() : $this: Unset old fields data from the object.
updateItem() : $this: Update wishlist Item and set data from request
__toJson() : string: Convert object attributes to JSON
__toXml() : string: Convert object attributes to XML
_addCatalogProduct() : Mage_Wishlist_Model_Item: Add catalog product object data to wishlist
_addFullNames() : mixed
_afterDelete() : $this: Processing object after delete data
_afterDeleteCommit() : $this: Processing manipulation after main transaction commit
_afterLoad() : $this: Processing object after load data
_afterSave() : $this: Save related items
_beforeDelete() : $this: Processing object before delete data
_beforeLoad() : $this: Processing object before load data
_beforeSave() : $this: Set date of last update for wishlist
_camelize() : string
_clearData() : $this: Clearing object's data
_clearReferences() : $this: Clearing cyclic references
_construct() : void: Initialize resource model
_getData() : mixed: Get value from _data array without parse key
_getEventData() : array<string|int, mixed>: Get array of objects transferred to default events processing
_getSharingRandomCode() : string: Retrieve sharing code (random string)
_hasModelChanged() : bool: Check whether model has changed data.
_init() : mixed: Standard model initialization
_initOldFieldsMap() : mixed: Inits mapping array of object's previously used fields to new fields.
_prepareArray() : array<string|int, mixed>: Set required array elements
_prepareSyncFieldsMap() : $this: Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.
_protectFromNonAdmin() : mixed: Safeguard func that will check, if we are in admin area
_setResourceModel() : mixed: Set resource names
_underscore() : string: Converts field names for setters and getters

$_cacheTag

Entity cache tag


        protected
            string|bool|array<string|int, mixed>
    $_cacheTag
     = 'wishlist'

#[Override]

$_data

Object attributes


        protected
            array<string|int, mixed>|null
    $_data
     = []

$_dataSaveAllowed

Flag which can stop data saving after before save Can be used for next sequence: we check data in _beforeSave, if data are not valid - we can set this flag to false value and save process will be stopped


        protected
            bool
    $_dataSaveAllowed
     = \true

$_dirty


        protected
            array<string|int, mixed>
    $_dirty

$_eventObject

Parameter name in event


        protected
            string
    $_eventObject
     = 'object'

In observe method you can use $observer->getEvent()->getObject() in this case

$_eventPrefix

Prefix of model events names


        protected
            string
    $_eventPrefix
     = 'wishlist'

#[Override]

$_hasDataChanges

Data changes flag (true after setData|unsetData call)


        protected
            bool
    $_hasDataChanges
     = false

$_idFieldName

Name of object id field


        protected
            string
    $_idFieldName
     = null

$_isDeleted

Object delete flag


        protected
            bool
    $_isDeleted
     = false

$_isObjectNew

Flag which allow detect object state: is it new object (without id) or existing one (with id)


        protected
            bool|null
    $_isObjectNew
     = \null

$_itemCollection

Wishlist item collection


        protected
            Mage_Wishlist_Model_Resource_Item_Collection|null
    $_itemCollection
     = \null

$_oldFieldsMap

Map short fields names to its full names


        protected
            array<string|int, mixed>
    $_oldFieldsMap
     = []

$_origData

Original data that was loaded


        protected
            array<string|int, mixed>|null
    $_origData

$_resource

Resource model instance


        protected
            Mage_Core_Model_Resource_Db_Abstract
    $_resource

$_resourceCollectionName

Name of the resource collection model


        protected
            string
    $_resourceCollectionName

$_resourceName

Name of the resource model


        protected
            string
    $_resourceName

$_store

Store filter for wishlist


        protected
            Mage_Core_Model_Store|null
    $_store
     = \null

$_storeIds

Shared store ids (website stores)


        protected
            array<string|int, mixed>|null
    $_storeIds
     = \null

$_syncFieldsMap

Map of fields to sync to other fields upon changing their data


        protected
            mixed
    $_syncFieldsMap
     = []

$_underscoreCache

Setter/Getter underscore transformation cache


        protected
        static    array<string|int, mixed>
    $_underscoreCache
     = []

__call()

Set/Get attribute wrapper


    public
                    __call(string $method, array<string|int, mixed> $args) : mixed

Parameters

$method : string
$args : array<string|int, mixed>

__construct()

Constructor


    public
                    __construct() : mixed

By default, is looking for first argument as array and assigns it as object attributes This behaviour may change in child classes

__get()

Attribute getter (deprecated)


    public
                    __get(string $var) : mixed

Parameters

$var : string

__set()

Attribute setter (deprecated)


    public
                    __set(string $var, mixed $value) : mixed

Parameters

$var : string
$value : mixed

__toArray()

Convert object attributes to array


    public
                    __toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

array<string|int, mixed>

_getResource()

Get resource instance


    public
                    _getResource() : Mage_Wishlist_Model_Resource_Wishlist

Return values

Mage_Wishlist_Model_Resource_Wishlist

addData()

Add data to the object.


    public
                    addData(array<string|int, mixed> $arr) : $this

Retains previous data in the object.

Parameters

$arr : array<string|int, mixed>

Return values

$this

addItem()

Adding item to wishlist


    public
                    addItem(Mage_Wishlist_Model_Item $item) : $this

Parameters

$item : Mage_Wishlist_Model_Item

Return values

$this

addNewItem()

Adds new product to wishlist.


    public
                    addNewItem(int|Mage_Catalog_Model_Product $product[, mixed $buyRequest = null ][, bool $forciblySetQty = false ]) : Mage_Wishlist_Model_Item|string

Returns new item or string on error.

Parameters

$product : int|Mage_Catalog_Model_Product
$buyRequest : mixed = null
$forciblySetQty : bool = false

Return values

Mage_Wishlist_Model_Item|string

afterCommitCallback()

Callback function which called after transaction commit in resource model


    public
                    afterCommitCallback() : $this

Return values

$this

afterLoad()

Object after load processing. Implemented as public interface for supporting objects after load in collections


    public
                    afterLoad() : $this

Return values

$this

cleanModelCache()

Remove model object related cache


    public
                    cleanModelCache() : $this

Return values

$this

clearInstance()

Clearing object for correct deleting by garbage collector


    public
        final            clearInstance() : $this

Return values

$this

dataHasChangedFor()

Compare object data with original data


    public
                    dataHasChangedFor(string $field) : bool

Parameters

$field : string

Return values

bool

debug()

Present object data as string in debug mode


    public
                    debug([mixed $data = null ][, array<string|int, mixed> &$objects = [] ]) : string|array<string|int, mixed>

Parameters

$data : mixed = null
$objects : array<string|int, mixed> = []

Return values

string|array<string|int, mixed>

delete()

Delete object from database


    public
                    delete() : $this

Return values

$this

flagDirty()


    public
                    flagDirty(string $field[, bool $flag = true ]) : $this

Parameters

$field : string
$flag : bool = true

Return values

$this

generateSharingCode()

Set random sharing code


    public
                    generateSharingCode() : $this

Return values

$this

getAllItems()

Retrieve wishlist items array


    public
                    getAllItems() : array<string|int, Mage_Wishlist_Model_Item>

Return values

array<string|int, Mage_Wishlist_Model_Item>

getBillingAddress()


    public
                    getBillingAddress() : Mage_Customer_Model_Address_Abstract|null

Return values

Mage_Customer_Model_Address_Abstract|null

getCacheIdTags()

Get cache tags associated with object id


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

Return values

array<string|int, mixed>|false

getCacheTags()

Get list of cache tags applied to model object.


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

Return false if cache tags are not supported by model

Return values

array<string|int, mixed>|false

getCollection()


    public
                    getCollection() : Mage_Wishlist_Model_Resource_Wishlist_Collection

Return values

Mage_Wishlist_Model_Resource_Wishlist_Collection

getCreatedAt()


    public
                    getCreatedAt() : string|null

Return values

string|null

getCustomerId()

Retrieve customer id


    public
                    getCustomerId() : int

Return values

int

getData()

Object data getter


    public
                    getData([string $key = '' ][, string|int $index = null ]) : mixed

If $key is not defined will return all the data as an array. Otherwise, it will return value of the element specified by $key. It is possible to use keys like a/b/c for access nested array data

If $index is specified it will assume that attribute data is an array and retrieve corresponding member. If data is the string - it will be explode by new line character and converted to array.

Parameters

$key : string = ''
$index : string|int = null

getDataByKey()

Get object data by particular key


    public
                    getDataByKey(string $key) : mixed

Parameters

$key : string

getDataByPath()

Get object data by path


    public
                    getDataByPath(string $path) : mixed

Method consider the path as chain of keys: a/b/c => ['a']['b']['c']

Parameters

$path : string

getDataForSave()

Retrieve data for save


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

Return values

array<string|int, mixed>

getDataSetDefault()

Fast get data or set default if value is not available


    public
                    getDataSetDefault(string $key, mixed $default) : mixed

Parameters

$key : string
$default : mixed

getDataUsingMethod()

Get object data by key with calling getter method


    public
                    getDataUsingMethod(string $key[, mixed $args = null ]) : mixed

Parameters

$key : string
$args : mixed = null

getEntityId()


    public
                    getEntityId() : int

Return values

int

getId()

Retrieve model object identifier


    public
                    getId() : int|string|null

#[Override]

Return values

int|string|null

getIdFieldName()

Retrieve identifier field name for model


    public
                    getIdFieldName() : string

#[Override]

Return values

string

getItemById()

Retrieve item model object by item identifier


    public
                    getItemById(int $itemId) : Mage_Wishlist_Model_Item|null

Parameters

$itemId : int

Return values

Mage_Wishlist_Model_Item|null

getItemByProduct()

Retrieve wishlist item by product id


    public
                    getItemByProduct(Mage_Catalog_Model_Product $product) : Mage_Wishlist_Model_Item|false

Parameters

$product : Mage_Catalog_Model_Product

Return values

Mage_Wishlist_Model_Item|false

getItemsCollection()

Retrieve wishlist item collection


    public
                    getItemsCollection() : Mage_Wishlist_Model_Resource_Item_Collection

Return values

Mage_Wishlist_Model_Resource_Item_Collection

getItemsCount()

Retrieve wishlist items count


    public
                    getItemsCount() : int

Return values

int

getName()

Retrieve wishlist name


    public
                    getName() : string

Return values

string

getOrigData()

Get object loaded data (original data)


    public
                    getOrigData([string $key = null ]) : mixed

Parameters

$key : string = null

getResource()

Retrieve model resource


    public
                    getResource() : Mage_Wishlist_Model_Resource_Wishlist

Return values

Mage_Wishlist_Model_Resource_Wishlist

getResourceCollection()

Get collection instance


    public
                    getResourceCollection() : Mage_Core_Model_Resource_Db_Collection_Abstract

Return values

Mage_Core_Model_Resource_Db_Collection_Abstract

getResourceName()

Retrieve model resource name


    public
                    getResourceName() : string

Return values

string

getShared()


    public
                    getShared() : bool|null

Return values

bool|null

getSharedStoreIds()

Get all available store ids for wishlist


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

Return values

array<string|int, mixed>

getSharingCode()


    public
                    getSharingCode() : string|null

Return values

string|null

getShippingAddress()


    public
                    getShippingAddress() : Mage_Customer_Model_Address_Abstract|null

Return values

Mage_Customer_Model_Address_Abstract|null

getStore()

Get wishlist store model object


    public
                    getStore() : Mage_Core_Model_Store

Return values

Mage_Core_Model_Store

getStoreId()

Get wishlist store identifier


    public
                    getStoreId() : int

Return values

int

getUpdatedAt()


    public
                    getUpdatedAt() : string|null

Return values

string|null

getVisibility()


    public
                    getVisibility() : string|null

Return values

string|null

hasData()

If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.


    public
                    hasData([string $key = '' ]) : bool

Parameters

$key : string = ''

Return values

bool

hasDataChanges()

Get data change status


    public
                    hasDataChanges() : bool

Return values

bool

hasErrors()


    public
                    hasErrors() : bool

Return values

bool

hasItems()

Checking items availability


    public
                    hasItems() : bool

Return values

bool

isDeleted()

Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value


    public
                    isDeleted([bool $isDeleted = null ]) : bool

Parameters

$isDeleted : bool = null

Return values

bool

isDirty()


    public
                    isDirty([string $field = null ]) : bool

Parameters

$field : string = null

Return values

bool

isEmpty()

checks whether the object is empty


    public
                    isEmpty() : bool

Return values

bool

isModuleEnabled()


    public
                    isModuleEnabled(string $moduleName[, string $helperAlias = 'core' ]) : bool

Parameters

$moduleName : string
$helperAlias : string = 'core'

Return values

bool

isObjectNew()

Check object state (true - if it is object without id on object just created) This method can help detect if object just created in _afterSave method problem is what in after save object has id and we can't detect what object was created in this transaction


    public
                    isObjectNew([bool $flag = null ]) : bool

Parameters

$flag : bool = null

Return values

bool

isOwner()

Check customer is owner this wishlist


    public
                    isOwner(int $customerId) : bool

Parameters

$customerId : int

Return values

bool

isSalable()

Retrieve wishlist has salable item(s)


    public
                    isSalable() : bool

Return values

bool

jsonSerialize()

Implementation of JsonSerializable::jsonSerialize()


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

Prepares the object data for JSON serialization. Returns all object data as an array, with special handling for nested DataObject instances:

If a nested DataObject has a custom jsonSerialize() implementation, it's preserved as-is
If a nested DataObject has a custom toJson() method, it's converted to JSON string
If a nested DataObject uses only the base implementations, it's excluded from output

This prevents infinite recursion and circular references when serializing object hierarchies.

#[Override]

Return values

array<string|int, mixed>

load()

Load object data


    public
                    load(string|null|int $id[, string|null $field = null ]) : $this

Parameters

$id : string|null|int
$field : string|null = null

Return values

$this

loadByCode()

Load by sharing code


    public
                    loadByCode(string $code) : $this

Parameters

$code : string

Return values

$this

loadByCustomer()

Load wishlist by customer


    public
                    loadByCustomer(int|Mage_Customer_Model_Customer $customer[, bool $create = false ]) : $this

Parameters

$customer : int|Mage_Customer_Model_Customer
$create : bool = false: Create wishlist if don't exists

Return values

$this

offsetExists()

Implementation of ArrayAccess::offsetExists()


    public
                    offsetExists(string $offset) : bool

Parameters

$offset : string

Return values

bool

offsetGet()

Implementation of ArrayAccess::offsetGet()


    public
                    offsetGet(string $offset) : mixed

Parameters

$offset : string

offsetSet()

Implementation of ArrayAccess::offsetSet()


    public
                    offsetSet(string $offset, mixed $value) : void

Parameters

$offset : string
$value : mixed

offsetUnset()

Implementation of ArrayAccess::offsetUnset()


    public
                    offsetUnset(string $offset) : void

Parameters

$offset : string

removeAllItems()

Mark all wishlist items as deleted (empty wishlist)


    public
                    removeAllItems() : $this

Return values

$this

removeItem()

Remove wishlist item by item identifier


    public
                    removeItem(int $itemId) : self

Parameters

$itemId : int

Return values

self

save()

Save object data


    public
                    save() : $this

#[Override]

Return values

$this

serialize()

serialize object attributes


    public
                    serialize([array<string|int, mixed> $attributes = [] ][, string $valueSeparator = '=' ][, string $fieldSeparator = ' ' ][, string $quote = '"' ]) : string

Parameters

$attributes : array<string|int, mixed> = []
$valueSeparator : string = '='
$fieldSeparator : string = ' '
$quote : string = '"'

Return values

string

setAttribute()


    public
                    setAttribute(Mage_Eav_Model_Entity_Attribute_Abstract $value) : $this

Parameters

$value : Mage_Eav_Model_Entity_Attribute_Abstract

Return values

$this

setCreatedAt()


    public
                    setCreatedAt(string|null $value) : static

Parameters

$value : string|null

Return values

static

setCustomerId()

Set customer id


    public
                    setCustomerId(int $customerId) : $this

Parameters

$customerId : int

Return values

$this

setData()

Overwrite data in the object.


    public
                    setData(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this

$key can be string or array. If $key is string, the attribute value will be overwritten by $value

If $key is an array, it will overwrite all the data in the object.

Parameters

$key : string|array<string|int, mixed>
$value : mixed = null

Return values

$this

setDataChanges()

Clears data changes status


    public
                    setDataChanges(bool $value) : $this

Parameters

$value : bool

Return values

$this

setDataUsingMethod()

Set object data with calling setter method


    public
                    setDataUsingMethod(string $key[, mixed $args = [] ]) : $this

Parameters

$key : string
$args : mixed = []

Return values

$this

setId()

Declare model object identifier value


    public
                    setId(mixed $id) : $this

Parameters

$id : mixed

#[Override]

Return values

$this

setIdFieldName()

set name of object id field


    public
                    setIdFieldName(string $name) : $this

Parameters

$name : string

Return values

$this

setOrigData()

Initialize object original data


    public
                    setOrigData([string $key = null ][, mixed $data = null ]) : $this

Parameters

$key : string = null
$data : mixed = null

Return values

$this

setShared()


    public
                    setShared([bool|null $value = true ]) : static

Parameters

$value : bool|null = true

Return values

static

setSharingCode()


    public
                    setSharingCode(string|null $value) : static

Parameters

$value : string|null

Return values

static

setStore()

Declare wishlist store model


    public
                    setStore(Mage_Core_Model_Store $store) : $this

Parameters

$store : Mage_Core_Model_Store

Return values

$this

setUpdatedAt()


    public
                    setUpdatedAt(string|null $value) : static

Parameters

$value : string|null

Return values

static

toArray()

Public wrapper for __toArray


    public
                    toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

array<string|int, mixed>

toJson()

Public wrapper for __toJson


    public
                    toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

string

toString()

Public wrapper for __toString


    public
                    toString([string $format = '' ]) : string

Will use $format as an template and substitute {{key}} for attributes

Parameters

$format : string = ''

Return values

string

toXml()

Public wrapper for __toXml


    public
                    toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []
$rootName : string = 'item'
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

unsetData()

Unset data from the object.


    public
                    unsetData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

unsetOldData()

Unset old fields data from the object.


    public
                    unsetOldData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

updateItem()

Update wishlist Item and set data from request


    public
                    updateItem(int|Mage_Wishlist_Model_Item $itemId, DataObject $buyRequest[, null|array<string|int, mixed>|DataObject $params = null ]) : $this

$params sets how current item configuration must be taken into account and additional options. It's passed to Mage_Catalog_Helper_Product->addParamsToBuyRequest() to compose resulting buyRequest.

Basically it can hold

'current_config', \Maho\DataObject or array - current buyRequest that configures product in this item, used to restore currently attached files
'files_prefix': string[a-z0-9_] - prefix that was added at frontend to names of file options (file inputs), so they won't intersect with other submitted options

For more options see Mage_Catalog_Helper_Product->addParamsToBuyRequest()

Parameters

$itemId : int|Mage_Wishlist_Model_Item
$buyRequest : DataObject
$params : null|array<string|int, mixed>|DataObject = null

Return values

$this

__toJson()

Convert object attributes to JSON


    protected
                    __toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

string

__toXml()

Convert object attributes to XML


    protected
                    __toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes
$rootName : string = 'item': name of the root element
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

_addCatalogProduct()

Add catalog product object data to wishlist


    protected
                    _addCatalogProduct(Mage_Catalog_Model_Product $product[, int $qty = 1 ][, bool $forciblySetQty = false ]) : Mage_Wishlist_Model_Item

Parameters

$product : Mage_Catalog_Model_Product
$qty : int = 1
$forciblySetQty : bool = false

Return values

Mage_Wishlist_Model_Item

_addFullNames()


    protected
                    _addFullNames() : mixed

_afterDelete()

Processing object after delete data


    protected
                    _afterDelete() : $this

Return values

$this

_afterDeleteCommit()

Processing manipulation after main transaction commit


    protected
                    _afterDeleteCommit() : $this

Return values

$this

_afterLoad()

Processing object after load data


    protected
                    _afterLoad() : $this

Return values

$this

_afterSave()

Save related items


    protected
                    _afterSave() : $this

#[Override]

Return values

$this

_beforeDelete()

Processing object before delete data


    protected
                    _beforeDelete() : $this

Return values

$this

_beforeLoad()

Processing object before load data


    protected
                    _beforeLoad(int $id[, string|null $field = null ]) : $this

Parameters

$id : int
$field : string|null = null

Return values

$this

_beforeSave()

Set date of last update for wishlist


    protected
                    _beforeSave() : $this

#[Override]

Return values

$this

_camelize()


    protected
                    _camelize(string $name) : string

Parameters

$name : string

Return values

string

_clearData()

Clearing object's data


    protected
                    _clearData() : $this

Return values

$this

_clearReferences()

Clearing cyclic references


    protected
                    _clearReferences() : $this

Return values

$this

_construct()

Initialize resource model


    protected
                    _construct() : void

#[Override]

_getData()

Get value from _data array without parse key


    protected
                    _getData(string $key) : mixed

Parameters

$key : string

_getEventData()

Get array of objects transferred to default events processing


    protected
                    _getEventData() : array<string|int, mixed>

Return values

array<string|int, mixed>

_getSharingRandomCode()

Retrieve sharing code (random string)


    protected
                    _getSharingRandomCode() : string

Return values

string

_hasModelChanged()

Check whether model has changed data.


    protected
                    _hasModelChanged() : bool

Can be overloaded in child classes to perform advanced check whether model needs to be saved e.g. using resourceModel->hasDataChanged() or any other technique

Return values

bool

_init()

Standard model initialization


    protected
                    _init(string $resourceModel) : mixed

Parameters

$resourceModel : string

_initOldFieldsMap()

Inits mapping array of object's previously used fields to new fields.


    protected
                    _initOldFieldsMap() : mixed

Must be overloaded by descendants to set concrete fields map.

_prepareArray()

Set required array elements


    protected
                    _prepareArray(array<string|int, mixed> &$arr[, array<string|int, mixed> $elements = [] ]) : array<string|int, mixed>

Parameters

$arr : array<string|int, mixed>
$elements : array<string|int, mixed> = []

Return values

array<string|int, mixed>

_prepareSyncFieldsMap()

Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.


    protected
                    _prepareSyncFieldsMap() : $this

Return values

$this

_protectFromNonAdmin()

Safeguard func that will check, if we are in admin area


    protected
                    _protectFromNonAdmin() : mixed

_setResourceModel()

Set resource names


    protected
                    _setResourceModel(string $resourceName[, string|null $resourceCollectionName = null ]) : mixed

If collection name is omitted, resource name will be used with _collection appended

Parameters

$resourceName : string
$resourceCollectionName : string|null = null

_underscore()

Converts field names for setters and getters


    protected
                    _underscore(string $name) : string

$this->setMyField($value) === $this->setData('my_field', $value) Uses cache to eliminate unnecessary preg_replace

Parameters

$name : string

Return values

string

Mage_Wishlist_Model_Wishlist extends Mage_Core_Model_Abstract in package Mage Wishlist

Table of Contents

Properties

Methods

Properties

$_cacheTag

Attributes

$_data

$_dataSaveAllowed

$_dirty

$_eventObject

$_eventPrefix

Attributes

$_hasDataChanges

$_idFieldName

$_isDeleted

$_isObjectNew

$_itemCollection

$_oldFieldsMap

$_origData

$_resource

$_resourceCollectionName

$_resourceName

$_store

$_storeIds

$_syncFieldsMap

$_underscoreCache

Methods

__call()

Parameters

__construct()

__get()

Parameters

__set()

Parameters

__toArray()

Parameters

Return values

_getResource()

Return values

addData()

Parameters

Return values

addItem()

Parameters

Return values

addNewItem()

Parameters

Return values

afterCommitCallback()

Return values

afterLoad()

Return values

cleanModelCache()

Return values

clearInstance()

Return values

dataHasChangedFor()

Parameters

Return values

debug()

Parameters

Return values

delete()

Tags

Return values

flagDirty()

Parameters

Return values

generateSharingCode()

Return values

getAllItems()

Return values

getBillingAddress()

Return values

getCacheIdTags()

Return values

getCacheTags()

Return values

getCollection()

Mage_Wishlist_Model_Wishlist extends Mage_Core_Model_Abstract
in package

Mage

Wishlist