TagManager.php

<?php
/**
 * Tags for Craft 3
 *
 * @link      https://ethercreative.co.uk
 * @copyright Copyright (c) 2018 Ether Creative
 */

namespace ether\tagManager;

use Craft;
use craft\base\Element;
use craft\base\Model;
use craft\base\Plugin;
use craft\elements\actions\Edit;
use craft\elements\Tag as CraftTagElement;
use craft\events\ModelEvent;
use craft\events\RegisterCpNavItemsEvent;
use craft\events\RegisterElementActionsEvent;
use craft\events\RegisterUrlRulesEvent;
use craft\gatsbyhelper\events\RegisterIgnoredTypesEvent;
use craft\gatsbyhelper\services\Deltas;
use craft\web\twig\variables\Cp;
use craft\web\UrlManager;
use ether\tagManager\elements\actions\Delete;
use ether\tagManager\elements\Tag;
use ether\tagManager\models\Settings;
use Twig\Error\LoaderError;
use Twig\Error\RuntimeError;
use Twig\Error\SyntaxError;
use yii\base\Event;
use yii\base\Exception;

/**
 * Class Tags
 *
 * @author  Ether Creative
 * @package ether\tags
 */
class TagManager extends Plugin
{

	// Properties
	// =========================================================================

	public $schemaVersion = '1.0.0';

	public $hasCpSettings = true;

	public $hasCpSection  = true;

	// Init
	// =========================================================================

	public function init ()
	{
		parent::init();

		// Events
		// ---------------------------------------------------------------------

		Event::on(
			UrlManager::class,
			UrlManager::EVENT_REGISTER_CP_URL_RULES,
			[$this, 'onRegisterCpUrlRules']
		);

		Event::on(
			Tag::class,
			Element::EVENT_REGISTER_ACTIONS,
			[$this, 'onRegisterTagActions']
		);

		Event::on(
			Cp::class,
			Cp::EVENT_REGISTER_CP_NAV_ITEMS,
			[$this, 'onRegisterCpNavItems']
		);

		if (class_exists(Deltas::class)) {
			Event::on(
				Deltas::class,
				Deltas::EVENT_REGISTER_IGNORED_TYPES,
				[$this, 'onRegisterIgnoredTypes']
			);
		}
		
		Event::on(
			CraftTagElement::class,
			CraftTagElement::EVENT_AFTER_SAVE,
			function (ModelEvent $event) {
				Craft::$app->elements->invalidateCachesForElementType(Tag::class);
			}
		);
	}

	// Craft
	// =========================================================================

	public function getCpNavItem ()
	{
		$item = parent::getCpNavItem();

		$item['id'] = 'tag-manager';
		$item['url'] = 'tags';

		return $item;
	}

	protected function createSettingsModel (): Settings
	{
		return new Settings();
	}

	/**
	 * @return bool|Model|null
	 */
	public function getSettings ()
	{
		return parent::getSettings();
	}

	/**
	 * @return string|null
	 * @throws LoaderError
	 * @throws RuntimeError
	 * @throws SyntaxError|Exception
	 */
	protected function settingsHtml ()
	{
		return Craft::$app->getView()->renderTemplate('tag-manager/_settings', [
			'settings' => $this->getSettings(),
		]);
	}

	// Events
	// =========================================================================

	public function onRegisterCpUrlRules (RegisterUrlRulesEvent $event)
	{
		$event->rules['tags'] = 'tag-manager/cp/index';
		$event->rules['tags/<groupHandle:{handle}>'] = 'tag-manager/cp/index';

		$event->rules['tags/<groupHandle:{handle}>/new'] = 'tag-manager/cp/edit';
		$event->rules['tags/<groupHandle:{handle}>/new/<siteHandle:{handle}>'] = 'tag-manager/cp/edit';
		$event->rules['tags/<groupHandle:{handle}>/<tagId:\d+>'] = 'tag-manager/cp/edit';
		$event->rules['tags/<groupHandle:{handle}>/<tagId:\d+>/<siteHandle:{handle}>'] = 'tag-manager/cp/edit';
	}

	public function onRegisterTagActions (RegisterElementActionsEvent $event)
	{
		$event->actions[] = Edit::class;
		$event->actions[] = Delete::class;
	}

	public function onRegisterCpNavItems (RegisterCpNavItemsEvent $event)
	{
		$navItems = $event->navItems;
		$navItemKeys = array_keys($navItems);
		$i = count($navItems);

		$tagsNavItemIndex = null;

		while (--$i)
		{
			$item = $navItems[$navItemKeys[$i]];
			$url = array_key_exists('url', $item) ? $item['url'] : null;

			if ($url === 'tags')
			{
				$tagsNavItemIndex = $i;
				continue;
			}

			if (in_array($url, ['dashboard', 'entries', 'globals', 'categories']))
			{
				$tagsItem = array_splice($navItems, $tagsNavItemIndex, 1);
				array_splice($navItems, $i + 1, 0, $tagsItem);
				break;
			}
		}

		$event->navItems = $navItems;
	}

	public function onRegisterIgnoredTypes (RegisterIgnoredTypesEvent $event)
	{
		$event->types[] = Tag::class;
	}

}