people_sdk/param

Library People SDK: configuration components

v1.0.0 2024-01-03 22:08 UTC

Requires

• php: ~7 || ~8
• liberty_code/http: ^1.0.
• liberty_code/library: ^1.0.
• liberty_code/model: ^1.0.
• liberty_code/parser: ^1.0.
• liberty_code/requisition: ^1.0.
• liberty_code/validation: ^1.0.
• people_sdk/library: ^1.0.

BSD-3-Clause

README

Description

Library contains configuration components, to implements configuration tools, using API configuration features.

Requirement

• Script language: PHP: version 7 || 8

Framework library implementation requirement

1. Library repository: liberty_code/parser: version 1.0

   • String table parser factory implementation:

     Persistor HTTP request, data HTTP response and persistor HTTP response instances, used via default persistor and/or requester, provided on repository, must be able to use string table parser factory features (or equivalent), allowing to provide JSON string table parser instances.

2. Library repository: liberty_code/validation: version 1.0

   • Standard rules implementation (or equivalent):

     Validator provided on entities, must contain all standard rules, added on its rule collection.

   • Validator rules implementation (or equivalent):

     Validator provided on entities, must contain all validator rules, added on its rule collection. Each validator rule must use validator, with same implementation as validator provided on entities.

3. Library repository: liberty_code/http: version 1.0

   • HTTP request factory implementation:

     Default persistor and/or requester, provided on repository, must be able to use HTTP request factory features (or equivalent), allowing to provide HTTP request and persistor HTTP request instances.

   • HTTP response factory implementation:

     Client used on default persistor and/or requester, provided on repository, must be able to use HTTP response factory features (or equivalent), allowing to provide data HTTP response and persistor HTTP response instances.

   • HTTP client implementation:

     Default persistor and/or requester, provided on repository, must be able to use HTTP client features (or equivalent), to execute HTTP request sending.

Installation

Several ways are possible:

Composer

1. Requirement

   It requires composer installation. For more information: https://getcomposer.org

2. Command: Move in project root directory

    cd "<project_root_dir_path>"
   

3. Command: Installation

    php composer.phar require people_sdk/param ["<version>"]
   

4. Note

   • Include vendor

     If project uses composer, vendor must be included:

       require_once('<project_root_dir_path>/vendor/autoload.php');
     

   • Configuration

     Installation command allows to add, on composer file "/composer.json", following configuration:

       {
           "require": {
               "people_sdk/param": "<version>"
           }
       }
     

Include

1. Download

   • Download following repository.
   • Put it on repository root directory.

2. Include source

    require_once('<repository_root_path>/include/Include.php');
   

Usage

TODO