API15

API15:JHTMLGrid/state

From Joomla! Documentation

Revision as of 22:21, 22 March 2010 by Doxiki (talk | contribs) (New page: <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </span> {{Description:JHTMLGrid/state}} ===...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

[Edit Descripton]

Template:Description:JHTMLGrid/state

Syntax

state($filter_state='*', $published='Published', $unpublished='Unpublished', $archived=NULL, $trashed=NULL)
Parameter Name Default Value Description
$filter_state '*'
$published 'Published'
$unpublished 'Unpublished'
$archived NULL
$trashed NULL

Defined in

libraries/joomla/html/html/grid.php

Importing

jimport( 'joomla.html.html.grid' );

Source Body

function state( $filter_state='*', $published='Published', $unpublished='Unpublished', $archived=NULL, $trashed=NULL )
{
        $state[] = JHTML::_('select.option',  '', '- '. JText::_( 'Select State' ) .' -' );
        //Jinx : Why is this used ?
        //$state[] = JHTML::_('select.option',  '*', JText::_( 'Any' ) );
        $state[] = JHTML::_('select.option',  'P', JText::_( $published ) );
        $state[] = JHTML::_('select.option',  'U', JText::_( $unpublished ) );

        if ($archived) {
                $state[] = JHTML::_('select.option',  'A', JText::_( $archived ) );
        }

        if ($trashed) {
                $state[] = JHTML::_('select.option',  'T', JText::_( $trashed ) );
        }

        return JHTML::_('select.genericlist',   $state, 'filter_state', 'class="inputbox" size="1" onchange="submitform( );"', 'value', 'text', $filter_state );
}

[Edit See Also] Template:SeeAlso:JHTMLGrid/state

Examples

<CodeExamplesForm />