Plugin.php

<?php
/**
 * Webiny Framework (http://www.webiny.com/framework)
 *
 * @copyright Copyright Webiny LTD
 */

namespace Webiny\Component\TemplateEngine;

use Webiny\Component\StdLib\StdLibTrait;

/**
 * Template engine plugin class.
 * This class is used by template engines to register plugins.
 * Based on the template engine a plugin can be a modifier, a tag, a filter or something else.
 *
 * @package         Webiny\Component\TemplateEngine
 */
class Plugin
{
    use StdLibTrait;

    /**
     * @var string
     */
    private $name;

    /**
     * @var string
     */
    private $type;

    /**
     * @var callable|string
     */
    private $callbackFunction;

    /**
     * @var array
     */
    private $params;

    /**
     * @var \Webiny\Component\StdLib\StdObject\ArrayObject\ArrayObject
     */
    private $attributes;


    /**
     * Base constructor.
     *
     * @param string          $name                            Plugin Name of the plugin.
     * @param string          $type                            Plugin type. The type value depends on the current template engine driver.
     *                                                         They usually have values like "function", "tag", "modifier"..etc.
     *                                                         Basically they define the type of the plugin.
     * @param \Closure|string $callbackFunction                Callback function that holds the plugin logic.
     * @param array           $params                          Optional parameters that can be passed to the plugin.
     */
    public function __construct($name, $type, $callbackFunction, $params = [])
    {
        $this->name = $name;
        $this->type = $type;
        $this->callbackFunction = $callbackFunction;
        $this->params = $params;
        $this->attributes = $this->arr([]);
    }

    /**
     * Sets an optional attribute to the plugin.
     *
     * @param string $key   Attribute key.
     * @param mixed  $value Attribute value.
     */
    public function setAttribute($key, $value)
    {
        $this->attributes->key($key, $value);
    }

    /**
     * Return the attribute value under the defined $key.
     *
     * @param string $key          Attribute key.
     * @param mixed  $defaultValue Default value that the method should return if $key is not found among the attributes.
     *
     * @return mixed
     */
    public function getAttribute($key, $defaultValue = false)
    {
        return $this->attributes->key($key, $defaultValue, true);
    }

    /**
     * Get plugin name.
     *
     * @return string Plugin name.
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Get plugin type.
     *
     * @return string Plugin type.
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Get the callable function.
     *
     * @return callable|string Plugin callable function.
     */
    public function getCallbackFunction()
    {
        return $this->callbackFunction;
    }

    /**
     * Get plugin parameters.
     *
     * @return array Plugin params.
     */
    public function getParams()
    {
        return $this->params;
    }
}