Exponent v2.7.2

product extends expRecord
in package

This is the class expRecord

Tags
subpackage

Models

Table of Contents

$active_display  : mixed
$active_display_desc  : mixed
$attachable_items_to_save  : mixed
$classname  : mixed
$default_sort_direction  : mixed
$default_sort_field  : mixed
$do_not_validate  : mixed
$get_assoc_for  : mixed
$get_attachable_for  : mixed
$grouping_sql  : mixed
$has_and_belongs_to_many  : mixed
$has_and_belongs_to_self  : mixed
$has_extended_fields  : mixed
$has_many  : mixed
$has_many_self  : mixed
$has_one  : mixed
$identifier  : mixed
$isQuantityAdjustable  : mixed
$needs_approval  : mixed
$product_name  : mixed
$product_type  : mixed
$quantity_discount_amount_modifiers  : mixed
$quantity_discount_items_modifiers  : mixed
$quantity_display  : mixed
$rank_by_field  : mixed
$requiresBilling  : mixed
$requiresShipping  : mixed
$supports_revisions  : mixed
$table  : mixed
$tablename  : mixed
$validate  : mixed
$validates  : mixed
$attachable_item_types  : mixed
$classinfo  : mixed
__construct()  : mixed
__get()  : null
Generic magic method
__isset()  : bool
Generic magic method
__set()  : mixed
Generic magic method We MUST create/set non-existing properties for Exponent code to work
__unset()  : mixed
Generic magic method
addContentToSearch()  : bool
Called when updating product
addToCart()  : mixed
afterCreate()  : mixed
after creating item
afterDelete()  : mixed
is run after deleting item, should delete associated items here if needed
afterSave()  : mixed
after saving item
afterUpdate()  : mixed
after updating item
afterValidation()  : mixed
after validating item
afterValidationOnCreate()  : mixed
after validating item during creation
afterValidationOnUpdate()  : mixed
after validating item during update
associateWith()  : mixed
get objects this item belongs to ??
attachItem()  : bool
attach to item
beforeCreate()  : mixed
before creating item
beforeDelete()  : mixed
is run before deleting item
beforeSave()  : mixed
before saving item
beforeUpdate()  : mixed
before updating item
beforeValidation()  : mixed
before validating item
beforeValidationOnCreate()  : mixed
before validating item during creation
beforeValidationOnUpdate()  : mixed
before validating item during update
build()  : mixed
Adds table fields as class properties to current "record" class.
canView()  : mixed
cartSummary()  : mixed
checkout()  : mixed
delete()  : bool
delete item
displayForm()  : mixed
displayname()  : string
name of model
find()  : array<string|int, mixed>|int|object
find an item or items
findBy()  : array<string|int, mixed>
find an item by column
findValue()  : array<string|int, mixed>|bool
find a value(s) by column
findWhereAttachedTo()  : array<string|int, mixed>
this function finds models that have this attachable item attached
formatExtraData()  : mixed
getAssociatedObjects()  : null
get item's associated objects
getAttachableItemTables()  : array<string|int, mixed>
used for import/export
getBasePrice()  : mixed
getDefaultQuantity()  : mixed
getForm()  : mixed
getPoster()  : null|string
return the item poster
getSEFURL()  : mixed
getSurcharge()  : mixed
getTimestamp()  : mixed
return the item timestamp
getViewDir()  : mixed
hasChildren()  : mixed
hasOptions()  : mixed
hasRequiredOptions()  : mixed
hasUserInputFields()  : mixed
incrementQuantity()  : mixed
isChild()  : mixed
isSearchable()  : bool
is model content searchable?
makeSefUrl()  : mixed
make an sef_url for item
name()  : string
name of model for backwards compat with old modules
optionDropdown()  : mixed
paginationCallback()  : mixed
process()  : mixed
Process submitted order and update product inventory/quantity
refresh()  : bool
re-construct the item from the database
removeItem()  : mixed
rerank()  : mixed
rerank items
save()  : mixed
save item
saveAssociatedObjects()  : mixed
save associated objects
saveCategories()  : mixed
sortChildren()  : mixed
storeListing()  : mixed
update()  : mixed
update item
updateCart()  : mixed
updateQuantity()  : mixed
validate()  : bool
validate item sef_url
checkForAttachableItems()  : bool
check for what objects may be attached
getAttachableItems()  : mixed
get attached objects for this item
createOrderItem()  : mixed
getAssociatedObjectsForThisModel()  : mixed
gets associated objects for this model
getProductFiles()  : mixed
makeManyToManyTablename()  : string
create a many to many table relationship

Properties

