WC_Shipping_Shipcloud_Label_Form
in package
Table of Contents
- $allowed_carriers : array<string|int, mixed>
- $order : WC_Shipcloud_Order
- $shipcloud_api : Api
- $template_file : mixed
- __construct() : mixed
- Create new bulk view.
- dispatch() : mixed
- Send content to client.
- get_allowed_carriers() : array<string|int, Carrier>
- get_order() : WC_Shipcloud_Order
- get_shipcloud_api() : Api
- render() : string
- Pre-render content.
- email_notification_enabled() : mixed
- get_calculated_weight() : mixed
- get_description() : mixed
- get_email_for_notification() : mixed
- get_global_reference_number() : mixed
- get_shipping_method_name() : mixed
- get_template_file() : mixed
- get_wc_order() : mixed
- is_auto_weight_calculation_on() : mixed
- add_admin_notice() : void
- Output an admin notice.
- get_option() : mixed|string
- Getting option (overwrite instance values if there option of instance is empty
- log() : void
- Output a debug message.
Properties
$allowed_carriers
protected
array<string|int, mixed>
$allowed_carriers
$order
protected
WC_Shipcloud_Order
$order
$shipcloud_api
private
Api
$shipcloud_api
$template_file
private
mixed
$template_file
Methods
__construct()
Create new bulk view.
public
__construct(string $template_file, WC_Shipcloud_Order $order, array<string|int, Carrier> $allowed_carriers, Api $shipcloud_api) : mixed
Parameters
- $template_file : string
-
Path to the template.
- $order : WC_Shipcloud_Order
- $allowed_carriers : array<string|int, Carrier>
-
List of carriers that can be selected.
- $shipcloud_api : Api
-
Connection to the API.
Return values
mixed —dispatch()
Send content to client.
public
dispatch() : mixed
Return values
mixed —get_allowed_carriers()
public
get_allowed_carriers() : array<string|int, Carrier>
Return values
array<string|int, Carrier> —get_order()
public
get_order() : WC_Shipcloud_Order
Return values
WC_Shipcloud_Order —get_shipcloud_api()
public
get_shipcloud_api() : Api
Return values
Api —render()
Pre-render content.
public
render() : string
Return values
string —email_notification_enabled()
protected
email_notification_enabled() : mixed
Return values
mixed —get_calculated_weight()
protected
get_calculated_weight() : mixed
Return values
mixed —get_description()
protected
get_description() : mixed
Return values
mixed —get_email_for_notification()
protected
get_email_for_notification() : mixed
Return values
mixed —get_global_reference_number()
protected
get_global_reference_number() : mixed
Return values
mixed —get_shipping_method_name()
protected
get_shipping_method_name() : mixed
Return values
mixed —get_template_file()
protected
get_template_file() : mixed
Return values
mixed —get_wc_order()
protected
get_wc_order() : mixed
Return values
mixed —is_auto_weight_calculation_on()
protected
is_auto_weight_calculation_on() : mixed
Return values
mixed —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 —get_option()
Getting option (overwrite instance values if there option of instance is empty
private
get_option(string $key[, null $empty_value = null ]) : mixed|string
Parameters
- $key : string
- $empty_value : null = null
Return values
mixed|string —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.