Advanced Shipping by Owebia

Global Variables

These variables are global variables and can be accessed everywhere (use the global keyword when you are inside a function).

The request object (\Magento\Quote\Model\Quote\Address\RateRequest) given by Magento:

• $request->all_items: array of items in cart
• The source address:
  • $request->country_id *
  • $request->region_id
  • $request->city
  • $request->postcode
• The destination address:
  • $request->dest_country_id *
  • $request->dest_region_id
  • $request->dest_region_code
  • $request->dest_street (known issue with Magento CE < 2.1.8)
  • $request->dest_city (known issue with Magento CE < 2.1.8)
  • $request->dest_postcode
• The package:
  • $request->package_value: value of the package
  • $request->package_value_with_discount: value of the package with discount
  • $request->package_weight: weight of the package
  • $request->package_qty: number of products in the package
• Other attributes:
  • $request->free_shipping: free shipping calculated by Magento rules
  • $request->*: property of the request object

The quote (\Magento\Quote\Model\Quote): (known issue #2, known issue #3):

• $quote->subtotal: subtotal (excluding tax)
• $quote->subtotal_with_discount: subtotal (excluding tax) with discount
• $quote->grand_total: total (including tax) with discount (known issues #3, you should avoid using this value)
• $quote->base_subtotal: subtotal (excluding tax) in base currency
• $quote->base_subtotal_with_discount: subtotal (excluding tax) with discount in base currency
• $quote->base_grand_total: total (including tax) with discount in base currency (known issues #3, you should avoid using this value)
• $quote->coupon_code: the coupon code used in cart
• $quote->*: property of the quote (e.g. $quote->subtotal)

The customer group (\Magento\Customer\Model\Group):

• $customer_group->id: alias of $customer_group->customer_group_id
• $customer_group->code: alias of $customer_group->customer_group_code
• $customer_group->name: alias of $customer_group->customer_group_code
• $customer_group->*: property of the customer group (e.g. $customer_group->tax_class_id)

The customer (\Magento\Customer\Model\Customer):

• $customer->id: alias of $customer->entity_id
• $customer->*: attribute of the customer (e.g. email, lastname, firstname, group_id…)
• $customer->getCustomAttribute('my_custom_attribute')->value: custom attribute of the customer (where 'my_custom_attribute' should be replaced by custom attribute's code)

Custom variables (\Magento\Variable\Model\Variable, examples):

• $variable->*: custom variable defined in Magento
  e.g. with $variable->my_var:
  • $variable->my_var->plain_value
  • $variable->my_var->html_value
  • $variable->my_var->code
  • $variable->my_var->name

The store (\Magento\Store\Model\Store):

• $store->id, $store->code, $store->name, $store->address, $store->phone

The app (see \Magento\Framework\App\State):

• $app->area_code
• $app->isAdminArea() (area_code == 'adminhtml')
• $app->isFrontendArea() (area_code == 'webapi_rest')

* Magento apparently uses the ISO 3166-1 alpha-2 codes.
Note that the country code for United Kingdom is GB and not UK.

Accessing Items

You can use $request->all_items with array functions.

The item (\Magento\Quote\Model\Quote\Item)

• $item->qty
  quantity of the item
• $item->weight
  weight of the item
• $item->base_original_price
  price excluding tax without discount
• $item->price_incl_tax
  price including tax without discount
• $item->options->*
  option (the available options depend on the product)

The product (\Magento\Catalog\Model\Product)

• $item->product->*
  • sku
  • name
  • weight
  • price (as defined in Magento backoffice)
  • special_price: (as defined in Magento backoffice)
  • tax_class_id: the taxclass id
  • getAttributeText('tax_class_id'): the tax class name
    To get the text value of an attribute of type select, use getAttributeText('attribute_code')
  • getSourceItems(): returns an array of \Magento\InventoryApi\Api\Data\SourceItemInterface to handle Inventory Management (Magento ≥ 2.3)
    Source item: (\Magento\InventoryApi\Api\Data\SourceItemInterface)
    • $sourceItem->*: attribute of the source item
      
      • source_code: the code of the inventory source
      • quantity: the quantity of the product in the inventory source
      • …
  • …
• Categories of the product: (\Magento\Catalog\Model\Category)
  • $item->product->category->*
  • attribute of the first category
    
    • id
    • name
    • is_active
    • …
• All product categories (returns an array, examples)
  • $item->product->category_ids
    array of id of the categories
• The attribute set (\Magento\Eav\Model\Entity\Attribute\Set)
  • $item->product->attribute_set
    the attribute set
  • $item->product->attribute_set->*
    attribute of the attribute set
    

    • id
    • attribute_set_name
    • …
• The stock item (\Magento\CatalogInventory\Model\Stock\Item)
  • $item->product->stock_item->*
    attribute of the product stock
    

    • is_in_stock
    • qty
    • …

Core Functions

• __ (
string $string_to_translate
) : string

  Translates the input string, see example (known issue #4)

• addMethod (
string $method_id ,
array $method_properties
) : object

  Adds a new shipping method

• addError (
string $message
) : object

  Adds an error, see example

• getMethods (
[ bool $only_enabled = false ]
) : array

  Gets an array of defined shipping methods, if $only_enabled is true, only enabled methods will be returned, see example

Native Functions Allowed

Look at the PHP documentation if you want to know how to use these functions.

Functions Available with Functions Add-On

• _country (
string $country_id1
[, string $... ]
) : bool

  Returns true if the destination country matches one of the given country IDs, see examples

• _postcode (
string $postcode_or_pattern1
[, mixed $... ]
) : bool

  Returns true if the destination postcode matches one of the given postcodes or regular expression patterns, see examples

• _customerGroup (
mixed $customer_group_id_or_name1
[, mixed $... ]
) : bool

  Returns true if the customer group matches one of the given ids or names, see examples

• _sum (
mixed $value1
[, mixed $... ]
) : mixed

  Returns the sum of the given values, see examples

• _min (
mixed $value1
[, mixed $... ]
) : mixed

  Returns the minimum of the given values, see examples

• _max (
mixed $value1
[, mixed $... ]
) : mixed

  Returns the maximum of the given values, see examples

• _count (
callable $callback
) : int

  Returns the number of matching items using a callback function, see examples

• _anyCat (
object $item ,
int $category_id1
[, int $... ]
) : bool

  Returns true if the item belongs to one of the given categories, see examples

• _allCat (
object $item ,
int $category_id1
[, int $... ]
) : bool

  Returns true if the item belongs to all given categories, see examples

• _table (
array $table
[, string $attribute_name = 'package_weight'
[, bool $include_upper_limit = true ]]
) : mixed

  Returns true if the item belongs to all given categories, see examples

• _setStopAtFirstMatch (
bool $stop_at_first_match
) : void
  Sets option to stop adding methods at first match (must be used at the beginning of the configuration)

France Excluding DOM/TOM

Defining a Table

Using an Associative Table

Count Items

Get Minimum Value, Get Maximum Value

Sum

Access New Customer Data (e.g. VAT ID)

Known issue with Magento CE < 2.1.8.

Using Custom Customer Attribute

In the following example, my_custom_attribute is a custom customer attribute created by a custom extension.

Display Error When No Method Is Available

Add this at the end of your configuration:

Display Method Description in Frontend

Read Magento DevDocs to understand how to override a template.

Display Custom Method Data in Frontend

Read Magento DevDocs to understand how to override a template.