simplify-service-layer/base

base service to simplify service layer implement

dev-master 2025-03-26 16:30 UTC

Requires

• php: >=7.4
• illuminate/validation: ^8.83

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.39
• phpunit/phpunit: ^9.5

MIT

README

helper for declarative backend service layer.

UseCase Example

class UserService extends Service {

    public function __constructor(UserRepository $userRepository)
    {
        $this->userRepository = $userRepository;
    }

    /**
     * names declaration be used in validation error message
     */
    public function getNames()
    {
        return [
            // basic example
            'token' => 'authorized token',
            // dictionary type data key must have '[...]' for subkey naming
            'auth_user' => 'authorized user[...]',
            // nested bound name with '{{keyName}}'
            'user_profile' => 'profile[...] for {{auth_user}}',
        ];
    }

    /**
     * callbacks declaration be run after validation check is passed
     */
    public function getCallbacks()
    {
        return [
            // called after `auth_user` validation check is passed
            'auth_user__session' => function ($authUser) {
                // session
                Session::setData('auth_user', $authUser)
            },
            // called after `auth_user` validation check is passed
            'auth_user__logging' => function ($authUser) {
                // logging
                Log::write('user id:'.$authUser->getId().' logged in');
            },
        ];
    }

    /**
     * loaders declaration be used for loading data
     */
    public function getLoaders()
    {
        return [
            // injected `$userRepository` value take from instance properties
            // injected `$jwe` value take from loaded data
            'auth_user' => function ($jwe, $userRepository) {
                return $userRepository->findById($jwe->sid);
            },
            // injected `$token` value take from init input token parameter
            'jwe' => function ($token) {
                return new JWE($token);
            },

            // result key must be exists
            // result key is output value of $service->run
            'result' => function ($authUser) {
                return $authUser;
            }
        ];
    }

    /**
     * rule lists declaration be used for validation check
     */
    public function getRuleLists()
    {
        return [
            // ...
        ];
    }
}