Documentation

Report extends BaseAction
in package

Report class.

Table of Contents

STATUSES  = [402 => 'PLL_FAILED', 403 => 'PLL_SENT', 404 => 'PLL_DELIVERED', 405 => 'PLL_FAILED', 406 => 'PLL_FAILED', 407 => 'PLL_FAILED', 408 => 'PLL_SENT', 410 => 'PLL_DELIVERED']
Get status for record by code.
$allowedHeaders  : array<string|int, mixed>
$allowedMethod  : mixed
{@inheritdoc}
$controller  : Controller
$responseType  : string
$moduleName  : string
$userData  : array<string|int, mixed>
checkAction()  : void
Check called action.
get()  : void
Update record status.
getLanguage()  : string
Get current language.
getParentCrmId()  : int|null
Get parent record.
getPermissionType()  : int
Get permission type.
getUserCrmId()  : int
Get crmid for portal user.
getUserData()  : mixed
Get user data and session data.
getUserStorageId()  : int
Get user storage ID.
post()  : void
Update record status.
preProcess()  : mixed
Pre process function.
setAllUserData()  : void
Set user data.
setUserData()  : void
Set user data.
updateSession()  : void
Update user session.
updateUser()  : void
Update user data.
checkLifetimeSession()  : void
Check lifetime user session.
checkPermission()  : void
Check permission to method.
checkPermissionToModule()  : void
{@inheritdoc}
loadSession()  : void
Load user session data .

Constants

STATUSES

Get status for record by code.

private mixed STATUSES = [402 => 'PLL_FAILED', 403 => 'PLL_SENT', 404 => 'PLL_DELIVERED', 405 => 'PLL_FAILED', 406 => 'PLL_FAILED', 407 => 'PLL_FAILED', 408 => 'PLL_SENT', 410 => 'PLL_DELIVERED']

Statuses from api: 402 => 'EXPIRED', 403 => 'SENT', 404 => 'DELIVERED', 405 => 'UNDELIVERED', 406 => 'FAILED', 407 => 'REJECTED', 408 => 'UNKNOWN', 409 => 'QUEUE', 410 => 'ACCEPTED', 411 => 'RENEWAL', 412 => 'STOP'.

Properties

$allowedHeaders

public array<string|int, mixed> $allowedHeaders = []

Allowed headers

$allowedMethod

{@inheritdoc}

public mixed $allowedMethod = ['GET', 'POST']

$responseType

public string $responseType = 'data'

Response data type.

$moduleName

private string $moduleName = 'SMSNotifier'

Module name

$userData

private array<string|int, mixed> $userData = []

User data

Methods

checkAction()

Check called action.

public checkAction() : void
Tags
throws
Exception
Return values
void —

get()

Update record status.

public get() : void
Tags
OA\Get

( path="/webservice/SMS/SMSAPI/Report", summary="Report for sms", tags={"SMSAPI"}, externalDocs={ "description" : "SMSApi Documentation", "url" : "https://www.smsapi.pl/docs" }, security={ {"ApiKeyAuth" : }, "token" : }} }, @OA\Response( response=200, description="Result", @OA\JsonContent(ref="#/components/schemas/SMS_SMSAPI_Get_Report") ), @OA\Response( response=401, description="No sent token OR Invalid token OR wrong data provided in the request", ), @OA\Response( response=403, description="No permissions for module", ), @OA\Response( response=405, description="Method Not Allowed", ), ),

OA\Schema

( schema="SMS_SMSAPI_Get_Report", title="Response", description="Response", type="string", example="OK" ),

Return values
void —

getLanguage()

Get current language.

public getLanguage() : string
Return values
string —

getParentCrmId()

Get parent record.

public getParentCrmId() : int|null
Tags
throws
Exception
Return values
int|null —

getPermissionType()

Get permission type.

public getPermissionType() : int
Return values
int —

getUserCrmId()

Get crmid for portal user.

public getUserCrmId() : int
Return values
int —

getUserData()

Get user data and session data.

public getUserData(string $key[, string $param = '' ]) : mixed
Parameters
$key : string
$param : string = ''
Return values
mixed —

getUserStorageId()

Get user storage ID.

public getUserStorageId() : int
Return values
int —

post()

Update record status.

public post() : void
Tags
OA\Post

( path="/webservice/SMS/SMSAPI/Report", summary="Report for sms", tags={"SMSAPI"}, externalDocs={ "description" : "SMSApi Documentation", "url" : "https://www.smsapi.pl/docs" }, security={ {"ApiKeyAuth" : }, "token" : }} }, @OA\Response( response=200, description="Result", @OA\JsonContent(ref="#/components/schemas/SMS_SMSAPI_Post_Report") ), @OA\Response( response=401, description="No sent token OR Invalid token OR wrong data provided in the request", ), @OA\Response( response=403, description="No permissions for module", ), @OA\Response( response=405, description="Method Not Allowed", ), ),

OA\Schema

( schema="SMS_SMSAPI_Post_Report", title="Response", description="Response", type="string", example="OK" ),

Return values
void —

preProcess()

Pre process function.

public preProcess() : mixed
Return values
mixed —

setAllUserData()

Set user data.

public setAllUserData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void —

setUserData()

Set user data.

public setUserData(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Return values
void —

updateSession()

Update user session.

public updateSession([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

updateUser()

Update user data.

public updateUser([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

checkLifetimeSession()

Check lifetime user session.

protected checkLifetimeSession() : void
Tags
throws
Exception
Return values
void —

checkPermission()

Check permission to method.

protected checkPermission() : void
Return values
void —

checkPermissionToModule()

{@inheritdoc}

protected checkPermissionToModule() : void
Return values
void —

loadSession()

Load user session data .

protected loadSession() : void
Tags
throws
Exception
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results