extension.driver.php

<?php

	/**
	 * @package symphony_tests
	 */

	/**
	 * A SimpleTest interface for Symphony.
	 */
	class Extension_Symphony_Tests extends Extension {
		/**
		 * Is the devkit active?
		 * @var boolean
		 */
		protected $devkit_active = false;

		/**
		 * True when no navigation group has been specified.
		 * @var boolean
		 */
		protected $missing_navigation_group = false;

		/**
		 * Cleanup installation.
		 */
		public function uninstall() {
			Symphony::Configuration()->remove('symphony_tests');
		}

		/**
		 * Create configuration.
		 */
		public function install() {
			Symphony::Configuration()->set('navigation_group', __('System'), 'symphony_tests');
			Administration::instance()->saveConfig();

			return true;
		}

		/**
		 * Listen for these delegates.
		 */
		public function getSubscribedDelegates() {
			return array(
				array(
					'page' => '/system/preferences/',
					'delegate' => 'AddCustomPreferenceFieldsets',
					'callback' => 'viewPreferences'
				),
				array(
					'page' => '/system/preferences/',
					'delegate' => 'Save',
					'callback' => 'actionsPreferences'
				),
				array(
					'page'		=> '/frontend/',
					'delegate'	=> 'FrontendDevKitResolve',
					'callback'	=> 'frontendDevKitResolve'
				),
				array(
					'page'		=> '/frontend/',
					'delegate'	=> 'ManipulateDevKitNavigation',
					'callback'	=> 'manipulateDevKitNavigation'
				)
			);
		}

		/**
		 * Add navigation items.
		 */
		public function fetchNavigation() {
			$group = $this->getNavigationGroup();

			return array(
				array(
					'location'	=> $group,
					'name'		=> __('Tests'),
					'link'		=> '/tests/'
				),
				array(
					'location'	=> $group,
					'name'		=> __('Tests'),
					'link'		=> '/test/',
					'visible'	=> 'no'
				)
			);
		}

		/**
		 * Get the current extension directory.
		 */
		public function getExtensionDir() {
			return dirname(__FILE__);
		}

		/**
		 * Show the devkit when someone accesses ?tests
		 */
		public function frontendDevKitResolve($context) {
			if (isset($_GET['tests'])) {
				require_once(EXTENSIONS . '/symphony_tests/content/content.devkit.php');

				$context['devkit'] = new Content_TestsDevKit();
				$this->devkit_active = true;
			}
		}

		/**
		 * Add "Tests" to the devkit menu.
		 */
		public function manipulateDevKitNavigation($context) {
			$xml = $context['xml'];
			$item = $xml->createElement('item');
			$item->setAttribute('name', __('Tests'));
			$item->setAttribute('handle', 'tests');
			$item->setAttribute('active', (
				$this->devkit_active
					? 'yes' : 'no'
			));

			$xml->documentElement->appendChild($item);
		}

		/**
		 * Get the name of the desired navigation group.
		 */
		public function getNavigationGroup() {
			if ($this->missing_navigation_group === true) return null;

			return Symphony::Configuration()->get('navigation_group', 'symphony_tests');
		}

		/**
		 * Get a list of available navigation groups.
		 */
		public function getNavigationGroups() {
			$sections = SectionManager::fetch(null, 'ASC', 'sortorder');
			$options = array();

			if (is_array($sections)) foreach ($sections as $section) {
				$options[] = $section->get('navigation_group');
			}

			$options[] = __('Blueprints');
			$options[] = __('System');

			return array_unique($options);
		}

		/**
		 * Validate preferences before saving.
		 * @param array $context
		 */
		public function actionsPreferences($context) {
			if (
				!isset($context['settings']['symphony_tests']['navigation_group'])
				|| trim($context['settings']['symphony_tests']['navigation_group']) == ''
			) {
				$context['errors']['symphony_tests']['navigation_group'] = __('This is a required field.');
				$this->missing_navigation_group = true;
			}
		}

		/**
		 * View preferences.
		 * @param array $context
		 */
		public function viewPreferences($context) {
			$wrapper = $context['wrapper'];
			$errors = Symphony::Engine()->Page->_errors;

			$fieldset = new XMLElement('fieldset');
			$fieldset->setAttribute('class', 'settings');
			$fieldset->appendChild(new XMLElement('legend', __('Symphony Tests')));

			$label = Widget::Label(
				__('Navigation Group')
				. ' <i>'
				. __('Created if does not exist')
				. '</i>'
			);
			$label->appendChild(Widget::Input(
				'settings[symphony_tests][navigation_group]',
				$this->getNavigationGroup()
			));

			if (isset($errors['symphony_tests']['navigation_group'])) {
				$label = Widget::wrapFormElementWithError($label, $errors['symphony_tests']['navigation_group']);
			}

			$fieldset->appendChild($label);

			$list = new XMLElement('ul');
			$list->setAttribute('class', 'tags singular');

			foreach ($this->getNavigationGroups() as $group) {
				$list->appendChild(new XMLElement('li', $group));
			}

			$fieldset->appendChild($list);
			$wrapper->appendChild($fieldset);
		}
	}