[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2017 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\Form\Field;
  11  
  12  use Joomla\CMS\Factory;
  13  use Joomla\CMS\Language\Text;
  14  use Joomla\Utilities\ArrayHelper;
  15  
  16  // phpcs:disable PSR1.Files.SideEffects
  17  \defined('JPATH_PLATFORM') or die;
  18  // phpcs:enable PSR1.Files.SideEffects
  19  
  20  /**
  21   * Form Field class for the Joomla Framework.
  22   *
  23   * @since  3.7.0
  24   */
  25  class ComponentsField extends ListField
  26  {
  27      /**
  28       * The form field type.
  29       *
  30       * @var     string
  31       * @since  3.7.0
  32       */
  33      protected $type = 'Components';
  34  
  35      /**
  36       * Method to get a list of options for a list input.
  37       *
  38       * @return  array  An array of JHtml options.
  39       *
  40       * @since   2.5.0
  41       */
  42      protected function getOptions()
  43      {
  44          $db    = $this->getDatabase();
  45          $query = $db->getQuery(true)
  46              ->select(
  47                  [
  48                      $db->quoteName('name', 'text'),
  49                      $db->quoteName('element', 'value'),
  50                  ]
  51              )
  52              ->from($db->quoteName('#__extensions'))
  53              ->where(
  54                  [
  55                      $db->quoteName('enabled') . ' >= 1',
  56                      $db->quoteName('type') . ' = ' . $db->quote('component'),
  57                  ]
  58              );
  59  
  60          $items = $db->setQuery($query)->loadObjectList();
  61  
  62          if ($items) {
  63              $lang = Factory::getLanguage();
  64  
  65              foreach ($items as &$item) {
  66                  // Load language
  67                  $extension = $item->value;
  68  
  69                  $lang->load("$extension.sys", JPATH_ADMINISTRATOR)
  70                      || $lang->load("$extension.sys", JPATH_ADMINISTRATOR . '/components/' . $extension);
  71  
  72                  // Translate component name
  73                  $item->text = Text::_($item->text);
  74              }
  75  
  76              // Sort by component name
  77              $items = ArrayHelper::sortObjects($items, 'text', 1, true, true);
  78          }
  79  
  80          // Merge any additional options in the XML definition.
  81          $options = array_merge(parent::getOptions(), $items);
  82  
  83          return $options;
  84      }
  85  }