rarus/bonus-server-php-sdk

Bonus server PHP SDK

1.3.0 2024-03-25 07:43 UTC

Requires

• php: ^7.2|^8.0
• ext-curl: *
• ext-json: *
• fig/http-message-util: 1.*
• guzzlehttp/guzzle: ^7.0
• moneyphp/money: ^3.0
• monolog/monolog: 2.*
• psr/log: ^1.1|^2.0|^3.0

Requires (Dev)

• php-parallel-lint/php-console-highlighter: ^1.0
• php-parallel-lint/php-parallel-lint: ^1.0
• phpunit/phpunit: ^7.0|^8.0
• vimeo/psalm: ^4.29

MIT

• Ivlev Andrey
• Grishin Mikhail

• php
• rest
• api
• Rarus

README

Архитектура

• Библиотека предоставляет сущности бонусного сервера в виде объектов.
• Обмен данными по сети осуществляется через транспорты, для каждой сущности он свой.
• С клиентским кодом библиотека взаимодействует с помощью DTO-объектов
• Транспорт получает и возвращает DTO-объекты или их коллекции.

Структура сущности

\Entity
    \DTO
        Entity.php - DTO-объект сущности
        EntityCollection - типизированая коллекция объектов сущности, наследуется от \SplObjectStorage
        Fabric.php - фабрика сущности 
    \Transport
        \Role
            \Organization
                Transport.php — класс транспорта сущности для роли организация
                Fabric.php - фабрика транспорта сущности            
            \User
                Transport.php — класс транспорта сущности для роли пользователь
                Fabric.php - фабрика транспорта сущности                        
    \Formatters
        Entity.php - класс, отвечающий за представление сущности в нужном виде, по умолчанию - массив

Иерархия исключений

\Exception
    \BonusServerException - корневой тип исключения
        \ApiClientException - ошибки, связанные с логикой работы предметной области
            \NetworkException - ошибки, связанные с передачей данных по сети и работой сервера
        \UnknownException - ошибки, которые не удалось классифицировать и корректно обработать