EtService

Type
Class
Namespace
Craft
Inherits
Craft\EtService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements
IApplicationComponent
Since
1.0

Class EtService

See also http://craftcms.com

View source (opens new window)

# Public Properties

Property Description
$behaviors (opens new window) array (opens new window) – The behaviors that should be attached to this component.

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__get() (opens new window) Returns a property value, an event handler list or a behavior based on its name.
__isset() (opens new window) Checks if a property value is null.
__set() (opens new window) Sets value of a component property.
__unset() (opens new window) Sets a component property to be null.
asa() (opens new window) Returns the named behavior object.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attachEventHandler() (opens new window) Attaches an event handler to an event.
canGetProperty() (opens new window) Determines whether a property can be read.
canSetProperty() (opens new window) Determines whether a property can be set.
checkForUpdates() Checks if any new updates are available.
decodeEtModel() Creates a new EtModel with provided JSON, and returns it if it's valid.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
detachEventHandler() (opens new window) Detaches an existing event handler.
disableBehavior() (opens new window) Disables an attached behavior.
disableBehaviors() (opens new window) Disables all behaviors attached to this component.
downloadUpdate()
enableBehavior() (opens new window) Enables an attached behavior.
enableBehaviors() (opens new window) Enables all behaviors attached to this component.
evaluateExpression() (opens new window) Evaluates a PHP expression or callback under the context of this component.
fetchCouponPrice() Fetches the price of an upgrade with a coupon applied to it.
fetchUpgradeInfo() Fetches info about the available Craft editions from Elliott.
getEventHandlers() (opens new window) Returns the list of attached event handlers for an event.
getIsInitialized() (opens new window) Checks if this application component has been initialized.
getLicenseKeyStatus() Returns the license key status, or false if it's unknown.
getLicensedDomain() Returns the domain that the installed license key is licensed for, null if it's not set yet, or false if it's unknown.
getUpdateFileInfo()
hasEvent() (opens new window) Determines whether an event is defined.
hasEventHandler() (opens new window) Checks whether the named event has attached handlers.
hasProperty() (opens new window) Determines whether a property is defined.
init() (opens new window) Initializes the application component.
isInitialized() Checks if this application component has been initialized yet, or not.
ping()
purchaseUpgrade() Attempts to purchase an edition upgrade.
raiseEvent() (opens new window) Raises an event.
registerPlugin() Registers a given plugin with the current Craft license.

# checkForUpdates()

Checks if any new updates are available.

View source (opens new window)

Arguments

  • $updateInfo

Returns

Craft\EtModel, null (opens new window)

Signature

public Craft\EtModel, null checkForUpdates ( $updateInfo )

# decodeEtModel()

Creates a new EtModel with provided JSON, and returns it if it's valid.

View source (opens new window)

Arguments

Returns

Craft\EtModel, null (opens new window)

Signature

public Craft\EtModel, null decodeEtModel ( $attributes )

# downloadUpdate()

Signature

public boolean downloadUpdate ( $downloadPath, $md5, $handle )

# fetchCouponPrice()

Fetches the price of an upgrade with a coupon applied to it.

View source (opens new window)

Arguments

  • $edition
  • $couponCode

Returns

Craft\EtModel, null (opens new window)

Signature

public Craft\EtModel, null fetchCouponPrice ( $edition, $couponCode )

# fetchUpgradeInfo()

Fetches info about the available Craft editions from Elliott.

View source (opens new window)

Returns

Craft\EtModel, null (opens new window)

Signature

public Craft\EtModel, null fetchUpgradeInfo ( )

# getLicenseKeyStatus()

Returns the license key status, or false if it's unknown.

View source (opens new window)

Returns

string (opens new window), false (opens new window)

Signature

public string, false getLicenseKeyStatus ( )

# getLicensedDomain()

Returns the domain that the installed license key is licensed for, null if it's not set yet, or false if it's unknown.

View source (opens new window)

Returns

string (opens new window), null (opens new window), false (opens new window)

Signature

public string, null, false getLicensedDomain ( )

# getUpdateFileInfo()

Signature

public Craft\EtModel, null getUpdateFileInfo ( $handle )

# ping()

Signature

public Craft\EtModel, null ping ( )

# purchaseUpgrade()

Attempts to purchase an edition upgrade.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Signature

public boolean purchaseUpgrade ( Craft\UpgradePurchaseModel $model )

# registerPlugin()

Registers a given plugin with the current Craft license.

View source (opens new window)

Arguments

  • $pluginHandle

Returns

Craft\EtModel

Signature

public Craft\EtModel registerPlugin ( $pluginHandle )

# Constants

Constant Description
ENDPOINT_CHECK_FOR_UPDATES
ENDPOINT_GET_COUPON_PRICE
ENDPOINT_GET_UPDATE_FILE_INFO
ENDPOINT_GET_UPGRADE_INFO
ENDPOINT_PING
ENDPOINT_PURCHASE_UPGRADE
ENDPOINT_REGISTER_PLUGIN