AbstractCollect
+ Inheritance diagram for AbstractCollect:

Description

A link between a collection and a product.

Immutable:
Collects can only be created and deleted.
See also
https://shopify.dev/docs/admin-api/rest/reference/products/collect

Public Properties

const DIR = 'collects'
 
const TYPE = 'collect'
 
- 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

AbstractCollection getCollection ()
 
magic string getCollectionId ()
 injected More...
 
magic string getCreatedAt ()
 
magic string getPosition ()
 
Product getProduct ()
 
magic string getProductId ()
 injected More...
 
magic string getSortValue ()
 
magic string getUpdatedAt ()
 
- 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 ()
 

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...
 

Methods

◆ getCollection()

AbstractCollection getCollection ( )
abstract
Returns
AbstractCollection

Reimplemented in CustomCollect, and SmartCollect.

◆ getCollectionId()

magic string getCollectionId ( )

injected

Returns
string

◆ getCreatedAt()

magic string getCreatedAt ( )
Returns
string

◆ getPosition()

magic string getPosition ( )
Returns
string

◆ getProduct()

Product getProduct ( )
Returns
Product

◆ getProductId()

magic string getProductId ( )

injected

Returns
string

◆ getSortValue()

magic string getSortValue ( )
Returns
string

◆ getUpdatedAt()

magic string getUpdatedAt ( )
Returns
string