Arikaim CMS

DocumentNumber

Document number table trait

Change document number column protected $documentNumberColumn = 'column name'

Change document number label protected $documentNumberLabel = ' label '

Table of Contents

Properties

$DEFAULT_DOCUMENT_NUMBER_COLUMN  : string
Default document number column

Methods

bootDocumentNumber()  : void
Boot trait
getDocumentNumber()  : string|null
Get document number
getDocumentNumberUniqueIndex()  : string|null
Get document number unique index columns
getNextDocumentNumber()  : int
Get next document number
isValidDocumentNumber()  : bool
Return true if document number is valid
printDocumentNumber()  : string
Print doc number
printNextDocumentNumber()  : string
Print next document number

Properties

$DEFAULT_DOCUMENT_NUMBER_COLUMN

Default document number column

protected static string $DEFAULT_DOCUMENT_NUMBER_COLUMN = 'document_number'

Methods

bootDocumentNumber()

Boot trait

public static bootDocumentNumber() : void

getDocumentNumber()

Get document number

public getDocumentNumber([string $prefix = '' ]) : string|null
Parameters
$prefix : string = ''
Return values
string|null

getDocumentNumberUniqueIndex()

Get document number unique index columns

public getDocumentNumberUniqueIndex() : string|null
Return values
string|null

getNextDocumentNumber()

Get next document number

public getNextDocumentNumber([mixed|null $filterColumnValue = null ]) : int
Parameters
$filterColumnValue : mixed|null = null
Return values
int

isValidDocumentNumber()

Return true if document number is valid

public isValidDocumentNumber([int|null $documentNumber = null ][, mixed|null $filterColumnValue = null ]) : bool
Parameters
$documentNumber : int|null = null
$filterColumnValue : mixed|null = null
Return values
bool

printDocumentNumber()

Print doc number

public printDocumentNumber([int|null $number = null ][, string $prefix = '' ]) : string
Parameters
$number : int|null = null
$prefix : string = ''
Return values
string

printNextDocumentNumber()

Print next document number

public printNextDocumentNumber([string $prefix = '' ]) : string
Parameters
$prefix : string = ''
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results