Documentation

Contingency
in package

Table of Contents

Constants

SVRS  = 'SVRS'
SVSP  = 'SVSP'

Properties

$motive  : string
$timestamp  : int
$tpEmis  : int
$type  : string
$config  : stdClass

Methods

__construct()  : mixed
Constructor
__toString()  : string
Returns a json string format
activate()  : string
Create a object with contingency data
deactivate()  : string
Deactivate contingency mode
load()  : void
Load json string with contingency configurations
configBuild()  : stdClass
Build parameter config as stdClass

Constants

Properties

Methods

__construct()

Constructor

public __construct([string $contingency = '' ]) : mixed
Parameters
$contingency : string = ''

__toString()

Returns a json string format

public __toString() : string
Return values
string

activate()

Create a object with contingency data

public activate(string $acronym, string $motive[, string $type = '' ]) : string
Parameters
$acronym : string

Sigla do estado

$motive : string
$type : string = ''

Opcional parameter only used if FS-DA, EPEC or OFFLINE

Return values
string

deactivate()

Deactivate contingency mode

public deactivate() : string
Return values
string

load()

Load json string with contingency configurations

public load(string $contingency) : void
Parameters
$contingency : string

configBuild()

Build parameter config as stdClass

private configBuild(int $timestamp, string $motive, string $type) : stdClass
Parameters
$timestamp : int
$motive : string
$type : string
Return values
stdClass 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results