Read from the package's own PHP files at the commit be3a619754fa: its namespaces, classes, interfaces and enums, their public constants, properties and methods with their PHPDoc, and the options its factories take. Nothing of it is run.
OfflineGatewayFactoryclassNo carrier API: the shop hands the parcel over itself (its own courier, a counter at the post office) or keeps it for collection.
5 options
PickupActionclassThe shop's own counters (click & collect), as configured - wherever the customer is.
3 methods
ShippingActionclassNothing to book: the tracking number is the one the shop typed (option "tracking_number", from the post office's receipt), else the shipment's reference. No document - the shop writes the address itself.
3 methods
TrackingActionclassNo carrier to ask: the status is unknown - the shop says it in person, or follows the tracking link.
2 methods
Omnibus\Offline
OfflineGatewayFactory class
final class OfflineGatewayFactory extends GatewayFactory OfflineGatewayFactory.php:22
No carrier API: the shop hands the parcel over itself (its own courier, a counter at the post office) or keeps it for collection.
options: rates: [...] # Omnibus\Action\ConfiguredRatingAction tracking_url: 'https://www.laposte.fr/outils/suivre-vos-envois?code={number}' pickup_points: # click & collect - { id: shop, name: 'La boutique', street: ['1 rue ...'], postcode: '75001', city: Paris, country: FR, opening_hours: { 1: [['10:00', '19:00']] } }
Options
| Option | Default | |
|---|---|---|
tracking_url | null | |
pickup_points | [] | |
omnibus.action.shipping | static fn(Config $c) => new ShippingAction($c['tracking_url']) | |
omnibus.action.tracking | new TrackingAction() | |
omnibus.action.pickup | static fn(Config $c) => new PickupAction($c['pickup_points']) |
Omnibus\Offline\Action
PickupAction class
final class PickupAction implements ActionInterface PickupAction.php:12
The shop's own counters (click & collect), as configured - wherever the customer is.
PickupAction::__construct()
public function __construct(readonly array $points)PickupAction::supports()
public function supports(Request $request): boolPickupAction::execute()
public function execute(Request $request): voidShippingAction class
final class ShippingAction implements ActionInterface ShippingAction.php:15
Nothing to book: the tracking number is the one the shop typed (option "tracking_number", from the post office's receipt), else the shipment's reference. No document - the shop writes the address itself.
ShippingAction::__construct()
public function __construct(readonly ?string $trackingUrl = null)ShippingAction::supports()
public function supports(Request $request): boolShippingAction::execute()
public function execute(Request $request): voidTrackingAction class
final class TrackingAction implements ActionInterface TrackingAction.php:12
No carrier to ask: the status is unknown - the shop says it in person, or follows the tracking link.
TrackingAction::supports()
public function supports(Request $request): boolTrackingAction::execute()
public function execute(Request $request): void