Back to Category class

Method categories

public static array
categories
(mixed $extension, mixed $config = array('filter.published' => array(0, 1)))
Returns an array of categories for the given extension.
Parameters
  • string $extension The extension option.
  • array $config An array of configuration options. By default, only published and unpublished categories are returned.
Returns
  • array Categories for the extension
Since
  • 1.6
Class: Category
Project: Joomla

Method categories - Source code

/**
 * Returns an array of categories for the given extension.
 *
 * @param   string  $extension  The extension option.
 * @param   array   $config     An array of configuration options. By default, only published and unpublished categories are returned.
 *
 * @return  array   Categories for the extension
 *
 * @since   1.6
 */
public static function categories($extension, $config = array('filter.published' => array(0, 1)))
{
    $hash = md5($extension . '.' . serialize($config));
    if (!isset(static::$items[$hash])) {
        $config = (array) $config;
        $user = Factory::getUser();
        $db = Factory::getDbo();
        $query = $db->getQuery(true)->select([$db->quoteName('a.id'), $db->quoteName('a.title'), $db->quoteName('a.level'), $db->quoteName('a.parent_id'), $db->quoteName('a.language')])->from($db->quoteName('#__categories', 'a'))->where($db->quoteName('a.parent_id') . ' > 0');
        // Filter on extension.
        $query->where($db->quoteName('extension') . ' = :extension')->bind(':extension', $extension);
        // Filter on user level.
        $groups = $user->getAuthorisedViewLevels();
        $query->whereIn($db->quoteName('a.access'), $groups);
        // Filter on the published state
        if (isset($config['filter.published'])) {
            if (is_numeric($config['filter.published'])) {
                $query->where($db->quoteName('a.published') . ' = :published')->bind(':published', $config['filter.published'], ParameterType::INTEGER);
            } elseif (is_array($config['filter.published'])) {
                $config['filter.published'] = ArrayHelper::toInteger($config['filter.published']);
                $query->whereIn($db->quoteName('a.published'), $config['filter.published']);
            }
        }
        $query->order($db->quoteName('a.lft'));
        $db->setQuery($query);
        $items = $db->loadObjectList();
        // Assemble the list options.
        static::$items[$hash] = array();
        foreach ($items as &$item) {
            $repeat = $item->level - 1 >= 0 ? $item->level - 1 : 0;
            $item->title = str_repeat('- ', $repeat) . $item->title;
            if ($item->language !== '*') {
                $item->title .= ' (' . $item->language . ')';
            }
            static::$items[$hash][] = HTMLHelper::_('select.option', $item->id, $item->title);
        }
        // Special "Add to root" option:
        static::$items[$hash][] = HTMLHelper::_('select.option', '1', Text::_('JLIB_HTML_ADD_TO_ROOT'));
    }
    return static::$items[$hash];
}