ActionContainerTrait::defaultActionStruct() - Code Metrics - locomotivemtl/charcoal-admin - Measure and Improve Code Quality continuously with Scrutinizer

ActionContainerTrait::defaultActionStruct() A
last analyzed 2019-03-06 21:44 UTC

↳ Parent: ActionContainerTrait
Complexity

Conditions	1
Paths	1
Size

Total Lines	28
Code Lines	26
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	26
nc	1
nop	0
dl	0
loc	28
rs	9.504
c	0
b	0
f	0
<?php

namespace Charcoal\Admin\Ui;

use RuntimeException;

// From 'charcoal-translator'
use Charcoal\Translator\Translation;

// From 'charcoal-view'
use Charcoal\View\ViewableInterface;

// From 'charcoal-user'
use Charcoal\User\AuthAwareInterface;

// From 'charcoal-admin'
use Charcoal\Admin\Ui\CollectionContainerInterface;
use Charcoal\Admin\Ui\FormSidebarInterface;
use Charcoal\Admin\Ui\ObjectContainerInterface;

/**
 * Provides methods for building groups of linked/action-capable items.
 *
 * Can be used to build navigation bars, lists, and dropdowns.
 * This trait {@todo should be replaced} with {@see \Charcoal\Ui\Menu}.
 */
trait ActionContainerTrait
{
    /**
     * Keep track of priority pool.
     *
     * @var integer|null
     */
    protected $actionsPriority;

    /**
     * Parse the given UI actions.
     *
     * @param  array $actions  Actions to resolve.
     * @param  mixed $renderer Either a {@see ViewableInterface} or TRUE
     *     to determine if any renderables should be processed.
     * @return array Returns a collection of parsed actions.
     */
    protected function parseActions(array $actions, $renderer = false)
    {
        $this->actionsPriority = $this->defaultActionPriority();

        $parsedActions = [];
        foreach ($actions as $ident => $action) {
            $ident  = $this->parseActionIdent($ident, $action);
            $action = $this->parseActionItem($action, $ident, $renderer);

            if (!isset($action['priority'])) {
                $action['priority'] = $this->actionsPriority++;
            }

            if (isset($parsedActions[$ident])) {
                $hasPriority = ($action['priority'] > $parsedActions[$ident]['priority']);
                if ($hasPriority || $action['isSubmittable']) {
                    $parsedActions[$ident] = array_replace($parsedActions[$ident], $action);
                } else {
                    $parsedActions[$ident] = array_replace($action, $parsedActions[$ident]);
                }
            } else {
                $parsedActions[$ident] = $action;
            }
        }

        usort($parsedActions, [ $this, 'sortActionsByPriority' ]);

        while (($first = reset($parsedActions)) && $first['isSeparator']) {
            array_shift($parsedActions);
        }

        while (($last = end($parsedActions)) && $last['isSeparator']) {
            array_pop($parsedActions);
        }

        return $parsedActions;
    }

