Back to Grid class

Method state

public static string
state
(mixed $filterState = '*', mixed $published = 'JPUBLISHED', mixed $unpublished = 'JUNPUBLISHED', mixed $archived = null, mixed $trashed = null)
Method to create a select list of states for filtering By default the filter shows only published and unpublished items
Parameters
  • string $filterState The initial filter state
  • string $published The Text string for published
  • string $unpublished The Text string for Unpublished
  • string $archived The Text string for Archived
  • string $trashed The Text string for Trashed
Returns
  • string
Since
  • 1.5
Class: Grid
Project: Joomla

Method state - Source code

/**
 * Method to create a select list of states for filtering
 * By default the filter shows only published and unpublished items
 *
 * @param   string  $filterState  The initial filter state
 * @param   string  $published    The Text string for published
 * @param   string  $unpublished  The Text string for Unpublished
 * @param   string  $archived     The Text string for Archived
 * @param   string  $trashed      The Text string for Trashed
 *
 * @return  string
 *
 * @since   1.5
 */
public static function state($filterState = '*', $published = 'JPUBLISHED', $unpublished = 'JUNPUBLISHED', $archived = null, $trashed = null)
{
    $state = array('' => '- ' . Text::_('JLIB_HTML_SELECT_STATE') . ' -', 'P' => Text::_($published), 'U' => Text::_($unpublished));
    if ($archived) {
        $state['A'] = Text::_($archived);
    }
    if ($trashed) {
        $state['T'] = Text::_($trashed);
    }
    return HTMLHelper::_('select.genericlist', $state, 'filter_state', array('list.attr' => 'class="form-select" size="1" onchange="Joomla.submitform();"', 'list.select' => $filterState, 'option.key' => null));
}