Documentation

SkupinaFirem extends RW
in package

Application

Skupina Firem.

$actionsAvailable

Pole akcí které podporuje ta která evidence.


    public
        array<string|int, mixed>|null
    $actionsAvailable
     = null

$apiURL

URL of object data in AbraFlexi.


    public
        string|null
    $apiURL
     = null

url

$atomic

Transaction processing mode.


    public
        bool
    $atomic
     = false

$authSessionId

Session ID.


    public
        string|null
    $authSessionId
     = null

$autoload

Load whole record when id is given ?


    public
        bool
    $autoload
     = true

$chained

Chained Objects.


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

$codes

Used codes storage.


    public
        array<string|int, mixed>|null
    $codes
     = null

$company


    public
        string|null
    $company
     = null

$curl

Curl Handle.


    public
        null|resource
    $curl

$curlInfo

Informace o posledním HTTP requestu.


    public
        array<string|int, mixed>|null
    $curlInfo

$defaultHttpHeaders


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

Pole HTTP hlaviček odesílaných s každým požadavkem

$defaultUrlParams

Default additional request url parameters after question mark.


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

$dryRun

Dry Run mode indicator.


    public
        bool
    $dryRun
     = false

$evidence

Evidence užitá objektem.


    public
        string|null
    $evidence
     = 'skupina-firem'

$evidenceInfo

Detaily evidence užité objektem.


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

$filter


    public
        string|null
    $filter
     = null

filter query

$format

Default communication format.


    public
        string
    $format
     = 'json'

json|xml|...

$globalVersion

Number from @globalVersion.


    public
        int|null
    $globalVersion
     = null

$infoDir

Where to get JSON files with evidence structure etc.


    public
    static    string
    $infoDir
     = __DIR__ . '/../../static'

$lastCurlError

Informace o poslední HTTP chybě.


    public
        string|null
    $lastCurlError
     = null

$lastCurlResponse

Raw Content of last curl response.


    public
        string
    $lastCurlResponse

$lastInsertedID

Last Inserted ID.


    public
        int|null
    $lastInsertedID
     = null

$lastResponseCode

HTTP Response code of last request.


    public
        int|null
    $lastResponseCode
     = null

$lastResult

Last operation result data or message(s).


    public
        array<string|int, mixed>|null
    $lastResult
     = null

$libVersion

Version of AbraFlexi library.


    public
    static    string
    $libVersion
     = '2.20'

$myCreateColumn

Sloupeček obsahující datum vložení záznamu do shopu.


    public
        string
    $myCreateColumn
     = 'false'

$myLastModifiedColumn

Sloupeček obsahujici datum poslení modifikace záznamu do shopu.


    public
        string
    $myLastModifiedColumn
     = 'lastUpdate'

$nameColumn

Sloupeček s názvem.


    public
        string
    $nameColumn
     = 'nazev'

$nameSpace

Basic namespace for communication with AbraFlexi.


    public
        string
    $nameSpace
     = 'winstrom'

Jmený prostor datového bloku odpovědi

$nativeTypes

Convert server data to its native types ? eg. nubmers to integer You can disable it using setUp.


    public
        bool
    $nativeTypes
     = true

$offline

We Connect to server by default.


    public
        bool
    $offline
     = false

$password

REST API Password.


    public
        string|null
    $password
     = null

$postFields

Body data for next curl POST operation.


    public
        string|null
    $postFields
     = null

$prefix

Default Line Prefix.


    public
        string
    $prefix
     = '/c/'

$protoVersion

Communication protocol version used.


    public
        string
    $protoVersion
     = '1.0'

Verze použitého API

$refreshToken

Token obtained during login procedure.


    public
        string|null
    $refreshToken
     = null

$reportRecipient

Send Error500 Report to.


    public
        string
    $reportRecipient
     = 'podpora@abraflexi.eu'

email address

$responseFormat

requested response format.


    public
        string
    $responseFormat
     = 'json'

json|xml|...

$resultField

Data block in response field.


    public
        string
    $resultField
     = 'results'

$rowCount

Number from @rowCount in response.


    public
        int|null
    $rowCount
     = null

$throwException

Throw Exception in case of AbraFlexi error.


    public
        bool
    $throwException
     = true

$timeout

Override cURL timeout.


    public
        int|null
    $timeout
     = null

seconds

$url

