psecio/gatekeeper

<?php

namespace Psecio\Gatekeeper;

abstract class Handler
{
    /**
     * Method name called for handler type
     * @var string
     */
    protected $name;

    /**
     * Arguments called to pass into handler
     * @var array
     */
    protected $arguments = array();

    /**
     * Data source instance
     * @var \Psecio\Gatekeeper\DataSource
     */
    protected $datasource;

    /**
     * Init the object and set up the name, arguments and data source
     *
     * @param string $name Method name called
     * @param array $arguments Arguments to pass to handler
     * @param \Psecio\Gatekeeper\DataSource $datasource Data source instance
     */
    public function __construct($name, array $arguments, \Psecio\Gatekeeper\DataSource $datasource)
    {
        $this->setArguments($arguments);
        $this->setName($name);
        $this->setDb($datasource);
    }

    /**
     * Set the current arguments
     *
     * @param array $arguments Method arguments
     */
    public function setArguments(array $arguments)
    {
        $this->arguments = $arguments;
    }

    /**
     * Get the current set of arguments
     *
     * @return array Arguemnt data set
     */
    public function getArguments()
    {
        return $this->arguments;
    }

    /**
     * Set method name called for handler
     *
     * @param string $name Method name called
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * Get the method name called
     *
     * @return string Method name
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Set the current data source
     *
     * @param \Psecio\Gatekeeper\DataSource $datasource data source instance (DB)
     */
    public function setDb(\Psecio\Gatekeeper\DataSource $datasource)
    {
        $this->datasource = $datasource;
    }

    /**
     * Get the current data source instance
     *
     * @return \Psecio\Gatekeeper\DataSource instance
     */
    public function getDb()
    {
        return $this->datasource;
    }

    /**
     * Execute the handler logic
     *
     * @return mixed
     */
    abstract public function execute();
}