Service Provider

Service Provider

We're building applications that has a single purpose in which it must be separated under your underlying app.

This page helps you to create your own service, or helps you on how to handle a service.

I you'd read the Module, there is a sample to create your own service provider.

Index

• Basic Usage
• Relying on a Service
• Vendor Publish

---

Basic Usage

To create a service, you must create a class, let's assume we're building a bridge to wrap a certain library.

Let's assume we have this package to be imported on our project jenssegers/agent, now we want to easily create a dependency injection for this project rather than having an instance everytime we need it.

Shell

cd /var/www/my-slayer-agent/
mkdir src/
composer init

Now manage your composer, write the essential things. Upon doing that you might want to add this to your composer.json

JSON

    "autoload": {
        "psr-4": {
            "MySlayerAgent\\Agent\\": "src/"
        }
    }

Run the initial composer dumpautoload so that it will register as a psr4, it interprets your src/ folder having this namespace MySlayerAgent\Agent. Let's create a class name it as AgentServiceProvider

PHP

// root-folder/src/AgentServiceProvider.php
<?php
namespace MySlayerAgent\Agent;

use Jenssegers\Agent\Agent;
use Clarity\Providers\ServiceProvider;

class AgentServiceProvider extends ServiceProvider
{
    protected $alias = 'agent';
    protected $shared = false;

    public function register()
    {
        return new Agent;
    }
}

Register this clas inside project-name/config/app.php under services, as MySlayerAgent\Agent\AgentServiceProvider::class

The above class will be injected as dependency using the alias agent, the register() function returns an instance of \Jenssegers\Agent\Agent in which you can call using the di() function.

PHP

di()->get('agent')->is('Windows');
di()->get('agent')->is('Firefox');
di()->get('agent')->is('iPhone');
di()->get('agent')->is('OS X');
di()->get('agent')->isAndroidOS();
di()->get('agent')->isNexus();
di()->get('agent')->isSafari();
di()->get('agent')->isMobile();
di()->get('agent')->isTablet();
di()->get('agent')->match('regexp');
di()->get('agent')->languages();

You could even create your own facade.

PHP

// root-folder/src/AgentFacade.php
<?php
namespace MySlayerAgent\Agent;

use Clarity\Facades\Facade;

class AgentFacade extends Facade
{
    protected static function getFacadeAccessor()
    {
        return 'agent';
    }
}

Register it as well at app.php config as 'Agent' => MySlayerAgent\Agent\AgentFacade::class

Now you can easily call it through this

PHP

\Agent::is('Windows');
\Agent::is('Firefox');
\Agent::is('iPhone');
\Agent::is('OS X');
\Agent::isAndroidOS();
\Agent::isNexus();
\Agent::isSafari();
\Agent::isMobile();
\Agent::isTablet();
\Agent::match('regexp');
\Agent::languages();

---

Relying on a Service

To rely on other services, there is a boot() function that you could call.

PHP

    public function boot()
    {
        # add some event manager and so on ...
        // di()->get('log')->...
    }

There is also an example, find project-name/components/Providers/, check the Application.php and Dispatcher.php, we call the dependency injection itself to create an event.

Application.php:

PHP

    public function boot()
    {
        $app = di()->get('application');

        $event_manager = new EventsManager;

        $event_manager->attach('application', new ApplicationEventListener);

        $app->setEventsManager($event_manager);
    }

---

Vendor Publish

So you have files that you want to import from the root path of your project. There is an option to do that.

Under boot() function, you can call the publish(<array folders>, <tag name>) command.

PHP

    public function boot()
    {
        $this->publish([
            __DIR__.'/resources/views' => base_path('resources/views/vendor/popeye'),
        ], 'view');
    
        $this->publish([
            __DIR__.'/dist' => base_path(),
        ], 'dist');
    }

The above code shows, on how you could publish your folders. Try to run this on your console. Here's the console format php brood vendor:publish <provider alias>, and there is a tag option.

PHP

php brood vendor:publish popeye

The above console command will iterate all the registered tags and requires you to confirm one-by-one.

To make a specific publish, you can add --tag in the command

PHP

php brood vendor:publish popeye --tag=dist