class Key extends Facade implements AttributeKeyInterface (View source)

Properties

static protected $app from Facade
static protected array $resolvedInstance The resolved object instances. from Facade
protected LegacyKey $legacyAttributeKey

Methods

static mixed
getFacadeRoot()

Get the root object behind the facade.

from Facade
static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static 
clearResolvedInstance(string $name)

Clear a resolved facade instance.

from Facade
static 
clearResolvedInstances()

Clear all of the resolved instances.

from Facade
static Application
getFacadeApplication()

Get the application instance behind the facade.

from Facade
static 
setFacadeApplication(Application $app)

Set the application instance.

from Facade
static mixed
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from Facade
static 
exportTranslations() deprecated

No description

getController() deprecated

No description

__toString()

No description

int
getAttributeKeyID() deprecated

No description

string
getAttributeKeyHandle() deprecated

No description

getAttributeType() deprecated

No description

bool
isAttributeKeySearchable() deprecated

No description

getSearchIndexer()

Get the search indexer.

static 
add($handle, $type, $args, $pkg = false) deprecated

This is how old attribute keys used to install themselves. They extended this class and would call parent::add(). Do NOT use this method. It is here for backward compatibility.

load($akID) deprecated

In 5.7 and earlier, if a subclassed Key object called load, it was loading the core data of an attribute key. we're going to load that data into an internal legacy key object that we can keep around to pass calls to for attribute keys that incorrectly subclass this Key object.

__call($name, $arguments) deprecated

This is here to fulfill this type of code $key = StoreOrderKey::getByID(10); Which then calls $ak = new self(); $ak->load(10); if ($ak->getAttributeKeyID()) {.

setPropertiesFromArray($array) deprecated

No description

saveAttributeForm($o) deprecated

No description

saveAttribute($attributeValue, $passedValue = false) deprecated

No description

addAttributeValue() deprecated

No description

getSearchIndexFieldDefinition() deprecated

No description

getIndexedSearchTable() deprecated

No description

setAttribute($o, $value) deprecated

No description

reindex($table, $columnHeaders, $attribs, $rs = null) deprecated

No description

Details

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

static string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

Exceptions

RuntimeException

static clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

static clearResolvedInstances()

Clear all of the resolved instances.

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application $app

static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

static exportTranslations() deprecated

deprecated Move to new location.

Controller getController() deprecated

deprecated

Return Value

Controller

__toString()

int getAttributeKeyID() deprecated

deprecated

Return Value

int

string getAttributeKeyHandle() deprecated

deprecated

Return Value

string

Type getAttributeType() deprecated

deprecated

Return Value

Type

bool isAttributeKeySearchable() deprecated

deprecated

Return Value

bool

SearchIndexerInterface getSearchIndexer()

Get the search indexer.

Return Value

SearchIndexerInterface

static add($handle, $type, $args, $pkg = false) deprecated

deprecated

This is how old attribute keys used to install themselves. They extended this class and would call parent::add(). Do NOT use this method. It is here for backward compatibility.

Parameters

$handle
$type
$args
$pkg

load($akID) deprecated

deprecated

In 5.7 and earlier, if a subclassed Key object called load, it was loading the core data of an attribute key. we're going to load that data into an internal legacy key object that we can keep around to pass calls to for attribute keys that incorrectly subclass this Key object.

Parameters

$akID

__call($name, $arguments) deprecated

deprecated

This is here to fulfill this type of code $key = StoreOrderKey::getByID(10); Which then calls $ak = new self(); $ak->load(10); if ($ak->getAttributeKeyID()) {.

..}

Parameters

$name
$arguments

setPropertiesFromArray($array) deprecated

deprecated

Parameters

$array

saveAttributeForm($o) deprecated

deprecated

Parameters

$o

protected saveAttribute($attributeValue, $passedValue = false) deprecated

deprecated

Parameters

$attributeValue
$passedValue

addAttributeValue() deprecated

deprecated

getSearchIndexFieldDefinition() deprecated

deprecated

getIndexedSearchTable() deprecated

deprecated

setAttribute($o, $value) deprecated

deprecated

Parameters

$o
$value

reindex($table, $columnHeaders, $attribs, $rs = null) deprecated

deprecated

Parameters

$table
$columnHeaders
$attribs
$rs