[protocol://]Server[:port].


    public
        string|null
    $url
     = null

$urlParams

The List of known parameters was renamed to $urlParamsKnown.


    public
        array<string|int, mixed>
    $urlParams

$urlParamsKnown

Parmetry pro URL.


    public
        array<string|int, mixed>
    $urlParamsKnown
     = [
    'add-global-version' => ['type' => 'boolean', 'description' => 'The response will contain the global version number of the current export'],
    'add-row-count' => ['type' => 'boolean', 'description' => 'Adding Total Records to Output (Pagination)'],
    'as-gui' => ['type' => 'boolean', 'description' => 'Turns on functions that complement the GUI processing outputs'],
    'auth' => ['type' => 'string', 'description' => 'http: Forces login using HTTP authentication, for example, to change the default WUI login method. html: Force HTML form authentication. This can be useful to suppress automatic SSO authentication.'],
    'authSessionId' => ['type' => 'string', 'description' => 'Authentification Session ID'],
    'code-as-id' => ['type' => 'boolean', 'description' => 'If an object has unique code, it is also exported (except for the <code> element) as <id> code: ... </id>'],
    'code-in-response' => ['type' => 'boolean', 'description' => 'The response will contain not only ID and URL for each object, but also code.'],
    'delimeter' => ['type' => 'string', 'description' => 'Specifies the input / output file separator in CSV format.', 'example' => ';'],
    'detail' => ['type' => 'string', 'description' => 'Definition of the level of detail'],
    // See: https://www.abraflexi.eu/api/dokumentace/ref/detail-levels
    'dir' => ['type' => 'string', 'description' => 'Sorting direction.', 'example' => 'desc'],
    'dry-run' => ['type' => 'boolean', 'description' => 'Test run (dry-run)'],
    // See: https://www.abraflexi.eu/api/dokumentace/ref/dry-run/
    'encoding' => ['type' => 'string', 'description' => 'Specifies the encoding of the input / output file in CSV format.'],
    'export-settings' => ['type' => 'boolean', 'description' => 'Export one extra entry with current settings at the beginning'],
    'fail-on-warning' => ['type' => 'boolean', 'description' => 'If a warning occurs, do not save a record (Data Validation)'],
    'filter' => ['type' => 'string', 'description' => 'filter results by this param'],
    'format' => ['type' => 'string', 'description' => 'One of the compiled XSL transforms will be applied to the output XML.'],
    'idUcetniObdobi' => ['type' => 'string', 'description' => ''],
    // See: https://www.abraflexi.eu/api/dokumentace/ref/stavy-uctu/
    'includes' => ['type' => 'string', 'description' => 'Include related detail level object ', 'example' => 'faktura-vydana/stredisko'],
    'inDesktopApp' => ['type' => 'boolean', 'description' => 'Hide menu and navigation in html format'],
    // Note: Undocumented function (html only)
    'limit' => ['type' => 'integer', 'description' => 'number of requested results'],
    'mode' => ['type' => 'string', 'description' => 'Support for RubyOnRails', 'example' => 'ruby'],
    'no-ext-ids' => ['type' => 'boolean', 'description' => 'The answer will not contain external identifiers (performance optimization)'],
    'no-http-errors' => ['type' => 'boolean', 'description' => 'If a 4xx error occurs while processing a request, the server sends 200 OK anyway'],
    'no-ids' => ['type' => 'boolean', 'description' => 'The response will not contain any primary identifiers (performance optimization). It only affects the main records.'],
    'only-ext-ids' => ['type' => 'boolean', 'description' => 'The primary key will not be exported, the <id> elements will only contain the external ID. Similar no-ids, but also affects subevidencies.'],
    'order' => ['type' => 'string', 'description' => 'Sorting records', 'example' => 'nazev@A'],
    'relations' => ['type' => 'string', 'description' => 'Adding session data (see detail levels) A session overview can be obtained for each record (/ relations).'],
    'report-lang' => ['type' => 'string', 'description' => 'The language in which to print the output when exporting to PDF', 'example' => 'en'],
    'report-name' => ['type' => 'string', 'description' => 'The name of the printout when exporting to PDF', 'example' => 'invoice'],
    'report-sign' => ['type' => 'string', 'description' => 'Whether the PDF should be exported electronically signed'],
    'skupina-stitku' => ['type' => 'string', 'description' => 'Enables grouping of labels when exporting by group (multiple labels)'],
    'sort' => ['type' => 'string', 'description' => 'Sorting records for ExtJS'],
    'start' => ['type' => 'integer', 'description' => 'Pagination'],
    'stitky-as-ids' => ['type' => 'boolean', 'description' => 'Labels will be exported and imported not as a code list but as a list of numeric IDs'],
    'use-ext-id' => ['type' => 'boolean', 'description' => 'If the object contains an external ESHOP or MY ID, use it as a bind.'],
    'use-internal-id' => ['type' => 'boolean', 'description' => 'In addition to the ref and showAs for objects, it also supplies an internalId attribute that contains the internal record ID'],
    'xpath' => ['type' => 'string', 'description' => 'Apply XPATH to result', 'example' => '//winstrom/adresar/email/text()'],
]

$user

REST API Username.


    public
        string|null
    $user
     = null

$action


    protected
        string|null
    $action
     = null

$errors

Array of errors caused by last request.


    protected
        array<string|int, mixed>
    $errors
     = []

$ignoreNotFound

Save 404 results to log ?


    protected
        bool
    $ignoreNotFound
     = false

$responseStats

Last Request response stats.


    protected
        array<string|int, mixed>|null
    $responseStats
     = null

$columnsInfo

Columns Info for serveral evidencies.


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

$jsonDepth

JSON Decode depth limit.


    private
        int
    $jsonDepth
     = 20

$reports

List of Error500 reports sent.


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

$sourceId

Record Copy helper.


    private
        int|null
    $sourceId

__construct()

Class for read only interaction with AbraFlexi.


    public
                __construct([mixed $init = null ][, array<string, int|string|true> $options = [] ]) : mixed

Parameters

$init : mixed = null: default record id or initial data. See processInit()
$options : array<string, int|string|true> = []: Connection settings and other options override

Return values

mixed —

__destruct()

Disconnect CURL before pass away.


    public
                __destruct() : mixed

Return values

mixed —

__sleep()

Only Variables to keep.


    public
                __sleep() : array<string|int, mixed>

Return values

array<string|int, mixed> —

__toString()

Obtain record/object identificator code: or id: Vrací identifikátor objektu code: nebo id:


    public
                __toString() : string

Return values

string —

indentifikátor záznamu reprezentovaného objektem

__wakeup()

Reconnect After unserialization.


    public
                __wakeup() : void

Return values

void —

addArrayToBranch()

Add Data to evidence Branch Přidá data do větve.


    public
                addArrayToBranch(array<string|int, mixed> $data[, string $relationPath = 'polozkyDokladu' ][, bool $removeAll = false ]) : bool

Parameters

$data : array<string|int, mixed>: pole dat
$relationPath : string = 'polozkyDokladu': path evidence (relation) pro vkládaná data
$removeAll : bool = false

Return values

bool —

Operation success

addDefaultUrlParams()

Add Default Url params to given url if not overrided.


    public
                addDefaultUrlParams(string $urlRaw) : string

Parameters

$urlRaw : string

Return values

string —

url with default params added

addExternalID()

Add External ID to Current Record.


    public
                addExternalID(string $extId) : array<string|int, mixed>

Parameters

$extId : string: ext:whatever:123 or simplay whatever:123

Return values

array<string|int, mixed> —

Insert result

addObjectToBranch()

Vloží do větve data z objektu.


    public
                addObjectToBranch(RO $object[, bool $removeAll = false ]) : void

Parameters

$object : RO: objekt evidence
$removeAll : bool = false: flush older items

Return values

void —

arrayCleanUP()

Remove all @ items from array.


    public
            static    arrayCleanUP(array<string|int, mixed> $data) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed>: original data

Return values

array<string|int, mixed> —

data without @ columns

assignResultIDs()

Assign result IDs to its source objects.


    public
                assignResultIDs(array<string|int, mixed> $candidates) : void

Parameters

$candidates : array<string|int, mixed>: AbraFlexi insert IDs prepared by extractResultIDs()

Return values

void —

changeExternalID()

Change Value of external id identified by selector. Add new if not exists.


    public
                changeExternalID(string $selector, int|string $newValue[, int|string $forID = null ]) : array<string|int, mixed>

Parameters

$selector : string: ext:$selector:$newValue
$newValue : int|string: string or number
$forID : int|string = null: Other than current record id

Return values

array<string|int, mixed> —

operation result

code()

Returns code:CODE.


    public
            static    code(string $code) : string

Parameters

$code : string

Return values

string —

companyUrlToOptions()

Convert companyUrl provided by CustomButton to options array.


    public
            static    companyUrlToOptions(string $companyUrl) : array<string|int, mixed>

Parameters

$companyUrl : string

Return values

array<string|int, mixed> —

Options

configToEnv()

Export current/given configutation into Environment.


    public
                configToEnv([array<string|int, mixed> $opts = [] ]) : void

Parameters

$opts : array<string|int, mixed> = []

Return values

void —

connectionReset()

Reset Curl Connection.


    public
                connectionReset() : void

Return values

void —

contentTypeToResponseFormat()

Obtain json for application/json.


    public
                contentTypeToResponseFormat(string $contentType[, string $url = '' ]) : string

Parameters

$contentType : string
$url : string = ''

Return values

string —

controlMandatoryColumns()

Control data for mandatory columns presence.


    public
                controlMandatoryColumns([array<string|int, mixed> $data = null ]) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed> = null

Return values

array<string|int, mixed> —

List of missing columns. Empty if all is ok

controlReadOnlyColumns()

Control data for readonly columns presence.


    public
                controlReadOnlyColumns([array<string|int, mixed> $data = null ]) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed> = null

Return values

array<string|int, mixed> —

List of ReadOnly columns. Empty if all is ok

copy()

Make Copy of given record with optional modifications.


    public
                copy(int $source[, array<string|int, mixed> $overrides = [] ]) : null|RW

!!!Experimental Feature!!!

Parameters

$source : int
$overrides : array<string|int, mixed> = []

Return values

null|RW —

copied record object or null in case of failure

curlInit()

Inicializace CURL.


    public
                curlInit() : bool

Return values

bool —

Online Status

dateToFlexiDate()

PHP Date object to AbraFlexi date format.


    public
            static    dateToFlexiDate(DateTime $date) : mixed

Parameters

$date : DateTime

Return values

mixed —

dateToFlexiDateTime()

PHP Date object to AbraFlexi date format.


    public
            static    dateToFlexiDateTime(DateTime $dateTime) : mixed

Parameters

$dateTime : DateTime

Return values

mixed —

deleteFromAbraFlexi()

Smaže záznam Delete record in AbraFlexi.


    public
                deleteFromAbraFlexi([int|string $id = null ]) : bool

Parameters

$id : int|string = null: identifikátor záznamu

Return values

bool —

Response code is 200 ?

disconnect()

Odpojení od AbraFlexi.


    public
                disconnect() : void

Return values

void —

doCurlRequest()

Vykonej HTTP požadavek.


    public
                doCurlRequest(string $url, string $method[, string $format = null ]) : int

Parameters

$url : string: URL požadavku
$method : string: HTTP Method GET|POST|PUT|OPTIONS|DELETE
$format : string = null: požadovaný formát komunikace

Return values

int —

HTTP Response CODE

downloadInFormat()

Uloží dokument v daném formátu do složky v systému souborů Save document in given format to directory in filesystem.


    public
                downloadInFormat(string $format[, string $destDir = './' ][, string $reportName = null ][, string $lang = null ][, bool $sign = false ]) : null|string

Parameters

$format : string: pdf/csv/xml/json/ ...
$destDir : string = './': where to put file (prefix)
$reportName : string = null: Template used to generate PDF
$lang : string = null: Requested Language
$sign : bool = false: download digital signed

Return values

null|string —

filename downloaded or none

error500Reporter()

Compile and send Report about Error500 to AbraFlexi developers If AbraFlexi is running on localost try also include java backtrace.


    public
                error500Reporter(array<string|int, mixed> $errorResponse) : void

Parameters

$errorResponse : array<string|int, mixed>: result of parseError();

Return values

void —

evidenceToClassName()

Gives you AbraFlexi class name for Given Evidence.


    public
            static    evidenceToClassName(string $evidence) : string

Parameters

$evidence : string

Return values

string —

Class name

evidenceUrlWithSuffix()

Add suffix to Evidence URL.


    public
                evidenceUrlWithSuffix(string $urlSuffix) : string

Parameters

$urlSuffix : string

Return values

string —

extractResultIDs()

Extract IDs from AbraFlexi response Array.


    public
                extractResultIDs(array<string|int, mixed> $resultInfo) : array<string|int, mixed>

Parameters

$resultInfo : array<string|int, mixed>: AbraFlexi response

Return values

array<string|int, mixed> —

List of [ 'evidence1'=>[ 'original-id'=>numericID,'original-id2'=>numericID2 ], 'evidence2'=> ... ]

extractUrlParams()

Oddělí z pole podmínek ty jenž patří za ? v URL požadavku.


    public
                extractUrlParams(array<string|int, mixed> &$conditions, array<string|int, mixed> &$urlParams) : void

Parameters

$conditions : array<string|int, mixed>: pole podmínek - rendrují se do ()
$urlParams : array<string|int, mixed>: pole parametrů - rendrují za ?

Return values

void —

fixRecordTypes()

Fix AbraFlexi record field types.


    public
                fixRecordTypes(array<string|int, mixed> $record[, string $evidence = null ]) : array<string|int, mixed>

Parameters

$record : array<string|int, mixed>
$evidence : string = null: force other than current

Return values

array<string|int, mixed> —

with items typed

fixResponseTypes()

Fix field types in AbraFlexi server response.


    public
                fixResponseTypes(array<string|int, mixed> $response) : array<string|int, mixed>

Parameters

$response : array<string|int, mixed>: raw response

Return values

array<string|int, mixed> —

types resolved

flexiDateTimeToDateTime()

AbraFlexi dateTime to PHP DateTime conversion.


    public
            static    flexiDateTimeToDateTime(string $flexidatetime) : DateTime|false

Parameters

$flexidatetime : string: 2017-09-26T10:00:53.755+02:00 or older 2017-05-19T00:00:00+02:00

Return values

DateTime|false —

flexiDateToDateTime()

AbraFlexi date to PHP DateTime conversion.


    public
            static    flexiDateToDateTime(string $flexidate) : DateTime|false

Parameters

$flexidate : string: 2017-05-26 or 2017-05-26Z or 2017-05-26+02:00

Return values

DateTime|false —

flexiEditUrl()

New Web Interface Item editor link. It use record ID. If record Id is not available try to load record using its code to obtain current record Id.


    public
                flexiEditUrl() : string

Return values

string —

link to item editor or empty string

flexiIN()

Prepare "IN" subselect.


    public
            static    flexiIN(array<string|int, mixed> $items, string $key) : string

Parameters

$items : array<string|int, mixed>
$key : string

Return values

string —

"in" fragment

flexiUrl()

Generuje fragment url pro filtrování.


    public
            static    flexiUrl(array<string|int, mixed> $data[, string $joiner = 'and' ][, string $defop = 'eq' ]) : string

Parameters

$data : array<string|int, mixed>: key=>values; value can bee class DatePeriod, DateTime or Array
$joiner : string = 'and': default and/or
$defop : string = 'eq': default operator

Return values

string —

getAbraFlexiURL()

Gives You URL for Current Record in AbraFlexi web interface.


    public
                getAbraFlexiURL() : string

Return values

string —

url

getActionsInfo()

Obtain actions for current (or given) evidence.


    public
                getActionsInfo([string $evidence = null ]) : array<string|int, mixed>

Parameters

$evidence : string = null

Return values

array<string|int, mixed> —

Evidence structure

getAllFromAbraFlexi()

Vrací z AbraFlexi sloupečky podle podmínek.


    public
                getAllFromAbraFlexi([array<string|int, mixed>|int|string $conditions = null ][, string $indexBy = null ]) : array<string|int, mixed>

Parameters

$conditions : array<string|int, mixed>|int|string = null: pole podmínek nebo ID záznamu
$indexBy : string = null: klice vysledku naplnit hodnotou ze sloupečku

Return values

array<string|int, mixed> —

getApiURL()

Gives you current ApiURL with given format suffix.


    public
                getApiURL([string $format = null ]) : string

Parameters

$format : string = null: json|html|xml|...

Return values

string —

API URL for current record or object/evidence

getColumnInfo()

Gives you properties for (current) evidence column.


    public
                getColumnInfo(string $column[, string $evidence = null ]) : array<string|int, mixed>

Parameters

$column : string: name of column
$evidence : string = null: evidence name if different

Return values

array<string|int, mixed> —

column properties or null if column not exits

getColumnsFromAbraFlexi()

Vrací z AbraFlexi sloupečky podle podmínek.


    public
                getColumnsFromAbraFlexi(string|array<string|int, string> $columnsList[, array<string|int, mixed> $conditions = [] ][, string $indexBy = null ]) : array<string|int, mixed>

Parameters

$columnsList : string|array<string|int, string>: seznam položek nebo úrověň detailu: id|summary|full
$conditions : array<string|int, mixed> = []: pole podmínek nebo ID záznamu
$indexBy : string = null: Sloupeček podle kterého indexovat záznamy

Return values

array<string|int, mixed> —

getColumnsInfo()

Gives you evidence structure. You can obtain current online by pre-calling: $this->updateColumnsInfo($evidence, $this->getOnlineColumnsInfo($evidence));


    public
                getColumnsInfo([string $evidence = null ]) : array<string|int, mixed>

Parameters

$evidence : string = null

Return values

array<string|int, mixed> —

getCompany()

Obtain company now used Vrací právě používanou firmu.


    public
                getCompany() : string

Return values

string —

getConnectionOptions()

Get Current connection options for use in another object.


    public
                getConnectionOptions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

usable as second constructor parameter

getDataForJSON()

Get Data Fragment specific for current object.


    public
                getDataForJSON([array<string|int, mixed> $data = null ]) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed> = null

Return values

array<string|int, mixed> —

getErrors()

Last operation errors.


    public
                getErrors() : array<string|int, mixed>

Return values

array<string|int, mixed> —

AbraFlexi error meassages

getEvidence()

Vrací právě používanou evidenci pro komunikaci Obtain current used evidence.


    public
                getEvidence() : string

Return values

string —

getEvidenceInfo()

Obtain info for current (or given) evidence.


    public
                getEvidenceInfo([string $evidence = '' ]) : array<string|int, mixed>

Parameters

$evidence : string = ''

Return values

array<string|int, mixed> —

Evidence info

getEvidenceName()

Obtain name for current (or given) evidence path.


    public
                getEvidenceName([string $evidence = null ]) : array<string|int, mixed>

Parameters

$evidence : string = null: Evidence Path

Return values

array<string|int, mixed> —

Evidence info

getEvidenceURL()

Return basic URL for used Evidence.


    public
                getEvidenceURL() : string

Return values

string —

Evidence URL

getExternalID()

Vrací hodnotu daného externího ID.


    public
                getExternalID([string $want = null ]) : array<string|int, mixed>|string

Parameters

$want : string = null: Namespace Selector. If empty,you obtain the first one.

Return values

array<string|int, mixed>|string —

one id or array if multiplete

getExternalIDs()

gives you currently loaded extermal IDs.


    public
                getExternalIDs() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getFirstRecordID()

Obtain ID of first record in evidence.


    public
                getFirstRecordID() : null|string

Return values

null|string —

id or null if no records

getFlexiData()

Načte data z AbraFlexi.


    public
                getFlexiData([string $suffix = '' ][, array<string|int, mixed>|string $conditions = null ]) : array<string|int, mixed>

Parameters

$suffix : string = '': dotaz
$conditions : array<string|int, mixed>|string = null: Custom filters or modifiers

Return values

array<string|int, mixed> —

Data obtained

getFlexiRow()

Načte řádek dat z AbraFlexi.


    public
                getFlexiRow(int $recordID) : array<string|int, mixed>

Parameters

$recordID : int: id požadovaného záznamu

Return values

array<string|int, mixed> —

getGlobalVersion()

Obtain actual GlobalVersion Vrací aktuální globální verzi změn.


    public
                getGlobalVersion() : int

Return values

int —

getInFormat()

Získá dokument v daném formátu Obtain document in given format.


    public
                getInFormat(string $format[, string $reportName = null ][, string $lang = null ][, bool $sign = false ]) : null|string

Parameters

$format : string: pdf/csv/xml/json/ ...
$reportName : string = null: Template used to generate PDF
$lang : string = null: cs|sk|en|de Template language used to generate PDF
$sign : bool = false: sign resulting PDF by certificate ?

Return values

null|string —

filename downloaded or none

getJsonizedData()

Převede data do Json formátu pro AbraFlexi.


    public
                getJsonizedData([array<string|int, mixed> $data = null ], int $options) : string

Convert data to AbraFlexi like Json format.

Parameters

$data : array<string|int, mixed> = null: object data
$options : int: json_encode options like JSON_PRETTY_PRINT etc

Return values

string —

getKod()

Vrací kód záznamu.


    public
                getKod([mixed $data = null ][, mixed $unique = true ]) : string

Obtain record CODE.

Parameters

$data : mixed = null
$unique : mixed = true

Return values

string —

getLastInsertedId()

Give you last inserted record ID.


    public
                getLastInsertedId() : int

Return values

int —

getLastOperationType()

Get Last operation type.


    public
                getLastOperationType() : string

Return values

string —

create|read|update|delete or update,insert for some inserted and updated in one transaction

getNextRecordID()

Get next record ID.


    public
                getNextRecordID([array<string|int, mixed> $conditions = [] ]) : null|int

Parameters

$conditions : array<string|int, mixed> = []: optional

Return values

null|int —

getOfflineColumnsInfo()

Obtain structure for current (or given) evidence.


    public
                getOfflineColumnsInfo([string $evidence = null ]) : array<string|int, mixed>

Parameters

$evidence : string = null

Return values

array<string|int, mixed> —

Evidence structure

getOnlineColumnsInfo()

Obtain Current evidence Live structure.


    public
                getOnlineColumnsInfo([string $evidence = null ]) : array<string|int, mixed>

Parameters

$evidence : string = null

Return values

array<string|int, mixed> —

structure

getPostFields()

Get Content ready to be send as POST body.


    public
                getPostFields() : string

Return values

string —

getPrevRecordID()

Get next record ID.


    public
                getPrevRecordID([array<string|int, mixed> $conditions = [] ]) : null|int

Parameters

$conditions : array<string|int, mixed> = []: optional

Return values

null|int —

getRecordCode()

Obtain record/object identificator code: Vrací identifikátor objektu code:


    public
                getRecordCode() : string

Return values

string —

record code identifier

getRecordID()

Obtain record/object numeric identificator id: Vrací číselný identifikátor objektu id:


    public
                getRecordID() : null|int

Return values

null|int —

indentifikátor záznamu reprezentovaného objektem

getRecordIdent()

Obtain record/object identificator extId: code: or id: Vrací identifikátor objektu extId: code: nebo id:


    public
                getRecordIdent() : null|int|string

Return values

null|int|string —

record code identifier

getRelationsInfo()

Obtain relations for current (or given) evidence.


    public
                getRelationsInfo([string $evidence = null ]) : array<string|int, mixed>

Parameters

$evidence : string = null

Return values

array<string|int, mixed> —

Evidence structure

getReportsInfo()

Get Current Evidence reports listing.


    public
                getReportsInfo() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getResponseEvidence()

Vrací název evidence použité v odpovědích z AbraFlexi.


    public
                getResponseEvidence() : string

Return values

string —

getResponseFormat()

Obtain content type of last response.


    public
                getResponseFormat() : string

Return values

string —

getVazby()

Obtain established relations listing.


    public
                getVazby([null|mixed $id = null ]) : null|array<string|int, mixed>

Parameters

$id : null|mixed = null

Return values

null|array<string|int, mixed> —

or Relations

idExists()

Test if given record ID exists in AbraFlexi.


    public
                idExists([mixed $identifer = null ]) : bool

Parameters

$identifer : mixed = null: presence state

Return values

bool —

ignore404()

Set or get ignore not found pages flag.


    public
                ignore404([bool $ignore = null ]) : bool

Parameters

$ignore : bool = null: set flag to

Return values

bool —

get flag state

insertToAbraFlexi()

Save record (if evidence allow to).


    public
                insertToAbraFlexi([array<string|int, mixed> $data = null ]) : array<string|int, mixed>|bool

Uloží záznam (pokud to evidence dovoluje).

Parameters

$data : array<string|int, mixed> = null: Data to save

Return values

array<string|int, mixed>|bool —

odpověď

join()

Join another Flexi Object.


    public
                join(RO &$object) : bool

Parameters

$object : RO

Return values

bool —

adding to stack success

loadFromAbraFlexi()

Načte záznam z AbraFlexi a uloží v sobě jeho data Read AbraFlexi record and store it inside od object.


    public
                loadFromAbraFlexi([array<string|int, mixed>|int|string $id = null ]) : int

Parameters

$id : array<string|int, mixed>|int|string = null: ID or conditions

Return values

int —

počet načtených položek

logBanner()

Add Info about used user, server and libraries.


    public
                logBanner([string $prefix = null ][, string $suffix = null ]) : void

Parameters

$prefix : string = null: banner prefix text
$suffix : string = null: banner suffix text

Return values

void —

login()

Try to Sign in current user to AbraFlexi and keep authSessionId.


    public
                login() : bool

Return values

bool —

logout()

End (current's user) session.


    public
                logout([string $username = null ]) : array<string|int, mixed>

Parameters

$username : string = null: force username to sign off

Return values

array<string|int, mixed> —

server response

object2array()

Převede rekurzivně Objekt na pole.


    public
            static    object2array(array<string|int, mixed>|object $object) : array<string|int, mixed>

Parameters

$object : array<string|int, mixed>|object

Return values

array<string|int, mixed> —

objectToID()

Převede rekurzivně v poli všechny objekty na jejich identifikátory.


    public
            static    objectToID(array<string|int, mixed>|object $object) : array<string|int, mixed>

Parameters

$object : array<string|int, mixed>|object

Return values

array<string|int, mixed> —

parseError()

Parse error message response.


    public
                parseError(array<string|int, mixed> $responseDecoded) : int

Parameters

$responseDecoded : array<string|int, mixed>

Return values

int —

number of errors processed

parseResponse()

Parse Response array.


    public
                parseResponse(array<string|int, mixed>|string $responseDecoded, int $responseCode) : array<string|int, mixed>

Parameters

$responseDecoded : array<string|int, mixed>|string
$responseCode : int: Request Response Code

Return values

array<string|int, mixed> —

main data part of response

performAction()

Perform given action (if availble) on current evidence/record.


    public
                performAction(string $action[, string $method = 'int' ]) : bool

Parameters

$action : string: one of evidence actions
$method : string = 'int': ext|int External method call operation in URL. Internal add the @action element to request body

Return values

bool —

operation success

performRequest()

Funkce, která provede I/O operaci a vyhodnotí výsledek.


    public
                performRequest([string $urlSuffix = '' ][, string $method = 'GET' ][, string $format = null ]) : array<string|int, mixed>|bool

Parameters

$urlSuffix : string = '': část URL za identifikátorem firmy
$method : string = 'GET': HTTP/REST metoda
$format : string = null: Requested format

Return values

array<string|int, mixed>|bool —

Výsledek operace

processInit()

Zinicializuje objekt dle daných dat. Možné hodnoty:


    public
                processInit(mixed $init) : void

234 - interní číslo záznamu k načtení
code:LOPATA - kód záznamu
BAGR - kód záznamu k načtení
['id'=>24,'nazev'=>'hoblík'] - pole hodnot k předvyplnění
743.json?relations=adresa,vazby - část url s parametry k načtení

Parameters

$init : mixed: číslo/"(code:)kód"/(část)URI záznamu k načtení | pole hodnot k předvyplnění

Return values

void —

rawJsonToArray()

Convert AbraFlexi Response JSON to Array.


    public
                rawJsonToArray(string $rawJson) : array<string|int, mixed>

Parameters

$rawJson : string

Return values

array<string|int, mixed> —

rawResponseToArray()

Parse Raw AbraFlexi response in several formats.


    public
                rawResponseToArray(string $responseRaw, string $format) : array<string|int, mixed>

Parameters

$responseRaw : string: raw response body
$format : string: Raw Response format json|xml|etc

Return values

array<string|int, mixed> —

rawXmlToArray()

Convert AbraFlexi Response XML to Array.


    public
                rawXmlToArray(string $rawXML) : array<string|int, mixed>

Parameters

$rawXML : string

Return values

array<string|int, mixed> —

recordExists()

Test if given record exists in AbraFlexi.


    public
                recordExists([array<string|int, mixed>|int|string $data = [] ]) : bool

Parameters

$data : array<string|int, mixed>|int|string = []: ext:id:23|code:ITEM|['id'=>23]|23

Return values

bool —

Record presence status

reload()

Reload current record from AbraFlexi.


    public
                reload() : bool

Return values

bool —

requestAuthSessionID()

Request authSessionId from current server.


    public
                requestAuthSessionID(string $username, string $password[, string $otp = null ]) : string

Parameters

$username : string
$password : string
$otp : string = null: optional onetime password

Return values

string —

authUserId or null in case of problems

saveDebugFiles()

Save RAW Curl Request & Response to files in Temp directory.


    public
                saveDebugFiles() : void

Return values

void —

saveResponseToFile()

Save current object to file.


    public
                saveResponseToFile(string $destfile) : void

Parameters

$destfile : string: path to file

Return values

void —

sendByMail()

Send Document by mail.


    public
                sendByMail(string $to, string $subject, string $body[, null|mixed $cc = null ]) : bool

Parameters

$to : string: Email ecipient
$subject : string: Email Subject
$body : string: Email Text
$cc : null|mixed = null

Return values

bool —

mail sent status

sendUnsent()

Send all unsent Documents by eMail.


    public
                sendUnsent() : bool

Return values

bool —

http response code

setAction()

Nastaví druh prováděné akce.


    public
                setAction(string $action) : bool

Parameters

$action : string

Return values

bool —

setCompany()

Set used company.


    public
                setCompany(string $company) : void

Nastaví Firmu.

Parameters

$company : string

Return values

void —

setDataValue()

Set Data Field value.


    public
                setDataValue(string $columnName, mixed $value) : bool

Parameters

$columnName : string: field name
$value : mixed: field data value

Return values

bool —

Success

setEvidence()

Nastaví Evidenci pro Komunikaci.


    public
                setEvidence(string $evidence) : bool

Set evidence for communication.

Parameters

$evidence : string: evidence pathName to use

Return values

bool —

evidence switching status

setFilter()

Set Filter code for requests.


    public
                setFilter(array<string|int, mixed>|string $filter) : string

Parameters

$filter : array<string|int, mixed>|string: filter formula or ['key'=>'value']

Return values

string —

Filter code

setFormat()

Set communication format.


    public
                setFormat(string $format) : bool

One of html|xml|json|csv|dbf|xls|isdoc|isdocx|edi|pdf|pdf|vcf|ical.

Parameters

$format : string

Return values

bool —

format is availble

setMyKey()

Set Record Key.


    public
                setMyKey(int|string $myKeyValue) : bool

Parameters

$myKeyValue : int|string

Return values

bool —

setObjectName()

Set internal Object name.


    public
                setObjectName([string $objectName = null ]) : string

Parameters

$objectName : string = null

Return values

string —

Jméno objektu

setPostFields()

Připraví data pro odeslání do AbraFlexi.


    public
                setPostFields(string $data) : void

Parameters

$data : string

Return values

void —

setPrefix()

Set URL prefix.


    public
                setPrefix(string $prefix) : void

Parameters

$prefix : string

Return values

void —

setUp()

SetUp Object to be ready for work.


    public
                setUp([array<string|int, mixed> $options = [] ]) : bool

Parameters

$options : array<string|int, mixed> = []: Object Options ( user,password,authSessionId company,url,evidence, prefix,defaultUrlParams,debug,autoload detail,offline,filter,ignore404,nativeTypes timeout,companyUrl,ver,throwException

Return values

bool —

stripBody()

Strip all non-identifier data.


    public
                stripBody([array<string|int, mixed> $keep = [] ]) : RO

Parameters

$keep : array<string|int, mixed> = []: extra columns to be preserved

Return values

RO —

Current object state

success()

Return last response success status.


    public
                success() : bool

Return values

bool —

sync()

Insert current data into AbraFlexi and load actual record data back.


    public
                sync([array<string|int, mixed> $data = null ]) : bool

Parameters

$data : array<string|int, mixed> = null: Initial data to save

Return values

bool —

Operation success

takeData()

Take data for object. separate external IDs.


    public
                takeData(array<string, mixed> $data) : int

Parameters

$data : array<string, mixed>: Data to keep

Return values

int —

number of records taken

timestampToFlexiDate()

Convert Timestamp to AbraFlexi Date format.


    public
            static    timestampToFlexiDate([int $timpestamp = null ]) : Date

Parameters

$timpestamp : int = null

Return values

Date —

or NULL

timestampToFlexiDateTime()

Convert Timestamp to Flexi DateTime format.


    public
            static    timestampToFlexiDateTime([int $timpestamp = null ]) : string

Parameters

$timpestamp : int = null

Return values

string —

AbraFlexi DateTime or NULL

uncode()

Returns CODE without code: prefix.


    public
            static    uncode(string $code) : string

Parameters

$code : string

Return values

string —

unifyResponseFormat()

Return the same response format for one and multiplete results.


    public
                unifyResponseFormat(array<string|int, mixed> $responseBody) : array<string|int, mixed>

Parameters

$responseBody : array<string|int, mixed>

Return values

array<string|int, mixed> —

updateApiURL()

Update $this->apiURL.


    public
                updateApiURL() : void

Return values

void —

updateColumnsInfo()

Update evidence info from array or online from properties.json or offline.


    public
                updateColumnsInfo([array<string|int, mixed> $columnsInfo = null ][, string $evidence = null ]) : void

Parameters

$columnsInfo : array<string|int, mixed> = null
$evidence : string = null

Return values

void —

urlEncode()

convert unicode to entities for use with AbraFlexi queries.


    public
            static    urlEncode(string $urlRaw) : string

Parameters

$urlRaw : string

Return values

string —

urlizeId()

Prepare record ID to use in URL.


    public
            static    urlizeId(mixed $id) : string

Parameters

$id : mixed

Return values

string —

id ready for use in URL

vazbaAdd()

Přidá uživatelskou vazbu.


    public
                vazbaAdd(string $vazba) : void

Parameters

$vazba : string

Return values

void —

vazbaDel()

Smaže uživatelskou vazbu.


    public
                vazbaDel(string $vazba) : void

Parameters

$vazba : string

Return values

void —

SkupinaFirem extends RW in package Application

Tags

Table of Contents

Properties

$actionsAvailable

Tags

$apiURL

$atomic

Tags

$authSessionId

$autoload

$chained

$codes

$company

Tags

$curl

$curlInfo

$defaultHttpHeaders

$defaultUrlParams

Tags

$dryRun

Tags

$evidence

$evidenceInfo

$filter

Tags

$format

Tags

$globalVersion

$infoDir

$lastCurlError

$lastCurlResponse

$lastInsertedID

$lastResponseCode

$lastResult

$libVersion

$myCreateColumn

$myLastModifiedColumn

$nameColumn

$nameSpace

$nativeTypes

$offline

$password

$postFields

$prefix

$protoVersion

$refreshToken

$reportRecipient

$responseFormat

Tags

$resultField

$rowCount

$throwException

$timeout

$url

$urlParams

Tags

$urlParamsKnown

Tags

$user

$action

Tags

$errors

$ignoreNotFound

$responseStats

$columnsInfo

$jsonDepth

$reports

$sourceId

Methods

__construct()

Parameters

Return values

__destruct()

Return values

__sleep()

Return values

__toString()

Tags

Return values

SkupinaFirem extends RW
in package

Application