Exponent v2.7.2

freeshippingcalculator extends shippingcalculator
in package

This is the class expRecord

Tags
subpackage

Calculators

Table of Contents

$attachable_items_to_save  : mixed
$classname  : mixed
$configdata  : 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
$icon  : mixed
$identifier  : mixed
$multiple_carriers  : mixed
$needs_approval  : mixed
$rank_by_field  : mixed
$shippingmethods  : 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
addressRequired()  : 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
availableMethods()  : array<string|int, mixed>
Return array of available shipping method names
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.
buyLabel()  : mixed
buyPickup()  : mixed
cancelLabel()  : mixed
cancelPickup()  : mixed
configForm()  : string
Return path to calculator configuration form template
createLabel()  : mixed
createPickup()  : mixed
delete()  : bool
delete item
description()  : 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
getAssociatedObjects()  : null
get item's associated objects
getAttachableItemTables()  : array<string|int, mixed>
used for import/export
getCalcName()  : string
Return shipping calculator name
getCalcTitle()  : string
Return shipping calculator title
getDefault()  : int
Return default shipping calculator
getHandling()  : int
Unused at this time
getLabel()  : mixed
getPackageDetails()  : mixed
getPackages()  : array<string|int, mixed>
Return array of packages
getPoster()  : null|string
return the item poster
getRates()  : array<string|int, mixed>
Main function to return (all possible) shipping rates for order
getTimestamp()  : mixed
return the item timestamp
handleTracking()  : mixed
hasConfig()  : mixed
isSearchable()  : bool
is model content searchable?
isSelectable()  : mixed
labelsEnabled()  : mixed
makeSefUrl()  : mixed
make an sef_url for item
meetsCriteria()  : bool
Does calculator meet criteria
name()  : mixed
parseConfig()  : array<string|int, mixed>
Parse configuration data into an array
pickupEnabled()  : mixed
refresh()  : bool
re-construct the item from the database
rerank()  : mixed
rerank items
save()  : mixed
save item
saveAssociatedObjects()  : mixed
save associated objects
trackerEnabled()  : mixed
update()  : mixed
update item
validate()  : bool
validate item sef_url
checkForAttachableItems()  : bool
check for what objects may be attached
getAttachableItems()  : mixed
get attached objects for this item
getAssociatedObjectsForThisModel()  : mixed
gets associated objects for this model
makeManyToManyTablename()  : string
create a many to many table relationship

Properties

$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()

$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()

$has_and_belongs_to_self

public mixed $has_and_belongs_to_self = array()

$has_extended_fields

public mixed $has_extended_fields = array()

$has_many_self

public mixed $has_many_self = array()

$needs_approval

public mixed $needs_approval = \false

$rank_by_field

public mixed $rank_by_field = ''

$supports_revisions

public mixed $supports_revisions = \false

$validates

public mixed $validates = array()

$attachable_item_types

protected mixed $attachable_item_types = array()

$classinfo

protected mixed $classinfo = \null

Methods

__construct()

public __construct([mixed $params = null ]) : mixed
Parameters
$params : mixed = null
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

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

availableMethods()

Return array of available shipping method names

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

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

buyLabel()

public buyLabel(mixed $shippingmethod) : mixed
Parameters
$shippingmethod : mixed
Return values
mixed

buyPickup()

public buyPickup(mixed $shippingmethod, mixed $type) : mixed
Parameters
$shippingmethod : mixed
$type : mixed
Return values
mixed

cancelLabel()

public cancelLabel(mixed $shippingmethod) : mixed
Parameters
$shippingmethod : mixed
Return values
mixed

cancelPickup()

public cancelPickup(mixed $shippingmethod) : mixed
Parameters
$shippingmethod : mixed
Return values
mixed

configForm()

Return path to calculator configuration form template

public configForm() : string
Return values
string

createLabel()

public createLabel(mixed $shippingmethod) : mixed
Parameters
$shippingmethod : mixed
Return values
mixed

createPickup()

public createPickup(mixed $shippingmethod, mixed $pickupdate, mixed $pickupenddate, mixed $instructions) : mixed
Parameters
$shippingmethod : mixed
$pickupdate : mixed
$pickupenddate : mixed
$instructions : mixed
Return values
mixed

delete()

delete item

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

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>

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>

getCalcName()

Return shipping calculator name

public static getCalcName( $calc_id) : string
Parameters
$calc_id :
Return values
string

getCalcTitle()

Return shipping calculator title

public static getCalcTitle( $calc_id) : string
Parameters
$calc_id :
Return values
string

getDefault()

Return default shipping calculator

public static getDefault() : int
Return values
int

getHandling()

Unused at this time

public getHandling() : int
Return values
int

getLabel()

public getLabel(mixed $shippingmethod) : mixed
Parameters
$shippingmethod : mixed
Return values
mixed

getPackageDetails()

public getPackageDetails(mixed $shippingmethod[, mixed $tracking_only = false ]) : mixed
Parameters
$shippingmethod : mixed
$tracking_only : mixed = false
Return values
mixed

getPackages()

Return array of packages

public getPackages( $carrier) : array<string|int, mixed>
Parameters
$carrier :
Return values
array<string|int, mixed>

getPoster()

return the item poster

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

getRates()

Main function to return (all possible) shipping rates for order

public getRates(mixed $order) : array<string|int, mixed>
Parameters
$order : mixed
Return values
array<string|int, mixed>

getTimestamp()

return the item timestamp

public getTimestamp(int $type) : mixed
Parameters
$type : int
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

meetsCriteria()

Does calculator meet criteria

public meetsCriteria(mixed $shippingmethod) : bool
Parameters
$shippingmethod : mixed
Return values
bool

parseConfig()

Parse configuration data into an array

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

refresh()

re-construct the item from the database

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

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

update()

update item

public update([array<string|int, mixed>|object $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed>|object = array()
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

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

makeManyToManyTablename()

create a many to many table relationship

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

Search results