Services

Type
Trait
Namespace
craft\commerce\plugin
Implemented by
craft\commerce\Plugin
Since
2.0

Trait Services

View source

Public Methods

MethodDescription
getAddresses()Returns the address service
getCarts()Returns the cart service
getCountries()Returns the countries service
getCurrencies()Returns the currencies service
getCustomers()Returns the customers service
getDiscounts()Returns the discounts service
getEmails()Returns the emails service
getGateways()Returns the gateways service
getLineItems()Returns the lineItems service
getOrderAdjustments()Returns the orderAdjustments service
getOrderHistories()Returns the orderHistories service
getOrderSettings()Returns the orderSettings service
getOrderStatuses()Returns the orderStatuses service
getOrders()Returns the orders service
getPaymentCurrencies()Returns the paymentCurrencies service
getPaymentSources()Returns the payment sources service
getPayments()Returns the payments service
getPdf()Returns the PDF service
getPlans()Returns the payment sources service
getProductTypes()Returns the productTypes service
getProducts()Returns the products service
getPurchasables()Returns the purchasables service
getReports()Returns the reporting service
getSales()Returns the sales service
getShippingCategories()Returns the shippingCategories service
getShippingMethods()Returns the shippingMethods service
getShippingRuleCategories()Returns the shippingRules service
getShippingRules()Returns the shippingRules service
getShippingZones()Returns the shippingZones service
getStates()Returns the states service
getSubscriptions()Returns the subscriptions service
getTaxCategories()Returns the taxCategories service
getTaxRates()Returns the taxRates service
getTaxZones()Returns the taxZones service
getTransactions()Returns the transactions service
getVariants()Returns the variants service

getAddresses()

Returns the address service

View source

Returns

craft\commerce\services\Addresses – The address service

Signature

public craft\commerce\services\Addresses getAddresses ( )

getCarts()

Returns the cart service

View source

Returns

craft\commerce\services\Carts – The cart service

Signature

public craft\commerce\services\Carts getCarts ( )

getCountries()

Returns the countries service

View source

Returns

craft\commerce\services\Countries – The countries service

Signature

public craft\commerce\services\Countries getCountries ( )

getCurrencies()

Returns the currencies service

View source

Returns

craft\commerce\services\Currencies – The currencies service

Signature

public craft\commerce\services\Currencies getCurrencies ( )

getCustomers()

Returns the customers service

View source

Returns

craft\commerce\services\Customers – The customers service

Signature

public craft\commerce\services\Customers getCustomers ( )

getDiscounts()

Returns the discounts service

View source

Returns

craft\commerce\services\Discounts – The discounts service

Signature

public craft\commerce\services\Discounts getDiscounts ( )

getEmails()

Returns the emails service

View source

Returns

craft\commerce\services\Emails – The emails service

Signature

public craft\commerce\services\Emails getEmails ( )

getGateways()

Returns the gateways service

View source

Returns

craft\commerce\services\Gateways – The gateways service

Signature

public craft\commerce\services\Gateways getGateways ( )

getLineItems()

Returns the lineItems service

View source

Returns

craft\commerce\services\LineItems – The lineItems service

Signature

public craft\commerce\services\LineItems getLineItems ( )

getOrderAdjustments()

Returns the orderAdjustments service

View source

Returns

craft\commerce\services\OrderAdjustments – The orderAdjustments service

Signature

public craft\commerce\services\OrderAdjustments getOrderAdjustments ( )

getOrderHistories()

Returns the orderHistories service

View source

Returns

craft\commerce\services\OrderHistories – The orderHistories service

Signature

public craft\commerce\services\OrderHistories getOrderHistories ( )

getOrderSettings()

Returns the orderSettings service

View source

Returns

craft\commerce\services\OrderSettings – The orderSettings service

Signature

public craft\commerce\services\OrderSettings getOrderSettings ( )

getOrderStatuses()

Returns the orderStatuses service

View source

Returns

craft\commerce\services\OrderStatuses – The orderStatuses service

Signature

public craft\commerce\services\OrderStatuses getOrderStatuses ( )

getOrders()

Returns the orders service

View source

Returns

craft\commerce\services\Orders – The orders service

Signature

