PHP AbraFlexi

https://github.com/spoje-net/php-abraflexi
Admin
A PHP library for seamless integration with the Czech accounting system AbraFlexi, enabling easy...
Tokens:6,173
Snippets:40
Trust Score:6.1
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### AbraFlexi Examples Overview

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

This list provides an overview of the example scripts available in the 'Examples' directory of the php-abraflexi project. Each entry includes the filename and a brief description of the functionality demonstrated.

```APIDOC
Examples:

- AttachmentSaveToFile.php: Uložení přílohy do souboru
- AttachmentUpload.php: Nahrání přílohy
- AuthSessionIdUsage.php: Ukázka autentizace AuthSessionId
- AuthentizeContact.php: Autentizace kontaktu
- BatchOperation.php: Použití filtru při dávkových operacích
- CreateLabel.php: Práce se štítky
- DryRun.php: Testovací uložení (dry-run)
- DownloadInvoicePDF.php: Stažení PDF faktury
- Error404.php: Práce s neexistujícími záznamy
- FindOverdueInvoices.php: Najdi faktury po splatnosti
- GetRecordWithRelation.php: Získání záznamu včetně dat z podevidence
- GetBankAccountForCompany.php: Získání bankovního účtu k firmě z adresáře
- InvoiceLockUnlock.php: Zamykání a odemykání záznamu
- InvoiceCopy.php: Vytvoření daňového dokladu ze zálohy
- LoginLogout.php: Přihlášení uživatele a jeho odhlášení
- NajdiDanovyDokladKzalohovemu.php: Dohledání dokladu
- Naskladnění.php: Naskladní produkt se sériovými čísly
- NewInvoice.php: Nová faktura se splatností vypsaná jako json
- ObjectChaining.php: Řetězení objektů pro více operací v jenom pořadavku
- ObjectCooperation.php: Sdílení data a parametrů připojení mezi objekty
- PerformingActions.php: Jak vykonávat akce nad dokladem akce. např. storno
- ReadAddressColumns.php: Vrať konkrétní sloupečky
- sendInvoiceByMail.php: Odeslání faktury mailem
- SendReminders.php: Odeslání upomínek
- SetContactAuth.php: Nastavení autentizace
- TestConnection.php: Kontrola spojení
```

--------------------------------

### Installation with Composer

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Installs the PHP AbraFlexi library using Composer. This command adds the library as a dependency to your project.

```shell
composer require spojenet/flexibee
```

--------------------------------

### Authentication Examples in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Illustrates different authentication methods for interacting with AbraFlexi, including using AuthSessionId and authenticating contacts. These examples are crucial for establishing secure connections.

```php
<?php

// Example for AuthSessionIdUsage.php
// Example of AuthSessionId authentication
// ... code ...

// Example for AuthentizeContact.php
// Contact authentication
// ... code ...

// Example for SetContactAuth.php
// Set authentication for a contact
// ... code ...

// Example for LoginLogout.php
// User login and logout
// ... code ...
```

--------------------------------

### Label Management in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Provides an example of how to work with labels in AbraFlexi, demonstrating the creation and management of labels for organizing records.

```php
<?php

// Example for CreateLabel.php
// working with labels
// ... code ...
```

--------------------------------

### Connection Check in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Shows a simple example of how to check the connection to the AbraFlexi service.

```php
<?php

// Example for TestConnection.php
// connection check
// ... code ...
```

--------------------------------

### Sending Reminders in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Provides an example of how to send reminders using the AbraFlexi system.

```php
<?php

// Example for SendReminders.php
// send reminders
// ... code ...
```

--------------------------------

### Install php-abraflexi using Composer

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

This snippet shows how to add the php-abraflexi library to your project's dependencies using Composer and the required composer.json configuration.

```shell
composer require spojenet/flexibee

{
    "require": {
        "spojenet/flexibee": "^3.6"
    }
}

composer install
```

--------------------------------

### Stock Management with Serial Numbers in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Provides an example of how to stock products, specifically handling items with serial numbers.

```php
<?php

// Example for Naskladnění.php
// Stock product with serial numbers
// ... code ...
```

--------------------------------

### Attachment Operations in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Demonstrates how to save attachments to a file and upload attachments using the AbraFlexi PHP library. These examples showcase basic file handling and data transfer operations.

```php
<?php

// Example for AttachmentSaveToFile.php
// Save attachment to file
// ... code ...

// Example for AttachmentUpload.php
// Upload attachment
// ... code ...
```

--------------------------------

### AbraFlexi Data Types

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

