Documentation

CompanyDivision
in package

Class responsible for managing company divisions.

Table of Contents

Properties

$mySql  : MySql

Methods

__construct()  : mixed
create()  : array<string, mixed>|false
Create a division under a company (legacy/other use).
createByAdmin()  : void
Create a division (admin).
getAll()  : array<int, array<string, mixed>>
Get all active company divisions for given statuses.
getAllforCompany()  : array<int, array<string, mixed>>
Get all divisions for a company.
getByCode()  : array<string, mixed>
Get a division by code.
listCodesForCompany()  : array<int, string>
List division codes for a company.
suggestNextCode()  : array{prefix: string, pad: int, code: string}
Suggest next division code by prefix.
updateByCode()  : void
Update division by code (admin).
updateName()  : bool
Update division name/display by code.

Properties

Methods

create()

Create a division under a company (legacy/other use).

public create(string $companyCode, string $divisionCode, string $divisionName, string $display[, int $status = 1 ][, string $user = 'admin' ]) : array<string, mixed>|false
Parameters
$companyCode : string
$divisionCode : string
$divisionName : string
$display : string
$status : int = 1
$user : string = 'admin'
Return values
array<string, mixed>|false

createByAdmin()

Create a division (admin).

public createByAdmin(array<string, mixed> $data) : void

Expects in $data:

  • company_division_code (string, required)
  • company_division_name (string, required)
  • company_division_display (string, required)
  • company_code (string, required, FK by code)
  • sort_order (int|null)
  • status (int, required)
  • createdby (string, required)
  • modifiedby (string, required)
Parameters
$data : array<string, mixed>

getAll()

Get all active company divisions for given statuses.

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>>

getAllforCompany()

Get all divisions for a company.

public getAllforCompany(string $companyCode) : array<int, array<string, mixed>>
Parameters
$companyCode : string
Return values
array<int, array<string, mixed>>

getByCode()

Get a division by code.

public getByCode(string $divisionCode) : array<string, mixed>
Parameters
$divisionCode : string
Return values
array<string, mixed>

listCodesForCompany()

List division codes for a company.

public listCodesForCompany(string $companyCode) : array<int, string>
Parameters
$companyCode : string
Return values
array<int, string>

suggestNextCode()

Suggest next division code by prefix.

public suggestNextCode([string $prefix = 'CDI-' ][, int $pad = 6 ]) : array{prefix: string, pad: int, code: string}
Parameters
$prefix : string = 'CDI-'
$pad : int = 6
Return values
array{prefix: string, pad: int, code: string}

updateByCode()

Update division by code (admin).

public updateByCode(array<string, mixed> $data) : void

Expects in $data:

  • company_division_code (string, required)
  • company_division_name (string|null)
  • company_division_display (string|null)
  • company_code (string|null)
  • sort_order (int|null)
  • status (int|null)
  • modifiedby (string, required)
Parameters
$data : array<string, mixed>

updateName()

Update division name/display by code.

public updateName(array<string, mixed> $data) : bool
Parameters
$data : array<string, mixed>
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results