flipbox\organizations\cp\controllers\UserIndexesController

Complexity

Total Complexity

5

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	init()	0	55	1
A	elementResponseData()	0	33	2
A	includeActions()	0	4	1
A	getOrganizationFromRequest()	0	4	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://flipboxfactory.com/software/organization/license
 * @link       https://www.flipboxfactory.com/software/organization/
 */

namespace flipbox\organizations\cp\controllers;

use Craft;
use craft\base\ElementInterface;
use craft\controllers\ElementIndexesController;
use craft\elements\User;
use craft\events\RegisterElementHtmlAttributesEvent;
use flipbox\organizations\events\handlers\RegisterOrganizationUserElementActions;
use flipbox\organizations\events\handlers\RegisterOrganizationUserElementDefaultTableAttributes;
use flipbox\organizations\events\handlers\RegisterOrganizationUserElementTableAttributes;
use flipbox\organizations\events\handlers\SetOrganizationUserElementTableAttributeHtml;
use yii\base\Event;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
class UserIndexesController extends ElementIndexesController
{
    /**
     * @inheritdoc
     */
    public function init()
    {
        Event::on(
            User::class,
            User::EVENT_REGISTER_ACTIONS,
            [
                RegisterOrganizationUserElementActions::class,
                'handle'
            ]
        );

        // Add attributes the user index
        Event::on(
            User::class,
            User::EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES,
            [
                RegisterOrganizationUserElementDefaultTableAttributes::class,
                'handle'
            ]
        );

        // Add attributes the user index
        Event::on(
            User::class,
            User::EVENT_REGISTER_TABLE_ATTRIBUTES,
            [
                RegisterOrganizationUserElementTableAttributes::class,
                'handle'
            ]
        );

        // Add 'organizations' on the user html element
        Event::on(
            User::class,
            User::EVENT_SET_TABLE_ATTRIBUTE_HTML,
            [
                SetOrganizationUserElementTableAttributeHtml::class,
                'handle'
            ]
        );

        // Add 'organizations' on the user html element
        Event::on(
            User::class,
            User::EVENT_REGISTER_HTML_ATTRIBUTES,
            function (RegisterElementHtmlAttributesEvent $event) {
                $event->htmlAttributes['data-organization'] = $event->data['organization'] ?? null;
            },
            [
                'organization' => $this->getOrganizationFromRequest()
            ]
        );

        parent::init();
    }

    /**
     * Returns the element data to be returned to the client.
     *
     * @param bool $includeContainer Whether the element container should be included in the response data
     * @param bool $includeActions Whether info about the available actions should be included in the response data
     * @return array
     */
    protected function elementResponseData(bool $includeContainer, bool $includeActions): array
    {
        $responseData = [];

        $view = $this->getView();

        // Get the action head/foot HTML before any more is added to it from the element HTML
        if ($includeActions) {
            $responseData['actions'] = $this->actionData();
            $responseData['actionsHeadHtml'] = $view->getHeadHtml();
            $responseData['actionsFootHtml'] = $view->getBodyHtml();
        }

        $disabledElementIds = Craft::$app->getRequest()->getParam('disabledElementIds', []);
        $showCheckboxes = !empty($this->actions);
        /** @var string|ElementInterface $elementType */
        $elementType = $this->elementType;

        $responseData['html'] = $elementType::indexHtml(
            $this->elementQuery,
            $disabledElementIds,
            $this->viewState,
            'organizations', // Changed this
            'index', // Changed this
            $includeContainer,
            $showCheckboxes
        );

        $responseData['headHtml'] = $view->getHeadHtml();
        $responseData['footHtml'] = $view->getBodyHtml();

        return $responseData;
    }

    /**
     * @inheritDoc
     */
    protected function includeActions(): bool
    {
        return true;
    }

    /**
     * @return mixed
     */
    private function getOrganizationFromRequest()
    {
        return Craft::$app->getRequest()->getParam('organization');
    }
}