$active_display

public mixed $active_display = array(0 => 'Active', 1 => 'Inactive but findable.', 2 => 'Inactive and disabled.')

$active_display_desc

public mixed $active_display_desc = array(0 => '', 1 => 'It will not be shown in product listings and the "Add to Cart" button is disabled but is still viewable directly. This can be advantageous with the page caching in the search engines.', 2 => 'Trying to view this product will produce an error indicating this product is currently not available.')

$attachable_items_to_save

public mixed $attachable_items_to_save

$default_sort_direction

public mixed $default_sort_direction = ''

$default_sort_field

public mixed $default_sort_field = ''

$do_not_validate

public mixed $do_not_validate = array()

$get_assoc_for

public mixed $get_assoc_for = array('optiongroup')

$get_attachable_for

public mixed $get_attachable_for = array()

$grouping_sql

public mixed $grouping_sql = ''

$has_and_belongs_to_many

public mixed $has_and_belongs_to_many = array('storeCategory')

$has_and_belongs_to_self

public mixed $has_and_belongs_to_self = array('crosssellItem')

$has_extended_fields

public mixed $has_extended_fields = array()

$has_many

public mixed $has_many = array('optiongroup', 'model_alias', 'product_notes')

$has_many_self

public mixed $has_many_self = array('childProduct')

$has_one

public mixed $has_one = array('company', 'product_status')

$isQuantityAdjustable

public mixed $isQuantityAdjustable = \true

$needs_approval

public mixed $needs_approval = \false

$product_name

public mixed $product_name = 'Product'

$product_type

public mixed $product_type = 'product'

$quantity_discount_amount_modifiers

public mixed $quantity_discount_amount_modifiers = array('$' => '$', '%' => '%')

$quantity_discount_items_modifiers

public mixed $quantity_discount_items_modifiers = array('gte' => 'Equal to or more than', 'gt' => 'More than')

$quantity_display

public mixed $quantity_display = array(0 => 'Always available even if out of stock.', 1 => '* Available to order, but will display the message below if out of stock.', 2 => '* Unavailable if out of stock and will display the message below.', 3 => 'Show as &quot;Call for Price&quot;.')

$rank_by_field

public mixed $rank_by_field = ''

$requiresBilling

public mixed $requiresBilling = \true

$requiresShipping

public mixed $requiresShipping = \true

$supports_revisions

public mixed $supports_revisions = \false

$table

public mixed $table = 'product'

$validates

public mixed $validates = array()

$attachable_item_types

