Model getListQuery() fetch all rows with using JPagination

Question

I have method getListQuery() in my model, which return query. As we know, Joomla automically set limit and offset to query when we use JPagination. I have problem, that I want to use JPagination and fetch all rows in getListQuery(). As far as, I wrote code like

protected function getListQuery(){

    // here is created my $query object with query

    // I'm fetching all rows
    $rows = $db->loadObjectList();
    $this->rows = $rows;

    return $query;

}

It means, query is executing 2 times: one by me in this method and one by Joomla core. I'm not so happy with this solution, because it causes page loads 2x longer. Query has about 10 joins... With milions of rows it's really problem. Do you see any right solution?

Answer 1

I found a solution (I think). I've overwritten JModelList methods.

class MyComponentModel extends JModelList{

    protected $_items = array();

    public function getItems() {
        // Get a storage key.
        $store = $this->getStoreId();

        // Try to load the data from internal storage.
        if (isset($this->cache[$store])) {
            return $this->cache[$store];
        }
        $query = $this->getQuery();
        $this->query = $query;
        $db = JFactory::getDbo();
        $db->setQuery($query);
        $rows = $db->loadObjectList();
        $this->cache[$store] = $rows;
        $this->_items = $rows;
        return array_slice($rows, $this->getStart(), $this->getState('list.limit'));
    }

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

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

        // Create the pagination object.
        jimport('joomla.html.pagination');
        $limit = (int) $this->getState('list.limit') - (int) $this->getState('list.links');
        $page = new JPagination($this->getTotal(), $this->getStart(), $limit);

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

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

    function getTotal() {
        return count($this->_items);
    }

    public function getQuery() {
        // query
        return $query;
    }

}

view.html.php

$this->model = $this->getModel();
$this->items = $this->model->getItems();
$this->pagination = $this->model->getPagination();

page loads much faster. Is it good solution?

Answer 2

Joomla should be using getItems to run the query. So your best bet is to alter the state of the model to make sure that it loads all the results.

Within the model you can do this by using setState like so:

$this->setState('list.limit', 0);

Run that before the model calls getItems and it will load all the items for you.

---

A few caveats with this.

1. You can also do this outside the model, so if for instance you were in your view. You could do the following:

   $model = $this->getModel(); $model->setState('list.limit', 0);

2. Sometimes you can do this too early, before the model's state has been populated, which will cause the model to get rebuilt from the user state after you have set the limit, basically overriding the limit.

To fix this, you can force the model to populate its state first:

$model = $this->getModel();
$model->getState();
$model->setState('list.limit', 0);

The actual populateState method is protected, so outside the model you can't call it directly, but any call to getState will make sure that the populateState is called before returning the current settings in the state.