public craft\commerce\services\Orders getOrders ( )

getPaymentCurrencies()

Returns the paymentCurrencies service

View source

Returns

craft\commerce\services\PaymentCurrencies – The paymentCurrencies service

Signature

public craft\commerce\services\PaymentCurrencies getPaymentCurrencies ( )

getPaymentSources()

Returns the payment sources service

View source

Returns

craft\commerce\services\PaymentSources – The payment sources service

Signature

public craft\commerce\services\PaymentSources getPaymentSources ( )

getPayments()

Returns the payments service

View source

Returns

craft\commerce\services\Payments – The payments service

Signature

public craft\commerce\services\Payments getPayments ( )

getPdf()

Returns the PDF service

View source

Returns

craft\commerce\services\Pdf – The PDF service

Signature

public craft\commerce\services\Pdf getPdf ( )

getPlans()

Returns the payment sources service

View source

Returns

craft\commerce\services\Plans – The subscription plans service

Signature

public craft\commerce\services\Plans getPlans ( )

getProductTypes()

Returns the productTypes service

View source

Returns

craft\commerce\services\ProductTypes – The productTypes service

Signature

public craft\commerce\services\ProductTypes getProductTypes ( )

getProducts()

Returns the products service

View source

Returns

craft\commerce\services\Products – The products service

Signature

public craft\commerce\services\Products getProducts ( )

getPurchasables()

Returns the purchasables service

View source

Returns

craft\commerce\services\Purchasables – The purchasables service

Signature

public craft\commerce\services\Purchasables getPurchasables ( )

getReports()

Returns the reporting service

View source

Returns

craft\commerce\services\Reports – The reports service

Signature

public craft\commerce\services\Reports getReports ( )

getSales()

Returns the sales service

View source

Returns

craft\commerce\services\Sales – The sales service

Signature

public craft\commerce\services\Sales getSales ( )

getShippingCategories()

Returns the shippingCategories service

View source

Returns

craft\commerce\services\ShippingCategories – The shippingCategories service

Signature

public craft\commerce\services\ShippingCategories getShippingCategories ( )

getShippingMethods()

Returns the shippingMethods service

View source

Returns

craft\commerce\services\ShippingMethods – The shippingMethods service

Signature

public craft\commerce\services\ShippingMethods getShippingMethods ( )

getShippingRuleCategories()

Returns the shippingRules service

View source

Returns

craft\commerce\services\ShippingRuleCategories – The shippingRuleCategories service

Signature

public craft\commerce\services\ShippingRuleCategories getShippingRuleCategories ( )

getShippingRules()

Returns the shippingRules service

View source

Returns

craft\commerce\services\ShippingRules – The shippingRules service

Signature

public craft\commerce\services\ShippingRules getShippingRules ( )

getShippingZones()

Returns the shippingZones service

View source

Returns

craft\commerce\services\ShippingZones – The shippingZones service

Signature

public craft\commerce\services\ShippingZones getShippingZones ( )

getStates()

Returns the states service

View source

Returns

craft\commerce\services\States – The states service

Signature

public craft\commerce\services\States getStates ( )

getSubscriptions()

Returns the subscriptions service

View source

Returns

craft\commerce\services\Subscriptions – The subscriptions service

Signature

public craft\commerce\services\Subscriptions getSubscriptions ( )

getTaxCategories()

Returns the taxCategories service

View source

Returns

craft\commerce\services\TaxCategories – The taxCategories service

Signature

public craft\commerce\services\TaxCategories getTaxCategories ( )

getTaxRates()

Returns the taxRates service

View source

Returns

craft\commerce\services\TaxRates – The taxRates service

Signature

public craft\commerce\services\TaxRates getTaxRates ( )

getTaxZones()

Returns the taxZones service

View source

Returns

craft\commerce\services\TaxZones – The taxZones service

Signature

public craft\commerce\services\TaxZones getTaxZones ( )

getTransactions()

Returns the transactions service

View source

Returns

craft\commerce\services\Transactions – The transactions service

Signature

public craft\commerce\services\Transactions getTransactions ( )

getVariants()

Returns the variants service

View source

Returns

craft\commerce\services\Variants – The variants service

Signature

public craft\commerce\services\Variants getVariants ( )