primo commit

libraries/f0f/form/field/components.php

@@ -0,0 +1,237 @@
+<?php
+/**
+ * @package    FrameworkOnFramework
+ * @subpackage form
+ * @copyright   Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+// Protect from unauthorized access
+defined('F0F_INCLUDED') or die;
+
+JFormHelper::loadFieldClass('list');
+
+/**
+ * Form Field class for F0F
+ * Components installed on the site
+ *
+ * @package  FrameworkOnFramework
+ * @since    2.1
+ */
+class F0FFormFieldComponents extends JFormFieldList implements F0FFormField
+{
+	protected $static;
+
+	protected $repeatable;
+
+	public $client_ids = null;
+
+	/** @var   F0FTable  The item being rendered in a repeatable form field */
+	public $item;
+
+	/** @var int A monotonically increasing number, denoting the row number in a repeatable view */
+	public $rowid;
+
+	/**
+	 * Method to get certain otherwise inaccessible properties from the form field object.
+	 *
+	 * @param   string  $name  The property name for which to the the value.
+	 *
+	 * @return  mixed  The property value or null.
+	 *
+	 * @since   2.1
+	 */
+	public function __get($name)
+	{
+		switch ($name)
+		{
+			case 'static':
+				if (empty($this->static))
+				{
+					$this->static = $this->getStatic();
+				}
+
+				return $this->static;
+				break;
+
+			case 'repeatable':
+				if (empty($this->repeatable))
+				{
+					$this->repeatable = $this->getRepeatable();
+				}
+
+				return $this->repeatable;
+				break;
+
+			default:
+				return parent::__get($name);
+		}
+	}
+
+	/**
+	 * Get the rendering of this field type for static display, e.g. in a single
+	 * item view (typically a "read" task).
+	 *
+	 * @since 2.1
+	 *
+	 * @return  string  The field HTML
+	 */
+	public function getStatic()
+	{
+		$class = $this->element['class'] ? ' class="' . (string) $this->element['class'] . '"' : '';
+
+		return '<span id="' . $this->id . '" ' . $class . '>' .
+			htmlspecialchars(F0FFormFieldList::getOptionName($this->getOptions(), $this->value), ENT_COMPAT, 'UTF-8') .
+			'</span>';
+	}
+
+	/**
+	 * Get the rendering of this field type for a repeatable (grid) display,
+	 * e.g. in a view listing many item (typically a "browse" task)
+	 *
+	 * @since 2.1
+	 *
+	 * @return  string  The field HTML
+	 */
+	public function getRepeatable()
+	{
+		$class = $this->element['class'] ? (string) $this->element['class'] : '';
+
+		return '<span class="' . $this->id . ' ' . $class . '">' .
+			htmlspecialchars(F0FFormFieldList::getOptionName($this->getOptions(), $this->value), ENT_COMPAT, 'UTF-8') .
+			'</span>';
+	}
+
+	/**
+	 * Get a list of all installed components and also translates them.
+	 *
+	 * The manifest_cache is used to get the extension names, since JInstaller is also
+	 * translating those names in stead of the name column. Else some of the translations
+	 * fails.
+	 *
+	 * @since    2.1
+	 *
+	 * @return 	array	An array of JHtml options.
+	 */
+	protected function getOptions()
+	{
+		$db = F0FPlatform::getInstance()->getDbo();
+
+		// Check for client_ids override
+		if ($this->client_ids !== null)
+		{
+			$client_ids = $this->client_ids;
+		}
+		else
+		{
+			$client_ids = $this->element['client_ids'];
+		}
+
+		$client_ids = explode(',', $client_ids);
+
+		// Calculate client_ids where clause
+		foreach ($client_ids as &$client_id)
+		{
+			$client_id = (int) trim($client_id);
+			$client_id = $db->q($client_id);
+		}
+
+		$query = $db->getQuery(true)
+			->select(
+				array(
+					$db->qn('name'),
+					$db->qn('element'),
+					$db->qn('client_id'),
+					$db->qn('manifest_cache'),
+				)
+			)
+			->from($db->qn('#__extensions'))
+			->where($db->qn('type') . ' = ' . $db->q('component'))
+			->where($db->qn('client_id') . ' IN (' . implode(',', $client_ids) . ')');
+		$db->setQuery($query);
+		$components = $db->loadObjectList('element');
+
+		// Convert to array of objects, so we can use sortObjects()
+		// Also translate component names with JText::_()
+		$aComponents = array();
+		$user = JFactory::getUser();
+
+		foreach ($components as $component)
+		{
+			// Don't show components in the list where the user doesn't have access for
+			// TODO: perhaps add an option for this
+			if (!$user->authorise('core.manage', $component->element))
+			{
+				continue;
+			}
+
+			$oData = (object) array(
+				'value'	=> $component->element,
+				'text' 	=> $this->translate($component, 'component')
+			);
+			$aComponents[$component->element] = $oData;
+		}
+
+		// Reorder the components array, because the alphabetical
+		// ordering changed due to the JText::_() translation
+		uasort(
+			$aComponents,
+			function ($a, $b) {
+				return strcasecmp($a->text, $b->text);
+			}
+		);
+
+		return $aComponents;
+	}
+
+	/**
+	 * Translate a list of objects with JText::_().
+	 *
+	 * @param   array   $item  The array of objects
+	 * @param   string  $type  The extension type (e.g. component)
+	 *
+	 * @since   2.1
+	 *
+	 * @return  string  $text  The translated name of the extension
+	 *
+	 * @see administrator/com_installer/models/extension.php
+	 */
+	public function translate($item, $type)
+	{
+        $platform = F0FPlatform::getInstance();
+
+		// Map the manifest cache to $item. This is needed to get the name from the
+		// manifest_cache and NOT from the name column, else some JText::_() translations fails.
+		$mData = json_decode($item->manifest_cache);
+
+		if ($mData)
+		{
+			foreach ($mData as $key => $value)
+			{
+				if ($key == 'type')
+				{
+					// Ignore the type field
+					continue;
+				}
+
+				$item->$key = $value;
+			}
+		}
+
+		$lang = $platform->getLanguage();
+
+		switch ($type)
+		{
+			case 'component':
+				$source = JPATH_ADMINISTRATOR . '/components/' . $item->element;
+				$lang->load("$item->element.sys", JPATH_ADMINISTRATOR, null, false, false)
+					||	$lang->load("$item->element.sys", $source, null, false, false)
+					||	$lang->load("$item->element.sys", JPATH_ADMINISTRATOR, $lang->getDefault(), false, false)
+					||	$lang->load("$item->element.sys", $source, $lang->getDefault(), false, false);
+				break;
+		}
+
+		$text = JText::_($item->name);
+
+		return $text;
+	}
+}