API Documentation
Back to top  

BinLocationCodeComponent

internal

Use the service pickware.erp.bin_location_code_generator_service to generate bin location code components instead.
package

Default

Methods

Takes the first component from the given array of components and parses it.

__construct(array $components)

If that component is a dynamic, letters component, the letteres are split up into several succeeding sub-components, where the first of these sub-components is used to create this linked component, while the other sub-components are prepended to the array of components. In any case, if any components remain in the array, a succeeding component is created using the array.

Arguments

$components

array

Creates all remaining bin locations using this component and any succeeding components. If a 'limit' greater zero is given, at most 'limit' locations are created. Note: Calling this method does not reset the state of this component. If you need to create all bin locations twice using the same BinLocationCodeComponent instance, you must call 'reset()' yourself before calling 'createBinLocationCodes' for a second time. This also means that calling 'createBinLocationCodes()' repeatedly on the same component never creates the same bin locations.

createCodes(integer $limit) : array

Arguments

$limit

integer

(optional)

Response

array

Calculates the number of values that can be generated by this component incl.

getNumberOfPossibleCodes() : integer

all succeeding components.

Response

integer

hasMoreCodes

hasMoreCodes() : boolean

Response

boolean