Documentation

Inventory
in package

Class SaveInventory.

Table of Contents

$errors  : array<string|int, mixed>
$inventory  : array<string|int, mixed>
$moduleName  : string
$parentRecordModel  : Vtiger_Record_Model
$permissionType  : int
$priceBookId  : int|null
$products  : array<string|int, mixed>
$seq  : int
$storage  : int
$fieldMapping  : array<string|int, mixed>|null
__construct()  : mixed
Construct.
getErrors()  : array<string|int, mixed>
Get errors.
getInventoryData()  : array<string|int, mixed>
Get inventory data.
getInventoryFromRecord()  : array<string|int, mixed>
Get Inventory from record.
validate()  : bool
Validate inventory.
getFieldMapping()  : array<string|int, mixed>
Get field mapping.
getInventoryCurrency()  : int
Get currency.
getInventorySeq()  : int
Returns sequence.
getInventoryTaxmode()  : mixed
getValue()  : mixed
Get the value for the column. Return null if it does not apply to this column.
getProductsByInventory()  : mixed
Get products by inventory.

Properties

$errors

protected array<string|int, mixed> $errors = []

Arrays with errors.

$inventory

protected array<string|int, mixed> $inventory

Inventory items passed from request.

$moduleName

protected string $moduleName

Module name.

$permissionType

protected int $permissionType

Permission type.

$priceBookId

protected int|null $priceBookId

Price book id.

$products

protected array<string|int, mixed> $products = []

Products

$fieldMapping

private array<string|int, mixed>|null $fieldMapping

Field mapping.

Methods

__construct()

Construct.

public __construct(string $moduleName, BaseAction $actionModel) : mixed
Parameters
$moduleName : string
$actionModel : BaseAction
Return values
mixed

getErrors()

Get errors.

public getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>

getInventoryData()

Get inventory data.

public getInventoryData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getInventoryFromRecord()

Get Inventory from record.

public getInventoryFromRecord(int $recordId, string $moduleName) : array<string|int, mixed>
Parameters
$recordId : int
$moduleName : string
Return values
array<string|int, mixed>

validate()

Validate inventory.

public validate() : bool
Return values
bool

getFieldMapping()

Get field mapping.

protected getFieldMapping() : array<string|int, mixed>
Return values
array<string|int, mixed>

getInventoryCurrency()

Get currency.

protected getInventoryCurrency(int $inventoryKey) : int
Parameters
$inventoryKey : int
Return values
int

getInventorySeq()

Returns sequence.

protected getInventorySeq(int $inventoryKey) : int
Parameters
$inventoryKey : int
Return values
int

getInventoryTaxmode()

protected getInventoryTaxmode(int $inventoryKey) : mixed
Parameters
$inventoryKey : int
Return values
mixed

getValue()

Get the value for the column. Return null if it does not apply to this column.

protected getValue(string $columnName, int $inventoryKey) : mixed
Parameters
$columnName : string
$inventoryKey : int
Return values
mixed

getProductsByInventory()

Get products by inventory.

private getProductsByInventory() : mixed
Return values
mixed

        

Search results