API15

JModelList/getTotal: Difference between revisions

From Joomla! Documentation

Doxiki (talk | contribs)
New page: ===Description=== Method to get the total number of items for the data set. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>[[Description:JModelList/getTotal|Edit ...
 
m removing red link to edit, no existant pages
Line 3: Line 3:


<span class="editsection" style="font-size:76%;">
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JModelList/getTotal|Edit Descripton]]<nowiki>]</nowiki>
<nowiki>[<! removed edit link to red link >]</nowiki>
</span>
</span>


{{Description:JModelList/getTotal}}
<! removed transcluded page call, red link never existed >


===Syntax===
===Syntax===
Line 51: Line 51:


<span class="editsection" style="font-size:76%;">
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JModelList/getTotal|Edit See Also]]<nowiki>]</nowiki>
<nowiki>[<! removed edit link to red link >]</nowiki>
</span>
</span>
{{SeeAlso:JModelList/getTotal}}
<! removed transcluded page call, red link never existed >


===Examples===
===Examples===
Line 66: Line 66:
  format= ,,,
  format= ,,,
</dpl>
</dpl>
[[Category:Archived pages API15]]

Revision as of 18:37, 12 May 2013

Description

Method to get the total number of items for the data set.

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

getTotal()


Returns

integer The total number of items available in the data set.

Defined in

libraries/joomla/application/component/modellist.php

Importing

jimport( 'joomla.application.component.modellist' );

Source Body

public function getTotal()
{
        // Get a storage key.
        $store = $this->_getStoreId('getTotal');

        // Try to load the data from internal storage.
        if (!empty($this->_cache[$store])) {
                return $this->_cache[$store];
        }

        // Load the total.
        $query = $this->_getListQuery();
        $total = (int) $this->_getListCount((string) $query);

        // Check for a database error.
        if ($this->_db->getErrorNum())
        {
                $this->setError($this->_db->getErrorMsg());
                return false;
        }

        // Add the total to the internal cache.
        $this->_cache[$store] = $total;

        return $this->_cache[$store];
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />