Index of all elements
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ q ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ _ ]
a
- $allowed_actions
- in file Product.php, variable Product_Controller::$allowed_actions
Allowed actions for this controller
- $allowed_actions
- in file AccountPage.php, variable AccountPage_Controller::$allowed_actions
Allowed actions that can be invoked.
- $allowed_currency
- in file Product.php, variable Product::$allowed_currency
Currency allowed to be used for products Code match Payment::$site_currency Only one currency site wide allowed
- $amount
- in file FlatFeeTaxField.php, variable FlatFeeTaxField::$amount
The amount this field represents e.g: 15% * order subtotal
- $attributeID
- in file OptionComplexTableField.php, variable OptionComplexTableField::$attributeID
Attribute ID for this options
- AccountPage
- in file AccountPage.php, class AccountPage
An account page which displays the order history for any given Member and displays an individual Order.
- AccountPage_Controller
- in file AccountPage.php, class AccountPage_Controller
Display the account page with listing of previous orders, and display an individual order.
- add
- in file Product.php, method Product_Controller::add()
Add an item to the current cart (Order) for a given Product.
- add
- in file ShopAdmin.php, method ShopAdmin_CollectionController::add()
Form for creating a new model record.
- addAddressesAtCheckout
- in file Order.php, method Order::addAddressesAtCheckout()
Add addresses to this Order at the checkout.
- addItem
- in file Order.php, method Order::addItem()
Add an item to the order representing the product, if an item for this product exists increase the quantity. Update the Order total afterward.
- addModifiersAtCheckout
- in file Order.php, method Order::addModifiersAtCheckout()
Save modifiers for this Order at the checkout process.
- Address
- in file Address.php, class Address
Represents a shipping or billing address which are both attached to Order.
- AddToCartForm
- in file AddToCartForm.php, class AddToCartForm
Form for adding items to the cart from a Product page.
- AddToCartForm
- in file Product.php, method Product_Controller::AddToCartForm()
Add to cart form for adding Products, to show on the Product page.
- AddToCartFormValidator
- in file AddToCartFormValidator.php, class AddToCartFormValidator
Validator for AddToCartForm which validates that the product Variation is correct for the Product being added to the cart.
- addToOrder
- in file Modifier.php, method Modifier_Interface::addToOrder()
Add modifider to an Order .
- addToOrder
- in file FlatFeeShipping.php, method FlatFeeShipping::addToOrder()
Add modifider to an Order .
- addToOrder
- in file FlatFeeTax.php, method FlatFeeTax::addToOrder()
Add modifider to an Order .
- addUnprocessableHTMLTag
- in file Emogrifier.php, method Emogrifier::addUnprocessableHTMLTag()
- Amount
- in file FlatFeeTax.php, method FlatFeeTax::Amount()
Get Amount for this modifier so that it can be saved into an Order Modification.
- Amount
- in file Modifier.php, method Modifier_Interface::Amount()
Get Amount for this modifier so that it can be saved into an Order Modification.
- Amount
- in file FlatFeeShipping.php, method FlatFeeShipping::Amount()
Get Amount for this modifier so that it can be saved into an Order Modification.
- apply
- in file PublishedStatusSearchFilter.php, method PublishedStatusSearchFilter::apply()
Apply filter query SQL to a search query
- apply
- in file ProductCategorySearchFilter.php, method ProductCategorySearchFilter::apply()
Apply filter query SQL to a search query
- apply
- in file PaymentSearchFilter.php, method PaymentSearchFilter::apply()
Apply filter query SQL to a search query
- apply
- in file DateRangeSearchFilter.php, method DateRangeSearchFilter::apply()
Apply filter query SQL to a search query Date range filtering between min and max values
- apply
- in file OptionSetSearchFilter.php, method OptionSetSearchFilter::apply()
Apply filter query SQL to a search query
- Attribute
- in file Attribute.php, class Attribute
Represents a Product Attribute, e.g: Size, Color, Material etc.
- augmentDatabase
- in file Order.php, method Order::augmentDatabase()
Testing to add auto increment to table
- AccountPage.php
- procedural page AccountPage.php
- AddToCartForm.php
- procedural page AddToCartForm.php
- AddToCartFormValidator.php
- procedural page AddToCartFormValidator.php
- Address.php
- procedural page Address.php
- Attribute.php
- procedural page Attribute.php
top
top
c
- $casting
- in file Order.php, variable Order::$casting
Castings for the searchable fields
- $casting
- in file Product.php, variable Product::$casting
Casting for searchable fields
- $collection_controller_class
- in file ShopAdmin.php, variable ShopAdmin::$collection_controller_class
Class used for administering the collections of products, orders etc.
- $create_table_options
- in file ItemOption.php, variable ItemOption::$create_table_options
Set table type to InnoDB to support transactions which are not currently implemented.
- $create_table_options
- in file Item.php, variable Item::$create_table_options
- $create_table_options
- in file Modification.php, variable Modification::$create_table_options
Set table to InnoDB in preparation for transaction support.
- $create_table_options
- in file Order.php, variable Order::$create_table_options
Table type for Orders should be InnoDB to support transactions - which are not implemented yet.
- $create_table_options
- in file Address.php, variable Address::$create_table_options
Table type needs to be InnoDB for transaction support (not currently implemented).
- $currency
- in file Modification.php, variable Modification::$currency
Modifier currency TODO move currency to one central location
- $currentOrder
- in file CartForm.php, variable CartForm::$currentOrder
The current Order (cart).
- $currentOrder
- in file CheckoutForm.php, variable CheckoutForm::$currentOrder
The current Order
- canCreate
- in file AccountPage.php, method AccountPage::canCreate()
Prevent CMS users from creating another account page.
- canCreate
- in file Order.php, method Order::canCreate()
Prevent orders from being created in the CMS
- canCreate
- in file CheckoutPage.php, method CheckoutPage::canCreate()
Prevent CMS users from creating another checkout page.
- canCreate
- in file PaymentDecorator.php, method PaymentDecorator::canCreate()
Cannot create Payments in the CMS.
- canCreate
- in file CartPage.php, method CartPage::canCreate()
Prevent CMS users from creating another cart page.
- canDelete
- in file Customer.php, method Customer::canDelete()
Prevent customers from being deleted.
- canDelete
- in file CheckoutPage.php, method CheckoutPage::canDelete()
Prevent CMS users from deleting the checkout page.
- canDelete
- in file PaymentDecorator.php, method PaymentDecorator::canDelete()
Cannot delete Payments in the CMS.
- canDelete
- in file Order.php, method Order::canDelete()
Prevent orders from being deleted in the CMS
- canDelete
- in file CartPage.php, method CartPage::canDelete()
Prevent CMS users from deleting the cart page.
- canDelete
- in file AccountPage.php, method AccountPage::canDelete()
Prevent CMS users from deleting the account page.
- canDeleteFromLive
- in file AccountPage.php, method AccountPage::canDeleteFromLive()
Prevent CMS users from unpublishing the account page.
- canDeleteFromLive
- in file CheckoutPage.php, method CheckoutPage::canDeleteFromLive()
Prevent CMS users from unpublishing the checkout page.
- canDeleteFromLive
- in file CartPage.php, method CartPage::canDeleteFromLive()
Prevent CMS users from unpublishing the cart page.
- Cart
- in file CartControllerExtension.php, method CartControllerExtension::Cart()
Retrieve the current cart for display in the template.
- Cart
- in file CartForm.php, method CartForm::Cart()
- Cart
- in file CheckoutForm.php, method CheckoutForm::Cart()
Helper function to return the current Order, used in the template for this form
- CartControllerExtension
- in file CartControllerExtension.php, class CartControllerExtension
Extends Page_Controller adding some functions to retrieve the current cart, and link to the cart.
- CartForm
- in file CartForm.php, class CartForm
Form to display the Order contents on the CartPage.
- CartForm
- in file CartPage.php, method CartPage_Controller::CartForm()
Form including quantities for items for displaying on the cart page.
- CartFormValidator
- in file CartFormValidator.php, class CartFormValidator
Validator for the CartForm, not really necessary
- CartLink
- in file CartControllerExtension.php, method CartControllerExtension::CartLink()
Convenience method to return links to cart related page.
- CartPage
- in file CartPage.php, class CartPage
A cart page for the frontend to display contents of a cart to a visitor.
- CartPage_Controller
- in file CartPage.php, class CartPage_Controller
Display the cart page, with cart form. Handle cart form actions.
- CartQuantityField
- in file CartQuantityField.php, class CartQuantityField
Quantity field for displaying each Item in an Order on the CartPage.
- CartTest
- in file CartTest.php, class CartTest
Testing Products added and removed from Orders.
- CheckoutForm
- in file CheckoutForm.php, class CheckoutForm
Form for displaying on the CheckoutPage with all the necessary details for a visitor to complete their order and pass off to the Payment gateway class.
- CheckoutPage
- in file CheckoutPage.php, class CheckoutPage
A checkout page for displaying the checkout form to a visitor.
- CheckoutPage_Controller
- in file CheckoutPage.php, class CheckoutPage_Controller
Display the checkout page, with order form. Process the order - send the order details off to the Payment class.
- CheckoutTest
- in file CheckoutTest.php, class CheckoutTest
Testing Order modifiers at checkout.
- CartControllerExtension.php
- procedural page CartControllerExtension.php
- CartPage.php
- procedural page CartPage.php
- CheckoutPage.php
- procedural page CheckoutPage.php
- Customer.php
- procedural page Customer.php
- CartForm.php
- procedural page CartForm.php
- CartFormValidator.php
- procedural page CartFormValidator.php
- CartQuantityField.php
- procedural page CartQuantityField.php
- CheckoutForm.php
- procedural page CheckoutForm.php
- combined_form_fields
- in file Modifier.php, method Modifier::combined_form_fields()
Get all the form fields from all the supported methods.
- combined_form_requirements
- in file Modifier.php, method Modifier::combined_form_requirements()
Get all the form requirements from all the supported methods.
- currency
- in file Modification.php, method Modification::currency()
Return the currency set for Order Modifications
- currentUser
- in file Customer.php, method Customer::currentUser()
Returns the current logged in customer
- Customer
- in file Customer.php, class Customer
Represents a Customer, a type of Member.
- CartTest.php
- procedural page CartTest.php
- CheckoutTest.php
- procedural page CheckoutTest.php
top
d
- $db
- in file StockLevel.php, variable StockLevel::$db
The stock level value (Int)
- $db
- in file Modification.php, variable Modification::$db
DB fields for the order Modification, the actual Modifier data is saved into this class so if a modifier is deleted the order still has the necessary details.
- $db
- in file Item.php, variable Item::$db
DB fields for an Item, the object this Item represents (e.g. Product has a version ID saved as well, so if price is changed or something then a record of the price at time of ordering exists and can be retrieved.
- $db
- in file FlatFeeTaxRate.php, variable FlatFeeTaxRate::$db
Fields for this tax rate
- $db
- in file Address.php, variable Address::$db
DB fields for an address
- $db
- in file Option.php, variable Option::$db
DB fields for this Option
- $db
- in file ProductImage.php, variable ProductImage::$db
DB fields for the ProductImage
- $db
- in file Product.php, variable Product::$db
DB fields for Product.
- $db
- in file Order.php, variable Order::$db
DB fields for Order, such as Stauts, Payment Status etc.
- $db
- in file FlatFeeShippingRate.php, variable FlatFeeShippingRate::$db
Fields for this shipping rate
- $db
- in file ItemOption.php, variable ItemOption::$db
DB fields for this class
- $db
- in file Variation.php, variable Variation::$db
DB fields for a Variation
- $db
- in file Attribute.php, variable Attribute::$db
DB fields for the Attribute, Title acts as the label for the select field on the AddToCartForm - so it does not need to be unique.
- $db
- in file Customer.php, variable Customer::$db
Extra DB fields, mostly for address - requirements for the Payment class.
- $db
- in file CheckoutPage.php, variable CheckoutPage::$db
Adding ChequeMessage field, a requirement for ChequePayment::ChequeContent().
- $defaults
- in file Product.php, variable Product::$defaults
Defaults for Product
- $defaults
- in file StockLevel.php, variable StockLevel::$defaults
Default stock level is -1 = unlimited stock.
- $defaults
- in file Item.php, variable Item::$defaults
Default values for this class
- $defaults
- in file Order.php, variable Order::$defaults
Default values for Order
- $default_model
- in file ShopAdmin.php, variable ShopAdmin::$default_model
Default model to be managed when the admin is loaded.
- $default_sort
- in file Order.php, variable Order::$default_sort
The default sort expression. This will be inserted in the ORDER BY clause of a SQL query if no other sort expression is provided.
- $disable_themes
- in file CartTest.php, variable CartTest::$disable_themes
- $disable_themes
- in file ProductCategoryTest.php, variable ProductCategoryTest::$disable_themes
- $disable_themes
- in file StockLevelTest.php, variable StockLevelTest::$disable_themes
- $disable_themes
- in file ProductTest.php, variable ProductTest::$disable_themes
- $disable_themes
- in file CheckoutTest.php, variable CheckoutTest::$disable_themes
- $disable_themes
- in file OrderModifierTest.php, variable OrderModifierTest::$disable_themes
- DateRangeSearchContext.php
- procedural page DateRangeSearchContext.php
- DateRangeSearchFilter.php
- procedural page DateRangeSearchFilter.php
- DateRangeSearchContext
- in file DateRangeSearchContext.php, class DateRangeSearchContext
Search context for date ranges, used in the CMS for searching Orders.
- DateRangeSearchFilter
- in file DateRangeSearchFilter.php, class DateRangeSearchFilter
Search filter for date ranges, used in the CMS for searching Orders.
- delete
- in file Order.php, method Order::delete()
Delete this data object.
- delete
- in file ShopAdmin.php, method ShopAdmin_RecordController::delete()
Handle deleting a record.
- deletefromlive
- in file ShopAdmin.php, method ShopAdmin_RecordController::deletefromlive()
Handle deleting a record from the live site, unpublishing.
- delete_abandoned
- in file Order.php, method Order::delete_abandoned()
Delete abandoned carts according to the Order timeout. This will release the stock in the carts back to the shop. Can be run from a cron job task, also run on Product, Cart and Checkout pages so that cron job is not necessary.
- Description
- in file ModifierHiddenField.php, method ModifierHiddenField::Description()
A description to show alongside the hidden field on the CheckoutForm.
- Description
- in file FlatFeeTax.php, method FlatFeeTax::Description()
Get Description for this modifier so that it can be saved into an Order Modification.
- Description
- in file FlatFeeShipping.php, method FlatFeeShipping::Description()
Get Description for this modifier so that it can be saved into an Order Modification.
- Description
- in file FlatFeeTaxField.php, method FlatFeeTaxField::Description()
Return the amount for this tax rate for displaying in the CheckoutForm
- Description
- in file Modifier.php, method Modifier_Interface::Description()
Get Description for this modifier so that it can be saved into an Order Modification.
- doSave
- in file ShopAdmin.php, method ShopAdmin_RecordController::doSave()
Save a record and perform any other actions such as sending an email to customer.
- duplicateProductImages
- in file Product.php, method Product::duplicateProductImages()
Duplicate product images, useful when duplicating a product.
top
e
- $extensions
- in file Variation.php, variable Variation::$extensions
Versioning for a Variation, so that Orders can access the version that was purchased and correct information can be retrieved.
- EditForm
- in file ShopAdmin.php, method ShopAdmin_RecordController::EditForm()
Create the form for editing a model.
- Emogrifier
- in file Emogrifier.php, class Emogrifier
For including inline CSS into email templates, strips out unnecessary selectors.
- emogrify
- in file Emogrifier.php, method Emogrifier::emogrify()
- enable
- in file FlatFeeTax.php, method FlatFeeTax::enable()
For setting configuration, should be called from _config.php files only
- enable
- in file FlatFeeShipping.php, method FlatFeeShipping::enable()
For setting configuration, should be called from _config.php files only
- extraStatics
- in file ShopSettings.php, method ShopSettings::extraStatics()
Add database fields for shop settings like emails etc.
- extraStatics
- in file FlatFeeShippingConfigDecorator.php, method FlatFeeShippingConfigDecorator::extraStatics()
Attach FlatFeeShippingRates to SiteConfig.
- extraStatics
- in file PaymentDecorator.php, method PaymentDecorator::extraStatics()
Extra fields to be added to the Payment class.
- extraStatics
- in file FlatFeeTaxConfigDecorator.php, method FlatFeeTaxConfigDecorator::extraStatics()
Attach FlatFeeTaxRates to SiteConfig.
- Emogrifier.php
- procedural page Emogrifier.php
top
f
- $firstWrite
- in file Product.php, variable Product::$firstWrite
Flag for denoting if this is the first time this Product is being written.
- $fixture_file
- in file StockLevelTest.php, variable StockLevelTest::$fixture_file
- $fixture_file
- in file ProductTest.php, variable ProductTest::$fixture_file
- $fixture_file
- in file CartTest.php, variable CartTest::$fixture_file
- $fixture_file
- in file OrderModifierTest.php, variable OrderModifierTest::$fixture_file
- $fixture_file
- in file ProductCategoryTest.php, variable ProductCategoryTest::$fixture_file
- $fixture_file
- in file CheckoutTest.php, variable CheckoutTest::$fixture_file
- FieldSetExtension.php
- procedural page FieldSetExtension.php
- FlatFeeShipping.php
- procedural page FlatFeeShipping.php
- FlatFeeShippingConfigDecorator.php
- procedural page FlatFeeShippingConfigDecorator.php
- FlatFeeShippingField.php
- procedural page FlatFeeShippingField.php
- FlatFeeShippingRate.php
- procedural page FlatFeeShippingRate.php
- FlatFeeTax.php
- procedural page FlatFeeTax.php
- FlatFeeTaxConfigDecorator.php
- procedural page FlatFeeTaxConfigDecorator.php
- FlatFeeTaxField.php
- procedural page FlatFeeTaxField.php
- FlatFeeTaxRate.php
- procedural page FlatFeeTaxRate.php
- Field
- in file StockField.php, method StockField::Field()
Create the field for display in CMS.
- FieldHolder
- in file ModifierHiddenField.php, method ModifierHiddenField::FieldHolder()
Render field with the appropriate template.
- FieldHolder
- in file ModifierSetField.php, method ModifierSetField::FieldHolder()
Render field with the appropriate template.
- FieldHolder
- in file OptionGroupField.php, method OptionGroupField::FieldHolder()
Display this field, add some javascript for handling changes to the dropdowns, populating the next dropdown via AJAX etc.
- FieldHolder
- in file OrderItemField.php, method OrderItemField::FieldHolder()
Render the form field with the correct template.
- FieldHolder
- in file FlatFeeShippingField.php, method FlatFeeShippingField::FieldHolder()
Render field with the appropriate template.
- FieldHolder
- in file StockField.php, method StockField::FieldHolder()
Render the fields and include javascript.
- FieldHolder
- in file FlatFeeTaxField.php, method FlatFeeTaxField::FieldHolder()
Render field with the appropriate template.
- FieldHolder
- in file CartQuantityField.php, method CartQuantityField::FieldHolder()
Render the field with the appropriate template.
- Fields
- in file CheckoutForm.php, method CheckoutForm::Fields()
Return the forms fields for the template, but filter the fields for a particular 'set' of fields.
- FieldSetExtension
- in file FieldSetExtension.php, class FieldSetExtension
Extend FieldSet with utility to findOrMakeTabSet so that modules can share the same tab in SiteConfig.
- findIdenticalItem
- in file Order.php, method Order::findIdenticalItem()
Find an identical item in the order/cart, item is identical if the productID, version and the options for the item are the same. Used to increase quantity of items that already exist in the cart/Order.
- findOrMakeTabSet
- in file FieldSetExtension.php, method FieldSetExtension::findOrMakeTabSet()
Utility function to make a tab set, so that other modules can share a tabset in the SiteConfig.
- FirstImage
- in file Product.php, method Product::FirstImage()
Get the first Image of all Images attached to this Product.
- FlatFeeShipping
- in file FlatFeeShipping.php, class FlatFeeShipping
Flat fee shipping, flat fees can be added for each supported shipping country from the SiteConfig using FlatFeeShippingRates.
- FlatFeeShippingConfigDecorator
- in file FlatFeeShippingConfigDecorator.php, class FlatFeeShippingConfigDecorator
So that FlatFeeShippingRates can be created in SiteConfig.
- FlatFeeShippingField
- in file FlatFeeShippingField.php, class FlatFeeShippingField
Form fields that represent FlatFeeShippingRates in the Checkout form.
- FlatFeeShippingRate
- in file FlatFeeShippingRate.php, class FlatFeeShippingRate
Shipping rates that can be set in SiteConfig. Several flat rates can be set for any supported shipping country.
- FlatFeeTax
- in file FlatFeeTax.php, class FlatFeeTax
Flat fee tax, flat fees can be added for each supported shipping country from the SiteConfig using FlatFeeShippingRates.
- FlatFeeTaxConfigDecorator
- in file FlatFeeTaxConfigDecorator.php, class FlatFeeTaxConfigDecorator
So that FlatFeeTaxRates can be created in SiteConfig.
- FlatFeeTaxField
- in file FlatFeeTaxField.php, class FlatFeeTaxField
Form field that represents FlatFeeTaxRates in the Checkout form.
- FlatFeeTaxRate
- in file FlatFeeTaxRate.php, class FlatFeeTaxRate
Tax rates that can be set in SiteConfig. Several flat rates can be set for any supported shipping country.
- fortemplate
- in file ProductImage.php, method ProductImage::fortemplate()
Necessary for displaying product images in the CMS
top
g
- $groupedFields
- in file CheckoutForm.php, variable CheckoutForm::$groupedFields
Fields for this form are grouped in sets, they are stored in an array so that the template can pull out a set of fields for a different part of the form.
- getCheckoutFormData
- in file Address.php, method Address::getCheckoutFormData()
Return data in an Array with keys formatted to match the field names on the checkout form so that it can be loaded into an order form.
- getCMSActions
- in file AccountPage.php, method AccountPage::getCMSActions()
To remove the unpublish button from the CMS, as this page must always be published
- getCMSActions
- in file CheckoutPage.php, method CheckoutPage::getCMSActions()
To remove the unpublish button from the CMS, as this page must always be published
- getCMSActions
- in file Order.php, method Order::getCMSActions()
Set custom CMS actions which call OrderAdmin_RecordController actions of the same name
- getCMSActions
- in file CartPage.php, method CartPage::getCMSActions()
To remove the unpublish button from the CMS, as this page must always be published
- getCMSFields
- in file CheckoutPage.php, method CheckoutPage::getCMSFields()
Remove page type dropdown to prevent users from changing page type.
- getCMSFields
- in file Product.php, method Product::getCMSFields()
Set some CMS fields for managing Product images, Variations, Options, Attributes etc.
- getCMSFields
- in file Order.php, method Order::getCMSFields()
Set CMS fields for viewing this Order in the CMS Cannot change status of an order in the CMS
- getCMSFields
- in file ProductCategory.php, method ProductCategory::getCMSFields()
Can add products to the category straight from the ProductCategory page TODO remove this, its not useful. And change the direction of the many_many relation so that patched version of CTF not needed
- getCMSFields
- in file Customer.php, method Customer::getCMSFields()
Add some fields for managing Members in the CMS.
- getCMSFields
- in file Attribute.php, method Attribute::getCMSFields()
Add some fields to the CMS for managing Attributes.
- getCMSFields
- in file CartPage.php, method CartPage::getCMSFields()
Remove page type dropdown to prevent users from changing page type.
- getCMSFields
- in file AccountPage.php, method AccountPage::getCMSFields()
Remove page type dropdown to prevent users from changing page type.
- getCMSFields_forPopup
- in file FlatFeeTaxRate.php, method FlatFeeTaxRate::getCMSFields_forPopup()
Field for editing a FlatFeeTaxRate.
- getCMSFields_forPopup
- in file Variation.php, method Variation::getCMSFields_forPopup()
Add fields for editing a Variation in the CMS popup.
- getCMSFields_forPopup
- in file Option.php, method Option::getCMSFields_forPopup()
Set fields for editing an Option in the CMS
- getCMSFields_forPopup
- in file ProductImage.php, method ProductImage::getCMSFields_forPopup()
Create fields for editing a ProductImage in the CMS.
- getCMSFields_forPopup
- in file FlatFeeShippingRate.php, method FlatFeeShippingRate::getCMSFields_forPopup()
Field for editing a FlatFeeShippingRate.
- getCMSValidator
- in file Product.php, method Product::getCMSValidator()
Set custom validator for validating EditForm in ShopAdmin. Not currently used.
- getDefaultSearchContext
- in file Order.php, method Order::getDefaultSearchContext()
Get a new date range search context for filtering the search results in OrderAdmin
- getFieldsFor
- in file OptionComplexTableField.php, method OptionComplexTableField::getFieldsFor()
Ensure the fields on the add and edit forms for each option have the correct Attribute ID set.
- getForm
- in file AddToCartFormValidator.php, method AddToCartFormValidator::getForm()
Helper so that form fields can access the form and current form data
- getForm
- in file CartFormValidator.php, method CartFormValidator::getForm()
Helper so that form fields can access the form and current form data
- getForm
- in file OrderFormValidator.php, method OrderFormValidator::getForm()
Helper so that form fields can access the form and current form data
- getForm
- in file ProductAdminValidator.php, method ProductAdminValidator::getForm()
Helper so that form fields can access the form and current form data
- getFormData
- in file ProductCategoryTest.php, method ProductCategoryTest::getFormData()
Helper to get data from a form.
- getFormData
- in file OrderModifierTest.php, method OrderModifierTest::getFormData()
Helper to get data from a form.
- getFormData
- in file ProductTest.php, method ProductTest::getFormData()
Helper to get data from a form.
- getFormData
- in file StockLevelTest.php, method StockLevelTest::getFormData()
Helper to get data from a form.
- getFormData
- in file CheckoutTest.php, method CheckoutTest::getFormData()
Helper to get data from a form.
- getFormData
- in file CartTest.php, method CartTest::getFormData()
Helper to get data from a form.
- getFormFields
- in file Modifier.php, method Modifier_Interface::getFormFields()
Get form fields for this modifier.
- getFormFields
- in file FlatFeeShipping.php, method FlatFeeShipping::getFormFields()
Form fields for displaying on the Checkout form, a dropdown of FlatFeeShippingRates that are filtered depending on the shipping country selected.
- getFormFields
- in file FlatFeeTax.php, method FlatFeeTax::getFormFields()
Form fields for displaying on the Checkout form, a FlatFeeTaxField that has a hidden field with an ID for the FlatFeeTaxRate and a description of how much the calculated tax amounts to for the current Order.
- getFormRequirements
- in file Modifier.php, method Modifier_Interface::getFormRequirements()
Get form requirements for this modifier.
- getFormRequirements
- in file FlatFeeTax.php, method FlatFeeTax::getFormRequirements()
Get form requirements for this modifier.
- getFormRequirements
- in file FlatFeeShipping.php, method FlatFeeShipping::getFormRequirements()
Get form requirements for this modifier.
- getModifier
- in file ModifierHiddenField.php, method ModifierHiddenField::getModifier()
Get the modifier e.g: FlatFeeShipping
- getModifier
- in file ModifierSetField.php, method ModifierSetField::getModifier()
Get the modifier e.g: FlatFeeShipping
- getOptionForAttribute
- in file Variation.php, method Variation::getOptionForAttribute()
Get a Variation option for an attribute
- getOptionsForAttribute
- in file Product.php, method Product::getOptionsForAttribute()
Get options for an Attribute of this Product.
- getPaid
- in file Order.php, method Order::getPaid()
If the order has been totally paid.
- getParentIdName
- in file BelongsManyManyComplexTableField.php, method BelongsManyManyComplexTableField::getParentIdName()
- getParentPage
- in file ShopAdmin.php, method ShopAdmin::getParentPage()
Retrieve a parent page for a particular record.
- getParentType
- in file Product.php, method Product::getParentType()
Get parent type for Product, extra parent type of exempt where the product is not part of the site tree (instead associated to product categories).
- getQuery
- in file BelongsManyManyComplexTableField.php, method BelongsManyManyComplexTableField::getQuery()
- getQuery
- in file DateRangeSearchContext.php, method DateRangeSearchContext::getQuery()
Alter the existing SQL query object by adding some filters for the search so that the query finds Orders between two dates min and max.
- getSearchFields
- in file DateRangeSearchContext.php, method DateRangeSearchContext::getSearchFields()
Replace the default form fields for the 'Created' search field with a single text field which we can use to apply jquery date range widget to.
- getSearchQuery
- in file ShopAdmin.php, method ShopAdmin_CollectionController::getSearchQuery()
Gets the search query generated on the SearchContext from DataObject::getDefaultSearchContext(), and the current GET parameters on the request.
- getUnprocessedQuantity
- in file Product.php, method Product::getUnprocessedQuantity()
Get the quantity of this product that is currently in shopping carts or unprocessed orders
- getUnprocessedQuantity
- in file Variation.php, method Variation::getUnprocessedQuantity()
Get the quantity of this product that is currently in shopping carts or unprocessed orders
- get_current_order
- in file CartControllerExtension.php, method CartControllerExtension::get_current_order()
Get the current order from the session, if order does not exist create a new one.
- get_license_key
- in file ShopSettings.php, method ShopSettings::get_license_key()
Get the license key
- get_timeout
- in file Order.php, method Order::get_timeout()
Get the order timeout, for managing stock levels.
- goToCheckout
- in file CartPage.php, method CartPage_Controller::goToCheckout()
Update the current cart quantities and redirect to checkout.
top
h
- $has_many
- in file Item.php, variable Item::$has_many
Relations for this class
- $has_many
- in file Order.php, variable Order::$has_many
- $has_many
- in file Customer.php, variable Customer::$has_many
Link customers to Addresses and Orders.
- $has_many
- in file Attribute.php, variable Attribute::$has_many
Has many relations for the Attribute
- $has_many
- in file Product.php, variable Product::$has_many
Has many relations for Product.
- $has_one
- in file Order.php, variable Order::$has_one
Relations for this Order
- $has_one
- in file ProductImage.php, variable ProductImage::$has_one
Has one relations for a ProductImage
- $has_one
- in file Variation.php, variable Variation::$has_one
Has one relation for a Variation
- $has_one
- in file Product.php, variable Product::$has_one
Has one relations for Product
- $has_one
- in file Option.php, variable Option::$has_one
Has one relations for an Option
- $has_one
- in file FlatFeeTaxRate.php, variable FlatFeeTaxRate::$has_one
Tax rates are associated with SiteConfigs.
- $has_one
- in file FlatFeeShippingRate.php, variable FlatFeeShippingRate::$has_one
Shipping rates are associated with SiteConfigs.
- $has_one
- in file ItemOption.php, variable ItemOption::$has_one
Relations for this class
- $has_one
- in file Item.php, variable Item::$has_one
Relations for this class
- $has_one
- in file Modification.php, variable Modification::$has_one
Relations for this class
- $has_one
- in file Address.php, variable Address::$has_one
Relations for address
- handleItem
- in file VariationComplexTableField.php, method VariationComplexTableField::handleItem()
Handle the item in each request?
- hasData
- in file OptionGroupField.php, method OptionGroupField::hasData()
This field has data
- hasValidOptions
- in file Variation.php, method Variation::hasValidOptions()
Convenience method to check that this Variation has valid options.
top
i
- $item
- in file OrderItemField.php, variable OrderItemField::$item
Current Item this field represents.
- $item
- in file CartQuantityField.php, variable CartQuantityField::$item
Current Item represented by this field.
- $itemClass
- in file BelongsManyManyComplexTableField.php, variable BelongsManyManyComplexTableField::$itemClass
- Item.php
- procedural page Item.php
- ItemOption.php
- procedural page ItemOption.php
- id
- in file RemoveItemAction.php, method RemoveItemAction::id()
Set the ID attribute for the HTML to something unique.
- index
- in file Product.php, method Product_Controller::index()
Display a Product.
- index
- in file AccountPage.php, method AccountPage_Controller::index()
Check access permissions for account page and return content for displaying the default page.
- index
- in file CheckoutPage.php, method CheckoutPage_Controller::index()
Include some CSS and javascript for the checkout page
- index
- in file CartPage.php, method CartPage_Controller::index()
Include some CSS for the cart page.
- inheritedDatabaseFields
- in file Product.php, method Product::inheritedDatabaseFields()
Hack to set Amount field in the array of database fields for this Product.
- init
- in file ShopAdmin.php, method ShopAdmin::init()
Load some css and javascript for the admin area, remove some functionality from tinymce.
- init
- in file Product.php, method Product_Controller::init()
Include some CSS and set the dataRecord to the current Product that is being viewed.
- init
- in file ShopSettings.php, method ShopSettings_Controller::init()
- InStock
- in file Product.php, method Product::InStock()
Product is in stock if stock level for product is != 0 or if ANY of its product variations is in stock.
- InStock
- in file Variation.php, method Variation::InStock()
Basic check to see if Product is in stock. Not currently used.
- isDeleted
- in file Variation.php, method Variation::isDeleted()
Check if the variation has been deleted, need to check the actual variation and not just this version.
- isDuplicate
- in file Variation.php, method Variation::isDuplicate()
Convenience method to check that this Variation is not a duplicate.
- isEmpty
- in file PublishedStatusSearchFilter.php, method PublishedStatusSearchFilter::isEmpty()
Determine whether the filter should be applied, depending on the value of the field being passed
- isEmpty
- in file PaymentSearchFilter.php, method PaymentSearchFilter::isEmpty()
Determine whether the filter should be applied, depending on the value of the field being passed
- isEmpty
- in file OptionSetSearchFilter.php, method OptionSetSearchFilter::isEmpty()
Determine whether the filter should be applied, depending on the value of the field being passed
- isEmpty
- in file ProductCategorySearchFilter.php, method ProductCategorySearchFilter::isEmpty()
Determine whether the filter should be applied, depending on the value of the field being passed
- isEnabled
- in file Variation.php, method Variation::isEnabled()
If current variation is enabled, checks lastest version of variation because status is saved in versions. So a variation can be saved as enabled, the version can be added to cart, then the variation is disabled but the previous version stays enabled.
- isNegativeAmount
- in file Variation.php, method Variation::isNegativeAmount()
Check if Variation amount is a negative value
- Item
- in file CartQuantityField.php, method CartQuantityField::Item()
Retrieve the current Item this field represents. Used in the template.
- Item
- in file Item.php, class Item
An Item for an Order.
- Item
- in file OrderItemField.php, method OrderItemField::Item()
Retrieve the Item this field represents.
- ItemOption
- in file ItemOption.php, class ItemOption
An option for an Item in the Order. Items can have many ItemOptions.
top
l
- Label
- in file FlatFeeShippingRate.php, method FlatFeeShippingRate::Label()
Label for using on FlatFeeShippingFields.
- Label
- in file FlatFeeTaxRate.php, method FlatFeeTaxRate::Label()
Label for using on FlatFeeTaxFields.
- Link
- in file Product.php, method Product::Link()
Get the URL for this Product, products that are not part of the SiteTree are displayed by the Product_Controller.
- Link
- in file Order.php, method Order::Link()
Generate the URL for viewing this order on the frontend
- ListView
- in file ShopAdmin.php, method ShopAdmin::ListView()
Perform a search for the default list view? TODO remove this, not sure it is required
- logOut
- in file ProductTest.php, method ProductTest::logOut()
Log current member out by clearing session
- logOut
- in file StockLevelTest.php, method StockLevelTest::logOut()
Log current member out by clearing session
- logOut
- in file ProductCategoryTest.php, method ProductCategoryTest::logOut()
Log current member out by clearing session
- logOut
- in file CartTest.php, method CartTest::logOut()
Log current member out by clearing session
- logout
- in file AccountPage.php, method AccountPage_Controller::logout()
Log the current member out and redirect to home page.
- logOut
- in file OrderModifierTest.php, method OrderModifierTest::logOut()
Log current member out by clearing session
- logOut
- in file CheckoutTest.php, method CheckoutTest::logOut()
Log current member out by clearing session
top
m
- $managed_models
- in file ShopAdmin.php, variable ShopAdmin::$managed_models
The data objects managed by this admin.
- $many_many
- in file Product.php, variable Product::$many_many
Many many relations for Product
- $many_many
- in file Variation.php, variable Variation::$many_many
Many many relation for a Variation
- $many_many
- in file ProductCategory.php, variable ProductCategory::$many_many
Many many relations for a ProductCategory
- $max
- in file DateRangeSearchFilter.php, variable DateRangeSearchFilter::$max
Maximum date
- $menu_priority
- in file ShopAdmin.php, variable ShopAdmin::$menu_priority
Set a high priority in the CMS top navigation
- $menu_title
- in file ShopAdmin.php, variable ShopAdmin::$menu_title
Menu title for this admin area.
- $min
- in file DateRangeSearchFilter.php, variable DateRangeSearchFilter::$min
Minimum date
- $modifier
- in file ModifierSetField.php, variable ModifierSetField::$modifier
To hold the modifier (link FlatFeeShipping) class that will set the value for the order Modification.
- $modifier
- in file ModifierHiddenField.php, variable ModifierHiddenField::$modifier
To hold the modifier (link FlatFeeShipping) class that will set the value for the order Modification.
- ModifierHiddenField.php
- procedural page ModifierHiddenField.php
- ModifierSetField.php
- procedural page ModifierSetField.php
- Modifier.php
- procedural page Modifier.php
- Modification.php
- procedural page Modification.php
- MarkingCheckbox
- in file BelongsManyManyComplexTableField.php, method BelongsManyManyComplexTableField_Item::MarkingCheckbox()
- Modification
- in file Modification.php, class Modification
Modification for the Order, saves data that is set by Modifiers
- Modifier
- in file Modifier.php, class Modifier
Represents the type of object that injects its details into an {@Link Order} Modification. Has a set interface so that all necessary details by Modification are available.
- ModifierHiddenField
- in file ModifierHiddenField.php, class ModifierHiddenField
For displaying a Modifier on the CheckoutPage which will inject details into Order Modifications.
- ModifierSetField
- in file ModifierSetField.php, class ModifierSetField
For displaying a set of modifiers on the CheckoutPage which will inject their details into Order Modifications.
- Modifier_Interface
- in file Modifier.php, class Modifier_Interface
Interface for Modifier classes to ensure they deliver the minimum details required by Modifications, namely: Amount() and Description().
top
n
- NotificationEmail.php
- procedural page NotificationEmail.php
- NotificationEmail
- in file NotificationEmail.php, class NotificationEmail
A notification email that is sent to an email address specified in ShopSettings, usually a site administrator or owner.
top
o
- OptionComplexTableField.php
- procedural page OptionComplexTableField.php
- OptionField.php
- procedural page OptionField.php
- OptionGroupField.php
- procedural page OptionGroupField.php
- OrderFormValidator.php
- procedural page OrderFormValidator.php
- OrderItemField.php
- procedural page OrderItemField.php
- Order.php
- procedural page Order.php
- Option.php
- procedural page Option.php
- OptionSetSearchFilter.php
- procedural page OptionSetSearchFilter.php
- Object
- in file Item.php, method Item::Object()
Retrieve the object this item represents (e.g. Product). Uses versioning so that the product that was bought can be retrieved with all the correct details.
- Object
- in file ItemOption.php, method ItemOption::Object()
Retrieve the object this item represents, usually a Variation.
- onAfterDelete
- in file Product.php, method Product::onAfterDelete()
Unpublish products if they get deleted, such as in product admin area
- onAfterPayment
- in file Order.php, method Order::onAfterPayment()
Processed if payment is successfully written, send a receipt to the customer TODO move sending receipts to CheckoutPage::ProcessOrder()
- onAfterWrite
- in file PaymentDecorator.php, method PaymentDecorator::onAfterWrite()
After payment success process onAfterPayment() in Order.
- onAfterWrite
- in file Product.php, method Product::onAfterWrite()
Copy the original product options or generate the default product options
- onAfterWrite
- in file Variation.php, method Variation::onAfterWrite()
Unpublish Products if after the Variations have been saved there are no enabled Variations.
- onAfterWrite
- in file ItemOption.php, method ItemOption::onAfterWrite()
- onAfterWrite
- in file Item.php, method Item::onAfterWrite()
Update stock levels for Item.
- onBeforeDelete
- in file Item.php, method Item::onBeforeDelete()
Find item options and delete them to clean up DB.
- onBeforeDelete
- in file Customer.php, method Customer::onBeforeDelete()
If this Member has Orders, then prevent member from being deleted.
- onBeforeInit
- in file CartControllerExtension.php, method CartControllerExtension::onBeforeInit()
Updates timestamp LastActive on the order, called on every page request.
- onBeforeWrite
- in file Product.php, method Product::onBeforeWrite()
Set firstWrite flag if this is the first time this Product is written.
- onBeforeWrite
- in file Item.php, method Item::onBeforeWrite()
Update the quantity of the item.
- onBeforeWrite
- in file Order.php, method Order::onBeforeWrite()
Set the LastActive time when Order first created.
- onBeforeWrite
- in file Variation.php, method Variation::onBeforeWrite()
Update stock level associated with this Variation.
- Option
- in file Option.php, class Option
Represents an Option for an Attribute, e.g: Small, Medium, Large, Red etc.
- OptionComplexTableField
- in file OptionComplexTableField.php, class OptionComplexTableField
For displaying a set of Options for a Product in the CMS.
- OptionField
- in file OptionField.php, class OptionField
For Product Option fields to be displayed on the Product page.
- OptionGroupField
- in file OptionGroupField.php, class OptionGroupField
Represents a group of dropdowns for options for a Product.
- options
- in file Product.php, method Product_Controller::options()
Get options for a product and return for use in the form Must get options for nextAttributeID, but these options should be filtered so that only the options for the variations that match attributeID and optionID are returned.
- OptionSetSearchFilter
- in file OptionSetSearchFilter.php, class OptionSetSearchFilter
Search filter for option sets, used for searching Order statuses in the CMS.
- order
- in file AccountPage.php, method AccountPage_Controller::order()
Return the Order details for the current Order ID that we're viewing (ID parameter in URL).
- Order
- in file Order.php, class Order
Order, created as soon as a user adds a Product to their cart, the cart is actually an Order with status of 'Cart'. Has many Items and can have Modifications which might represent a Modifier like shipping, tax, coupon codes.
- OrderForm
- in file CheckoutPage.php, method CheckoutPage_Controller::OrderForm()
Create an order form for customers to fill out their details and pass the order on to the payment class.
- OrderFormValidator
- in file OrderFormValidator.php, class OrderFormValidator
Validate the OrderForm, check that the current Order is valid.
- OrderItemField
- in file OrderItemField.php, class OrderItemField
Represent each Item in the Order on the OrderForm.
- OrderModifierTest
- in file OrderModifierTest.php, class OrderModifierTest
Testing Order modifiers at checkout.
- Orders
- in file Customer.php, method Customer::Orders()
Overload getter to return only non-cart orders
- OrderModifierTest.php
- procedural page OrderModifierTest.php
top
p
- $page_length
- in file ShopAdmin.php, variable ShopAdmin::$page_length
Number of records to display at one time.
- $parent_page_type
- in file ShopAdmin.php, variable ShopAdmin::$parent_page_type
No idea why this exists.
- ProcessedEmail.php
- procedural page ProcessedEmail.php
- ProductAdminValidator.php
- procedural page ProductAdminValidator.php
- PaymentDecorator.php
- procedural page PaymentDecorator.php
- Product.php
- procedural page Product.php
- ProductCategory.php
- procedural page ProductCategory.php
- ProductImage.php
- procedural page ProductImage.php
- PaymentSearchFilter.php
- procedural page PaymentSearchFilter.php
- ProductCategorySearchFilter.php
- procedural page ProductCategorySearchFilter.php
- PublishedStatusSearchFilter.php
- procedural page PublishedStatusSearchFilter.php
- parseVariables
- in file ProcessedEmail.php, method ProcessedEmail::parseVariables()
Runs the content through Emogrifier to merge css style inline before sending
- PaymentDecorator
- in file PaymentDecorator.php, class PaymentDecorator
Mixin to augment the Payment class.
- Payments
- in file Order.php, method Order::Payments()
Helper to get Payments that are made against this Order
- PaymentSearchFilter
- in file PaymentSearchFilter.php, class PaymentSearchFilter
Search filter for determining whether an Order has a Payment attached.
- performRollback
- in file ShopAdmin.php, method ShopAdmin_RecordController::performRollback()
Handle a rollback for a record.
- php
- in file AddToCartFormValidator.php, method AddToCartFormValidator::php()
Check that current product variation is valid
- php
- in file ProductAdminValidator.php, method ProductAdminValidator::php()
Currently not used
- php
- in file OrderFormValidator.php, method OrderFormValidator::php()
Check that current order is valid
- process
- in file RemoveAbandonedCartsTask.php, method RemoveAbandonedCartsTask::process()
Remove Orders that have not been active for a certain period of time, do not have a Payment attached and have the status of 'Cart'.
- process
- in file VirtualProductCleanupTask.php, method VirtualProductCleanupTask::process()
- ProcessedEmail
- in file ProcessedEmail.php, class ProcessedEmail
Same as the normal system email class, but runs the content through Emogrifier to merge css rules inline before sending.
- ProcessOrder
- in file CheckoutPage.php, method CheckoutPage_Controller::ProcessOrder()
Process the order by sending form information to Payment class.
- Product
- in file Product.php, class Product
Represents a Product, which is a type of a Page. Products are managed in a seperate
- Product
- in file Item.php, method Item::Product()
Get the product for the item
- ProductAdminValidator
- in file ProductAdminValidator.php, class ProductAdminValidator
Validator for editing Products in the ShopAdmin. Currently not used.
- ProductCategory
- in file ProductCategory.php, class ProductCategory
Represents a Product category, Products can be added to many categories and they can have a ProductCategory as a parent in the site tree.
- ProductCategorySearchFilter
- in file ProductCategorySearchFilter.php, class ProductCategorySearchFilter
Search filter for Product categories, filtering search results for certain ProductCategorys in the CMS.
- ProductCategoryTest
- in file ProductCategoryTest.php, class ProductCategoryTest
Testing Product attributes and options on product pages.
- ProductCategory_Controller
- in file ProductCategory.php, class ProductCategory_Controller
Controller to display a ProductCategory and retrieve its Products.
- ProductImage
- in file ProductImage.php, class ProductImage
A image for Products.
- Products
- in file ProductCategory.php, method ProductCategory_Controller::Products()
Get Products that have this ProductCategory set or have this ProductCategory as a parent in site tree.
- Products
- in file Order.php, method Order::Products()
Retreive products for this order from the order Items.
- ProductTest
- in file ProductTest.php, class ProductTest
Testing Product attributes and options on product pages.
- Product_Controller
- in file Product.php, class Product_Controller
Displays a product, add to cart form, gets options and variation price for a Product via AJAX.
- publish
- in file ShopAdmin.php, method ShopAdmin_RecordController::publish()
Handle publishing a record, will set errors on form if Product validation fails.
- PublishedStatusSearchFilter
- in file PublishedStatusSearchFilter.php, class PublishedStatusSearchFilter
Search filter for Product status, whether a Product is published or unpublished.
- ProductCategoryTest.php
- procedural page ProductCategoryTest.php
- ProductTest.php
- procedural page ProductTest.php
top
top
r
- $record_controller_class
- in file ShopAdmin.php, variable ShopAdmin::$record_controller_class
Class used for administering a record
- $resultsTableClassName
- in file ShopAdmin.php, variable ShopAdmin::$resultsTableClassName
Class for displaying collection results.
- ReceiptEmail.php
- procedural page ReceiptEmail.php
- RemoveItemAction.php
- procedural page RemoveItemAction.php
- ReceiptEmail
- in file ReceiptEmail.php, class ReceiptEmail
A receipt email that is sent to the customer after they have completed their Order.
- redirectToOrder
- in file PaymentDecorator.php, method PaymentDecorator::redirectToOrder()
For the purpose of certain payment gateways.
- RemoveAbandonedCartsTask
- in file RemoveAbandonedCartsTask.php, class RemoveAbandonedCartsTask
Remove abandoned carts that have not been active for a certain period of time So that stock that is tied up in the carts can be released back if the customers do not go through the checkout process.
- removeItem
- in file CartPage.php, method CartPage_Controller::removeItem()
Remove an item from the cart
- RemoveItemAction
- in file CartQuantityField.php, method CartQuantityField::RemoveItemAction()
Get a form action to remove an order item.
- RemoveItemAction
- in file RemoveItemAction.php, class RemoveItemAction
FormAction to remove an item from the CartPage.
- removeUnprocessableHTMLTag
- in file Emogrifier.php, method Emogrifier::removeUnprocessableHTMLTag()
- requireDefaultRecords
- in file CartPage.php, method CartPage::requireDefaultRecords()
Automatically create a CheckoutPage if one is not found on the site at the time the database is built (dev/build).
- requireDefaultRecords
- in file AccountPage.php, method AccountPage::requireDefaultRecords()
Automatically create an AccountPage if one is not found on the site at the time the database is built (dev/build).
- requireDefaultRecords
- in file CheckoutPage.php, method CheckoutPage::requireDefaultRecords()
Automatically create a CheckoutPage if one is not found on the site at the time the database is built (dev/build).
- requiresVariation
- in file Product.php, method Product::requiresVariation()
A product is required to be added to a cart with a variation if it has attributes.
- rollback
- in file ShopAdmin.php, method ShopAdmin_RecordController::rollback()
Handle a rollback for a record.
- RemoveAbandonedCartsTask.php
- procedural page RemoveAbandonedCartsTask.php
top
s
- $searchable_fields
- in file Order.php, variable Order::$searchable_fields
Searchable fields with search filters
- $searchable_fields
- in file Attribute.php, variable Attribute::$searchable_fields
Searchable fields for Attributes
- $searchable_fields
- in file Product.php, variable Product::$searchable_fields
Searchable fields for searching for Products in the CMS
- $showImportForm
- in file ShopAdmin.php, variable ShopAdmin::$showImportForm
Do not show an import form
- $signature
- in file ProcessedEmail.php, variable ProcessedEmail::$signature
Email signature
- $stockChoiceField
- in file StockField.php, variable StockField::$stockChoiceField
OptionSetField for unlimited/limited stock level.
- $stockLevelField
- in file StockField.php, variable StockField::$stockLevelField
NumericField for specifying limited stock level.
- $summary_fields
- in file Variation.php, variable Variation::$summary_fields
Summary fields for displaying Variations in the CMS
- $summary_fields
- in file ProductCategory.php, variable ProductCategory::$summary_fields
Summary fields for viewing categories in the CMS
- $summary_fields
- in file Order.php, variable Order::$summary_fields
Summary fields for displaying Orders in the admin area
- $summary_fields
- in file Product.php, variable Product::$summary_fields
Summary fields for displaying Products in the CMS
- $supported_countries
- in file Shipping.php, variable Shipping::$supported_countries
Countries allowed to be shipped to, these will be options in the shipping address of the Checkout form.
- $supported_methods
- in file Modifier.php, variable Modifier::$supported_methods
Methods supported, array of class names of classes that extend Modifier and have been enabled, e.g: FlatFeeShipping
- ShopAdmin.php
- procedural page ShopAdmin.php
- ShopSettings.php
- procedural page ShopSettings.php
- StockField.php
- procedural page StockField.php
- Shipping.php
- procedural page Shipping.php
- StockLevel.php
- procedural page StockLevel.php
- save
- in file ShopAdmin.php, method ShopAdmin_RecordController::save()
Handle saving a record.
- saveComplexTableField
- in file VariationComplexTableField.php, method VariationComplexTableField::saveComplexTableField()
Use the URL-Parameter "action_saveComplexTableField" to provide a clue to the main controller if the main form has to be rendered, even if there is no action relevant for the main controller (to provide the instance of ComplexTableField which in turn saves the record.
- saveComplexTableField
- in file VariationComplexTableField.php, method VariationComplexTableField_ItemRequest::saveComplexTableField()
Use the URL-Parameter "action_saveComplexTableField" to provide a clue to the main controller if the main form has to be rendered, even if there is no action relevant for the main controller (to provide the instance of ComplexTableField which in turn saves the record.
- scaffoldSearchFields
- in file Product.php, method Product::scaffoldSearchFields()
Filter for order admin area search.
- scaffoldSearchFields
- in file Order.php, method Order::scaffoldSearchFields()
Filters for order admin area search.
- SearchClassSelector
- in file ShopAdmin.php, method ShopAdmin::SearchClassSelector()
Return 'dropdown' or 'tabs' for template file.
- sendNotification
- in file Order.php, method Order::sendNotification()
Send an order notification to admin if one has not already been sent.
- sendReceipt
- in file Order.php, method Order::sendReceipt()
Send a receipt if one has not already been sent.
- setAmount
- in file FlatFeeTaxField.php, method FlatFeeTaxField::setAmount()
Set the amount that this field represents.
- setAttributeID
- in file OptionComplexTableField.php, method OptionComplexTableField::setAttributeID()
Set the Attribute ID for these options
- setCSS
- in file Emogrifier.php, method Emogrifier::setCSS()
- setHTML
- in file Emogrifier.php, method Emogrifier::setHTML()
- setItem
- in file OrderItemField.php, method OrderItemField::setItem()
Set the Item this field represents.
- setItem
- in file CartQuantityField.php, method CartQuantityField::setItem()
Set the current Item this field represents
- setMax
- in file DateRangeSearchFilter.php, method DateRangeSearchFilter::setMax()
Setter for max date value
- setMin
- in file DateRangeSearchFilter.php, method DateRangeSearchFilter::setMin()
Setter for min date value
- setUp
- in file ProductTest.php, method ProductTest::setUp()
- setUp
- in file ProductCategoryTest.php, method ProductCategoryTest::setUp()
- setUp
- in file OrderModifierTest.php, method OrderModifierTest::setUp()
- setUp
- in file StockLevelTest.php, method StockLevelTest::setUp()
- setUp
- in file CartTest.php, method CartTest::setUp()
- setUp
- in file CheckoutTest.php, method CheckoutTest::setUp()
- setValue
- in file StockField.php, method StockField::setValue()
Set value of the NumericField because that is the actual value of the stock level. If unlimited stock is selected the value is -1.
- set_allowed_currency
- in file Product.php, method Product::set_allowed_currency()
Set the currency for all products. Must match site curency.
- set_currency
- in file Modification.php, method Modification::set_currency()
Set the currency code that this site uses for Order Modifications
- set_license_key
- in file ShopSettings.php, method ShopSettings::set_license_key()
Set the license key, usually called in mysite/_config.
- set_supported_countries
- in file Shipping.php, method Shipping::set_supported_countries()
Set countries that are supported for shipping to.
- set_timeout
- in file Order.php, method Order::set_timeout()
Set order timeout, how long the cart will remain after abandoned.
- Shipping
- in file Shipping.php, class Shipping
A convenience class to set shipping supported countries in a centralised location.
- ShippingAddress
- in file Customer.php, method Customer::ShippingAddress()
Retrieve the last used shipping address for this Member from their previous saved addresses.
- ShippingAddress
- in file Order.php, method Order::ShippingAddress()
Retrieve the shipping Address for this Order.
- ShopAdmin
- in file ShopAdmin.php, class ShopAdmin
The shop admin area which provides access to orders, products and attributes.
- ShopAdmin_CollectionController
- in file ShopAdmin.php, class ShopAdmin_CollectionController
Managing collections of the model class, includes overloaded methods for adding and getting a search query.
- ShopAdmin_RecordController
- in file ShopAdmin.php, class ShopAdmin_RecordController
Handles operations on a single model record.
- ShopSettings
- in file ShopSettings.php, class ShopSettings
Adding shop settings to the main SiteConfig. This will not work with subsites module due to a problem with ComplexTableField which does not set the SiteConfig ID on records.
- ShopSettings_Controller
- in file ShopSettings.php, class ShopSettings_Controller
Controller to display a shop settings such as the license key publicly.
- STATUS_DISPATCHED
- in file Order.php, class constant Order::STATUS_DISPATCHED
Order status once Order has been sent
- STATUS_PENDING
- in file Order.php, class constant Order::STATUS_PENDING
Order status once Order has been made, waiting for payment to clear/be approved
- STATUS_PROCESSING
- in file Order.php, class constant Order::STATUS_PROCESSING
Order status once payment approved, order being processed before being dispatched
- StockChoiceField
- in file StockField.php, method StockField::StockChoiceField()
Retrieve the OptionsetField for stock choice for display in CMS.
- StockField
- in file StockField.php, class StockField
Stock field for displaying and editing stock levels for Products and Variations. The value for this field is represented in the NumericField stockLevelField.
- StockLevel
- in file StockLevel.php, class StockLevel
Stock level for associating with Products or Variations.
- StockLevelTest
- in file StockLevelTest.php, class StockLevelTest
Testing Product stock, updating stock levels when products added, removed and carts are deleted by scheduled tasks.
- SummaryOfAmount
- in file PaymentDecorator.php, method PaymentDecorator::SummaryOfAmount()
Helper to get a nicely formatted amount for this Payment
- SummaryOfAmount
- in file FlatFeeShippingRate.php, method FlatFeeShippingRate::SummaryOfAmount()
Summary of the amount
- SummaryOfAmount
- in file FlatFeeTaxRate.php, method FlatFeeTaxRate::SummaryOfAmount()
Summary of the amount
- SummaryOfCategories
- in file Product.php, method Product::SummaryOfCategories()
Summary of product categories for convenience, categories are comma seperated.
- SummaryOfCountryCode
- in file FlatFeeTaxRate.php, method FlatFeeTaxRate::SummaryOfCountryCode()
Country name for a given country code
- SummaryOfCountryCode
- in file FlatFeeShippingRate.php, method FlatFeeShippingRate::SummaryOfCountryCode()
Country name for a given country code
- SummaryOfImage
- in file ProductImage.php, method ProductImage::SummaryOfImage()
Helper method to return a thumbnail image for displaying in CTF fields in CMS.
- SummaryOfOptions
- in file Variation.php, method Variation::SummaryOfOptions()
Get a summary of the Options, helper method for displaying Options nicely
- SummaryOfOptionValueForAttribute
- in file Variation.php, method Variation::SummaryOfOptionValueForAttribute()
Get attribute option value, helper method
- SummaryOfPaymentStatus
- in file Order.php, method Order::SummaryOfPaymentStatus()
Helper to summarize payment status for an order.
- SummaryOfPrice
- in file Variation.php, method Variation::SummaryOfPrice()
Summarize the Product price, returns Amount formatted with Nice()
- SummaryOfPrice
- in file Product.php, method Product::SummaryOfPrice()
Summary of price for convenience
- SummaryOfRate
- in file FlatFeeTaxRate.php, method FlatFeeTaxRate::SummaryOfRate()
Summary of the current tax rate
- SummaryOfStock
- in file Variation.php, method Variation::SummaryOfStock()
Summary of stock, not currently used.
- SummaryOfTotal
- in file Order.php, method Order::SummaryOfTotal()
Helper to get a nicely formatted total of the order
- SummaryOfType
- in file PaymentDecorator.php, method PaymentDecorator::SummaryOfType()
Helper to get type of Payment depending on payment class used.
- supported_countries
- in file Shipping.php, method Shipping::supported_countries()
Get countries supported for shipping.
- StockLevelTest.php
- procedural page StockLevelTest.php
top
t
- $table_overview_fields
- in file Order.php, variable Order::$table_overview_fields
Overview fields for displaying Orders in the admin area
- $template
- in file ModifierSetField.php, variable ModifierSetField::$template
Template for rendering
- $template
- in file OrderItemField.php, variable OrderItemField::$template
Template for rendering
- $template
- in file StockField.php, variable StockField::$template
Template filename
- $template
- in file CartQuantityField.php, variable CartQuantityField::$template
Template for rendering the field
- $template
- in file ModifierHiddenField.php, variable ModifierHiddenField::$template
Template for rendering
- $timeout
- in file Order.php, variable Order::$timeout
Life of shopping cart, how long the cart will remain after abandoned.
- testAddDisabledProductVariationToCart
- in file CartTest.php, method CartTest::testAddDisabledProductVariationToCart()
Add disabled product variation to cart should not work
- testAddInvalidProductVariationToCart
- in file CartTest.php, method CartTest::testAddInvalidProductVariationToCart()
Add invalid product variation to cart should not work
- testAddNonPublishedProductToCart
- in file CartTest.php, method CartTest::testAddNonPublishedProductToCart()
Adding non published product to a cart should fail
- testAddProductNegativeQuantityToCart
- in file CartTest.php, method CartTest::testAddProductNegativeQuantityToCart()
Add negative quantity to cart, should have no effect on cart
- testAddProductQuantityToCart
- in file CartTest.php, method CartTest::testAddProductQuantityToCart()
Add product to the cart twice and check quantity
- testAddProductToCart
- in file CartTest.php, method CartTest::testAddProductToCart()
Add an item to the cart for a basic product and check correct product added
- testAddProductToCartChangePrice
- in file CartTest.php, method CartTest::testAddProductToCartChangePrice()
Change product price after it is in the cart, check that price has not changed in cart
- testAddProductToCartLoggedInCustomer
- in file CartTest.php, method CartTest::testAddProductToCartLoggedInCustomer()
Add a product logged in as a customer
- testAddProductToCartLoggedOut
- in file CartTest.php, method CartTest::testAddProductToCartLoggedOut()
Add a product to the cart as a visitor to the website
- testAddProductToCartReduceStock
- in file StockLevelTest.php, method StockLevelTest::testAddProductToCartReduceStock()
Add a product to the cart and reduce stock level of product without affecting versions of product
- testAddProductVariationQuantity
- in file CartTest.php, method CartTest::testAddProductVariationQuantity()
Add product variations and check quantities
- testAddProductVariations
- in file CartTest.php, method CartTest::testAddProductVariations()
Add different product variations for the same product
- testAddProductVariationToCart
- in file CartTest.php, method CartTest::testAddProductVariationToCart()
Add a product variation to the cart
- testAddProductVariationToCartReduceStock
- in file StockLevelTest.php, method StockLevelTest::testAddProductVariationToCartReduceStock()
Add a product variation to the cart, reduce stock level for variation without creating
- testAddProductVersionToCart
- in file CartTest.php, method CartTest::testAddProductVersionToCart()
Published products should get different versions, new versions are new items in the cart
- testAddProductZeroQuantityToCart
- in file CartTest.php, method CartTest::testAddProductZeroQuantityToCart()
Adding product with zero quantity should have no effect on cart
- testAddVariationWithPriceChanged
- in file CartTest.php, method CartTest::testAddVariationWithPriceChanged()
Add product variation with different price and check order total
- testAddVariationWithVersion
- in file CartTest.php, method CartTest::testAddVariationWithVersion()
Add product variations and check version correct
- testCartTotals
- in file CartTest.php, method CartTest::testCartTotals()
Add product and variation with quantity to cart and check total and subtotal
- testChangeProductAmount
- in file ProductTest.php, method ProductTest::testChangeProductAmount()
Try to publish a product with amount changed
- testCheckBoundsWhenReducingProductStock
- in file StockLevelTest.php, method StockLevelTest::testCheckBoundsWhenReducingProductStock()
Stock levels cannot be reduced < 0, need to check bounds of stock level being set
- testCheckBoundsWhenReducingProductVariationStock
- in file StockLevelTest.php, method StockLevelTest::testCheckBoundsWhenReducingProductVariationStock()
Stock levels cannot be reduced < 0, need to check bounds of stock level being set
- testCheckoutDeletedFlatFeeShipping
- in file OrderModifierTest.php, method OrderModifierTest::testCheckoutDeletedFlatFeeShipping()
Try to checkout with deleted flat fee shipping option
- testCheckoutFlatFeeShipping
- in file OrderModifierTest.php, method OrderModifierTest::testCheckoutFlatFeeShipping()
Try to checkout with valid flat fee shipping option
- testCheckoutInvalidFlatFeeShipping
- in file OrderModifierTest.php, method OrderModifierTest::testCheckoutInvalidFlatFeeShipping()
Try checkout with invalid flat fee shipping option
- testCheckoutWithDeletedProduct
- in file CheckoutTest.php, method CheckoutTest::testCheckoutWithDeletedProduct()
Try to checkout a deleted product
- testCheckoutWithDeletedVariation
- in file CheckoutTest.php, method CheckoutTest::testCheckoutWithDeletedVariation()
Try to checkout a deleted variation
- testCheckoutWithDisabledVariation
- in file CheckoutTest.php, method CheckoutTest::testCheckoutWithDisabledVariation()
Try to checkout a disabled variation
- testCheckoutWithoutPaymentGateway
- in file CheckoutTest.php, method CheckoutTest::testCheckoutWithoutPaymentGateway()
Try checking out an order without specifying a payment gateway
- testCheckoutWithoutProducts
- in file CheckoutTest.php, method CheckoutTest::testCheckoutWithoutProducts()
Try to checkout without products added to the order
- testCheckoutWithoutRequiredFields
- in file CheckoutTest.php, method CheckoutTest::testCheckoutWithoutRequiredFields()
Try to submit the checkout form without some required fields
- testCheckoutWithoutRequiredVariation
- in file CheckoutTest.php, method CheckoutTest::testCheckoutWithoutRequiredVariation()
Try to checkout with a product that requires a variation, without a variation in the cart
- testCheckoutWithPublishedProduct
- in file CheckoutTest.php, method CheckoutTest::testCheckoutWithPublishedProduct()
Create product and check basic attributes
- testCheckoutWithUnpublishedProduct
- in file CheckoutTest.php, method CheckoutTest::testCheckoutWithUnpublishedProduct()
Try to checkout an unpublished product
- testDeleteProduct
- in file ProductTest.php, method ProductTest::testDeleteProduct()
Try to delete a product, make sure it is unpublished but that versions remain the same
- testNegativeVariationPrice
- in file ProductTest.php, method ProductTest::testNegativeVariationPrice()
Try to save a Variation with a negative price difference
- testOutOfStockVariationsNotAvailable
- in file StockLevelTest.php, method StockLevelTest::testOutOfStockVariationsNotAvailable()
Test that only in stock variations are available on the add to cart form.
- testProduct
- in file CartTest.php, method CartTest::testProduct()
Create product and check basic attributes
- testProductAttributeOptions
- in file CartTest.php, method CartTest::testProductAttributeOptions()
Get product attribute and test options associated with it
- testProductCategoryProducts
- in file ProductCategoryTest.php, method ProductCategoryTest::testProductCategoryProducts()
- testProductOptionsFirstSet
- in file ProductTest.php, method ProductTest::testProductOptionsFirstSet()
Load the project page and test the first select for correct product options
- testProductOptionsSecondSet
- in file ProductTest.php, method ProductTest::testProductOptionsSecondSet()
Post add to cart form and retreive second set of product options
- testProductOptionsThirdSet
- in file ProductTest.php, method ProductTest::testProductOptionsThirdSet()
Post add to cart form and retreive third set of product options
- testProductOutOfStockNoAddForm
- in file StockLevelTest.php, method StockLevelTest::testProductOutOfStockNoAddForm()
Check that out of stock products do not display a functioning add to cart form
- testProductStockLevelReducedToZero
- in file StockLevelTest.php, method StockLevelTest::testProductStockLevelReducedToZero()
Stock levels can be reduced to exactly 0 for products
- testProductUnlimitedStockUnaffected
- in file StockLevelTest.php, method StockLevelTest::testProductUnlimitedStockUnaffected()
Add and remove product to cart with unlimited stock (-1), stock level unaffected
- testProductVariationOptions
- in file CartTest.php, method CartTest::testProductVariationOptions()
Get variation options and test that they are correct
- testProductVariationStockLevelReducedToZero
- in file StockLevelTest.php, method StockLevelTest::testProductVariationStockLevelReducedToZero()
Stock levels can be reduced to exactly 0 for product variations
- testProductVariationUnlimitedStockUnaffected
- in file StockLevelTest.php, method StockLevelTest::testProductVariationUnlimitedStockUnaffected()
Add and remove product variation to cart with unlimited stock (-1), stock level unaffected
- testProductWithVariationsOutOfStockNoAddForm
- in file StockLevelTest.php, method StockLevelTest::testProductWithVariationsOutOfStockNoAddForm()
Check that products with all out of stock variations do not have add to cart forms that function
- testRemoveAbandonedCartsWithProductsTask
- in file StockLevelTest.php, method StockLevelTest::testRemoveAbandonedCartsWithProductsTask()
Clean up abandoned carts, restock products in the orders that are deleted
- testRemoveAbandonedCartsWithProductVariationsTask
- in file StockLevelTest.php, method StockLevelTest::testRemoveAbandonedCartsWithProductVariationsTask()
Add a product variation to the cart, change the cart so that it is out of date
- testRemoveProductFromCartReplaceStock
- in file StockLevelTest.php, method StockLevelTest::testRemoveProductFromCartReplaceStock()
remove a product from the cart and replenish stock levels
- testRemoveProductVariationFromCartReplaceStock
- in file StockLevelTest.php, method StockLevelTest::testRemoveProductVariationFromCartReplaceStock()
Remove variation from the cart and replenish stock levels
- testSaveDuplicateProductVariation
- in file CartTest.php, method CartTest::testSaveDuplicateProductVariation()
Test saving duplicate product variations
- testSaveInvalidProductVariation
- in file CartTest.php, method CartTest::testSaveInvalidProductVariation()
Test saving variation without all options set Disabled validation for product variations because preventing disabling a variation
- testSetDraftTrue
- in file CartTest.php, method CartTest::testSetDraftTrue()
Have to use draft site for following test testAddNonPublishedProductToCart
- testStockLevels
- in file StockLevelTest.php, method StockLevelTest::testStockLevels()
Check that stock level correct, considering an item is added to an order in the fixture.
- testVariationsDisabledAfterAttributeAdded
- in file ProductTest.php, method ProductTest::testVariationsDisabledAfterAttributeAdded()
Try adding a new attribute to a product, existing variations that do not have an option set for
- Total
- in file Item.php, method Item::Total()
Get unit price for this item including item options price and quantity.
- TotalOutstanding
- in file Order.php, method Order::TotalOutstanding()
Calculate the total outstanding for this order that remains to be paid, all payments except 'Failure' payments are considered
- TotalPaid
- in file Order.php, method Order::TotalPaid()
Calculate the total paid for this order, only 'Success' payments are considered.
top
u
- $url_handlers
- in file Product.php, variable Product_Controller::$url_handlers
URL handlers to redirect URLs of the type /product/[Product URL Segment] to the correct actions. As well as directing norman nested URLs to the same actions. This is so that Products without a ParentID (not part of the site tree) can be accessed from a nicely formatted generic URL.
- $url_segment
- in file ShopAdmin.php, variable ShopAdmin::$url_segment
URL segment for this admin area.
- $use_draft_site
- in file StockLevelTest.php, variable StockLevelTest::$use_draft_site
- $use_draft_site
- in file OrderModifierTest.php, variable OrderModifierTest::$use_draft_site
- $use_draft_site
- in file ProductCategoryTest.php, variable ProductCategoryTest::$use_draft_site
- $use_draft_site
- in file CartTest.php, variable CartTest::$use_draft_site
- $use_draft_site
- in file CheckoutTest.php, variable CheckoutTest::$use_draft_site
- $use_draft_site
- in file ProductTest.php, variable ProductTest::$use_draft_site
- UnitPrice
- in file Item.php, method Item::UnitPrice()
Get unit price for this Item including price or any ItemOptions.
- unpublish
- in file ShopAdmin.php, method ShopAdmin_RecordController::unpublish()
Handle unpublishing a record
- updateCart
- in file CartPage.php, method CartPage_Controller::updateCart()
Update the current cart quantities then redirect back to the cart page.
- updateCMSFields
- in file PaymentDecorator.php, method PaymentDecorator::updateCMSFields()
Fields to display this Payment in the CMS, removed some of the unnecessary fields.
- updateCMSFields
- in file ShopSettings.php, method ShopSettings::updateCMSFields()
Adding fields for shop settings such as email, license key.
- updateCMSFields
- in file FlatFeeShippingConfigDecorator.php, method FlatFeeShippingConfigDecorator::updateCMSFields()
Create ComplexTableField for managing FlatFeeShippingRates.
- updateCMSFields
- in file FlatFeeTaxConfigDecorator.php, method FlatFeeTaxConfigDecorator::updateCMSFields()
Create ComplexTableField for managing FlatFeeTaxRates.
- updateOrderFormCart
- in file CheckoutPage.php, method CheckoutPage_Controller::updateOrderFormCart()
Update the order form cart, called via AJAX with current order form data.
- updatePaymentStatus
- in file Order.php, method Order::updatePaymentStatus()
Update the order payment status after Payment is made.
- updateStockBy
- in file Variation.php, method Variation::updateStockBy()
Update the stock level for this Product. A negative quantity is passed when product is added to a cart, a positive quantity when product is removed from a cart.
- updateStockBy
- in file Product.php, method Product::updateStockBy()
Update the stock level for this Product. A negative quantity is passed when product is added to a cart, a positive quantity when product is removed from a cart.
- updateStockLevels
- in file Item.php, method Item::updateStockLevels()
Update StockLevel for Product exists.
- updateTotal
- in file Order.php, method Order::updateTotal()
Go through items and modifiers and update cart total
- updateValue
- in file FlatFeeShippingField.php, method FlatFeeShippingField::updateValue()
Update value of the field according to any matching Modifications in the Order. Useful when the source options have changed, if a matching option cannot be found in a Modification then the first option is set at the value (selected).
- updateValue
- in file FlatFeeTaxField.php, method FlatFeeTaxField::updateValue()
Update value of the field according to any matching Modifications in the Order. Useful when the source options have changed, if a matching option cannot be found in a Modification then the first option is set at the value (selected).
top
v
- VariationComplexTableField.php
- procedural page VariationComplexTableField.php
- VariationMoneyField.php
- procedural page VariationMoneyField.php
- Variation.php
- procedural page Variation.php
- VirtualProductCleanupTask.php
- procedural page VirtualProductCleanupTask.php
- validate
- in file Address.php, method Address::validate()
By default an order is always valid. Empty orders are often created and saved in the DB to represent a cart, so cannot validate that Items and Addresses exist for the order until the checkout process.
- validate
- in file QuantityField.php, method QuantityField::validate()
Validate the quantity is above 0.
- validate
- in file OrderItemField.php, method OrderItemField::validate()
Validate this form field, make sure the Item exists, is in the current Order and the item is valid for adding to the cart.
- validate
- in file Order.php, method Order::validate()
By default Orders are always valid
- validate
- in file Variation.php, method Variation::validate()
Validate the Variation before it is saved.
- validate
- in file VariationMoneyField.php, method VariationMoneyField::validate()
Validate this form field, make sure the Variation amount is not negative.
- validate
- in file ModifierSetField.php, method ModifierSetField::validate()
Validation is not currently done on this field at this point.
- validate
- in file StockField.php, method StockField::validate()
Validate that the stock level is numeric and greater than -2.
- validate
- in file Product.php, method Product::validate()
Validate the Product before it is saved in ShopAdmin.
- validate
- in file CheckoutForm.php, method CheckoutForm::validate()
Overloaded so that form error messages are displayed.
- validate
- in file Item.php, method Item::validate()
Validate that product exists and is published, variation exists for product if necessary and quantity is greater than 0
- validate
- in file ModifierHiddenField.php, method ModifierHiddenField::validate()
Validation is not currently done on this field at this point.
- validate
- in file CartQuantityField.php, method CartQuantityField::validate()
Validate this field, check that the current Item is in the current {@Link Order} and is valid for adding to the cart.
- validate
- in file AddToCartForm.php, method AddToCartForm::validate()
Overloaded so that form error messages are displayed.
- validate
- in file Modification.php, method Modification::validate()
By default Modifications are valid
- validate
- in file FlatFeeTaxField.php, method FlatFeeTaxField::validate()
Ensure that the value is the ID of a valid FlatFeeShippingRate and that the FlatFeeShippingRate it represents is valid for the Shipping country being set in the Order.
- validate
- in file ItemOption.php, method ItemOption::validate()
By default all ItemOptions are valid.
- validate
- in file FlatFeeShippingField.php, method FlatFeeShippingField::validate()
Ensure that the value is the ID of a valid FlatFeeShippingRate and that the FlatFeeShippingRate it represents is valid for the Shipping country being set in the Order.
- validateForCart
- in file Variation.php, method Variation::validateForCart()
Validate that this variation is suitable for adding to the cart.
- validateForCart
- in file Item.php, method Item::validateForCart()
Validate this Item to make sure it can be added to a cart.
- validateForCart
- in file Order.php, method Order::validateForCart()
Valdiate this Order for use in Validators at checkout. Makes sure Items exist and each Item is valid.
- Value
- in file StockField.php, method StockField::Value()
Get the value of the stock level
- Variation
- in file Variation.php, class Variation
Represents a Variation for a Product. A variation needs to have a valid Option set for each Attribute that the product has e.g Size:Medium, Color:Red, Material:Cotton. Variations are Versioned so that when they are added to an Order and then changed, the Order can still access the correct information.
- Variation
- in file Item.php, method Item::Variation()
Get the variation for the item if a Variation exists in the ItemOptions This assumes only one variation per item.
- VariationComplexTableField
- in file VariationComplexTableField.php, class VariationComplexTableField
For managing Variations on the Product page in the CMS.
- VariationComplexTableField_ItemRequest
- in file VariationComplexTableField.php, class VariationComplexTableField_ItemRequest
- VariationMoneyField
- in file VariationMoneyField.php, class VariationMoneyField
For adding amount to Variations which alter the overall Product amount, validates that amount is not negative.
- variationprice
- in file Product.php, method Product_Controller::variationprice()
Calculate the Variation price difference based on current request.
- VirtualProductCleanupTask
- in file VirtualProductCleanupTask.php, class VirtualProductCleanupTask
Remove virtual products that are older than the download window, cleaning up the filesystem and preventing linking directly to product downloads for extended periods of time.
top
_
- _config.php
- procedural page _config.php
- __construct
- in file OrderItemField.php, method OrderItemField::__construct()
Construct the form field and set the Item it represents.
- __construct
- in file OptionGroupField.php, method OptionGroupField::__construct()
Construct the field with correct ID names and values
- __construct
- in file ReceiptEmail.php, method ReceiptEmail::__construct()
Create the new receipt email.
- __construct
- in file RemoveItemAction.php, method RemoveItemAction::__construct()
Create the form action with a useful description.
- __construct
- in file StockField.php, method StockField::__construct()
Create an OptionSetField and NumericField.
- __construct
- in file OptionField.php, method OptionField::__construct()
Create drop down field for a product option, just ensures name of field is in the format Options[OptionClassName].
- __construct
- in file NotificationEmail.php, method NotificationEmail::__construct()
Create the new notification email.
- __construct
- in file CartQuantityField.php, method CartQuantityField::__construct()
Construct the field and set the current Item that this field represents.
- __construct
- in file CartForm.php, method CartForm::__construct()
Construct the form, set the current order and the template to be used for rendering.
- __construct
- in file CheckoutForm.php, method CheckoutForm::__construct()
Construct the form, get the grouped fields and set the fields for this form appropriately, the fields are passed in an associative array so that the fields can be grouped into sets making it easier for the template to grab certain fields for different parts of the form.
- __construct
- in file Emogrifier.php, method Emogrifier::__construct()
- __construct
- in file ModifierSetField.php, method ModifierSetField::__construct()
Creates a new optionset field for order modifers with the naming convention Modifiers[ClassName] where ClassName is name of modifier class.
- __construct
- in file ModifierHiddenField.php, method ModifierHiddenField::__construct()
Creates a new optionset field for order modifers with the naming convention Modifiers[ClassName] where ClassName is name of modifier class.
- __construct
- in file BelongsManyManyComplexTableField.php, method BelongsManyManyComplexTableField::__construct()
- __get
- in file Variation.php, method Variation::__get()
Overloaded magic method so that attribute values can be retrieved for display in CTFs etc.
top
|
|