GetCandy 2 Docs

# Attributes

# Overview

Attributes can be associated to Eloquent models to allow custom data to be stored. Typically, these will be used the most with Products where different information is needed to be stored and presented to visitors.

For example, a television might have the following attributes assigned...

  • Screen Size
  • Screen Technology
  • Tuner
  • Resolution

# Attributes

GetCandy\Models\Attribute
Field Description
attribute_type Model type that can use attribute, e.g. GetCandy\Models\ProductType
attribute_group_id The associated group
position An integer used to define the sorting order of attributes within attribute groups
name Laravel Collection of translations {'en': 'Screen Size'}
handle Kebab-cased reference, e.g. screen-size
section An optional name to define where an attribute should be used.
type The field type to be used, e.g. GetCandy\FieldTypes\Number
required Boolean
default_value
configuration Meta data stored as a Laravel Collection
system If set to true, indicates it should not be deleted

# Field Types

Type Config
GetCandy\FieldTypes\Number Integer or Decimal
GetCandy\FieldTypes\Text Single-line, Multi-line, Rich Text
GetCandy\FieldTypes\TranslatedText Single-line, Multi-line, Rich Text
GetCandy\FieldTypes\ListField An re-orderable list of text values

INFO

More field types will be coming soon.

# Models that use Attributes

  • GetCandy\Models\Product
  • GetCandy\Models\ProductVariant
  • GetCandy\Models\Collection

# Saving Attribute Data

$product->attribute_data = collect([
    'meta_title' => new \GetCandy\FieldTypes\Text('The best screwdriver you will ever buy!'),
    'pack_qty' => new \GetCandy\FieldTypes\Number(2),
    'description' => new \GetCandy\FieldTypes\TranslatedText(collect([
        'en' => new \GetCandy\FieldTypes\Text('Blue'),
        'fr' => new \GetCandy\FieldTypes\Text('Bleu'),
    ])),
]);

# Adding attributes to your own model

use GetCandy\Base\Casts\AsAttributeData;
use GetCandy\Base\Traits\HasAttributes;

class Collection extends Model
{
    use HasAttributes;

    /**
     * Define which attributes should be cast.
     *
     * @var array
     */
    protected $casts = [
        'attribute_data' => AsAttributeData::class,
    ];

    //...
}

Then ensure you have a JSON field (opens new window) on your model's table called attribute_data.

TIP

When loading models it is advised you eager load the attribute data required.

# Accessing Attribute Data.

There will come times where you need to be able to retrieve the attribute data you have stored against a model. When you target the attribute_data property it will be cast as a collection and resolved into it's corresponding field type.

dump($product->attribute_data);

Illuminate\Support\Collection {#1522 ▼
  #items: array:2 [▼
    "name" => GetCandy\FieldTypes\TranslatedText {#1533 ▼
      #value: Illuminate\Support\Collection {#1505 ▼
        #items: array:3 [▼
          "de" => GetCandy\FieldTypes\Text {#1506 ▼
            #value: "Leren laarzen"
          }
          "en" => GetCandy\FieldTypes\Text {#1514 ▼
            #value: "Leather boots"
          }
          "fr" => GetCandy\FieldTypes\Text {#1502 ▼
            #value: "Bottes en cuires"
          }
        ]
      }
    }
    "description" => GetCandy\FieldTypes\Text {#1537 ▼
      #value: "<p>I'm a description!</p>"
    }
  ]
}

If you need to just get the value for one field, you can use the translateAttribute method on the model:

// Leather boots
$product->translateAttribute('name');

// Bootes en cuires
$product->translateAttribute('name', 'fr');

// Leather boots
$product->translateAttribute('name', 'FOO');
// We will default here to either the current system locale or the first value available.

# Advanced usage

use GetCandy\Base\Traits\HasAttributes;

class ProductType extends Model
{
    use HasAttributes;

    //...
}



use GetCandy\Base\Casts\AsAttributeData;

class Product extends Model
{
    /**
     * Define which attributes should be cast.
     *
     * @var array
     */
    protected $casts = [
        'attribute_data' => AsAttributeData::class,
    ];

    //...
}



use GetCandy\Base\Casts\AsAttributeData;

class ProductVariant extends Model
{
    /**
     * Define which attributes should be cast.
     *
     * @var array
     */
    protected $casts = [
        'attribute_data' => AsAttributeData::class,
    ];

    //...
}

# Attribute Groups

Attribute Groups form a collection of attributes that are logically grouped together for display purposes.

A good example might be an "SEO" attribute group which has attributes for "Meta Title" and "Meta Description".

GetCandy\Models\AttributeGroup
Field Description
name Laravel Collection of translations {'en': 'SEO'}
handle Kebab-cased reference, e.g. seo
position An integer used to define the sorting order of groups

← Carts →