ZenMagick 0.9.10


zenmagick.store.shared.model.checkout\ZMShippingProvider
model\checkout\ZMShippingProvider.php at line 36

Interface ZMShippingProvider

ZMShippingProvider

public interface ZMShippingProvider

A shipping provider.

A shipping provider may offer 1-n shipping methods, depending on the address, or other shipping conditions.

Author:
DerManoMann

Method Summary
array

getErrors()

Get the errors.

string

getIcon()

Get the icon.

int

getId()

Get the shipping provider id.

string

getName()

Get the shipping provider name.

ZMShippingMethod

getShippingMethodForId(string id, ZMShoppingCart shoppingCart, ZMAddress address)

Get a specific shipping method for the given address.

array

getShippingMethods(ZMShoppingCart shoppingCart, ZMAddress address)

Get available shipping methods for the given address.

boolean

hasErrors()

Checks if errors are logged for this provider.

boolean

hasIcon()

Checks if an icon exists for this provider.

boolean

isInstalled()

Flags whether this shipping provider is installed or not.

Method Detail

model\checkout\ZMShippingProvider.php at line 85

getErrors

public array getErrors()

Get the errors.

Returns:
List of error messages.

model\checkout\ZMShippingProvider.php at line 64

getIcon

public string getIcon()

Get the icon.

Returns:
The icon.

model\checkout\ZMShippingProvider.php at line 43

getId

public int getId()

Get the shipping provider id.

Returns:
The shipping provider id.

model\checkout\ZMShippingProvider.php at line 50

getName

public string getName()

Get the shipping provider name.

Returns:
The shipping provider name.

model\checkout\ZMShippingProvider.php at line 95

getShippingMethodForId

public ZMShippingMethod getShippingMethodForId(string id, ZMShoppingCart shoppingCart, ZMAddress address)

Get a specific shipping method for the given address.

Parameters:
id - The method id.
shoppingCart - The shopping cart.
address - The shipping address.
Returns:
A shipping method or null.

model\checkout\ZMShippingProvider.php at line 104

getShippingMethods

public array getShippingMethods(ZMShoppingCart shoppingCart, ZMAddress address)

Get available shipping methods for the given address.

Parameters:
shoppingCart - The shopping cart.
address - The shipping address.
Returns:
A list of ZMShippingMethod instances.

model\checkout\ZMShippingProvider.php at line 78

hasErrors

public boolean hasErrors()

Checks if errors are logged for this provider.

Returns:
true if errors exist, false if not.

model\checkout\ZMShippingProvider.php at line 57

hasIcon

public boolean hasIcon()

Checks if an icon exists for this provider.

Returns:
true if an icon, false if not.

model\checkout\ZMShippingProvider.php at line 71

isInstalled

public boolean isInstalled()

Flags whether this shipping provider is installed or not.

Returns:
true if installed, false if not.

ZenMagick 0.9.10