WC_Shipping_Shipcloud
extends WC_Shipping_Method
in package
Table of Contents
- $allowed_carriers : array<string|int, mixed>
- Allowed Carriers
- $allowed_carriers_options : array<string|int, mixed>
- Allowed carriers select options
- $api : WC_Shipping_Shipcloud_API_Adapter
- API Adapter
- $calculated_parcels : array<string|int, mixed>
- All Parcels which have been requested at shipcloud for later usage
- $carriers : array<string|int, mixed>
- Loaded Carriers
- $carriers_options : array<string|int, mixed>
- Carriers select options
- $options : array<string|int, mixed>
- Loaded Options
- $recipient : array<string|int, mixed>
- Recipient data
- $sender : array<string|int, mixed>
- Sender data
- __construct() : void
- Constructor.
- add_calculate_shipping_fields() : void
- Setting Address field after submiting
- add_calculate_shipping_form_fields() : bool
- Adding form field for Address Field and enabling City field
- admin_options() : void
- This method is called just before the settings are displayed.
- calculate_shipping() : void
- Calculate shipping costs.
- clear_transients() : void
- Clear Template transients.
- generate_hidden_html() : string
- Generate hidden HTML.
- generate_multiselect_html() : string
- Generate multi-select HTML.
- get_allowed_carriers() : array<string|int, mixed>
- Getting allowed carriers
- get_carriers() : array<string|int, mixed>
- Getting carriers
- get_instance_form_fields() : array<string|int, mixed>
- Get settings fields for instances of this shipping method (within zones).
- get_option() : mixed|string
- Getting option (overwrite instance values if there option of instance is empty
- init_form_fields() : void
- Set form fields.
- is_available() : bool
- Checks whether shipping method is available or not.
- process_admin_options() : void
- This method is called once settings are saved.
- add_admin_notice() : void
- Output an admin notice.
- check_webhook_preconditions() : void
- Check if webhook woocommerce api is enabled when shipcloud webhook should be used
- environment_check() : void
- Environment check.
- get_carrier_options() : array<string|int, mixed>
- Extract carrier options for multiselect list.
- get_parcel_dimensions() : array<string|int, mixed>
- Getting dimensions for each parcel
- get_product_dimensions() : array<string|int, mixed>
- Getting product dimensions
- get_recipient() : array<string|int, mixed>
- Getting recipient address from package
- get_sender() : array<string|int, mixed>
- Getting sender address
- get_shipping_class_dimensions() : array<string|int, mixed>|null
- Getting shipping class dimensions
- get_shipping_classes() : array<string|int, mixed>
- Getting shipping classes for order package
- get_shipping_costs() : float
- Calculate the costs for parcel shipping.
- init() : void
- Initialization.
- log() : void
- Output a debug message.
- set_settings() : bool
- Initialize settings is called on init and after saving plugin settings.
Properties
$allowed_carriers
Allowed Carriers
private
array<string|int, mixed>
$allowed_carriers
$allowed_carriers_options
Allowed carriers select options
private
array<string|int, mixed>
$allowed_carriers_options
$api
API Adapter
private
WC_Shipping_Shipcloud_API_Adapter
$api
$calculated_parcels
All Parcels which have been requested at shipcloud for later usage
private
array<string|int, mixed>
$calculated_parcels
= []
$carriers
Loaded Carriers
private
array<string|int, mixed>
$carriers
$carriers_options
Carriers select options
private
array<string|int, mixed>
$carriers_options
$options
Loaded Options
private
array<string|int, mixed>
$options
$recipient
Recipient data
private
array<string|int, mixed>
$recipient
= []
$sender
Sender data
private
array<string|int, mixed>
$sender
= []
Methods
__construct()
Constructor.
public
__construct(int $instance_id) : void
Parameters
- $instance_id : int
-
Instance ID.
Return values
void —add_calculate_shipping_fields()
Setting Address field after submiting
public
add_calculate_shipping_fields() : void
Return values
void —add_calculate_shipping_form_fields()
Adding form field for Address Field and enabling City field
public
add_calculate_shipping_form_fields(bool $wc_shipping_calculator_enable_city) : bool
Parameters
- $wc_shipping_calculator_enable_city : bool
Return values
bool —admin_options()
This method is called just before the settings are displayed.
public
admin_options() : void
Return values
void —calculate_shipping()
Calculate shipping costs.
public
calculate_shipping([array<string|int, mixed> $package = [] ]) : void
Parameters
- $package : array<string|int, mixed> = []
-
Package to ship.
Return values
void —clear_transients()
Clear Template transients.
public
clear_transients() : void
Return values
void —generate_hidden_html()
Generate hidden HTML.
public
generate_hidden_html(string $key, array<string|int, mixed> $data) : string
Parameters
- $key : string
-
Field key.
- $data : array<string|int, mixed>
-
Field data.
Return values
string —generate_multiselect_html()
Generate multi-select HTML.
public
generate_multiselect_html(string $key, array<string|int, mixed> $data) : string
Parameters
- $key : string
-
Field key.
- $data : array<string|int, mixed>
-
Field data.
Return values
string —get_allowed_carriers()
Getting allowed carriers
public
get_allowed_carriers() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_carriers()
Getting carriers
public
get_carriers() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_instance_form_fields()
Get settings fields for instances of this shipping method (within zones).
public
get_instance_form_fields() : array<string|int, mixed>
Should be overridden by shipping methods to add options.
Return values
array<string|int, mixed> —get_option()
Getting option (overwrite instance values if there option of instance is empty
public
get_option(string $key[, null $empty_value = null ]) : mixed|string
Parameters
- $key : string
- $empty_value : null = null
Return values
mixed|string —init_form_fields()
Set form fields.
public
init_form_fields() : void
Return values
void —is_available()
Checks whether shipping method is available or not.
public
is_available(array<string|int, mixed> $package) : bool
Parameters
- $package : array<string|int, mixed>
-
Package to ship.
Return values
bool —True if shipping method is available.
process_admin_options()
This method is called once settings are saved.
public
process_admin_options() : void
Return values
void —add_admin_notice()
Output an admin notice.
private
add_admin_notice(string $message[, string $type = 'info' ][, bool $dismissible = true ]) : void
Parameters
- $message : string
-
Debug message.
- $type : string = 'info'
-
Message type.
- $dismissible : bool = true
-
Message type.
Return values
void —check_webhook_preconditions()
Check if webhook woocommerce api is enabled when shipcloud webhook should be used
private
check_webhook_preconditions() : void
Return values
void —environment_check()
Environment check.
private
environment_check() : void
Return values
void —get_carrier_options()
Extract carrier options for multiselect list.
private
get_carrier_options(array<string|int, mixed> $carriers[, bool $only_allowed = false ][, bool $grouped = false ]) : array<string|int, mixed>
Parameters
- $carriers : array<string|int, mixed>
- $only_allowed : bool = false
- $grouped : bool = false
Return values
array<string|int, mixed> —get_parcel_dimensions()
Getting dimensions for each parcel
private
get_parcel_dimensions(mixed $package) : array<string|int, mixed>
Parameters
- $package : mixed
Return values
array<string|int, mixed> —$parcels
get_product_dimensions()
Getting product dimensions
private
get_product_dimensions( $product) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —get_recipient()
Getting recipient address from package
private
get_recipient( $package) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —get_sender()
Getting sender address
private
get_sender() : array<string|int, mixed>
Return values
array<string|int, mixed> —$sender
get_shipping_class_dimensions()
Getting shipping class dimensions
private
get_shipping_class_dimensions( $shipping_class) : array<string|int, mixed>|null
Parameters
Return values
array<string|int, mixed>|null —get_shipping_classes()
Getting shipping classes for order package
private
get_shipping_classes( $package) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —$shipping_classes
get_shipping_costs()
Calculate the costs for parcel shipping.
private
get_shipping_costs( $parcel_dimensions) : float
Parameters
Return values
float —init()
Initialization.
private
init() : void
Return values
void —log()
Output a debug message.
private
log(string $message[, string $level = 'info' ][, mixed $context = [] ]) : void
Parameters
- $message : string
-
Debug message.
- $level : string = 'info'
-
Debug level.
- $context : mixed = []
-
The Debug context.
Return values
void —set_settings()
Initialize settings is called on init and after saving plugin settings.
private
set_settings() : bool