1. class
  2. Cable8mm
  3. \
  4. Waybill
  5. \
  6. WaybillCollection

WaybillCollection

class WaybillCollection (View source)

Main entry point for creating new waybills

Methods

WaybillCollection
add(Waybill|array $waybill)

Adds a Waybill object to the container

WaybillCollection
path(string $path)

Setter for $path

array
toArray()

Export the waybills data to array or CSV

mixed
save(string $filename = 'waybills.pdf')

Save the waybills data to PDF

mixed
download(string $filename = 'waybills.pdf')

Download the waybills data to PDF

static WaybillCollection
of(Waybills|null $waybills = null, int $count = 1, Mpdf|null $mpdf = null)

Factory method to create an instance of WaybillCollection

static WaybillCollection
make(Waybills|null $waybills = null, int $count = 1)

Factory method to create an instance without mpdf of WaybillCollection

Details

at line 45
WaybillCollection add(Waybill|array $waybill)

Adds a Waybill object to the container

Parameters

Waybill|array $waybill

a Waybill object

Return Value

WaybillCollection

The method returns the instance

at line 60
WaybillCollection path(string $path)

Setter for $path

Parameters

string $path

The path to save the waybills

Return Value

WaybillCollection

The method returns self instance

Examples

$waybillCollection = WaybillCollection::of($waybill, 5)->path(realpath(__DIR__.'/../dist'))->...

at line 74
array toArray()

Export the waybills data to array or CSV

Return Value

array

The method returns the waybills data as array or CSV string

Examples

$waybillCollection = WaybillCollection::of($waybill, 5)->toArray();

at line 86
mixed save(string $filename = 'waybills.pdf')

Save the waybills data to PDF

Parameters

string $filename

A filename to create

Return Value

mixed

Examples

$waybillCollection = WaybillCollection::of($waybill, 5)->path(realpath(__DIR__.'/../dist'))->save('test.pdf');

at line 102
mixed download(string $filename = 'waybills.pdf')

Download the waybills data to PDF

Parameters

string $filename

A filename to create

Return Value

mixed

Examples

$waybillCollection = WaybillCollection::of($waybill, 5)->path(realpath(__DIR__.'/../dist'))->download('test.pdf');

at line 116
static WaybillCollection of(Waybills|null $waybills = null, int $count = 1, Mpdf|null $mpdf = null)

Factory method to create an instance of WaybillCollection

Parameters

Waybills|null $waybills
int $count
Mpdf|null $mpdf

Return Value

WaybillCollection

The method returns the WaybillCollection instance

Examples

WaybillCollection::of($waybill, 5, $mpdf)->...

at line 132
static WaybillCollection make(Waybills|null $waybills = null, int $count = 1)

Factory method to create an instance without mpdf of WaybillCollection

Parameters

Waybills|null $waybills
int $count

Return Value

WaybillCollection

The method returns the WaybillCollection instance

Examples

WaybillCollection::make($waybill, 5)->mpdf($mpdf)->...