shipcloud PHP Client

EventType extends Enum
in package

EventType enumeration class

Tags
category

Enum

author

Daniel Muenter info@msltns.com

version
0.0.1
since
0.0.1
license

GPL 3 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 3, as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

see
https://developers.shipcloud.io/concepts/#event-types

Table of Contents

ALL  = '*'
EXAMPLE_EVENT  = 'example.event'
SHIPMENT_ALL  = 'shipment.*'
SHIPMENT_STATUS_DELETED  = 'shipment.status.deleted'
SHIPMENT_TRACKING_ALL  = 'shipment.tracking.*'
SHIPMENT_TRACKING_AWAITS_PICKUP_BY_RECEIVER  = 'shipment.tracking.awaits_pickup_by_receiver'
SHIPMENT_TRACKING_CANCELED  = 'shipment.tracking.canceled'
SHIPMENT_TRACKING_DELAYED  = 'shipment.tracking.delayed'
SHIPMENT_TRACKING_DELIVERED  = 'shipment.tracking.delivered'
SHIPMENT_TRACKING_DESTROYED  = 'shipment.tracking.destroyed'
SHIPMENT_TRACKING_EXCEPTION  = 'shipment.tracking.exception'
SHIPMENT_TRACKING_LABEL_CREATED  = 'shipment.tracking.label_created'
SHIPMENT_TRACKING_NOT_DELIVERED  = 'shipment.tracking.not_delivered'
SHIPMENT_TRACKING_NOTIFICATION  = 'shipment.tracking.notification'
SHIPMENT_TRACKING_OUT_FOR_DELIVERY  = 'shipment.tracking.out_for_delivery'
SHIPMENT_TRACKING_PICKED_UP  = 'shipment.tracking.picked_up'
SHIPMENT_TRACKING_TRANSIT  = 'shipment.tracking.transit'
SHIPMENT_TRACKING_UNKNOWN  = 'shipment.tracking.unknown'
$constCacheArray  : mixed
get_class_name()  : string
Returns the name of the current instance.
get_name_by_value()  : mixed
is_valid_value()  : bool
Validates a given $enum_value against a given $enum_type.
to_string()  : string
For a given $enum_type, give the complete string representation for the given $enum_value (class::const)
__construct()  : void
Due to singleton pattern make sure there are never any instances created.

Constants

EXAMPLE_EVENT

public mixed EXAMPLE_EVENT = 'example.event'

SHIPMENT_ALL

public mixed SHIPMENT_ALL = 'shipment.*'

SHIPMENT_STATUS_DELETED

public mixed SHIPMENT_STATUS_DELETED = 'shipment.status.deleted'

SHIPMENT_TRACKING_ALL

public mixed SHIPMENT_TRACKING_ALL = 'shipment.tracking.*'

SHIPMENT_TRACKING_AWAITS_PICKUP_BY_RECEIVER

public mixed SHIPMENT_TRACKING_AWAITS_PICKUP_BY_RECEIVER = 'shipment.tracking.awaits_pickup_by_receiver'

SHIPMENT_TRACKING_CANCELED

public mixed SHIPMENT_TRACKING_CANCELED = 'shipment.tracking.canceled'

SHIPMENT_TRACKING_DELAYED

public mixed SHIPMENT_TRACKING_DELAYED = 'shipment.tracking.delayed'

SHIPMENT_TRACKING_DELIVERED

public mixed SHIPMENT_TRACKING_DELIVERED = 'shipment.tracking.delivered'

SHIPMENT_TRACKING_DESTROYED

public mixed SHIPMENT_TRACKING_DESTROYED = 'shipment.tracking.destroyed'

SHIPMENT_TRACKING_EXCEPTION

public mixed SHIPMENT_TRACKING_EXCEPTION = 'shipment.tracking.exception'

SHIPMENT_TRACKING_LABEL_CREATED

public mixed SHIPMENT_TRACKING_LABEL_CREATED = 'shipment.tracking.label_created'

SHIPMENT_TRACKING_NOT_DELIVERED

public mixed SHIPMENT_TRACKING_NOT_DELIVERED = 'shipment.tracking.not_delivered'

SHIPMENT_TRACKING_NOTIFICATION

public mixed SHIPMENT_TRACKING_NOTIFICATION = 'shipment.tracking.notification'

SHIPMENT_TRACKING_OUT_FOR_DELIVERY

public mixed SHIPMENT_TRACKING_OUT_FOR_DELIVERY = 'shipment.tracking.out_for_delivery'

SHIPMENT_TRACKING_PICKED_UP

public mixed SHIPMENT_TRACKING_PICKED_UP = 'shipment.tracking.picked_up'

SHIPMENT_TRACKING_TRANSIT

public mixed SHIPMENT_TRACKING_TRANSIT = 'shipment.tracking.transit'

SHIPMENT_TRACKING_UNKNOWN

public mixed SHIPMENT_TRACKING_UNKNOWN = 'shipment.tracking.unknown'

Properties

$constCacheArray

private static mixed $constCacheArray = NULL

Methods

get_class_name()

Returns the name of the current instance.

public static get_class_name() : string
Return values
string —

get_name_by_value()

public static get_name_by_value(mixed $enum_type, mixed $enum_value) : mixed
Parameters
$enum_type : mixed
$enum_value : mixed
Return values
mixed —

is_valid_value()

Validates a given $enum_value against a given $enum_type.

public static is_valid_value(string $enum_type, string $enum_value) : bool
Parameters
$enum_type : string
$enum_value : string
Return values
bool —

to_string()

For a given $enum_type, give the complete string representation for the given $enum_value (class::const)

public static to_string(string $enum_type, string $enum_value) : string
Parameters
$enum_type : string
$enum_value : string
Return values
string —

__construct()

Due to singleton pattern make sure there are never any instances created.

private final __construct() : void
Return values
void —

Search results