    /**
     * Merge the given (raw) UI actions into a unique set.
     *
     * @param  array ...$params Variable list of actions to merge.
     * @return array Returns a collection of merged actions.
     */
    protected function mergeActions(array ...$params)
    {
        $unique = [];
        foreach ($params as $actions) {
            foreach ($actions as $ident => $action) {
                if ($action === '|') {
                    $unique[$ident] = $action;
                    continue;
                }

                $ident = $this->parseActionIdent($ident, $action);
                $action['ident'] = $ident;

                $hasActions = (isset($action['actions']) && is_array($action['actions']));
                if ($hasActions) {
                    $action['actions'] = $this->mergeActions($action['actions']);
                } else {
                    $action['actions'] = [];
                }

                if (isset($unique[$ident])) {
                    if (static::compareActions($action, $unique[$ident])) {
                    if (static::/** @scrutinizer ignore-call */ compareActions($action, $unique[$ident])) {
                        if ($hasActions && !!$unique[$ident]['actions']) {
                            $action['actions'] = $this->mergeActions(
                                $unique[$ident]['actions'],
                                $action['actions']
                            );
                            unset($unique[$ident]['actions']);
                        }
                        $unique[$ident] = array_replace($unique[$ident], $action);
                    } else {
                        if ($hasActions && !!$unique[$ident]['actions']) {
                            $unique[$ident]['actions'] = $this->mergeActions(
                                $unique[$ident]['actions'],
                                $action['actions']
                            );
                            unset($action['actions']);
                        }
                        $unique[$ident] = array_replace($action, $unique[$ident]);
                    }
                } else {
                    $unique[$ident] = $action;
                }
            }
        }

        return $unique;
    }

    /**
     * Parse the given UI action identifier.
     *
     * @param  string $ident  The action identifier.
     * @param  mixed  $action The action structure.
     * @return string Resolved action identifier.
     */
    protected function parseActionIdent($ident, $action)
    {
        if (isset($action['ident'])) {
            return $action['ident'];
        }

        return $ident;
    }

    /**
     * Parse the given UI action structure.
     *
     * @param  mixed  $action   The action structure.
     * @param  string $ident    The action identifier.
     * @param  mixed  $renderer Either a {@see ViewableInterface} or TRUE
     *     to determine if any renderables should be processed.
     * @return array Resolved action structure.
     */
    protected function parseActionItem($action, $ident, $renderer = false)
    {
        if ($action === '|') {
            $action = $this->defaultActionStruct();
            $action['isSeparator'] = true;
        } elseif (is_array($action)) {
            $buttonTypes = [ 'button', 'menu', 'reset', 'submit', 'action'];
            // Normalize structure keys
            foreach ($action as $key => $val) {
                $attr = $this->camelize($key);
                if ($key !== $attr) {
                    $action[$attr] = $val;
                    unset($action[$key]);
                }
            }

            if (!isset($action['ident'])) {
                $action['ident'] = $ident;
            }

            if (isset($action['buttonType'])) {
                if (!in_array($action['buttonType'], $buttonTypes)) {
                    $action['actionType'] = $action['buttonType'];
                    $action['buttonType'] = 'button';
                }
            }

            if (!isset($action['actionType'])) {
                $action['actionType'] = $this->resolveActionType($action);
            }

            if (isset($action['label'])) {
                $action['label'] = $this->translator()->translation($action['label']);
                $action['label'] = $this->/** @scrutinizer ignore-call */ translator()->translation($action['label']);
            } else {
                $action['label'] = ucwords(str_replace([ '.', '_' ], ' ', $action['ident']));

                $model = $this->getActionRenderer();
                if ($model) {
                    $meta  = $model->metadata();
                    $meta  = $model->metadata();
                    $label = sprintf('%s_item', $action['ident']);
                    if (isset($meta['labels'][$label])) {
                        $action['label'] = $this->translator()->translation($meta['labels'][$label]);
                    }
                }
            }

            if (isset($action['url'])) {
                $action['url']      = $this->translator()->translation($action['url']);
                $action['isText']   = false;
                $action['isLink']   = true;
                $action['isButton'] = false;
            } else {
                $action['url'] = null;
            }

            if (isset($action['buttonType'])) {
                if ($action['url'] === '#' && in_array($action['buttonType'], $buttonTypes)) {
                    $action['isLink']   = false;
                    $action['isButton'] = true;
                }

                if ($action['buttonType'] === 'submit') {
                    $action['isSubmittable'] = true;
                }

                if ($action['buttonType'] === 'action') {
                    $action['actionType'] = 'primary';
                    $action['cssClasses'] = 'js-action-button btn btn-primary';
                }
            }

            if (isset($action['extraTemplate'])) {
                    $action['extraTemplate'] = $this->render($action['extraTemplate']);
                    $action['extraTemplate'] = $this->render($action['extraTemplate']);
            }

            if (isset($action['dataAttributes']) && is_array($action['dataAttributes'])) {
                $action['dataAttributes'] = array_filter($action['dataAttributes'], function ($attribute) {
                    return  !empty($attribute['key']) &&
                            is_string($attribute['key']) &&
                            !empty($attribute['value']) &&
                            is_string($attribute['value']);
                });
            } else {
                $action['dataAttributes'] = [];
            }

            if (isset($action['actions']) && is_array($action['actions'])) {
                $action['actions']    = $this->parseActions($action['actions']);
                $action['hasActions'] = !!array_filter($action['actions'], function ($action) {
                    return $action['active'];
                });
            } else {
                $action['actions']    = [];
                $action['hasActions'] = false;
            }

            $action = array_replace($this->defaultActionStruct(), $action);
            $action = $this->parseActionRenderables($action, $renderer);

            if ($action['active'] === true && !empty($action['permissions']) && $this instanceof AuthAwareInterface) {
                $action['active'] = $this->hasPermissions($action['permissions']);
            }
        }

        return $action;
    }

    /**
     * Resolve the action's type.
     *
     * @param  mixed $action The action structure.
     * @return string
     */
    protected function resolveActionType($action)
    {
        switch ($action['ident']) {
            case 'create':
            case 'save':
            case 'submit':
            case 'update':
            case 'edit':
                return 'primary';

            case 'reset':
                return 'warning';

            case 'delete':
                return 'danger';

            default:
                return 'dark';
        }
    }

    /**
     * Fetch a viewable instance to process an action's renderables.
     *
     * @return ViewableInterface|null
     */
    protected function getActionRenderer()
    {
        $obj = null;
        if ($this instanceof FormSidebarInterface) {
            if ($this->form()) {
                $obj = $this->form()->obj();
                $obj = $this->form()->/** @scrutinizer ignore-call */ obj();
            }
        }

        if ($this instanceof ObjectContainerInterface) {
            $obj = $this->obj();
        }

        if ($this instanceof CollectionContainerInterface) {
            $obj = isset($this->currentObj) ? $this->currentObj : $this->proto();
        }

        return $obj instanceof ViewableInterface ? $obj : null;
    }

    /**
     * Parse the given UI action's renderables (e.g., URLs).
     *
     * @param  mixed $action   The action structure.
     * @param  mixed $renderer Either a {@see ViewableInterface} or TRUE
     *     to determine if any renderables should be processed.
     * @throws RuntimeException If a renderer is unavailable.
     * @return array Resolved action structure.
     */
    protected function parseActionRenderables($action, $renderer)
    {
        if ($renderer === false) {
            return $action;
        }

        if ($renderer === true) {
            $renderer = $this->getActionRenderer();
        }

        if ($action['active'] === true && isset($action['condition'])) {
            $action['active'] = $this->parseActionCondition($action['condition'], $action, $renderer);
            unset($action['condition']);
        }

        if (isset($action['url'])) {
            $action['url'] = $this->parseActionUrl($action['url'], $action, $renderer);
        }

        $action['cssClasses'] = $this->parseActionCssClasses($action['cssClasses'], $action, $renderer);
        $action['cssClasses'] = implode(' ', array_unique($action['cssClasses']));

        return $action;
    }

    /**
     * Parse the given UI action conditional check.
     *
     * @param  mixed $condition The action's conditional check.
     * @param  mixed $action    The action structure.
     * @param  mixed $renderer  The renderer.
     * @return array Resolved action structure.
     */
    protected function parseActionCondition($condition, $action = null, $renderer = null)
    {
        unset($action);

        if ($renderer === null) {
            $renderer = $this->getActionRenderer();
        }

        if (is_bool($condition)) {
            return $condition;

        } elseif (is_string($condition)) {
            $not = ($condition[0] === '!');
            if ($not) {
                $condition = ltrim($condition, '!');
            }

            $result = null;
            if ($renderer && is_callable([ $renderer, $condition ])) {
                $result = !!$renderer->{$condition}();
            } elseif (is_callable([ $this, $condition ])) {
                $result = !!$this->{$condition}();
            } elseif (is_callable($condition)) {
                $result = !!$condition();
            } elseif ($renderer) {
                $result = !!$renderer->renderTemplate($condition);
            }

            if ($result !== null) {
                return $not ? !$result : $result;

            }
        }

        return $condition;

    }

    /**
     * Parse the given UI action URL.
     *
     * @param  string $url      The action's URL.
     * @param  mixed  $action   The action structure.
     * @param  mixed  $renderer The renderer.
     * @return array Resolved action structure.
     */
    protected function parseActionUrl($url, $action = null, $renderer = null)
    {
        unset($action);

        if ($renderer === null) {
            $renderer = $this->getActionRenderer();
        }

        if ($url instanceof Translation) {

            $url = (string)$url;
        }

        $url = trim($url);

        if (empty($url) && !is_numeric($url)) {
            return '#';

        }

        if ($renderer === null) {
            /** @todo Shame! Force `{{ id }}` to use "obj_id" GET parameter… */
            $objId = filter_input(INPUT_GET, 'obj_id', FILTER_SANITIZE_STRING);
            if ($objId) {
                $url = preg_replace('~\{\{\s*(obj_)?id\s*\}\}~', $objId, $url);
            }

            /** @todo Shame! Force `{{ type }}` to use "obj_type" GET parameter… */
            $objType = filter_input(INPUT_GET, 'obj_type', FILTER_SANITIZE_STRING);
            if ($objType) {
                $url = preg_replace('~\{\{\s*(obj_)?type\s*\}\}~', $objType, $url);
            }

            if ($url && strpos($url, ':') === false && !in_array($url[0], [ '/', '#', '?' ])) {
                $url = $this->adminUrl().$url;
                $url = $this->/** @scrutinizer ignore-call */ adminUrl().$url;
            }

            return $url;
        } elseif ($renderer instanceof ViewableInterface) {
            $url = $renderer->renderTemplate($url);

            if ($url && strpos($url, ':') === false && !in_array($url[0], [ '/', '#', '?' ])) {
                $url = $this->adminUrl().$url;
            }
        }

        return $url;
    }

    /**
     * Parse the given UI action CSS classes.
     *
     * @param  mixed $classes  The action's CSS classes.
     * @param  mixed $action   The action structure.
     * @param  mixed $renderer The renderer.
     * @return array
     */
    protected function parseActionCssClasses($classes, $action = null, $renderer = null)
    {
        if ($renderer === null) {
            $renderer = $this->getActionRenderer();

        }

        if (is_string($classes)) {
            $classes = explode(' ', $classes);
        } elseif (!is_array($classes)) {
            $classes = [];
        }
        $classes[] = 'btn';
        $classes[] = 'btn-'.$action['actionType'];
        $classes[] = $this->jsActionPrefix().'-'.$action['ident'];

        return $classes;
    }

    /**
     * Retrieve the default action structure.
     *
     * @return array
     */
    protected function defaultActionStruct()
    {
        return [
            'ident'         => null,
            'priority'      => null,
            'permissions'   => [],
            'condition'     => null,
            'active'        => true,
            'empty'         => false,
            'label'         => null,
            'showLabel'     => true,
            'icon'          => null,
            'url'           => null,
            'name'          => null,
            'value'         => null,
            'target'        => null,
            'isText'        => false,
            'isLink'        => false,
            'isButton'      => true,
            'isHeader'      => false,
            'isSubmittable' => false,
            'isSeparator'   => false,
            'cssClasses'    => null,
            'actionType'    => 'dark',
            'buttonType'    => 'button',
            'splitButton'   => false,
            'hasActions'    => false,
            'actions'       => [],
        ];
    }

    /**
     * Retrieve the default sorting priority for actions.
     *
     * @return integer
     */
    protected function defaultActionPriority()
    {
        return defined('static::DEFAULT_ACTION_PRIORITY') ? static::DEFAULT_ACTION_PRIORITY : 10;

    }

    /**
     * To be called with {@see uasort()}.
     *
     * @param  array $a Sortable action A.
     * @param  array $b Sortable action B.
     * @return integer
     */
    protected function sortActionsByPriority(array $a, array $b)
    {
        $a = isset($a['priority']) ? $a['priority'] : 0;
        $b = isset($b['priority']) ? $b['priority'] : 0;

        if ($a === $b) {
            return 0;
        }
        return ($a < $b) ? (-1) : 1;
    }

    /**
     * To be called when merging actions.
     *
     * Note: Practical for extended classes.
     *
     * @param  array $a First action object to sort.
     * @param  array $b Second action object to sort.
     * @return boolean Returns TRUE if $a has priority. Otherwise, FALSE for $b.
     */
    protected function compareActions(array $a, array $b)
    {
        $a = isset($a['priority']) ? $a['priority'] : 0;
        $b = isset($b['priority']) ? $b['priority'] : 0;
        $c = isset($action['isSubmittable']) && $action['isSubmittable'];


        return ($c || ($a === 0) || ($a >= $b));
    }

    /**
     * @return string
     */
    abstract public function jsActionPrefix();

    /**
     * Transform a snake_case string to camelCase.
     *
     * @param  string $str The snake_case string to camelize.
     * @return string The camelcase'd string.
     */
    abstract protected function camelize($str);
}

locomotivemtl / charcoal-admin

ActionContainerTrait::defaultActionStruct() A last analyzed 2019-03-06 21:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ActionContainerTrait::defaultActionStruct() A
last analyzed 2019-03-06 21:44 UTC
