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

libraries/src/Form/Field/WorkflowconditionField.php
132 строки4 KB
Hans Kuijpers
[4.4] fixing typo (#43875)
02 авг 2024, 22:28
02 авг 2024, 22:2869a6529
<?php

/**
 * Joomla! Content Management System
 *
 * @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\CMS\Form\Field;

use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Workflow\WorkflowServiceInterface;

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

/**
 * Workflow States field.
 *
 * @since  4.0.0
 */
class WorkflowconditionField extends ListField
{
    /**
     * The form field type.
     *
     * @var     string
     * @since  4.0.0
     */
    protected $type = 'Workflowcondition';

    /**
     * The component and section separated by ".".
     *
     * @var    string
     * @since  4.0.0
     */
    protected $extension = '';

    /**
     * Determinate if the "All" value should be added
     *
     * @var boolean
     * @since  4.0.0
     */
    protected $hideAll = false;

    /**
     * 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.
     *
     * @since  4.0.0
     */
    public function setup(\SimpleXMLElement $element, $value, $group = null)
    {
        $success = parent::setup($element, $value, $group);

        if ($success) {
            if (\strlen($element['extension'])) {
                $this->extension = (string) $element['extension'];
            } else {
                $this->extension = Factory::getApplication()->getInput()->getCmd('extension');
            }

            if (\strlen($element['hide_all'])) {
                $this->hideAll = (string) $element['hide_all'] === 'true' || (string) $element['hide_all'] === 'yes';
            }
        }

        return $success;
    }

    /**
     * Method to get the field options.
     *
     * @return  object[]  The field option objects.
     *
     * @since   4.0.0
     */
    protected function getOptions()
    {
        $fieldname  = preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname);
        $options    = [];
        $conditions = [];

        $parts = explode('.', $this->extension);

        $component = Factory::getApplication()->bootComponent($parts[0]);

        if ($component instanceof WorkflowServiceInterface) {
            $conditions = $component->getConditions($this->extension);
        }

        foreach ($conditions as $value => $option) {
            $text = trim((string) $option) != '' ? trim((string) $option) : $value;

            $selected = ((int) $this->value === $value);

            $tmp = [
                'value'    => $value,
                'text'     => Text::alt($text, $fieldname),
                'selected' => $selected,
                'checked'  => $selected,
            ];

            // Add the option object to the result set.
            $options[] = (object) $tmp;
        }

        if (!$this->hideAll) {
            $options[] = (object) [
                'value'    => '*',
                'text'     => Text::_('JALL'),
                'selected' => $this->value === '*',
                'checked'  => $this->value === '*',
            ];
        }

        // Merge any additional options in the XML definition.
        return array_merge(parent::getOptions(), $options);
    }
}