midgard_admin_asgard_toolbar

Complexity

Total Complexity

46

Size/Duplication

Total Lines	236
Duplicated Lines	0 %

Test Coverage

Coverage

84.8%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	_generate_url()	0	3	1
F	bind_to_object()	0	133	26
C	_disable_active_item()	0	37	13
B	get_toolbar_update_items()	0	51	6

<?php
/**
 * @package midgard.admin.asgard
 * @author CONTENT CONTROL http://www.contentcontrol-berlin.de/
 * @copyright CONTENT CONTROL http://www.contentcontrol-berlin.de/
 * @license http://www.gnu.org/licenses/gpl.html GNU General Public License
 */

/**
 * Wrapper for Asgard's toolbar
 *
 * @package midgard.admin.asgard
 */
class midgard_admin_asgard_toolbar extends midcom_helper_toolbar_view
{
    private function _generate_url(string $action, midcom_core_dbaobject $object) : string
    {
        return '__mfa/asgard/object/' . $action . '/' . $object->guid . '/';
    }

    /**
     * Populate the object toolbar
     */
    public function bind_to_object(midcom_core_dbaobject $object, string $handler_id, array $data)
    {
        if ($handler_id == 'object_deleted') {
            return;
        }
        $buttons = [];
        // Show view toolbar button, if the user hasn't configured to use straight the edit mode
        if ($data['default_mode'] === 'view') {
            $buttons[] = [
                MIDCOM_TOOLBAR_URL => $this->_generate_url('view', $object),
                MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('view', 'midcom'),
                MIDCOM_TOOLBAR_GLYPHICON => 'eye',
                MIDCOM_TOOLBAR_ACCESSKEY => 'v',
            ];
        }
        $config = midcom_baseclasses_components_configuration::get('midgard.admin.asgard', 'config');
        $no_permalink = false;
        foreach ($config->get_array('no_permalinks_for') as $classname) {
            if ($object instanceof $classname) {
                $no_permalink = true;
                break;
            }
        }
        if (!$no_permalink) {
            $link = midcom::get()->permalinks->resolve_permalink($object->guid);
            if ($link) {
                $buttons[] = [
                    MIDCOM_TOOLBAR_URL => $link,
                    MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('view on site', 'midgard.admin.asgard'),
                    MIDCOM_TOOLBAR_GLYPHICON => 'globe',
                ];
            }
        }

        if ($object->can_do('midgard:update')) {
            $buttons[] = [
                MIDCOM_TOOLBAR_URL => $this->_generate_url('edit', $object),
                MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('edit', 'midcom'),
                MIDCOM_TOOLBAR_GLYPHICON => 'pencil',
                MIDCOM_TOOLBAR_ACCESSKEY => 'e',
            ];
        }

        if ($object->can_do('midgard:create')) {
            $buttons[] = [
                MIDCOM_TOOLBAR_URL => $this->_generate_url('copy', $object),
                MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('copy', 'midcom'),
                MIDCOM_TOOLBAR_GLYPHICON => 'clone',
            ];
        }

        if ($object->can_do('midgard:update')) {
            $buttons = array_merge($buttons, $this->get_toolbar_update_items($object));
        }

        if ($object->can_do('midgard:create')) {
            // Find out what types of children the object can have and show create buttons for them
            $child_types = $data['tree_reflector']->get_child_classes();
            foreach ($child_types as $type) {
                $display_button = true;
                if ($object instanceof midcom_db_topic) {
                    // With topics we should check for component before populating create buttons as so many types can be children of topics
                    switch ($type) {
                        case 'midgard_topic':
                        case 'midgard_article':
                            // Articles and topics can always be created
                            break;
                        default:
                            if (!midcom::get()->dbclassloader->get_midcom_class_name_for_mgdschema_object($type)) {
                                $display_button = false;
                                break;
                            }
                            $component = midcom::get()->dbclassloader->get_component_for_class($type);
                            if ($component != $object->component) {
                                $display_button = false;
                            }
                            break;
                    }
                } elseif ($object instanceof midcom_db_article) {
                    try {
                        $topic = new midcom_db_topic($object->topic);
                        // With articles we should check for topic component before populating create buttons as so many types can be children of topics
                        switch ($type) {
                            case 'midgard_article':
                                // Articles can always be created
                                break;
                            default:
                                $component = midcom::get()->dbclassloader->get_component_for_class($type);
                                if ($component != $topic->component) {
                                    $display_button = false;
                                }
                                break;
                        }
                    } catch (midcom_error $e) {
                        $e->log();
                    }
                }

                if (!$display_button) {
                    // Skip this type
                    continue;
                }

                $buttons[] = [
                    MIDCOM_TOOLBAR_URL => $this->_generate_url('create/' . $type, $object),
                    MIDCOM_TOOLBAR_LABEL => sprintf(midcom::get()->i18n->get_string('create %s', 'midcom'), midgard_admin_asgard_plugin::get_type_label($type)),
                    MIDCOM_TOOLBAR_GLYPHICON => $data['tree_reflector']->get_create_icon($type),
                ];
            }
        }

        if ($object->can_do('midgard:delete')) {
            $buttons[] = [
                MIDCOM_TOOLBAR_URL => $this->_generate_url('delete', $object),
                MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('delete', 'midcom'),
                MIDCOM_TOOLBAR_GLYPHICON => 'trash',
                MIDCOM_TOOLBAR_ACCESSKEY => 'd',
            ];
        }

        if (   midcom::get()->config->get('midcom_services_rcs_enable')
            && $object->can_do('midgard:update')
            && $object->_use_rcs) {
            $buttons[] = [
                MIDCOM_TOOLBAR_URL => $this->_generate_url('rcs', $object),
                MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('show history', 'midcom.admin.rcs'),
                MIDCOM_TOOLBAR_GLYPHICON => 'history',
                MIDCOM_TOOLBAR_ENABLED => !str_starts_with($handler_id, 'object_rcs'),
                MIDCOM_TOOLBAR_ACCESSKEY => 'h',
            ];
        }
        $this->add_items($buttons);
        $this->_disable_active_item($handler_id, $object, $data);
    }

