primo commit

administrator/components/com_modules/src/Field/ModulesModuleField.php

@@ -0,0 +1,123 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  com_modules
+ *
+ * @copyright   (C) 2015 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Modules\Administrator\Field;
+
+use Joomla\CMS\Form\Field\ListField;
+use Joomla\Component\Modules\Administrator\Helper\ModulesHelper;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Modules Module field.
+ *
+ * @since  3.4.2
+ */
+class ModulesModuleField extends ListField
+{
+    /**
+     * The form field type.
+     *
+     * @var    string
+     * @since  3.4.2
+     */
+    protected $type = 'ModulesModule';
+
+    /**
+     * Client name.
+     *
+     * @var    string
+     * @since  4.0.0
+     */
+    protected $client;
+
+    /**
+     * Method to get certain otherwise inaccessible properties from the form field object.
+     *
+     * @param   string  $name  The property name for which to get the value.
+     *
+     * @return  mixed  The property value or null.
+     *
+     * @since   4.0.0
+     */
+    public function __get($name)
+    {
+        switch ($name) {
+            case 'client':
+                return $this->$name;
+        }
+
+        return parent::__get($name);
+    }
+
+    /**
+     * Method to set certain otherwise inaccessible properties of the form field object.
+     *
+     * @param   string  $name   The property name for which to set the value.
+     * @param   mixed   $value  The value of the property.
+     *
+     * @return  void
+     *
+     * @since   4.0.0
+     */
+    public function __set($name, $value)
+    {
+        switch ($name) {
+            case 'client':
+                $this->$name = (string) $value;
+                break;
+
+            default:
+                parent::__set($name, $value);
+        }
+    }
+
+    /**
+     * Method to attach a Form object to the field.
+     *
+     * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+     * @param   mixed              $value    The form field value to validate.
+     * @param   string             $group    The field name group control value. This acts as an array container for the field.
+     *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+     *                                       full field name would end up being "bar[foo]".
+     *
+     * @return  boolean  True on success.
+     *
+     * @see     FormField::setup()
+     * @since   4.0.0
+     */
+    public function setup(\SimpleXMLElement $element, $value, $group = null)
+    {
+        $result = parent::setup($element, $value, $group);
+
+        if ($result === true) {
+            $this->client = $this->element['client'] ? (string) $this->element['client'] : 'site';
+        }
+
+        return $result;
+    }
+
+    /**
+     * Method to get the field options.
+     *
+     * @return  array  The field option objects.
+     *
+     * @since   3.4.2
+     */
+    public function getOptions()
+    {
+        $clientId = $this->client === 'administrator' ? 1 : 0;
+        $options  = ModulesHelper::getModules($clientId);
+
+        return array_merge(parent::getOptions(), $options);
+    }
+}

administrator/components/com_modules/src/Field/ModulesPositionField.php

@@ -0,0 +1,123 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  com_modules
+ *
+ * @copyright   (C) 2015 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Modules\Administrator\Field;
+
+use Joomla\CMS\Form\Field\ListField;
+use Joomla\Component\Modules\Administrator\Helper\ModulesHelper;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Modules Position field.
+ *
+ * @since  3.4.2
+ */
+class ModulesPositionField extends ListField
+{
+    /**
+     * The form field type.
+     *
+     * @var    string
+     * @since  3.4.2
+     */
+    protected $type = 'ModulesPosition';
+
+    /**
+     * Client name.
+     *
+     * @var    string
+     * @since  4.0.0
+     */
+    protected $client;
+
+    /**
+     * Method to get certain otherwise inaccessible properties from the form field object.
+     *
+     * @param   string  $name  The property name for which to get the value.
+     *
+     * @return  mixed  The property value or null.
+     *
+     * @since   4.0.0
+     */
+    public function __get($name)
+    {
+        switch ($name) {
+            case 'client':
+                return $this->$name;
+        }
+
+        return parent::__get($name);
+    }
+
+    /**
+     * Method to set certain otherwise inaccessible properties of the form field object.
+     *
+     * @param   string  $name   The property name for which to set the value.
+     * @param   mixed   $value  The value of the property.
+     *
+     * @return  void
+     *
+     * @since   4.0.0
+     */
+    public function __set($name, $value)
+    {
+        switch ($name) {
+            case 'client':
+                $this->$name = (string) $value;
+                break;
+
+            default:
+                parent::__set($name, $value);
+        }
+    }
+
+    /**
+     * Method to attach a Form object to the field.
+     *
+     * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+     * @param   mixed              $value    The form field value to validate.
+     * @param   string             $group    The field name group control value. This acts as an array container for the field.
+     *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+     *                                       full field name would end up being "bar[foo]".
+     *
+     * @return  boolean  True on success.
+     *
+     * @see     FormField::setup()
+     * @since   4.0.0
+     */
+    public function setup(\SimpleXMLElement $element, $value, $group = null)
+    {
+        $result = parent::setup($element, $value, $group);
+
+        if ($result === true) {
+            $this->client = $this->element['client'] ? (string) $this->element['client'] : 'site';
+        }
+
+        return $result;
+    }
+
+    /**
+     * Method to get the field options.
+     *
+     * @return  array  The field option objects.
+     *
+     * @since   3.4.2
+     */
+    public function getOptions()
+    {
+        $clientId = $this->client === 'administrator' ? 1 : 0;
+        $options  = ModulesHelper::getPositions($clientId);
+
+        return array_merge(parent::getOptions(), $options);
+    }
+}