This table describes various data types used in AbraFlexi, including their Czech names, descriptions, example values, and corresponding PHP types.

```APIDOC
Data Types:

- datetime: Datum + čas
  - Description: Datum a čas ve formátu YYYY-MM-DD'T'HH:MM:SS.SSS; lze zadat i časovou zónu (YYYY-MM-DD'T'HH:MM:SS.SSSZZZ), ale ta bude ignorována.
  - Example Values: 1980‑05‑06, 1980‑05‑06T12:30:12, 2015‑01‑30T22:55:33Z, 2008‑09‑01T17:18:14+02:00, 2008‑09‑01T17:18:14.075+02:00
  - PHP Type: \DateTime()

- logic: Logická hodnota
  - Description: boolean
  - Example Values: true, false
  - PHP Type: boolean

- select: Výběr jedné z hodnot
  - Description: Výběr jedné z hodnot. Je reprezentován jako řetězec.
  - Example Values: typVztahu.odberDodav
  - PHP Type: string

- relation: Vazba mezi daty
  - Description: Vstupem je záznam z jiné evidence (přehled typů identifikátorů)
  - Example Values: 123 code:CZK ext:DB:232
  - PHP Type: \AbraFlexi\Relation
```

--------------------------------

### Configuration via Class Instantiation (Session ID)

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Shows how to connect to a specific AbraFlexi instance and order using dynamic parameters like company URL and authentication session ID, often passed from user input.

```php
$order = new \AbraFlexi\ObjednavkaPrijata('code:OBP0034/2019',['companyUrl'=> $_GET['companyUrl'], 'authSessionId'=>$_GET['authSessionId'] ])
```

--------------------------------

### Configuration via Environment Variables

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Demonstrates how the library can automatically pick up configuration from environment variables if the PHP constants are not defined. This allows for flexible deployment configurations.

```php
// Example: getenv('ABRAFLEXI_URL')
```

--------------------------------

### Configuration via Class Instantiation (Credentials)

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Provides an alternative method for configuring connection details by passing them directly as an array when creating an instance of an AbraFlexi class. This method has higher priority than constants.

```php
$invoicer = new \AbraFlexi\FakturaVydana(null,[
            'company' => 'Firma_s_r_o_',
            'url' => 'https://abraflexi.firma.cz/',
            'user' => 'rest',
            'password' => '-dj3x21xaA_'
        ]);
```

--------------------------------

### Instantiate FakturaVydana with Options

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Demonstrates creating an instance of the FakturaVydana class with custom constructor parameters like disabling native types and enabling debug mode.

```php
new \AbraFlexi\FakturaVydana( 'code:VF2-12345', ['nativeTypes'=>false,'debug'=>true,'ignore404'=>false] );
```

--------------------------------

### Composer Autoload Configuration for Testing

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Shows how to configure the 'autoload-dev' section in composer.json to include paths for testing classes from the php-abraflexi library and other related packages.

```json
{
    "autoload-dev": {
        "psr-4": {
            "Test\\": "vendor/spojenet/php-abraflexi/test/src/AbraFlexi/test/",
            "Test\\Ease\": "vendor/vitexsoftware/ease-core/tests/src/Ease",
            "Test\\AbraFlexi\": "vendor/spojenet/php-abraflexi/test/src/AbraFlexi/"
         }
    }
}
```

--------------------------------

### Instantiating AbraFlexi Classes with Credentials

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

Demonstrates how to create instances of AbraFlexi classes, such as FakturaVydana and ObjednavkaPrijata, by passing connection details directly during instantiation, overriding constant configurations.

```php
$invoicer = new \AbraFlexi\FakturaVydana(null,[
                'company' => 'Firma_s_r_o_',
                'url' => 'https://abraflexi.firma.cz/',
                'user' => 'rest',
                'password' => '-dj3x21xaA_'
            ]);

$order = new \AbraFlexi\ObjednavkaPrijata('code:OBP0034/2019',['companyUrl'=> $_GET['companyUrl'], 'authSessionId'=>$_GET['authSessionId'] ])
```

--------------------------------

### Configuration via Constants

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Sets up the connection details for the AbraFlexi API using PHP constants. These constants define the API URL, login credentials, company, and optional settings like timeout and exception handling.

