1. class
  2. Cable8mm
  3. \
  4. OrderSheet
  5. \
  6. OrderSheet

OrderSheet

class OrderSheet (View source)

Main entry point for creating new order sheets

Methods

OrderSheet
count(int $count)

Setter for $count

OrderSheet
state(array $state)

Setter for $state

OrderSheet
path(string $path)

Setter for $path

OrderSheet
header(bool $header = true)

Setter for $header

array
toArray()

Export the order sheet data to array or CSV

string
csv()

Export the order sheet data to CSV

void
xlsx(string $filename = 'order_sheet.xlsx')

Export the order sheet data to XLSX

string
__toString()

Magic method to convert the order sheet type to string

static OrderSheet
of(OrderSheetType $orderSheetType)

Factory method to create an instance of OrderSheet

Details

at line 55
OrderSheet count(int $count)

Setter for $count

Parameters

int $count

The number of rows in the order sheet

Return Value

OrderSheet

The method returns self instance

at line 68
OrderSheet state(array $state)

Setter for $state

Parameters

array $state

The state of the order sheet

Return Value

OrderSheet

The method returns self instance

at line 81
OrderSheet path(string $path)

Setter for $path

Parameters

string $path

The path to save the order sheet

Return Value

OrderSheet

The method returns self instance

at line 94
OrderSheet header(bool $header = true)

Setter for $header

Parameters

bool $header

Whether to include the header in the order sheet

Return Value

OrderSheet

The method returns self instance

at line 106
array toArray()

Export the order sheet data to array or CSV

Return Value

array

The method returns the order sheet data as array or CSV string

at line 122
string csv()

Export the order sheet data to CSV

Return Value

string

The method returns the order sheet data as CSV string

at line 135
void xlsx(string $filename = 'order_sheet.xlsx')

Export the order sheet data to XLSX

Parameters

string $filename

A filename to create

Return Value

void

at line 151
string __toString()

Magic method to convert the order sheet type to string

Return Value

string

The method returns the order sheet type as string

at line 162
static OrderSheet of(OrderSheetType $orderSheetType)

Factory method to create an instance of OrderSheet

Parameters

OrderSheetType $orderSheetType

The order sheet type

Return Value

OrderSheet

The method returns the OrderSheet instance