File common/interfaces/Shortcode.php | HJI WP Membership Code Reference

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144

<?php
namespace hji\common\interfaces;


abstract class Shortcode
{
    /**
     * Shortcode name
     * @var
     */
    protected $name;

    /**
     * Parameters supported by the shortcode
     * @var
     */
    protected $parameters = array();


    /**
     * @param       $name
     * @param array $parameters
     */
    function __construct($name, $parameters = array())
    {
        $this->name         = str_replace('-', '_', $name);
        $this->parameters   = $parameters;
    }


    function __get($name)
    {
        if (property_exists($this, $name))
        {
            return $this->$name;
        }
    }


    function register()
    {
        if ($this->name)
        {
            add_shortcode($this->name, array($this, 'doShortcode'));
        }
    }


    /**
     * Processes shortcode atts and renders shortcode content
     *
     * @param $atts
     * @return mixed|string
     */
    function doShortcode($atts)
    {
        // Validate atts against supported parameters

        if ($this->parameters)
        {
            $params = $this->validateParameters($atts);

            if (is_wp_error($params))
            {
                // Render error only if user is logged in

                if (is_user_logged_in())
                {
                    return $params->get_error_message();
                }

                return;
            }
        }
        else
        {
            $params = $atts;
        }

        return $this->render($params);
    }


    /**
     * Renders shortcode's content
     *
     * @param array $params
     * @internal param $atts - attributes passed via shortcode.
     * @return mixed
     */
    abstract function render($params = array());


    /**
     * Validates shortcode attributes against supported parameters
     *
     * @param $atts
     * @return \WP_Error
     */
    function validateParameters($atts)
    {
        if (empty($atts))
        {
            return $atts;
        }

        $params = $atts;
        $invalid = false;

        foreach ($this->parameters as $param)
        {
            $supportedParams[strtolower($param)] = $param;
        }

        $supportedKeys = array_keys($supportedParams);

        foreach($atts as $k => $v)
        {
            $key = strtolower($k);

            if (is_int($k) || strpos($k, ' ') !== false || !in_array($key, $supportedKeys))
            {
                $invalid[] = $k;
            }
            else
            {
                // If attribute exists in the array of supported parameters
                // unset the lowercase attribute passed by shortcode
                unset($params[$k]);
                // and set it's corresponding camelCase key from the supported parameters array
                $params[$supportedParams[$key]] = $v;
            }
        }

        if ($invalid)
        {
            $message = sprintf('Shortcode contains invalid parameters: %s.', implode(', ', $invalid));

            return new \WP_Error('hji shortcode', $message);
        }

        return $params;
    }
}

Namespaces

Classes

Interfaces

Functions