Joomla! Documentation™

Description

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

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];
}

Examples

<CodeExamplesForm />