Complex classes like FlexiBeeRO often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use FlexiBeeRO, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | class FlexiBeeRO extends \Ease\Sand { |
||
| 18 | |||
| 19 | use \Ease\RecordKey; |
||
| 20 | |||
| 21 | /** |
||
| 22 | * Where to get JSON files with evidence stricture etc. |
||
| 23 | * @var string |
||
| 24 | */ |
||
| 25 | public static $infoDir = __DIR__ . '/../../static'; |
||
| 26 | |||
| 27 | /** |
||
| 28 | * Version of FlexiPeeHP library |
||
| 29 | * |
||
| 30 | * @var string |
||
| 31 | */ |
||
| 32 | public static $libVersion = '1.34'; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * Základní namespace pro komunikaci s FlexiBee. |
||
| 36 | * Basic namespace for communication with FlexiBee |
||
| 37 | * |
||
| 38 | * @var string Jmený prostor datového bloku odpovědi |
||
| 39 | */ |
||
| 40 | public $nameSpace = 'winstrom'; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * URL of object data in FlexiBee |
||
| 44 | * @var string url |
||
| 45 | */ |
||
| 46 | public $apiURL = null; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Datový blok v poli odpovědi. |
||
| 50 | * Data block in response field. |
||
| 51 | * |
||
| 52 | * @var string |
||
| 53 | */ |
||
| 54 | public $resultField = 'results'; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Verze protokolu použitého pro komunikaci. |
||
| 58 | * Communication protocol version used. |
||
| 59 | * |
||
| 60 | * @var string Verze použitého API |
||
| 61 | */ |
||
| 62 | public $protoVersion = '1.0'; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * Evidence užitá objektem. |
||
| 66 | * Evidence used by object |
||
| 67 | * |
||
| 68 | * @link https://demo.flexibee.eu/c/demo/evidence-list Přehled evidencí |
||
| 69 | * @var string |
||
| 70 | */ |
||
| 71 | public $evidence = null; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Detaily evidence užité objektem |
||
| 75 | * |
||
| 76 | * @var array |
||
| 77 | */ |
||
| 78 | public $evidenceInfo = []; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Výchozí formát pro komunikaci. |
||
| 82 | * Default communication format. |
||
| 83 | * |
||
| 84 | * @link https://www.flexibee.eu/api/dokumentace/ref/format-types Přehled možných formátů |
||
| 85 | * |
||
| 86 | * @var string json|xml|... |
||
| 87 | */ |
||
| 88 | public $format = 'json'; |
||
| 89 | |||
| 90 | /** |
||
| 91 | * formát příchozí odpovědi |
||
| 92 | * response format |
||
| 93 | * |
||
| 94 | * @link https://www.flexibee.eu/api/dokumentace/ref/format-types Přehled možných formátů |
||
| 95 | * |
||
| 96 | * @var string json|xml|... |
||
| 97 | */ |
||
| 98 | public $responseFormat = 'json'; |
||
| 99 | |||
| 100 | /** |
||
| 101 | * Curl Handle. |
||
| 102 | * |
||
| 103 | * @var resource |
||
| 104 | */ |
||
| 105 | public $curl = null; |
||
| 106 | |||
| 107 | /** |
||
| 108 | * @link https://demo.flexibee.eu/devdoc/company-identifier Identifikátor firmy |
||
| 109 | * @var string |
||
| 110 | */ |
||
| 111 | public $company = null; |
||
| 112 | |||
| 113 | /** |
||
| 114 | * [protocol://]Server[:port] |
||
| 115 | * @var string |
||
| 116 | */ |
||
| 117 | public $url = null; |
||
| 118 | |||
| 119 | /** |
||
| 120 | * REST API Username |
||
| 121 | * @var string |
||
| 122 | */ |
||
| 123 | public $user = null; |
||
| 124 | |||
| 125 | /** |
||
| 126 | * REST API Password |
||
| 127 | * @var string |
||
| 128 | */ |
||
| 129 | public $password = null; |
||
| 130 | |||
| 131 | /** |
||
| 132 | * @var array Pole HTTP hlaviček odesílaných s každým požadavkem |
||
| 133 | */ |
||
| 134 | public $defaultHttpHeaders = ['User-Agent' => 'FlexiPeeHP']; |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Default additional request url parameters after question mark |
||
| 138 | * |
||
| 139 | * @link https://www.flexibee.eu/api/dokumentace/ref/urls Common params |
||
| 140 | * @link https://www.flexibee.eu/api/dokumentace/ref/paging Paging params |
||
| 141 | * @var array |
||
| 142 | */ |
||
| 143 | public $defaultUrlParams = []; |
||
| 144 | |||
| 145 | /** |
||
| 146 | * Identifikační řetězec. |
||
| 147 | * |
||
| 148 | * @var string |
||
| 149 | */ |
||
| 150 | public $init = null; |
||
| 151 | |||
| 152 | /** |
||
| 153 | * Sloupeček s názvem. |
||
| 154 | * |
||
| 155 | * @var string |
||
| 156 | */ |
||
| 157 | public $nameColumn = 'nazev'; |
||
| 158 | |||
| 159 | /** |
||
| 160 | * Sloupeček obsahující datum vložení záznamu do shopu. |
||
| 161 | * |
||
| 162 | * @var string |
||
| 163 | */ |
||
| 164 | public $myCreateColumn = 'false'; |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Slopecek obsahujici datum poslení modifikace záznamu do shopu. |
||
| 168 | * |
||
| 169 | * @var string |
||
| 170 | */ |
||
| 171 | public $myLastModifiedColumn = 'lastUpdate'; |
||
| 172 | |||
| 173 | /** |
||
| 174 | * Klíčový idendifikátor záznamu. |
||
| 175 | * |
||
| 176 | * @var string |
||
| 177 | */ |
||
| 178 | public $fbKeyColumn = 'id'; |
||
| 179 | |||
| 180 | /** |
||
| 181 | * Informace o posledním HTTP requestu. |
||
| 182 | * |
||
| 183 | * @var * |
||
| 184 | */ |
||
| 185 | public $curlInfo; |
||
| 186 | |||
| 187 | /** |
||
| 188 | * Informace o poslední HTTP chybě. |
||
| 189 | * |
||
| 190 | * @var string |
||
| 191 | */ |
||
| 192 | public $lastCurlError = null; |
||
| 193 | |||
| 194 | /** |
||
| 195 | * Used codes storage. |
||
| 196 | * |
||
| 197 | * @var array |
||
| 198 | */ |
||
| 199 | public $codes = null; |
||
| 200 | |||
| 201 | /** |
||
| 202 | * Last Inserted ID. |
||
| 203 | * |
||
| 204 | * @var int |
||
| 205 | */ |
||
| 206 | public $lastInsertedID = null; |
||
| 207 | |||
| 208 | /** |
||
| 209 | * Default Line Prefix. |
||
| 210 | * |
||
| 211 | * @var string |
||
| 212 | */ |
||
| 213 | public $prefix = '/c/'; |
||
| 214 | |||
| 215 | /** |
||
| 216 | * Raw Content of last curl response |
||
| 217 | * |
||
| 218 | * @var string |
||
| 219 | */ |
||
| 220 | public $lastCurlResponse; |
||
| 221 | |||
| 222 | /** |
||
| 223 | * HTTP Response code of last request |
||
| 224 | * |
||
| 225 | * @var int |
||
| 226 | */ |
||
| 227 | public $lastResponseCode = null; |
||
| 228 | |||
| 229 | /** |
||
| 230 | * Body data for next curl POST operation |
||
| 231 | * |
||
| 232 | * @var string |
||
| 233 | */ |
||
| 234 | protected $postFields = null; |
||
| 235 | |||
| 236 | /** |
||
| 237 | * Last operation result data or message(s) |
||
| 238 | * |
||
| 239 | * @var array |
||
| 240 | */ |
||
| 241 | public $lastResult = null; |
||
| 242 | |||
| 243 | /** |
||
| 244 | * Number from @rowCount in response |
||
| 245 | * @var int |
||
| 246 | */ |
||
| 247 | public $rowCount = null; |
||
| 248 | |||
| 249 | /** |
||
| 250 | * Number from @globalVersion |
||
| 251 | * @var int |
||
| 252 | */ |
||
| 253 | public $globalVersion = null; |
||
| 254 | |||
| 255 | /** |
||
| 256 | * @link https://www.flexibee.eu/api/dokumentace/ref/zamykani-odemykani/ |
||
| 257 | * @var string filter query |
||
| 258 | */ |
||
| 259 | public $filter; |
||
| 260 | |||
| 261 | /** |
||
| 262 | * @link https://demo.flexibee.eu/devdoc/actions Provádění akcí |
||
| 263 | * @var string |
||
| 264 | */ |
||
| 265 | protected $action; |
||
| 266 | |||
| 267 | /** |
||
| 268 | * Pole akcí které podporuje ta která evidence |
||
| 269 | * @link https://demo.flexibee.eu/c/demo/faktura-vydana/actions.json Např. Akce faktury |
||
| 270 | * @var array |
||
| 271 | */ |
||
| 272 | public $actionsAvailable = null; |
||
| 273 | |||
| 274 | /** |
||
| 275 | * Parmetry pro URL |
||
| 276 | * @link https://www.flexibee.eu/api/dokumentace/ref/urls/ Všechny podporované parametry |
||
| 277 | * @var array |
||
| 278 | */ |
||
| 279 | public $urlParams = [ |
||
| 280 | 'add-global-version' => ['type' => 'boolean', 'description' => 'The response will contain the global version number of the current export'], |
||
| 281 | 'add-row-count' => ['type' => 'boolean', 'description' => 'Adding Total Records to Output (Pagination)'], |
||
| 282 | 'as-gui' => ['type' => 'boolean', 'description' => 'Turns on functions that complement the GUI processing outputs'], |
||
| 283 | '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.'], |
||
| 284 | 'authSessionId' => ['type' => 'string', 'description' => 'Authentification Session ID'], |
||
| 285 | '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>'], |
||
| 286 | 'code-in-response' => ['type' => 'boolean', 'description' => 'The response will contain not only ID and URL for each object, but also code.'], |
||
| 287 | 'delimeter' => ['type' => 'string', 'description' => 'Specifies the input / output file separator in CSV format.', |
||
| 288 | 'example' => ';'], |
||
| 289 | 'detail' => ['type' => 'string', 'description' => 'Definition of the level of detail'], //See: https://www.flexibee.eu/api/dokumentace/ref/detail-levels |
||
| 290 | 'dir' => ['type' => 'string', 'description' => 'Sorting direction.', 'example' => 'desc'], |
||
| 291 | 'dry-run' => ['type' => 'boolean', 'description' => 'Test run (dry-run)'], // See: https://www.flexibee.eu/api/dokumentace/ref/dry-run/ |
||
| 292 | 'encoding' => ['type' => 'string', 'description' => 'Specifies the encoding of the input / output file in CSV format.'], |
||
| 293 | 'export-settings' => ['type' => 'boolean', 'description' => 'Export one extra entry with current settings at the beginning'], |
||
| 294 | 'fail-on-warning' => ['type' => 'boolean', 'description' => 'If a warning occurs, do not save a record (Data Validation)'], |
||
| 295 | 'filter' => ['type' => 'string', 'description' => 'filter results by this param'], |
||
| 296 | 'format' => ['type' => 'string', 'description' => 'One of the compiled XSL transforms will be applied to the output XML.'], |
||
| 297 | 'idUcetniObdobi' => ['type' => 'string', 'description' => ''], //See: https://www.flexibee.eu/api/dokumentace/ref/stavy-uctu/ |
||
| 298 | 'includes' => ['type' => 'string', 'description' => 'Include related detail level object ', |
||
| 299 | 'example' => 'faktura-vydana/stredisko'], |
||
| 300 | 'inDesktopApp' => ['type' => 'boolean', 'description' => 'Hide menu and navigation in html format'], // Note: Undocumented function (html only) |
||
| 301 | 'limit' => ['type' => 'integer', 'description' => 'number of requested results'], |
||
| 302 | 'mode' => ['type' => 'string', 'description' => 'Support for RubyOnRails', |
||
| 303 | 'example' => 'ruby'], |
||
| 304 | 'no-ext-ids' => ['type' => 'boolean', 'description' => 'The answer will not contain external identifiers (performance optimization)'], |
||
| 305 | 'no-http-errors' => ['type' => 'boolean', 'description' => 'If a 4xx error occurs while processing a request, the server sends 200 OK anyway'], |
||
| 306 | 'no-ids' => ['type' => 'boolean', 'description' => 'The response will not contain any primary identifiers (performance optimization). It only affects the main records.'], |
||
| 307 | '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.'], |
||
| 308 | 'order' => ['type' => 'string', 'description' => 'Sorting records', 'example' => 'nazev@A'], |
||
| 309 | 'relations' => ['type' => 'string', 'description' => 'Adding session data (see detail levels) A session overview can be obtained for each record (/ relations).'], |
||
| 310 | 'report-lang' => ['type' => 'string', 'description' => 'The language in which to print the output when exporting to PDF', |
||
| 311 | 'example' => 'en'], |
||
| 312 | 'report-name' => ['type' => 'string', 'description' => 'The name of the printout when exporting to PDF', |
||
| 313 | 'example' => 'invoice'], |
||
| 314 | 'report-sign' => ['type' => 'string', 'description' => 'Whether the PDF should be exported electronically signed'], |
||
| 315 | 'skupina-stitku' => ['type' => 'string', 'description' => 'Enables grouping of labels when exporting by group (multiple labels)'], |
||
| 316 | 'sort' => ['type' => 'string', 'description' => 'Sorting records for ExtJS'], |
||
| 317 | 'start' => ['type' => 'integer', 'description' => 'Pagination'], |
||
| 318 | 'stitky-as-ids' => ['type' => 'boolean', 'description' => 'Labels will be exported and imported not as a code list but as a list of numeric IDs'], |
||
| 319 | 'use-ext-id' => ['type' => 'boolean', 'description' => 'If the object contains an external ESHOP or MY ID, use it as a bind.'], |
||
| 320 | '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'], |
||
| 321 | 'xpath' => ['type' => 'string', 'description' => 'Apply XPATH to result', |
||
| 322 | 'example' => '//winstrom/adresar/email/text()'] // See: https://www.flexibee.eu/api/dokumentace/ref/xpath/ |
||
| 323 | ]; |
||
| 324 | |||
| 325 | /** |
||
| 326 | * Session ID |
||
| 327 | * @var string |
||
| 328 | */ |
||
| 329 | public $authSessionId = null; |
||
| 330 | |||
| 331 | /** |
||
| 332 | * Token obtained during login procedure |
||
| 333 | * @var string |
||
| 334 | */ |
||
| 335 | public $refreshToken = null; |
||
| 336 | |||
| 337 | /** |
||
| 338 | * Save 404 results to log ? |
||
| 339 | * @var boolean |
||
| 340 | */ |
||
| 341 | protected $ignoreNotFound = false; |
||
| 342 | |||
| 343 | /** |
||
| 344 | * Array of errors caused by last request |
||
| 345 | * @var array |
||
| 346 | */ |
||
| 347 | private $errors = []; |
||
| 348 | |||
| 349 | /** |
||
| 350 | * List of Error500 reports sent |
||
| 351 | * @var array |
||
| 352 | */ |
||
| 353 | private $reports = []; |
||
| 354 | |||
| 355 | /** |
||
| 356 | * Send Error500 Report to |
||
| 357 | * @var string email address |
||
| 358 | */ |
||
| 359 | public $reportRecipient = '[email protected]'; |
||
| 360 | |||
| 361 | /** |
||
| 362 | * Formating string for \DateTime::format() for datetime columns |
||
| 363 | * @var string |
||
| 364 | */ |
||
| 365 | static public $DateTimeFormat = 'Y-m-d\TH:i:s.u+P'; |
||
| 366 | |||
| 367 | /** |
||
| 368 | * Formating string for \DateTime::format() for date columns |
||
| 369 | * @var string |
||
| 370 | */ |
||
| 371 | static public $DateFormat = 'Y-m-d'; |
||
| 372 | |||
| 373 | /** |
||
| 374 | * Last Request response stats |
||
| 375 | * @var array |
||
| 376 | */ |
||
| 377 | protected $responseStats = null; |
||
| 378 | |||
| 379 | /** |
||
| 380 | * Chained Objects |
||
| 381 | * @var array |
||
| 382 | */ |
||
| 383 | public $chained = []; |
||
| 384 | |||
| 385 | /** |
||
| 386 | * We Connect to server by default |
||
| 387 | * @var boolean |
||
| 388 | */ |
||
| 389 | public $offline = false; |
||
| 390 | |||
| 391 | /** |
||
| 392 | * Override cURL timeout |
||
| 393 | * @var int seconds |
||
| 394 | */ |
||
| 395 | public $timeout = null; |
||
| 396 | |||
| 397 | /** |
||
| 398 | * Columns Info for serveral evidencies |
||
| 399 | * @var array |
||
| 400 | */ |
||
| 401 | private $columnsInfo = []; |
||
| 402 | |||
| 403 | /** |
||
| 404 | * Throw Exception in case of FlexiBee error |
||
| 405 | * @var boolean |
||
| 406 | */ |
||
| 407 | public $throwException = false; |
||
| 408 | |||
| 409 | /** |
||
| 410 | * Class for read only interaction with FlexiBee. |
||
| 411 | * |
||
| 412 | * @param mixed $init default record id or initial data. See processInit() |
||
| 413 | * @param array $options Connection settings and other options override |
||
| 414 | */ |
||
| 415 | public function __construct($init = null, $options = []) { |
||
| 424 | |||
| 425 | /** |
||
| 426 | * Set internal Object name |
||
| 427 | * |
||
| 428 | * @param string $objectName |
||
| 429 | * |
||
| 430 | * @return string Jméno objektu |
||
| 431 | */ |
||
| 432 | public function setObjectName($objectName = null) { |
||
| 435 | |||
| 436 | /** |
||
| 437 | * SetUp Object to be ready for work |
||
| 438 | * |
||
| 439 | * @param array $options Object Options ( user,password,authSessionId |
||
| 440 | * company,url,evidence, |
||
| 441 | * prefix,defaultUrlParams,debug, |
||
| 442 | * detail,offline,filter,ignore404 |
||
| 443 | * timeout,companyUrl,ver,throwException |
||
| 444 | */ |
||
| 445 | public function setUp($options = []) { |
||
| 487 | |||
| 488 | /** |
||
| 489 | * Convert companyUrl provided by CustomButton to options array |
||
| 490 | * |
||
| 491 | * @param string $companyUrl |
||
| 492 | * |
||
| 493 | * @return array Options |
||
| 494 | */ |
||
| 495 | public static function companyUrlToOptions($companyUrl) { |
||
| 506 | |||
| 507 | /** |
||
| 508 | * Get Current connection options for use in another object |
||
| 509 | * |
||
| 510 | * @return array usable as second constructor parameter |
||
| 511 | */ |
||
| 512 | public function getConnectionOptions() { |
||
| 529 | |||
| 530 | /** |
||
| 531 | * Inicializace CURL |
||
| 532 | * |
||
| 533 | * @return boolean Online Status |
||
| 534 | */ |
||
| 535 | public function curlInit() { |
||
| 554 | |||
| 555 | /** |
||
| 556 | * Zinicializuje objekt dle daných dat. Možné hodnoty: |
||
| 557 | * |
||
| 558 | * * 234 - interní číslo záznamu k načtení |
||
| 559 | * * code:LOPATA - kód záznamu |
||
| 560 | * * BAGR - kód záznamu k načtení |
||
| 561 | * * ['id'=>24,'nazev'=>'hoblík'] - pole hodnot k předvyplnění |
||
| 562 | * * 743.json?relations=adresa,vazby - část url s parametry k načtení |
||
| 563 | * |
||
| 564 | * @param mixed $init číslo/"(code:)kód"/(část)URI záznamu k načtení | pole hodnot k předvyplnění |
||
| 565 | */ |
||
| 566 | public function processInit($init) { |
||
| 577 | |||
| 578 | /** |
||
| 579 | * Set Data Field value |
||
| 580 | * |
||
| 581 | * @param string $columnName field name |
||
| 582 | * @param mixed $value field data value |
||
| 583 | * |
||
| 584 | * @return bool Success |
||
| 585 | */ |
||
| 586 | public function setDataValue($columnName, $value) { |
||
| 612 | |||
| 613 | /** |
||
| 614 | * PHP Date object to FlexiBee date format |
||
| 615 | * |
||
| 616 | * @param \DateTime $date |
||
| 617 | */ |
||
| 618 | public static function dateToFlexiDate($date) { |
||
| 621 | |||
| 622 | /** |
||
| 623 | * PHP Date object to FlexiBee date format |
||
| 624 | * |
||
| 625 | * @param \DateTime $dateTime |
||
| 626 | */ |
||
| 627 | public static function dateToFlexiDateTime($dateTime) { |
||
| 630 | |||
| 631 | /** |
||
| 632 | * Set URL prefix |
||
| 633 | * |
||
| 634 | * @param string $prefix |
||
| 635 | */ |
||
| 636 | public function setPrefix($prefix) { |
||
| 656 | |||
| 657 | /** |
||
| 658 | * Set communication format. |
||
| 659 | * One of html|xml|json|csv|dbf|xls|isdoc|isdocx|edi|pdf|pdf|vcf|ical |
||
| 660 | * |
||
| 661 | * @param string $format |
||
| 662 | * |
||
| 663 | * @return boolean format is availble |
||
| 664 | */ |
||
| 665 | public function setFormat($format) { |
||
| 678 | |||
| 679 | /** |
||
| 680 | * Nastaví Evidenci pro Komunikaci. |
||
| 681 | * Set evidence for communication |
||
| 682 | * |
||
| 683 | * @param string $evidence evidence pathName to use |
||
| 684 | * |
||
| 685 | * @return boolean evidence switching status |
||
| 686 | */ |
||
| 687 | public function setEvidence($evidence) { |
||
| 712 | |||
| 713 | /** |
||
| 714 | * Vrací právě používanou evidenci pro komunikaci |
||
| 715 | * Obtain current used evidence |
||
| 716 | * |
||
| 717 | * @return string |
||
| 718 | */ |
||
| 719 | public function getEvidence() { |
||
| 722 | |||
| 723 | /** |
||
| 724 | * Set used company. |
||
| 725 | * Nastaví Firmu. |
||
| 726 | * |
||
| 727 | * @param string $company |
||
| 728 | */ |
||
| 729 | public function setCompany($company) { |
||
| 732 | |||
| 733 | /** |
||
| 734 | * Obtain company now used |
||
| 735 | * Vrací právě používanou firmu |
||
| 736 | * |
||
| 737 | * @return string |
||
| 738 | */ |
||
| 739 | public function getCompany() { |
||
| 742 | |||
| 743 | /** |
||
| 744 | * Vrací název evidence použité v odpovědích z FlexiBee |
||
| 745 | * |
||
| 746 | * @return string |
||
| 747 | */ |
||
| 748 | public function getResponseEvidence() { |
||
| 762 | |||
| 763 | /** |
||
| 764 | * Převede rekurzivně Objekt na pole. |
||
| 765 | * |
||
| 766 | * @param object|array $object |
||
| 767 | * |
||
| 768 | * @return array |
||
| 769 | */ |
||
| 770 | public static function object2array($object) { |
||
| 789 | |||
| 790 | /** |
||
| 791 | * Převede rekurzivně v poli všechny objekty na jejich identifikátory. |
||
| 792 | * |
||
| 793 | * @param object|array $object |
||
| 794 | * |
||
| 795 | * @return array |
||
| 796 | */ |
||
| 797 | public static function objectToID($object) { |
||
| 814 | |||
| 815 | /** |
||
| 816 | * Return basic URL for used Evidence |
||
| 817 | * |
||
| 818 | * @link https://www.flexibee.eu/api/dokumentace/ref/urls/ Sestavování URL |
||
| 819 | * |
||
| 820 | * @return string Evidence URL |
||
| 821 | */ |
||
| 822 | public function getEvidenceURL() { |
||
| 830 | |||
| 831 | /** |
||
| 832 | * Add suffix to Evidence URL |
||
| 833 | * |
||
| 834 | * @param string $urlSuffix |
||
| 835 | * |
||
| 836 | * @return string |
||
| 837 | */ |
||
| 838 | public function evidenceUrlWithSuffix($urlSuffix) { |
||
| 848 | |||
| 849 | /** |
||
| 850 | * Update $this->apiURL |
||
| 851 | */ |
||
| 852 | public function updateApiURL() { |
||
| 866 | |||
| 867 | /* |
||
| 868 | * Add Default Url params to given url if not overrided |
||
| 869 | * |
||
| 870 | * @param string $urlRaw |
||
| 871 | * |
||
| 872 | * @return string url with default params added |
||
| 873 | */ |
||
| 874 | |||
| 875 | public function addDefaultUrlParams($urlRaw) { |
||
| 879 | |||
| 880 | /** |
||
| 881 | * Funkce, která provede I/O operaci a vyhodnotí výsledek. |
||
| 882 | * |
||
| 883 | * @param string $urlSuffix část URL za identifikátorem firmy. |
||
| 884 | * @param string $method HTTP/REST metoda |
||
| 885 | * @param string $format Requested format |
||
| 886 | * |
||
| 887 | * @return array|boolean Výsledek operace |
||
| 888 | */ |
||
| 889 | public function performRequest($urlSuffix = null, $method = 'GET', |
||
| 909 | |||
| 910 | /** |
||
| 911 | * Parse Raw FlexiBee response in several formats |
||
| 912 | * |
||
| 913 | * @param string $responseRaw raw response body |
||
| 914 | * @param string $format Raw Response format json|xml|etc |
||
| 915 | * |
||
| 916 | * @return array |
||
| 917 | */ |
||
| 918 | public function rawResponseToArray($responseRaw, $format) { |
||
| 936 | |||
| 937 | /** |
||
| 938 | * Convert FlexiBee Response JSON to Array |
||
| 939 | * |
||
| 940 | * @param string $rawJson |
||
| 941 | * |
||
| 942 | * @return array |
||
| 943 | */ |
||
| 944 | public function rawJsonToArray($rawJson) { |
||
| 959 | |||
| 960 | /** |
||
| 961 | * Convert FlexiBee Response XML to Array |
||
| 962 | * |
||
| 963 | * @param string $rawXML |
||
| 964 | * |
||
| 965 | * @return array |
||
| 966 | */ |
||
| 967 | public function rawXmlToArray($rawXML) { |
||
| 970 | |||
| 971 | /** |
||
| 972 | * Parse Response array |
||
| 973 | * |
||
| 974 | * @param array $responseDecoded |
||
| 975 | * @param int $responseCode Request Response Code |
||
| 976 | * |
||
| 977 | * @return array main data part of response |
||
| 978 | */ |
||
| 979 | public function parseResponse($responseDecoded, $responseCode) { |
||
| 1047 | |||
| 1048 | /** |
||
| 1049 | * Parse error message response |
||
| 1050 | * |
||
| 1051 | * @param array $responseDecoded |
||
| 1052 | * |
||
| 1053 | * @return int number of errors processed |
||
| 1054 | */ |
||
| 1055 | public function parseError(array $responseDecoded) { |
||
| 1072 | |||
| 1073 | /** |
||
| 1074 | * Vykonej HTTP požadavek |
||
| 1075 | * |
||
| 1076 | * @link https://www.flexibee.eu/api/dokumentace/ref/urls/ Sestavování URL |
||
| 1077 | * @param string $url URL požadavku |
||
| 1078 | * @param string $method HTTP Method GET|POST|PUT|OPTIONS|DELETE |
||
| 1079 | * @param string $format požadovaný formát komunikace |
||
| 1080 | * |
||
| 1081 | * @return int HTTP Response CODE |
||
| 1082 | */ |
||
| 1083 | public function doCurlRequest($url, $method, $format = null) { |
||
| 1133 | |||
| 1134 | /** |
||
| 1135 | * Obtain json for application/json |
||
| 1136 | * |
||
| 1137 | * @param string $contentType |
||
| 1138 | * @param string $url |
||
| 1139 | * |
||
| 1140 | * @return string response format |
||
| 1141 | */ |
||
| 1142 | public function contentTypeToResponseFormat($contentType, $url = null) { |
||
| 1169 | |||
| 1170 | /** |
||
| 1171 | * Nastaví druh prováděné akce. |
||
| 1172 | * |
||
| 1173 | * @link https://demo.flexibee.eu/devdoc/actions Provádění akcí |
||
| 1174 | * @param string $action |
||
| 1175 | * |
||
| 1176 | * @return boolean |
||
| 1177 | */ |
||
| 1178 | public function setAction($action) { |
||
| 1188 | |||
| 1189 | /** |
||
| 1190 | * Convert XML to array. |
||
| 1191 | * |
||
| 1192 | * @param string $xml |
||
| 1193 | * |
||
| 1194 | * @return array |
||
| 1195 | */ |
||
| 1196 | public static function xml2array($xml) { |
||
| 1215 | |||
| 1216 | /** |
||
| 1217 | * Odpojení od FlexiBee. |
||
| 1218 | */ |
||
| 1219 | public function disconnect() { |
||
| 1225 | |||
| 1226 | /** |
||
| 1227 | * Disconnect CURL befere pass away |
||
| 1228 | */ |
||
| 1229 | public function __destruct() { |
||
| 1232 | |||
| 1233 | /** |
||
| 1234 | * Načte řádek dat z FlexiBee. |
||
| 1235 | * |
||
| 1236 | * @param int $recordID id požadovaného záznamu |
||
| 1237 | * |
||
| 1238 | * @return array |
||
| 1239 | */ |
||
| 1240 | public function getFlexiRow($recordID) { |
||
| 1249 | |||
| 1250 | /** |
||
| 1251 | * Oddělí z pole podmínek ty jenž patří za ? v URL požadavku |
||
| 1252 | * |
||
| 1253 | * @link https://www.flexibee.eu/api/dokumentace/ref/urls/ Sestavování URL |
||
| 1254 | * @param array $conditions pole podmínek - rendrují se do () |
||
| 1255 | * @param array $urlParams pole parametrů - rendrují za ? |
||
| 1256 | */ |
||
| 1257 | public function extractUrlParams(&$conditions, &$urlParams) { |
||
| 1264 | |||
| 1265 | /** |
||
| 1266 | * convert unicode to entities for use with FlexiBee queries |
||
| 1267 | * |
||
| 1268 | * @param string $urlRaw |
||
| 1269 | * |
||
| 1270 | * @return string |
||
| 1271 | */ |
||
| 1272 | public static function urlEncode($urlRaw) { |
||
| 1275 | |||
| 1276 | /** |
||
| 1277 | * Načte data z FlexiBee. |
||
| 1278 | * |
||
| 1279 | * @param string $suffix dotaz |
||
| 1280 | * @param string|array $conditions Custom filters or modifiers |
||
| 1281 | * |
||
| 1282 | * @return array Data obtained |
||
| 1283 | */ |
||
| 1284 | public function getFlexiData($suffix = null, $conditions = null) { |
||
| 1350 | |||
| 1351 | /** |
||
| 1352 | * Načte záznam z FlexiBee a uloží v sobě jeho data |
||
| 1353 | * Read FlexiBee record and store it inside od object |
||
| 1354 | * |
||
| 1355 | * @param int|string $id ID or conditions |
||
| 1356 | * |
||
| 1357 | * @return int počet načtených položek |
||
| 1358 | */ |
||
| 1359 | public function loadFromFlexiBee($id = null) { |
||
| 1373 | |||
| 1374 | /** |
||
| 1375 | * Reload current record from FlexiBee |
||
| 1376 | * |
||
| 1377 | * @return boolean |
||
| 1378 | */ |
||
| 1379 | public function reload() { |
||
| 1385 | |||
| 1386 | /** |
||
| 1387 | * Set Filter code for requests |
||
| 1388 | * |
||
| 1389 | * @link https://www.flexibee.eu/api/dokumentace/ref/zamykani-odemykani/ |
||
| 1390 | * |
||
| 1391 | * @param array|string $filter filter formula or ['key'=>'value'] |
||
| 1392 | * |
||
| 1393 | * @return string Filter code |
||
| 1394 | */ |
||
| 1395 | public function setFilter($filter) { |
||
| 1398 | |||
| 1399 | /** |
||
| 1400 | * Převede data do Json formátu pro FlexiBee. |
||
| 1401 | * Convert data to FlexiBee like Json format |
||
| 1402 | * |
||
| 1403 | * @url https://www.flexibee.eu/api/dokumentace/ref/actions/ |
||
| 1404 | * @url https://www.flexibee.eu/api/dokumentace/ref/zamykani-odemykani/ |
||
| 1405 | * |
||
| 1406 | * @param array $data object data |
||
| 1407 | * @param int $options json_encode options like JSON_PRETTY_PRINT etc |
||
| 1408 | * |
||
| 1409 | * @return string |
||
| 1410 | */ |
||
| 1411 | public function getJsonizedData($data = null, $options = 0) { |
||
| 1423 | |||
| 1424 | /** |
||
| 1425 | * Get Data Fragment specific for current object |
||
| 1426 | * |
||
| 1427 | * @param array $data |
||
| 1428 | * |
||
| 1429 | * @return array |
||
| 1430 | */ |
||
| 1431 | public function getDataForJSON($data = null) { |
||
| 1473 | |||
| 1474 | /** |
||
| 1475 | * Join another FlexiPeeHP Object |
||
| 1476 | * |
||
| 1477 | * @param FlexiBeeRO $object |
||
| 1478 | * |
||
| 1479 | * @return boolean adding to stack success |
||
| 1480 | */ |
||
| 1481 | public function join(&$object) { |
||
| 1491 | |||
| 1492 | /** |
||
| 1493 | * Prepare record ID to use in URL |
||
| 1494 | * |
||
| 1495 | * @param mixed $id |
||
| 1496 | * |
||
| 1497 | * @return string id ready for use in URL |
||
| 1498 | */ |
||
| 1499 | public static function urlizeId($id) { |
||
| 1509 | |||
| 1510 | /** |
||
| 1511 | * Test if given record ID exists in FlexiBee. |
||
| 1512 | * |
||
| 1513 | * @param mixed $identifer presence state |
||
| 1514 | * |
||
| 1515 | * @return boolean |
||
| 1516 | */ |
||
| 1517 | public function idExists($identifer = null) { |
||
| 1531 | |||
| 1532 | /** |
||
| 1533 | * Test if given record exists in FlexiBee. |
||
| 1534 | * |
||
| 1535 | * @param array|string|int $data ext:id:23|code:ITEM|['id'=>23]|23 |
||
| 1536 | * |
||
| 1537 | * @return boolean Record presence status |
||
| 1538 | */ |
||
| 1539 | public function recordExists($data = []) { |
||
| 1558 | |||
| 1559 | /** |
||
| 1560 | * Subitems - ex. items of invoice |
||
| 1561 | * |
||
| 1562 | * @return array of document items or null |
||
| 1563 | */ |
||
| 1564 | public function getSubItems() { |
||
| 1567 | |||
| 1568 | /** |
||
| 1569 | * Vrací z FlexiBee sloupečky podle podmínek. |
||
| 1570 | * |
||
| 1571 | * @param array|int|string $conditions pole podmínek nebo ID záznamu |
||
| 1572 | * @param string $indexBy klice vysledku naplnit hodnotou ze |
||
| 1573 | * sloupečku |
||
| 1574 | * @return array |
||
| 1575 | */ |
||
| 1576 | public function getAllFromFlexibee($conditions = null, $indexBy = null) { |
||
| 1589 | |||
| 1590 | /** |
||
| 1591 | * Vrací z FlexiBee sloupečky podle podmínek. |
||
| 1592 | * |
||
| 1593 | * @param string|string[] $columnsList seznam položek nebo úrověň detailu: id|summary|full |
||
| 1594 | * @param array $conditions pole podmínek nebo ID záznamu |
||
| 1595 | * @param string $indexBy Sloupeček podle kterého indexovat záznamy |
||
| 1596 | * |
||
| 1597 | * @return array |
||
| 1598 | */ |
||
| 1599 | public function getColumnsFromFlexibee($columnsList, $conditions = [], |
||
| 1637 | |||
| 1638 | /** |
||
| 1639 | * Vrací kód záznamu. |
||
| 1640 | * Obtain record CODE |
||
| 1641 | * |
||
| 1642 | * @param mixed $data |
||
| 1643 | * |
||
| 1644 | * @return string |
||
| 1645 | */ |
||
| 1646 | public function getKod($data = null, $unique = true) { |
||
| 1699 | |||
| 1700 | /** |
||
| 1701 | * Write Operation Result. |
||
| 1702 | * |
||
| 1703 | * @param array $resultData |
||
| 1704 | * @param string $url URL |
||
| 1705 | * |
||
| 1706 | * @return boolean Log save success |
||
| 1707 | */ |
||
| 1708 | public function logResult($resultData = null, $url = null) { |
||
| 1753 | |||
| 1754 | /** |
||
| 1755 | * Save RAW Curl Request & Response to files in Temp directory |
||
| 1756 | */ |
||
| 1757 | public function saveDebugFiles() { |
||
| 1770 | |||
| 1771 | /** |
||
| 1772 | * Připraví data pro odeslání do FlexiBee |
||
| 1773 | * |
||
| 1774 | * @param string $data |
||
| 1775 | */ |
||
| 1776 | public function setPostFields($data) { |
||
| 1779 | |||
| 1780 | /** |
||
| 1781 | * Get Content ready to be send as POST body |
||
| 1782 | * @return string |
||
| 1783 | */ |
||
| 1784 | public function getPostFields() { |
||
| 1787 | |||
| 1788 | /** |
||
| 1789 | * Generuje fragment url pro filtrování. |
||
| 1790 | * |
||
| 1791 | * @see https://www.flexibee.eu/api/dokumentace/ref/filters |
||
| 1792 | * |
||
| 1793 | * @param array $data key=>values; value can bee class DatePeriod, DateTime or Array |
||
| 1794 | * @param string $joiner default and/or |
||
| 1795 | * @param string $defop default operator |
||
| 1796 | * |
||
| 1797 | * @return string |
||
| 1798 | */ |
||
| 1799 | public static function flexiUrl(array $data, $joiner = 'and', $defop = 'eq') { |
||
| 1882 | |||
| 1883 | /** |
||
| 1884 | * Obtain record/object numeric identificator id: |
||
| 1885 | * Vrací číselný identifikátor objektu id: |
||
| 1886 | * |
||
| 1887 | * @link https://demo.flexibee.eu/devdoc/identifiers Identifikátory záznamů |
||
| 1888 | * |
||
| 1889 | * @return null|int indentifikátor záznamu reprezentovaného objektem |
||
| 1890 | */ |
||
| 1891 | public function getRecordID() { |
||
| 1895 | |||
| 1896 | /** |
||
| 1897 | * Obtain record/object identificator code: |
||
| 1898 | * Vrací identifikátor objektu code: |
||
| 1899 | * |
||
| 1900 | * @link https://demo.flexibee.eu/devdoc/identifiers Identifikátory záznamů |
||
| 1901 | * |
||
| 1902 | * @return string record code identifier |
||
| 1903 | */ |
||
| 1904 | public function getRecordCode() { |
||
| 1907 | |||
| 1908 | /** |
||
| 1909 | * Obtain record/object identificator extId: code: or id: |
||
| 1910 | * Vrací identifikátor objektu extId: code: nebo id: |
||
| 1911 | * |
||
| 1912 | * @link https://demo.flexibee.eu/devdoc/identifiers Identifikátory záznamů |
||
| 1913 | * |
||
| 1914 | * @return string|int|null record code identifier |
||
| 1915 | */ |
||
| 1916 | public function getRecordIdent() { |
||
| 1926 | |||
| 1927 | /** |
||
| 1928 | * Obtain record/object identificator code: or id: |
||
| 1929 | * Vrací identifikátor objektu code: nebo id: |
||
| 1930 | * |
||
| 1931 | * @link https://demo.flexibee.eu/devdoc/identifiers Identifikátory záznamů |
||
| 1932 | * |
||
| 1933 | * @return string indentifikátor záznamu reprezentovaného objektem |
||
| 1934 | */ |
||
| 1935 | public function __toString() { |
||
| 1938 | |||
| 1939 | /** |
||
| 1940 | * Gives you FlexiPeeHP class name for Given Evidence |
||
| 1941 | * |
||
| 1942 | * @param string $evidence |
||
| 1943 | * |
||
| 1944 | * @return string Class name |
||
| 1945 | */ |
||
| 1946 | public static function evidenceToClassName($evidence) { |
||
| 1949 | |||
| 1950 | /** |
||
| 1951 | * Obtain ID of first record in evidence |
||
| 1952 | * |
||
| 1953 | * @return string|null id or null if no records |
||
| 1954 | */ |
||
| 1955 | public function getFirstRecordID() { |
||
| 1965 | |||
| 1966 | /** |
||
| 1967 | * Get previous record ID |
||
| 1968 | * |
||
| 1969 | * @param array $conditions optional |
||
| 1970 | * |
||
| 1971 | * @return int|null |
||
| 1972 | */ |
||
| 1973 | public function getNextRecordID($conditions = []) { |
||
| 1981 | |||
| 1982 | /** |
||
| 1983 | * Get next record ID |
||
| 1984 | * |
||
| 1985 | * @param array $conditions optional |
||
| 1986 | * |
||
| 1987 | * @return int|null |
||
| 1988 | */ |
||
| 1989 | public function getPrevRecordID($conditions = []) { |
||
| 1997 | |||
| 1998 | /** |
||
| 1999 | * Vrací hodnotu daného externího ID |
||
| 2000 | * |
||
| 2001 | * @param string $want Namespace Selector. If empty,you obtain the first one. |
||
| 2002 | * |
||
| 2003 | * @return string|array one id or array if multiplete |
||
| 2004 | */ |
||
| 2005 | public function getExternalID($want = null) { |
||
| 2032 | |||
| 2033 | /** |
||
| 2034 | * gives you currently loaded extermal IDs |
||
| 2035 | * |
||
| 2036 | * @return array |
||
| 2037 | */ |
||
| 2038 | public function getExternalIDs() { |
||
| 2041 | |||
| 2042 | /** |
||
| 2043 | * Obtain actual GlobalVersion |
||
| 2044 | * Vrací aktuální globální verzi změn |
||
| 2045 | * |
||
| 2046 | * @link https://www.flexibee.eu/api/dokumentace/ref/changes-api#globalVersion Globální Verze |
||
| 2047 | * |
||
| 2048 | * @return int |
||
| 2049 | */ |
||
| 2050 | public function getGlobalVersion() { |
||
| 2055 | |||
| 2056 | /** |
||
| 2057 | * Gives you current ApiURL with given format suffix |
||
| 2058 | * |
||
| 2059 | * @param string $format json|html|xml|... |
||
| 2060 | * |
||
| 2061 | * @return string API URL for current record or object/evidence |
||
| 2062 | */ |
||
| 2063 | public function getApiURL($format = null) { |
||
| 2067 | |||
| 2068 | /** |
||
| 2069 | * Obtain content type of last response |
||
| 2070 | * |
||
| 2071 | * @return string |
||
| 2072 | */ |
||
| 2073 | public function getResponseFormat() { |
||
| 2076 | |||
| 2077 | /** |
||
| 2078 | * Return the same response format for one and multiplete results |
||
| 2079 | * |
||
| 2080 | * @param array $responseBody |
||
| 2081 | * |
||
| 2082 | * @return array |
||
| 2083 | */ |
||
| 2084 | public function unifyResponseFormat($responseBody) { |
||
| 2112 | |||
| 2113 | /** |
||
| 2114 | * Obtain structure for current (or given) evidence |
||
| 2115 | * |
||
| 2116 | * @param string $evidence |
||
| 2117 | * |
||
| 2118 | * @return array Evidence structure |
||
| 2119 | */ |
||
| 2120 | public function getOfflineColumnsInfo($evidence = null) { |
||
| 2128 | |||
| 2129 | /** |
||
| 2130 | * Obtain Current evidence Live structure |
||
| 2131 | * |
||
| 2132 | * @param string $evidence |
||
| 2133 | * |
||
| 2134 | * @return array structure |
||
| 2135 | */ |
||
| 2136 | public function getOnlineColumnsInfo($evidence = null) { |
||
| 2156 | |||
| 2157 | /** |
||
| 2158 | * Update evidence info from array or online from properties.json or offline |
||
| 2159 | * |
||
| 2160 | * @param array $columnsInfo |
||
| 2161 | * @param string $evidence |
||
| 2162 | */ |
||
| 2163 | public function updateColumnsInfo($columnsInfo = null, $evidence = null) { |
||
| 2171 | |||
| 2172 | /** |
||
| 2173 | * Gives you evidence structure. You can obtain current online by pre-calling: |
||
| 2174 | * $this->updateColumnsInfo($evidence, $this->getOnlineColumnsInfo($evidence)); |
||
| 2175 | * |
||
| 2176 | * @param string $evidence |
||
| 2177 | * |
||
| 2178 | * @return array |
||
| 2179 | */ |
||
| 2180 | public function getColumnsInfo($evidence = null) { |
||
| 2188 | |||
| 2189 | /** |
||
| 2190 | * Gives you properties for (current) evidence column |
||
| 2191 | * |
||
| 2192 | * @param string $column name of column |
||
| 2193 | * @param string $evidence evidence name if different |
||
| 2194 | * |
||
| 2195 | * @return array column properties or null if column not exits |
||
| 2196 | */ |
||
| 2197 | public function getColumnInfo($column, $evidence = null) { |
||
| 2201 | |||
| 2202 | /** |
||
| 2203 | * Obtain actions for current (or given) evidence |
||
| 2204 | * |
||
| 2205 | * @param string $evidence |
||
| 2206 | * |
||
| 2207 | * @return array Evidence structure |
||
| 2208 | */ |
||
| 2209 | public function getActionsInfo($evidence = null) { |
||
| 2220 | |||
| 2221 | /** |
||
| 2222 | * Obtain relations for current (or given) evidence |
||
| 2223 | * |
||
| 2224 | * @param string $evidence |
||
| 2225 | * |
||
| 2226 | * @return array Evidence structure |
||
| 2227 | */ |
||
| 2228 | public function getRelationsInfo($evidence = null) { |
||
| 2239 | |||
| 2240 | /** |
||
| 2241 | * Obtain info for current (or given) evidence |
||
| 2242 | * |
||
| 2243 | * @param string $evidence |
||
| 2244 | * |
||
| 2245 | * @return array Evidence info |
||
| 2246 | */ |
||
| 2247 | public function getEvidenceInfo($evidence = null) { |
||
| 2261 | |||
| 2262 | /** |
||
| 2263 | * Obtain name for current (or given) evidence path |
||
| 2264 | * |
||
| 2265 | * @param string $evidence Evidence Path |
||
| 2266 | * |
||
| 2267 | * @return array Evidence info |
||
| 2268 | */ |
||
| 2269 | public function getEvidenceName($evidence = null) { |
||
| 2279 | |||
| 2280 | /** |
||
| 2281 | * Save current object to file |
||
| 2282 | * |
||
| 2283 | * @param string $destfile path to file |
||
| 2284 | */ |
||
| 2285 | public function saveResponseToFile($destfile) { |
||
| 2291 | |||
| 2292 | /** |
||
| 2293 | * Obtain established relations listing |
||
| 2294 | * |
||
| 2295 | * @return array Null or Relations |
||
| 2296 | */ |
||
| 2297 | public function getVazby($id = null) { |
||
| 2310 | |||
| 2311 | /** |
||
| 2312 | * Gives You URL for Current Record in FlexiBee web interface |
||
| 2313 | * |
||
| 2314 | * @return string url |
||
| 2315 | */ |
||
| 2316 | public function getFlexiBeeURL() { |
||
| 2327 | |||
| 2328 | /** |
||
| 2329 | * Set Record Key |
||
| 2330 | * |
||
| 2331 | * @param int|string $myKeyValue |
||
| 2332 | * |
||
| 2333 | * @return boolean |
||
| 2334 | */ |
||
| 2335 | public function setMyKey($myKeyValue) { |
||
| 2357 | |||
| 2358 | /** |
||
| 2359 | * Set or get ignore not found pages flag |
||
| 2360 | * |
||
| 2361 | * @param boolean $ignore set flag to |
||
| 2362 | * |
||
| 2363 | * @return boolean get flag state |
||
| 2364 | */ |
||
| 2365 | public function ignore404($ignore = null) { |
||
| 2371 | |||
| 2372 | /** |
||
| 2373 | * Send Document by mail |
||
| 2374 | * |
||
| 2375 | * @url https://www.flexibee.eu/api/dokumentace/ref/odesilani-mailem/ |
||
| 2376 | * |
||
| 2377 | * @param string $to Email ecipient |
||
| 2378 | * @param string $subject Email Subject |
||
| 2379 | * @param string $body Email Text |
||
| 2380 | * |
||
| 2381 | * @return boolean mail sent status |
||
| 2382 | */ |
||
| 2383 | public function sendByMail($to, $subject, $body, $cc = null) { |
||
| 2391 | |||
| 2392 | /** |
||
| 2393 | * Send all unsent Documents by eMail |
||
| 2394 | * |
||
| 2395 | * @url https://www.flexibee.eu/api/dokumentace/ref/odesilani-mailem/ |
||
| 2396 | * |
||
| 2397 | * @return int http response code |
||
| 2398 | */ |
||
| 2399 | public function sendUnsent() { |
||
| 2403 | |||
| 2404 | /** |
||
| 2405 | * FlexiBee date to PHP DateTime conversion |
||
| 2406 | * |
||
| 2407 | * @param string $flexidate 2017-05-26 or 2017-05-26+02:00 |
||
| 2408 | * |
||
| 2409 | * @return \DateTime | false |
||
| 2410 | */ |
||
| 2411 | public static function flexiDateToDateTime($flexidate) { |
||
| 2414 | |||
| 2415 | /** |
||
| 2416 | * FlexiBee dateTime to PHP DateTime conversion |
||
| 2417 | * |
||
| 2418 | * @param string $flexidatetime 2017-09-26T10:00:53.755+02:00 or older 2017-05-19T00:00:00+02:00 |
||
| 2419 | * |
||
| 2420 | * @return \DateTime | false |
||
| 2421 | */ |
||
| 2422 | public static function flexiDateTimeToDateTime($flexidatetime) { |
||
| 2430 | |||
| 2431 | /** |
||
| 2432 | * Získá dokument v daném formátu |
||
| 2433 | * Obtain document in given format |
||
| 2434 | * |
||
| 2435 | * @link https://www.flexibee.eu/api/dokumentace/ref/pdf/ PDF Exports |
||
| 2436 | * |
||
| 2437 | * @param string $format pdf/csv/xml/json/ ... |
||
| 2438 | * @param string $reportName Template used to generate PDF |
||
| 2439 | * @param string $lang cs|sk|en|de Template language used to generate PDF |
||
| 2440 | * @param boolean $sign sign resulting PDF by certificate ? |
||
| 2441 | * |
||
| 2442 | * @return string|null filename downloaded or none |
||
| 2443 | */ |
||
| 2444 | public function getInFormat($format, $reportName = null, $lang = null, |
||
| 2483 | |||
| 2484 | /** |
||
| 2485 | * Uloží dokument v daném formátu do složky v systému souborů |
||
| 2486 | * Save document in given format to directory in filesystem |
||
| 2487 | * |
||
| 2488 | * @param string $format pdf/csv/xml/json/ ... |
||
| 2489 | * @param string $destDir where to put file (prefix) |
||
| 2490 | * @param string $reportName Template used to generate PDF |
||
| 2491 | * |
||
| 2492 | * @return string|null filename downloaded or none |
||
| 2493 | */ |
||
| 2494 | public function downloadInFormat($format, $destDir = './', |
||
| 2509 | |||
| 2510 | /** |
||
| 2511 | * Take data for object. separate external IDs |
||
| 2512 | * |
||
| 2513 | * @param array $data Data to keep |
||
| 2514 | * |
||
| 2515 | * @return int number of records taken |
||
| 2516 | */ |
||
| 2517 | public function takeData($data) { |
||
| 2538 | |||
| 2539 | /** |
||
| 2540 | * Get Current Evidence reports listing |
||
| 2541 | * |
||
| 2542 | * @link https://www.flexibee.eu/api/dokumentace/casto-kladene-dotazy-pro-api/vyber-reportu-do-pdf/ Výběr reportu do PDF |
||
| 2543 | * |
||
| 2544 | * @return array |
||
| 2545 | */ |
||
| 2546 | public function getReportsInfo() { |
||
| 2560 | |||
| 2561 | /** |
||
| 2562 | * Request authSessionId from current server |
||
| 2563 | * |
||
| 2564 | * @link https://www.flexibee.eu/api/dokumentace/ref/login/ description |
||
| 2565 | * |
||
| 2566 | * @param string $username |
||
| 2567 | * @param string $password |
||
| 2568 | * @param string $otp optional onetime password |
||
| 2569 | * |
||
| 2570 | * @return string authUserId or null in case of problems |
||
| 2571 | */ |
||
| 2572 | public function requestAuthSessionID($username, $password, $otp = null) { |
||
| 2585 | |||
| 2586 | /** |
||
| 2587 | * Try to Sign in current user to FlexiBee and keep authSessionId |
||
| 2588 | * |
||
| 2589 | * @return boolean sign in success |
||
| 2590 | */ |
||
| 2591 | public function login() { |
||
| 2596 | |||
| 2597 | /** |
||
| 2598 | * End (current's user) session |
||
| 2599 | * |
||
| 2600 | * |
||
| 2601 | * @link https://www.flexibee.eu/api/dokumentace/ref/logout Logout Reference |
||
| 2602 | * |
||
| 2603 | * @param string $username force username to sign off |
||
| 2604 | * |
||
| 2605 | * @return array server response |
||
| 2606 | */ |
||
| 2607 | public function logout($username = null) { |
||
| 2610 | |||
| 2611 | /** |
||
| 2612 | * Compile and send Report about Error500 to FlexiBee developers |
||
| 2613 | * If FlexiBee is running on localost try also include java backtrace |
||
| 2614 | * |
||
| 2615 | * @param array $errorResponse result of parseError(); |
||
| 2616 | */ |
||
| 2617 | public function error500Reporter($errorResponse) { |
||
| 2681 | |||
| 2682 | /** |
||
| 2683 | * Returns code:CODE |
||
| 2684 | * |
||
| 2685 | * @param string $code |
||
| 2686 | * |
||
| 2687 | * @return string |
||
| 2688 | */ |
||
| 2689 | public static function code($code) { |
||
| 2692 | |||
| 2693 | /** |
||
| 2694 | * Returns CODE without code: prefix |
||
| 2695 | * |
||
| 2696 | * @param string $code |
||
| 2697 | * |
||
| 2698 | * @return string |
||
| 2699 | */ |
||
| 2700 | public static function uncode($code) { |
||
| 2703 | |||
| 2704 | /** |
||
| 2705 | * Remove all @ items from array |
||
| 2706 | * |
||
| 2707 | * @param array $data original data |
||
| 2708 | * |
||
| 2709 | * @return array data without @ columns |
||
| 2710 | */ |
||
| 2711 | public static function arrayCleanUP($data) { |
||
| 2718 | |||
| 2719 | /** |
||
| 2720 | * Add Info about used user, server and libraries |
||
| 2721 | * |
||
| 2722 | * @param string $prefix banner prefix text |
||
| 2723 | * @param string $suffix banner suffix text |
||
| 2724 | */ |
||
| 2725 | public function logBanner($prefix = null, $suffix = null) { |
||
| 2732 | |||
| 2733 | /** |
||
| 2734 | * Get Last operation type |
||
| 2735 | * |
||
| 2736 | * @return string create|read|update|delete or update,insert for some inserted and updated in one transaction |
||
| 2737 | */ |
||
| 2738 | public function getLastOperationType() { |
||
| 2741 | |||
| 2742 | /** |
||
| 2743 | * Last operation errors |
||
| 2744 | * |
||
| 2745 | * @return array FlexiBee error meassages |
||
| 2746 | */ |
||
| 2747 | public function getErrors() { |
||
| 2750 | |||
| 2751 | /** |
||
| 2752 | * Reconnect After unserialization |
||
| 2753 | */ |
||
| 2754 | public function __wakeup() { |
||
| 2757 | |||
| 2758 | } |
||
| 2759 |
Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.
Let’s take a look at an example:
As you can see in this example, the array
$myArrayis initialized the first time when the foreach loop is entered. You can also see that the value of thebarkey is only written conditionally; thus, its value might result from a previous iteration.This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.