libraries/src/Form/Field/OrderingField.php - 5.4-dev - githubmirror/joomla-cms

libraries/src/Form/Field/OrderingField.php
195 строк6 KB
Hannes Papenberg
[5.4] Deprecating UCM code (#44910)
29 июн 2025, 18:29
29 июн 2025, 18:29ba91f96
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2013 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Form\Field;

use Joomla\CMS\Form\FormField;
use Joomla\CMS\HTML\HTMLHelper;
use Joomla\Database\ParameterType;
use Joomla\Database\QueryInterface;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Ordering field.
 *
 * @since  3.2
 */
class OrderingField extends FormField
{
    /**
     * The form field type.
     *
     * @var     string
     * @since   3.2
     */
    protected $type = 'Ordering';

    /**
     * The form field content type.
     *
     * @var     string
     * @since   3.2
     */
    protected $contentType;

    /**
     * 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   3.2
     */
    public function __get($name)
    {
        if ($name === 'contentType') {
            return $this->contentType;
        }

        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   3.2
     */
    public function __set($name, $value)
    {
        switch ($name) {
            case 'contentType':
                $this->contentType = (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   3.2
     */
    public function setup(\SimpleXMLElement $element, $value, $group = null)
    {
        $result = parent::setup($element, $value, $group);

        if ($result === true) {
            $this->contentType = (string) $this->element['content_type'];
        }

        return $result;
    }

    /**
     * Method to get the field input markup.
     *
     * @return  string  The field input markup.
     *
     * @since   3.2
     */
    protected function getInput()
    {
        $html = [];
        $attr = '';

        // Initialize some field attributes.
        $attr .= !empty($this->class) ? ' class="form-select' . $this->class . '"' : ' class="form-select"';
        $attr .= $this->disabled ? ' disabled' : '';
        $attr .= !empty($this->size) ? ' size="' . $this->size . '"' : '';

        // Initialize JavaScript field attributes.
        $attr .= !empty($this->onchange) ? ' onchange="' . $this->onchange . '"' : '';

        $itemId = (int) $this->getItemId();

        $query = $this->getQuery();

        // Create a read-only list (no name) with a hidden input to store the value.
        if ($this->readonly) {
            $html[] = HTMLHelper::_('list.ordering', '', $query, trim($attr), $this->value, $itemId ? 0 : 1, $this->id);
            $html[] = '<input type="hidden" name="' . $this->name . '" value="' . $this->value . '">';
        } else {
            // Create a regular list.
            $html[] = HTMLHelper::_('list.ordering', $this->name, $query, trim($attr), $this->value, $itemId ? 0 : 1, $this->id);
        }

        return implode($html);
    }

    /**
     * Builds the query for the ordering list.
     *
     * @return  QueryInterface  The query for the ordering form field
     *
     * @since   3.2
     */
    protected function getQuery()
    {
        $categoryId = (int) $this->form->getValue('catid');
        $db         = $this->getDatabase();
        $query      = $db->getQuery(true)
            ->select($db->quoteName('ct') . '.*')
            ->from($db->quoteName('#__content_types', 'ct'))
            ->where($db->quoteName('ct.type_alias') . ' = :alias')
            ->bind(':alias', $this->contentType);

        $db->setQuery($query);
        $ucmRow       = $db->loadObject();
        $ucmMapCommon = json_decode($ucmRow->field_mappings)->common;

        if (\is_object($ucmMapCommon)) {
            $ordering = $ucmMapCommon->core_ordering;
            $title    = $ucmMapCommon->core_title;
        } elseif (\is_array($ucmMapCommon)) {
            $ordering = $ucmMapCommon[0]->core_ordering;
            $title    = $ucmMapCommon[0]->core_title;
        }

        $query = $db->getQuery(true);
        $query->select([$db->quoteName($ordering, 'value'), $db->quoteName($title, 'text')])
            ->from($db->quoteName(json_decode($ucmRow->table)->special->dbtable))
            ->where($db->quoteName('catid') . ' = :categoryId')
            ->order($db->quoteName('ordering'))
            ->bind(':categoryId', $categoryId, ParameterType::INTEGER);

        return $query;
    }

    /**
     * Retrieves the current Item's Id.
     *
     * @return  integer  The current item ID
     *
     * @since   3.2
     */
    protected function getItemId()
    {
        return (int) $this->form->getValue('id');
    }
}