/ 
Interchange6-Schema-0.040
River stage one • 1 direct dependent • 1 total dependent
/ Interchange6::Schema::Result::Product

NAME

Interchange6::Schema::Result::Product

TABLE: products

DESCRIPTION

The products table contains three product types parent, child and single.

  • Parent Product A parent product is a container product in which variations of parent product or "child products" are linked.

  • Child Product A child product for example "Acme Pro 10lb Dumbbell" would include the canonical_sku of the parent item whose description might be something like "Acme Pro Dumbbell". In general a child product would contain attributes while a parent product would not.

  • Single Product A single product does not have child products and will become a parent product if a child product exists.

ACCESSORS

sku

data_type: 'varchar'
is_nullable: 0
size: 64

name

data_type: 'varchar'
default_value: (empty string)
is_nullable: 0
size: 255

short_description

data_type: 'varchar'
default_value: (empty string)
is_nullable: 0
size: 500

description

data_type: 'text'
default_value: (empty string)
is_nullable: 0

price

data_type: 'numeric'
default_value: 0.0
is_nullable: 0
size: [10,2]

uri

Unique product uri. Example "acme-pro-dumbbells".

data_type: 'varchar'
is_nullable: 1
size: 255

weight

data_type: 'numeric'
default_value: 0.0
is_nullable: 0
size: [10,2]

priority

Display order priority.

data_type: 'integer'
default_value: 0
is_nullable: 0

gtin

EAN or UPC type data.

data_type: 'varchar'
is_nullable: 1
size: 32

canonical_sku

The SKU of the main product if this product is a variant of a main product, otherwise NULL.

data_type: 'varchar'
is_nullable: 1
size: 64

active

data_type: 'boolean'
default_value: true
is_nullable: 0

inventory_exempt

data_type: 'boolean'
default_value: false
is_nullable: 0

created

data_type: 'datetime'
set_on_create: 1
is_nullable: 0

last_modified

data_type: 'datetime'
set_on_create: 1
set_on_update: 1
is_nullable: 0

METHODS

Attribute methods are provided by the Interchange6::Schema::Base::Attribute class.

path

Produces navigation path for this product. Returns array reference in scalar context.

Uses $type to select specific taxonomy from navigation if present.

find_variant \%input [\%match_info]

Find product variant with the given attribute values in $input.

Returns variant in case of success.

Returns undef in case of failure.

You can pass an optional hash reference \%match_info which is filled with attribute matches (only valid in case of failure).

attribute_iterator

Returns nested iterator for product attributes.

For canonical products, it shows all the attributes of the child products.

For a child product, it shows all the attributes of the siblings.

add_variants @variants

Add variants from a list of hash references.

Returns product object.

Each hash reference contains attributes and column data which overrides data from the canonical product.

The canonical sku of the variant is automatically set.

Example for the hash reference (attributes in the first line):

{color => 'yellow', size => 'small',
 sku => 'G0001-YELLOW-S',
 name => 'Six Small Yellow Tulips',
 uri => 'six-small-yellow-tulips'}

PRIMARY KEY

UNIQUE CONSTRAINTS

products_gtin

products_uri

RELATIONS

canonical

Type: belongs_to

Related object: Interchange6::Schema::Result::Product

variants

Type: has_many

Related object: Interchange6::Schema::Result::Product

cart_products

Type: has_many

Related object: Interchange6::Schema::Result::CartProduct

group_pricing

Type: has_many

Related object: Interchange6::Schema::Result::GroupPricing

inventory

Type: might_have

Related object: Interchange6::Schema::Result::Inventory

media_products

Type: has_many

Related object: Interchange6::Schema::Result::MediaProduct

merchandising_products

Type: has_many

Related object: Interchange6::Schema::Result::MerchandisingProduct

Type: has_many

Related object: Interchange6::Schema::Result::MerchandisingProduct

Type: has_many

Related object: Interchange6::Schema::Result::NavigationProduct

orderlines

Type: has_many

Related object: Interchange6::Schema::Result::Orderline

product_attributes

Type: has_many

Related object: Interchange6::Schema::Result::ProductAttribute

media

Type: many_to_many with media

METHODS

media_by_type

Return a Media resultset with the related media, filtered by type (e.g. video or image). On the results you can call display_uri("type") to get the actual uri.