```php
define('ABRAFLEXI_URL', 'https://abraflexi-dev.spoje.net:5434');
define('ABRAFLEXI_LOGIN', 'apiuser');
define('ABRAFLEXI_PASSWORD', 'apipass');
define('ABRAFLEXI_COMPANY', 'test_s_r_o_');
define('ABRAFLEXI_AUTHSESSID', '6QuifebMits'); // Optional
define('ABRAFLEXI_TIMEOUT', 60); // Optional
define('ABRAFLEXI_EXCEPTIONS', true); // Optional
```

--------------------------------

### Invoice Creation with JSON Output in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Shows how to create a new invoice and print the due date as JSON, demonstrating flexible data formatting.

```php
<?php

// Example for NewInvoice.php
// New invoice with due date printed as json
// ... code ...
```

--------------------------------

### Instantiate FakturaVydana Class

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

Demonstrates how to create an instance of the FakturaVydana class with specific constructor parameters, including disabling native types and enabling debug mode.

```php
new AbraFlexiFakturaVydana( 'code:VF2-12345', ['nativeTypes'=>false,'debug'=>true,'ignore404'=>false] );
```

--------------------------------

### Object Chaining and Cooperation in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Illustrates advanced usage patterns like object chaining for multiple operations in a single request and sharing data/connection parameters between objects.

```php
<?php

// Example for ObjectChaining.php
// Chaining objects for multiple operations in one request
// ... code ...

// Example for ObjectCooperation.php
// Sharing data and connection parameters between objects
// ... code ...
```

--------------------------------

### List All Units of Measure

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Demonstrates how to instantiate the MernaJednotka class and retrieve all records using the getAllFromAbraFlexi method.

```php
$jednotky = new MernaJednotka();
print_r( $jednotky->getAllFromAbraFlexi() );
```

--------------------------------

### Performing Actions on Documents in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Demonstrates how to perform actions on a document, such as cancellation, using the AbraFlexi library.

```php
<?php

// Example for PerformingActions.php
// How to perform actions on a document, e.g. cancellation
// ... code ...
```

--------------------------------

### PHPUnit Test Configuration

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

This snippet shows how to configure the 'autoload-dev' section in your composer.json file to include paths for the php-abraflexi tests and related libraries. This is crucial for running tests, especially when extending AbraFlexi classes.

```json
{
    "autoload-dev": {
        "psr-4": {
            "Test\\": "vendor/spojenet/php-abraflexi/test/src/AbraFlexi/test/",
            "Test\\Ease\": "vendor/vitexsoftware/ease-core/tests/src/Ease",
            "Test\\AbraFlexi\": "vendor/spojenet/php-abraflexi/test/src/AbraFlexi/"
         }
    }
}
```

--------------------------------

### Dry Run and Testing in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Demonstrates how to perform a test save operation using the 'dry-run' feature in AbraFlexi. This allows for validation without committing changes.

```php
<?php

// Example for DryRun.php
// Test save (dry-run)
// ... code ...
```

--------------------------------

### Monitor Structure Update Progress

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Shell command to monitor the progress of the structure update process by tailing the syslog for 'AbraFlexitest' entries.

```shell
tail -f /var/log/syslog | grep  AbraFlexitest
```

--------------------------------

### Batch Operations and Filtering in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Shows how to perform batch operations and utilize filters for efficient data management within AbraFlexi. This is useful for processing multiple records or specific subsets of data.

```php
<?php

// Example for BatchOperation.php
// Using filter in batch operations
// ... code ...
```

--------------------------------

### Invoice and Document Handling in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Covers various operations related to invoices and documents, including downloading PDFs, handling errors for non-existent records, finding overdue invoices, creating documents from advances, and sending invoices by email.

```php
<?php

// Example for DownloadInvoicePDF.php
// download invoice PDF
// ... code ...

// Example for Error404.php
// working with non-existent records
// ... code ...

// Example for FindOverdueInvoices.php
// find overdue invoices
// ... code ...

// Example for InvoiceCopy.php
// create tax document from advance
// ... code ...

// Example for sendInvoiceByMail.php
// send invoice by email
// ... code ...

// Example for NajdiDanovyDokladKzalohovemu.php
// find document
// ... code ...
```

--------------------------------

### Composer.json Dependency

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Specifies the PHP AbraFlexi library as a requirement in your project's composer.json file.

```json
{
    "require": {
        "spojenet/flexibee": "^3.6"
    }
}
```

--------------------------------

### Access Evidence Structure

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Retrieves the structure definition for a specific evidence type ('faktura-vydana') directly from the static Structure::$evidence array.

```php
echo AbraFlexiStructure::$evidence['faktura-vydana'];
```

--------------------------------

### Accessing Evidence Structure Information

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