    private function _disable_active_item(string $handler_id, midcom_core_dbaobject $object, array $data)
    {
        switch ($handler_id) {
            case 'object_view':
                $this->disable_item($this->_generate_url('view', $object));
                break;
            case 'object_edit':
                $this->disable_item($this->_generate_url('edit', $object));
                break;
            case 'object_copy':
                $this->disable_item($this->_generate_url('copy', $object));
                break;
            case 'components_configuration_edit_folder':
                $this->disable_item("__mfa/asgard/components/configuration/edit/{$object->component}/{$object->guid}/");

The property component does not exist on midcom_core_dbaobject. Since you implemented __get, consider adding a @property annotation.

                break;
            case 'object_metadata':
                $this->disable_item($this->_generate_url('metadata', $object));
                break;
            case 'object_attachments':
            case 'object_attachments_edit':
                $this->disable_item($this->_generate_url('attachments', $object));
                break;
            case 'object_parameters':
                $this->disable_item($this->_generate_url('parameters', $object));
                break;
            case 'object_permissions':
                $this->disable_item($this->_generate_url('permissions', $object));
                break;
            case 'object_create':
                $this->disable_item($this->_generate_url('create/' . $data['current_type'], $object));
                break;
            case 'object_delete':
                $this->disable_item($this->_generate_url('delete', $object));
                break;
            case '____mfa-asgard_midcom.helper.replicator-object':
                $this->disable_item("__mfa/asgard_midcom.helper.replicator/object/{$object->guid}/");
                break;
        }
    }

    private function get_toolbar_update_items(midcom_core_dbaobject $object) : array
    {
        $buttons = [];
        if (   $object instanceof midcom_db_topic
            && $object->component
            && $object->can_do('midcom:component_config')) {
            $buttons[] = [
                MIDCOM_TOOLBAR_URL => "__mfa/asgard/components/configuration/edit/{$object->component}/{$object->guid}/",
                MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('component configuration', 'midcom'),
                MIDCOM_TOOLBAR_GLYPHICON => 'wrench',
            ];
        }

        $buttons[] = [
            MIDCOM_TOOLBAR_URL => $this->_generate_url('metadata', $object),
            MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('metadata', 'midcom'),
            MIDCOM_TOOLBAR_GLYPHICON => 'database',
            MIDCOM_TOOLBAR_ACCESSKEY => 'm',
        ];
        $buttons = array_merge($buttons, $this->get_approval_controls($object));

        $buttons[] = [
            MIDCOM_TOOLBAR_URL => $this->_generate_url('attachments', $object),
            MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('attachments', 'midgard.admin.asgard'),
            MIDCOM_TOOLBAR_GLYPHICON => 'paperclip',
        ];

        $buttons[] = [
            MIDCOM_TOOLBAR_URL => $this->_generate_url('parameters', $object),
            MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('parameters', 'midcom'),
            MIDCOM_TOOLBAR_GLYPHICON => 'sitemap',
            MIDCOM_TOOLBAR_ENABLED => $object->can_do('midgard:parameters'),
        ];

        $buttons[] = [
            MIDCOM_TOOLBAR_URL => $this->_generate_url('permissions', $object),
            MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('privileges', 'midcom'),
            MIDCOM_TOOLBAR_GLYPHICON => 'shield',
            MIDCOM_TOOLBAR_ENABLED => $object->can_do('midgard:privileges'),
        ];

        if (   midcom::get()->componentloader->is_installed('midcom.helper.replicator')
            && midcom::get()->auth->admin) {
            $buttons[] = [
                MIDCOM_TOOLBAR_URL => "__mfa/asgard_midcom.helper.replicator/object/{$object->guid}/",
                MIDCOM_TOOLBAR_LABEL => midcom::get()->i18n->get_string('replication information', 'midcom.helper.replicator'),
                MIDCOM_TOOLBAR_GLYPHICON => 'files-o',
                MIDCOM_TOOLBAR_ACCESSKEY => 'r',
            ];
        }
        return $buttons;
    }
}