Product
+ Inheritance diagram for Product:

Description

Public Properties

const DIR = 'products'
 
const MAP
 
const TYPE = 'product'
 
- Public Properties inherited from AbstractEntity
const DIR = ''
 All subclasses must redeclare this to match their REST directory (without container). More...
 
const TYPE = ''
 All subclasses must redeclare this to match their types. More...
 
- Public Properties inherited from Data
const MAP = []
 
const PATCH = []
 

Public Methods

magic string getBodyHtml ()
 
magic string getCreatedAt ()
 
magic string getHandle ()
 
magic Image[] getImages ()
 
magic Option[] getOptions ()
 
magic string getProductType ()
 
magic null string getPublishedAt ()
 
magic string getPublishedScope ()
 
magic string getTags ()
 
magic null string getTemplateSuffix ()
 
magic string getTitle ()
 
magic string getUpdatedAt ()
 
magic Variant[] getVariants ()
 
magic string getVendor ()
 
magic bool hasImages ()
 
magic bool hasOptions ()
 
magic bool hasVariants ()
 
Image newImage ()
 
Option newOption ()
 
Variant newVariant ()
 
magic Image[] selectImages (callable $filter)
 fn( Image $image ): bool More...
 
magic Option[] selectOptions (callable $filter)
 fn( Option $option ): bool More...
 
magic Variant[] selectVariants (callable $filter)
 fn( Variant $variant ): bool More...
 
magic $this setBodyHtml (string $html)
 
magic $this setHandle (string $handle)
 
magic $this setImages (Image[] $images)
 
magic $this setOptions (Option[] $options)
 
magic $this setProductType (string $type)
 
magic $this setPublishedAt (?string $iso8601)
 
magic $this setPublishedScope (string $scope)
 
magic $this setTags (string $tags)
 
magic $this setTemplateSuffix (?string $suffix)
 
magic $this setTitle (string $title)
 
magic $this setVariants (Variant[] $variants)
 
magic $this setVendor (string $vendor)
 
- Public Methods inherited from AbstractEntity
string __toString ()
 
null string getId ()
 
string[] getPoolKeys ()
 
bool hasId ()
 
$this reload ()
 Fully reloads the entity from Shopify. More...
 
- Public Methods inherited from Data
mixed __call (string $method, array $args)
 
 __construct ($caller, array $data=[])
 
string serialize ()
 Dehydrated JSON encode. More...
 
array toArray ()
 
void unserialize ($serialized)
 
- Public Methods inherited from CreateTrait
$this create ()
 
- Public Methods inherited from DeleteTrait
void delete ()
 
- Public Methods inherited from UpdateTrait
$this update ()
 
- Public Methods inherited from MetafieldTrait
Metafield[] getMetafields ()
 
Metafield newMetafield ()
 Factory. More...
 

Additional Inherited Members

- Protected Properties inherited from Data
Api $api
 
Pool $pool
 
- Public Static Methods inherited from AbstractEntity
static null self load ($caller, string $id, array $query=[])
 
static self[] loadAll ($caller, string $path, array $query=[])
 
- Protected Methods inherited from AbstractEntity
null AbstractEntity _container ()
 The container/owner object, if any. More...
 
mixed _get (string $field)
 Lazy-loads missing fields. More...
 
void _onDelete ()
 
void _onSave ()
 
void _reload (string $field)
 
- Protected Methods inherited from Data
mixed _hydrate (string $class, $item)
 A factory that also hydrates / caches entities. More...
 
array _select ($subject, callable $filter,... $args)
 Magic method: selectField(callable $filter) More...
 
$this _setData (array $data)
 Clears all diffs and sets all data, hydrating mapped fields. More...
 
$this _setField (string $field, $value)
 Sets a value, hydrating if mapped, and clears the diff. More...
 
- Protected Methods inherited from CreateTrait
string _dir ()
 The POST directory. More...
 
- Protected Methods inherited from MetafieldTrait
string _metafieldType ()
 

Properties

◆ MAP

const MAP
Initial value:
= [
'image' => Image::class,
'images' => [Image::class],
'options' => [Option::class],
'variants' => [Variant::class]
]

Methods

◆ getBodyHtml()

magic string getBodyHtml ( )
Returns
string

◆ getCreatedAt()

magic string getCreatedAt ( )
Returns
string

◆ getHandle()

magic string getHandle ( )
Returns
string

◆ getImages()

magic Image [] getImages ( )
Returns
Image[]

◆ getOptions()

magic Option [] getOptions ( )
Returns
Option[]

◆ getProductType()

magic string getProductType ( )
Returns
string

◆ getPublishedAt()

magic null string getPublishedAt ( )
Returns
null|string

◆ getPublishedScope()

magic string getPublishedScope ( )
Returns
string

◆ getTags()

magic string getTags ( )
Returns
string

◆ getTemplateSuffix()

magic null string getTemplateSuffix ( )
Returns
null|string

◆ getTitle()

magic string getTitle ( )
Returns
string

◆ getUpdatedAt()

magic string getUpdatedAt ( )
Returns
string

◆ getVariants()

magic Variant [] getVariants ( )
Returns
Variant[]

◆ getVendor()

magic string getVendor ( )
Returns
string

◆ hasImages()

magic bool hasImages ( )
Returns
bool

◆ hasOptions()

magic bool hasOptions ( )
Returns
bool

◆ hasVariants()

magic bool hasVariants ( )
Returns
bool

◆ newImage()

Image newImage ( )
Returns
Image

◆ newOption()

Option newOption ( )
Returns
Option

◆ newVariant()

Variant newVariant ( )
Returns
Variant

◆ selectImages()

magic Image [] selectImages ( callable  $filter)

fn( Image $image ): bool

Returns
Image[]

◆ selectOptions()

magic Option [] selectOptions ( callable  $filter)

fn( Option $option ): bool

Returns
Option[]

◆ selectVariants()

magic Variant [] selectVariants ( callable  $filter)

fn( Variant $variant ): bool

Returns
Variant[]

◆ setBodyHtml()

magic $this setBodyHtml ( string  $html)
Returns
$this

◆ setHandle()

magic $this setHandle ( string  $handle)
Returns
$this

◆ setImages()

magic $this setImages ( Image[]  $images)
Returns
$this

◆ setOptions()

magic $this setOptions ( Option[]  $options)
Returns
$this

◆ setProductType()

magic $this setProductType ( string  $type)
Returns
$this

◆ setPublishedAt()

magic $this setPublishedAt ( ?string  $iso8601)
Returns
$this

◆ setPublishedScope()

magic $this setPublishedScope ( string  $scope)
Returns
$this

◆ setTags()

magic $this setTags ( string  $tags)
Returns
$this

◆ setTemplateSuffix()

magic $this setTemplateSuffix ( ?string  $suffix)
Returns
$this

◆ setTitle()

magic $this setTitle ( string  $title)
Depends:
required
Returns
$this

◆ setVariants()

magic $this setVariants ( Variant[]  $variants)
Returns
$this

◆ setVendor()

magic $this setVendor ( string  $vendor)
Returns
$this