PommProject\Foundation\Listener\Listener

Complexity

Total Complexity

6

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getClientType()	0	4	1
A	getClientIdentifier()	0	4	1
A	attachAction()	0	6	1
A	notify()	0	8	2

<?php
/*
 * This file is part of the Pomm's Foundation package.
 *
 * (c) 2014 - 2017 Grégoire HUBERT <hubert.greg@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PommProject\Foundation\Listener;

use PommProject\Foundation\Exception\FoundationException;
use PommProject\Foundation\Client\ClientInterface;
use PommProject\Foundation\Client\Client;

/**
 * Listener
 *
 * Listener client.
 * This class may attach actions that are triggered by events.
 *
 * @package   Foundation
 * @copyright 2014 - 2017 Grégoire HUBERT
 * @author    Grégoire HUBERT
 * @license   X11 {@link http://opensource.org/licenses/mit-license.php}
 * @see       Client
 */
class Listener extends Client
{
    protected $name;
    protected $actions = [];

    /**
     * __construct
     *
     * Take the client identifier as argument.
     *
     * @param  string $name
     */
    public function __construct($name)
    {
        $this->name = $name;
    }

    /**
     * getClientType
     *
     * @see ClientInterface
     */
    public function getClientType()
    {
        return 'listener';
    }

    /**
     * getClientIdentifier
     *
     * @see ClientInterface
     */
    public function getClientIdentifier()
    {
        return $this->name;
    }

    /**
     * attachAction
     *
     * Attach a new callback to the callback list.
     *
     * @param  callable $action
     * @throws  FoundationException if $action is not a callable.
     * @return Listener $this
     */
    public function attachAction(callable $action)
    {
        $this->actions[] = $action;

        return $this;
    }

    /**
     * notify
     *
     * Trigger actions. All actions are executed passing the following parameters:
     * string   $name    name of the event
     * array    $data    event's payload if any
     * Session  $session the current session
     *
     * @param  string $name
     * @param  array $data
     * @return Listener $this
     */
    public function notify($name, array $data)
    {
        foreach ($this->actions as $action) {
            call_user_func($action, $name, $data, $this->getSession());
        }

        return $this;
    }
}