protected mixed $attachable_item_types = array( // 'content_expCats'=>'expCat', 'content_expComments' => 'expComment', // 'content_expDefinableFields'=> 'expDefinableField', 'content_expFiles' => 'expFile', 'content_expRatings' => 'expRating', 'content_expSimpleNote' => 'expSimpleNote', )

$classinfo

protected mixed $classinfo = \null

Methods

__construct()

public __construct([mixed $params = array() ][, mixed $get_assoc = true ][, mixed $get_attached = true ]) : mixed
Parameters
$params : mixed = array()
$get_assoc : mixed = true
$get_attached : mixed = true
Return values
mixed —

__get()

Generic magic method

public __get( $property) : null
Parameters
$property :
Return values
null —

__isset()

Generic magic method

public __isset( $property) : bool
Parameters
$property :
Return values
bool —

__set()

Generic magic method We MUST create/set non-existing properties for Exponent code to work

public __set( $property,  $value) : mixed
Parameters
$property :
$value :
Return values
mixed —

__unset()

Generic magic method

public __unset( $property) : mixed
Parameters
$property :
Return values
mixed —

addContentToSearch()

Called when updating product

public addContentToSearch() : bool
Return values
bool —

addToCart()

public addToCart(mixed $params[, mixed $orderid = null ]) : mixed
Parameters
$params : mixed
$orderid : mixed = null
Return values
mixed —

afterCreate()

after creating item

public afterCreate() : mixed
Return values
mixed —

afterDelete()

is run after deleting item, should delete associated items here if needed

public afterDelete() : mixed
Return values
mixed —

afterSave()

after saving item

public afterSave() : mixed
Return values
mixed —

afterUpdate()

after updating item

public afterUpdate() : mixed
Return values
mixed —

afterValidation()

after validating item

public afterValidation() : mixed
Return values
mixed —

afterValidationOnCreate()

after validating item during creation

public afterValidationOnCreate() : mixed
Return values
mixed —

afterValidationOnUpdate()

after validating item during update

public afterValidationOnUpdate() : mixed
Return values
mixed —

associateWith()

get objects this item belongs to ??

public associateWith( $datatype,  $id) : mixed

Type of associations has_and_belongs_to_many

Parameters
$datatype :
$id :
Return values
mixed —

attachItem()

attach to item

public attachItem( $item[, string $subtype = '' ][, bool $replace = true ]) : bool
Parameters
$item :
$subtype : string = ''
$replace : bool = true
Return values
bool —

beforeCreate()

before creating item

public beforeCreate() : mixed
Return values
mixed —

beforeDelete()

is run before deleting item

public beforeDelete() : mixed
Return values
mixed —

beforeSave()

before saving item

public beforeSave() : mixed
Return values
mixed —

beforeUpdate()

before updating item

public beforeUpdate() : mixed
Return values
mixed —

beforeValidation()

before validating item

public beforeValidation() : mixed
Return values
mixed —

beforeValidationOnCreate()

before validating item during creation

public beforeValidationOnCreate() : mixed
Return values
mixed —

beforeValidationOnUpdate()

before validating item during update

public beforeValidationOnUpdate() : mixed
Return values
mixed —

build()

Adds table fields as class properties to current "record" class.

public build([mixed $params = array() ]) : mixed

Loads Table schema data and creates new class properties based upon the fields in given table.

Additionally, if a record ID is given, that record is pulled and field values are also populated into class properties.

Parameters
$params : mixed = array()

array or Object for table selection

Tags
category

db_record

uses

[db_type]::getDataDefinition() Builds a data definition from existing table.

requires

$db

access

protected

final
PHPUnit

Not Defined

global

object $db

Return values
mixed —

canView()

public static canView(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed —

cartSummary()

public cartSummary(mixed $item) : mixed
Parameters
$item : mixed
Return values
mixed —

checkout()

public checkout() : mixed
Return values
mixed —

delete()

delete item

public delete([string $where = '' ]) : bool
Parameters
$where : string = ''
Return values
bool —

displayForm()

public displayForm(mixed $form, mixed $params) : mixed
Parameters
$form : mixed
$params : mixed
Return values
mixed —

displayname()

name of model

public static displayname() : string
Return values
string —

find()

find an item or items

public find([string $range = 'all' ][, null $where = null ][, null $order = null ][, null $limit = null ], int $limitstart[, bool $get_assoc = true ][, bool $get_attached = true ][, array<string|int, mixed> $except = array() ][, bool $cascade_except = false ]) : array<string|int, mixed>|int|object
Parameters
$range : string = 'all'

// all, revisions, first, bytitle, count, bytag, bycat,

$where : null = null
$order : null = null
$limit : null = null
$limitstart : int
$get_assoc : bool = true
$get_attached : bool = true
$except : array<string|int, mixed> = array()
$cascade_except : bool = false
Return values
array<string|int, mixed>|int|object —

findBy()

find an item by column

public findBy( $column,  $value[, bool $get_assoc = true ][, bool $get_attached = true ][, array<string|int, mixed> $except = array() ][, bool $cascade_except = false ]) : array<string|int, mixed>
Parameters
$column :
$value :
$get_assoc : bool = true
$get_attached : bool = true
$except : array<string|int, mixed> = array()
$cascade_except : bool = false
Return values
array<string|int, mixed> —

findValue()

find a value(s) by column

public findValue([string $range = 'all' ][, string $column = null ][, string $where = null ][, string $order = null ][, bool $distinct = false ]) : array<string|int, mixed>|bool
Parameters
$range : string = 'all'
$column : string = null
$where : string = null
$order : string = null
$distinct : bool = false
Return values
array<string|int, mixed>|bool —

findWhereAttachedTo()

this function finds models that have this attachable item attached

public findWhereAttachedTo( $content_type) : array<string|int, mixed>
Parameters
$content_type :
Return values
array<string|int, mixed> —

formatExtraData()

public formatExtraData(mixed $item) : mixed
Parameters
$item : mixed
Return values
mixed —

getAssociatedObjects()

get item's associated objects

public getAssociatedObjects([object $obj = null ]) : null

Type of associations has_one has_many has_and_belongs_to_many

Parameters
$obj : object = null
Return values
null —

getAttachableItemTables()

used for import/export

public getAttachableItemTables() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getBasePrice()

public getBasePrice([mixed $orderitem = null ]) : mixed
Parameters
$orderitem : mixed = null
Return values
mixed —

getDefaultQuantity()

public getDefaultQuantity() : mixed
Return values
mixed —

getForm()

public getForm(mixed $form) : mixed
Parameters
$form : mixed
Return values
mixed —

getPoster()

return the item poster

public getPoster([null $display = null ]) : null|string
Parameters
$display : null = null
Return values
null|string —

getSEFURL()

public getSEFURL() : mixed
Return values
mixed —

getSurcharge()

public getSurcharge() : mixed
Return values
mixed —

getTimestamp()

return the item timestamp

public getTimestamp(int $type) : mixed
Parameters
$type : int
Return values
mixed —

getViewDir()

public getViewDir() : mixed
Return values
mixed —

hasChildren()

public hasChildren() : mixed
Return values
mixed —

hasOptions()

public hasOptions() : mixed
Return values
mixed —

hasRequiredOptions()

public hasRequiredOptions() : mixed
Return values
mixed —

hasUserInputFields()

public hasUserInputFields() : mixed
Return values
mixed —

incrementQuantity()

public incrementQuantity(mixed $oldval) : mixed
Parameters
$oldval : mixed
Return values
mixed —

isChild()

public isChild() : mixed
Return values
mixed —

isSearchable()

is model content searchable?

public static isSearchable() : bool
Return values
bool —

makeSefUrl()

make an sef_url for item

public makeSefUrl() : mixed
Return values
mixed —

name()

name of model for backwards compat with old modules

public name() : string
Return values
string —

optionDropdown()

public optionDropdown(mixed $key, mixed $display_price_as) : mixed
Parameters
$key : mixed
$display_price_as : mixed
Return values
mixed —

paginationCallback()

public paginationCallback(mixed &$item) : mixed
Parameters
$item : mixed
Return values
mixed —

process()

Process submitted order and update product inventory/quantity

public process( $item[, bool $affects_inventory = false ]) : mixed
Parameters
$item :
$affects_inventory : bool = false
Return values
mixed —

refresh()

re-construct the item from the database

public refresh() : bool
Tags
throws
ReflectionException
Return values
bool —

removeItem()

public removeItem(mixed $item) : mixed
Parameters
$item : mixed
Return values
mixed —

rerank()

rerank items

public rerank( $direction[, string $where = '' ]) : mixed
Parameters
$direction :
$where : string = ''
Return values
mixed —

save()

save item

public save([bool $validate = false ][, bool $force_no_revisions = false ]) : mixed
Parameters
$validate : bool = false
$force_no_revisions : bool = false
Return values
mixed —

saveAssociatedObjects()

save associated objects

public saveAssociatedObjects() : mixed

Type of associations has_one

Return values
mixed —

saveCategories()

public saveCategories(mixed $catArray[, mixed $catRankArray = null ][, mixed $id = '' ][, mixed $product_type = '' ]) : mixed
Parameters
$catArray : mixed
$catRankArray : mixed = null
$id : mixed = ''
$product_type : mixed = ''
Return values
mixed —

sortChildren()

public static sortChildren(mixed $a, mixed $b) : mixed
Parameters
$a : mixed
$b : mixed
Return values
mixed —

storeListing()

public storeListing() : mixed
Return values
mixed —

update()

update item

public update([mixed $params = array() ]) : mixed
Parameters
$params : mixed = array()
Return values
mixed —

updateCart()

public updateCart() : mixed
Return values
mixed —

updateQuantity()

public updateQuantity(mixed $newval) : mixed
Parameters
$newval : mixed
Return values
mixed —

validate()

validate item sef_url

public validate() : bool
Return values
bool —

checkForAttachableItems()

check for what objects may be attached

protected checkForAttachableItems( $params) : bool
Parameters
$params :
Return values
bool —

getAttachableItems()

get attached objects for this item

protected getAttachableItems() : mixed
Return values
mixed —

createOrderItem()

private createOrderItem(mixed $product, mixed $params, mixed $user_input_info, mixed $orderid) : mixed
Parameters
$product : mixed
$params : mixed
$user_input_info : mixed
$orderid : mixed
Return values
mixed —

getAssociatedObjectsForThisModel()

gets associated objects for this model

private getAssociatedObjectsForThisModel([array<string|int, mixed> $except = array() ][, bool $cascade_except = false ]) : mixed

Type of associations has_extended_fields has_one has_many has_many_self has_and_belongs_to_many has_and_belongs_to_self

Parameters
$except : array<string|int, mixed> = array()
$cascade_except : bool = false
Return values
mixed —

getProductFiles()

private getProductFiles([mixed $id = '' ]) : mixed
Parameters
$id : mixed = ''
Return values
mixed —

makeManyToManyTablename()

create a many to many table relationship

private makeManyToManyTablename( $assoc_table) : string
Parameters
$assoc_table :
Return values
string —

Search results