Company
in package
Class Company
Provides functionality to manage and retrieve company data, including fetching, creating, and updating company records.
Table of Contents
Constants
- PRELIMINARY_COMPANY_VALUES = 'to be defined by client'
Properties
Methods
- __construct() : mixed
- createByAdmin() : void
- Create a company (admin).
- getAll() : array<int, array<string, mixed>>
- Get all companies by status.
- getByCode() : array<string, mixed>|null
- Get a company by its code.
- updateByCode() : void
- Update company by code (admin).
Constants
PRELIMINARY_COMPANY_VALUES
private
mixed
PRELIMINARY_COMPANY_VALUES
= 'to be defined by client'
Properties
$mySql
protected
MySql
$mySql
Methods
__construct()
public
__construct(MySql $mySql) : mixed
Parameters
- $mySql : MySql
createByAdmin()
Create a company (admin).
public
createByAdmin(array<string, mixed> $data) : void
Expects in $data:
- company_code (string, required)
- company_name (string, required)
- company_display (string, required)
- currency_code (string, required)
- status (int, required)
- sort_order (int|null)
- createdby (string, required)
- modifiedby (string, required)
- company_address (string|null)
- company_logo (string|null)
- company_business_description(string|null)
- company_vat (string|null)
- company_business_type (string|null)
- company_email (string|null)
- company_webpage (string|null)
- company_industry (string|null)
- company_founding_date (string|null|int)
Parameters
- $data : array<string, mixed>
getAll()
Get all companies by status.
public
getAll(array<string|int, int> $statuses) : array<int, array<string, mixed>>
Parameters
- $statuses : array<string|int, int>
Return values
array<int, array<string, mixed>>getByCode()
Get a company by its code.
public
getByCode(string $companyCode) : array<string, mixed>|null
Parameters
- $companyCode : string
Return values
array<string, mixed>|nullupdateByCode()
Update company by code (admin).
public
updateByCode(array<string, mixed> $data) : void
Expects in $data:
- company_code (string, required)
- company_name (string|null)
- company_display (string|null)
- currency_code (string|null)
- company_address (string|null)
- company_logo (string|null)
- company_business_description (string|null)
- company_vat (string|null)
- company_business_type (string|null)
- company_email (string|null)
- company_webpage (string|null)
- company_industry (string|null)
- company_founding_date (string|null|int)
- sort_order (int|null)
- status (int|null)
- modifiedby (string, required)
Parameters
- $data : array<string, mixed>