Demonstrates how to retrieve and display structural information about AbraFlexi evidence, such as the details for 'faktura-vydana', by accessing static properties within the `AbraFlexi\Structure` class.

```php
echo \AbraFlexi\Structure::$evidence['faktura-vydana'];
```

--------------------------------

### AbraFlexi API Configuration Constants

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

Defines the necessary PHP constants for configuring the connection to the AbraFlexi API, including URL, login, password, company, and optional settings like timeout and exception handling.

```php
define('ABRAFLEXI_URL', 'https://abraflexi-dev.spoje.net:5434');
define('ABRAFLEXI_LOGIN', 'apiuser');
define('ABRAFLEXI_PASSWORD', 'apipass');
define('ABRAFLEXI_COMPANY', 'test_s_r_o_');
define('ABRAFLEXI_AUTHSESSID', '6QuifebMits'); //Volitelné
define('ABRAFLEXI_TIMEOUT', 60); //Volitelné
define('ABRAFLEXI_EXCEPTIONS', true); //Vracet PHP vyjímku v případě že AbraFlexi vrátí chybu
```

--------------------------------

### Data Retrieval and Relations in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Shows how to retrieve records along with data from related sub-records and fetch specific columns from addresses. This is useful for accessing complex data structures.

```php
<?php

// Example for GetRecordWithRelation.php
// Get record including data from sub-record
// ... code ...

// Example for GetBankAccountForCompany.php
// Get bank account for company from directory
// ... code ...

// Example for ReadAddressColumns.php
// return specific columns
// ... code ...
```

--------------------------------

### Creating Custom Evidence Classes

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

Shows how to extend the base AbraFlexi classes (RW or RW) to create custom classes for specific AbraFlexi evidence types, like 'merna-jednotka'. This involves defining the `$evidence` property and optionally using methods like `getAllFromAbraFlexi`.

```php
function evidenceToClass($evidence)
    {
        return str_replace(' ', '', ucwords(str_replace('-', ' ', $evidence)));
    }

    <?php
    /**
     * @link https://demo.abraflexi.eu/c/demo/merna-jednotka/properties Vlastnosti evidence
     */
    class MernaJednotka extends /AbraFlexi/RW
    {
        /**
         * Evidence užitá objektem.
         *
         * @var string
         */
        public $evidence = 'merna-jednotka';
    }

    $jednotky = new MernaJednotka();
    print_r( $jednotky->getAllFromAbraFlexi() );
```

--------------------------------

### Convert Evidence to Class Name

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Converts an evidence string (e.g., 'merna-jednotka') into a class-friendly format (e.g., 'MernaJednotka') by removing hyphens and capitalizing words.

```php
function evidenceToClass($evidence)
{
    return str_replace(' ', '', ucwords(str_replace('-', ' ', $evidence)));
}
```

--------------------------------

### Record Locking and Unlocking in PHP

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Demonstrates how to lock and unlock records in AbraFlexi, ensuring data integrity during concurrent operations.

```php
<?php

// Example for InvoiceLockUnlock.php
// Locking and unlocking record
// ... code ...
```

--------------------------------

### Update All Structures Script

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Shell command to execute the update_all.sh script, which regenerates current record structures. This process can take several minutes.

```shell
cd tools/
./update_all.sh
```

--------------------------------

### Define MernaJednotka Class

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.md

Defines a custom class 'MernaJednotka' that extends the AbraFlexi\RW base class, specifying its associated evidence type 'merna-jednotka'. Includes a link to API properties.

```php
<?php
/**
 * @link https://demo.abraflexi.eu/c/demo/merna-jednotka/properties Properties of the record
 */
class MernaJednotka extends /AbraFlexi/RW
{
    /**
     * Record used by the object.
     *
     * @var string
     */
    public $evidence = 'merna-jednotka';
}
```

--------------------------------

### Monitor AbraFlexi Logs

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

Monitors the system log for messages related to AbraFlexi, useful for tracking operations and debugging.

```shell
tail -f /var/log/syslog | grep  AbraFlexitest
```

--------------------------------

### Generate Evidence Class Name

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

Generates the class name for an evidence by converting the evidence name to a camel-cased string with the first letter in lowercase.

```php
lcfirst(AbraFlexiFunctions::evidenceToClassName($evidence))
```

--------------------------------

### Update All Scripts

Source: https://github.com/spoje-net/php-abraflexi/blob/main/README.cs.md

Executes a shell script to update all necessary components. This operation may take several minutes.

```shell
cd tools/
./update_all.sh
```
Tokens:
Raw