administrator/components/com_modules/src/Field/ModulesPositioneditField.php

@@ -0,0 +1,140 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  com_modules
+ *
+ * @copyright   (C) 2018 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Modules\Administrator\Field;
+
+use Joomla\CMS\Form\FormField;
+use Joomla\CMS\HTML\HTMLHelper;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Edit Modules Position field.
+ *
+ * @since  4.0.0
+ */
+class ModulesPositioneditField extends FormField
+{
+    /**
+     * The form field type.
+     *
+     * @var    string
+     * @since  4.0.0
+     */
+    protected $type = 'ModulesPositionedit';
+
+    /**
+     * Name of the layout being used to render the field
+     *
+     * @var    string
+     * @since  4.0.0
+     */
+    protected $layout = 'joomla.form.field.modulespositionedit';
+
+    /**
+     * Client name.
+     *
+     * @var    string
+     * @since  4.0.0
+     */
+    protected $client;
+
+    /**
+     * Method to get certain otherwise inaccessible properties from the form field object.
+     *
+     * @param   string  $name  The property name for which to get the value.
+     *
+     * @return  mixed  The property value or null.
+     *
+     * @since   4.0.0
+     */
+    public function __get($name)
+    {
+        switch ($name) {
+            case 'client':
+                return $this->$name;
+        }
+
+        return parent::__get($name);
+    }
+
+    /**
+     * Method to set certain otherwise inaccessible properties of the form field object.
+     *
+     * @param   string  $name   The property name for which to set the value.
+     * @param   mixed   $value  The value of the property.
+     *
+     * @return  void
+     *
+     * @since   4.0.0
+     */
+    public function __set($name, $value)
+    {
+        switch ($name) {
+            case 'client':
+                $this->$name = (string) $value;
+                break;
+
+            default:
+                parent::__set($name, $value);
+        }
+    }
+
+    /**
+     * Method to attach a Form object to the field.
+     *
+     * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
+     * @param   mixed              $value    The form field value to validate.
+     * @param   string             $group    The field name group control value. This acts as an array container for the field.
+     *                                       For example if the field has name="foo" and the group value is set to "bar" then the
+     *                                       full field name would end up being "bar[foo]".
+     *
+     * @return  boolean  True on success.
+     *
+     * @see     FormField::setup()
+     * @since   4.0.0
+     */
+    public function setup(\SimpleXMLElement $element, $value, $group = null)
+    {
+        $result = parent::setup($element, $value, $group);
+
+        if ($result === true) {
+            $this->client = $this->element['client'] ? (string) $this->element['client'] : 'site';
+        }
+
+        return $result;
+    }
+
+    /**
+     * Method to get the field input markup.
+     *
+     * @return  string  The field input markup.
+     *
+     * @since   4.0.0
+     */
+    protected function getInput()
+    {
+        $data = $this->getLayoutData();
+
+        $clientId  = $this->client === 'administrator' ? 1 : 0;
+        $positions = HTMLHelper::_('modules.positions', $clientId, 1, $this->value);
+
+        $data['client']    = $clientId;
+        $data['positions'] = $positions;
+
+        $renderer = $this->getRenderer($this->layout);
+        $renderer->setComponent('com_modules');
+        $renderer->setClient(1);
+
+        return $renderer->render($data);
+    }
+}