people_sdk/module_role

Module People SDK: permission and role components

v1.0.0 2024-06-09 16:24 UTC

Requires

• php: ~7 || ~8
• liberty_code/config: ^1.0.
• liberty_code/di: ^1.0.
• liberty_code/framework: ^1.0.
• liberty_code/library: ^1.0.
• liberty_code/role: ^1.0.
• people_sdk/library: ^1.0.
• people_sdk/role: ^1.0.

BSD-3-Clause

README

Description

Library contains application modules, to implements permission and role components, to use API authorization features, on application. Application is considered as LibertyCode application.

Requirement

• Script language: PHP: version 7 || 8

Framework module installation requirement

1. Module repository: liberty_code_module/validation: version 1.0

   • Module validation (or equivalent).
   • Module rule (or equivalent).

2. Module repository: liberty_code_module/datetime: version 1.0

   • Module datetime (or equivalent).

3. Module repository: people_sdk/module_library: version 1.0

   • Module requisition (or equivalent).

4. Other module implementation:

   • DI configuration:

     • people_requisition_persistor:

       See people_sdk/role v1.0 framework library implementation requirement, for persistor.

     • people_requisition_requester:

       See people_sdk/role v1.0 framework library implementation requirement, for requester.

     • people_requisition_config.

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/module_role ["<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 "

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

Include

1. Download

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

2. Include source

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

Application installation

Configuration

1. Configuration: application module: "

   Add in list part, required modules:

   Example for YML configuration format, from composer installation:

    list: [
        {
            path: "/vendor/people_sdk/module_role/src/permission",
            config_parser: {
                type: "string_table_php",
                source_format_get_regexp: "#^\\<\\?php\\s*(.*)(\\s\\?\\>)?\\s*$#ms",
                source_format_set_pattern: "<?php \\n%1$s",
                cache_parser_require: true,
                cache_file_parser_require: true
            }
        },
        {
            path: "/vendor/people_sdk/module_role/src/role",
            config_parser: {
                type: "string_table_php",
                source_format_get_regexp: "#^\\<\\?php\\s*(.*)(\\s\\?\\>)?\\s*$#ms",
                source_format_set_pattern: "<?php \\n%1$s",
                cache_parser_require: true,
                cache_file_parser_require: true
            }
        },
        {
            path: "/vendor/people_sdk/module_role/src/profile",
            config_parser: {
                type: "string_table_php",
                source_format_get_regexp: "#^\\<\\?php\\s*(.*)(\\s\\?\\>)?\\s*$#ms",
                source_format_set_pattern: "<?php \\n%1$s",
                cache_parser_require: true,
                cache_file_parser_require: true
            }
        },
        {
            path: "/vendor/people_sdk/module_role/src/requisition",
            config_parser: {
                type: "string_table_php",
                source_format_get_regexp: "#^\\<\\?php\\s*(.*)(\\s\\?\\>)?\\s*$#ms",
                source_format_set_pattern: "<?php \\n%1$s",
                cache_parser_require: true,
                cache_file_parser_require: true
            }
        }
    ]
   

Configuration

Application parameters configuration

• Use following file on your modules to configure specific elements

    <module_root_path>/config/ParamApp.php
  

• Elements configurables

  • Configuration to param permission specification.

  • Configuration to param role factory.

  • Configuration to param role requisition request sending information factory.

Usage

TODO