\CGProductBuilderProductSpec

An intermediate class that defines a product specification.

An instance of this class is passed to dispositions. Dispositions can use this object to output the complete product specification in various formats.

Summary

Methods

Properties

Constants

__construct()
build_from_content()

$returnid
$content
$name
$baseprice
$price
$description
$optionsets
$
$options

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: class.ProductSpec.php
Package: \CGProductBuilder
Class hierarchy: \CGProductBuilder\ProductSpec

Properties

$returnid

$returnid : int

The id of the content page that created this productSpec

Type

int

$content

$content : \CGProductBuilder\cgpb_productbuilder

A reference to the actual content page that created this productspec (read only)

Type

\CGProductBuilder\cgpb_productbuilder

$name

$name : string

The name of this product.

Type

string

$baseprice

$baseprice : float

The base price of this product (actual value may change for each occurrance depending upon FEU status)

Type

float

$price

$price : float

The final price of this product including all selected options.

Type

float

$description

$description : string

The description for the product. May include HTML.

Type

string

$optionsets

$optionsets : \CGProductBuilder\optionsets[]

The optionsets associated with the product.

Type

\CGProductBuilder\optionsets[]

$

$ : bool

is_wholesale A boolean indicating that wholesale prices are in effect and used in calculations.

Type

bool

$options

$options : array

An array of stdclass objects that define the selected options. See the module help for a clear description of each member.

Type

array

Methods

__construct()

__construct(\CGProductBuilder\cgpb_productbuilder $content)

Constructor

Parameters

\CGProductBuilder\cgpb_productbuilder

$content

The content page that contains the current state of the product build.