API15

JModelList/getItems: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m preparing for archive only
 
Line 56: Line 56:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getItems
  category=getItems
  category=JModelList
  category=JModelList
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 00:58, 25 March 2017

Description

Method to get an array of data items.

[<! removed edit link to red link >]

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

Syntax

getItems()


Returns

mixed An array of data items on success, false on failure.

Defined in

libraries/joomla/application/component/modellist.php

Importing

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

Source Body

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

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

        // Load the list items.
        $query  = $this->_getListQuery();
        $items  = $this->_getList((string) $query, $this->getState('list.start'), $this->getState('list.limit'));

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

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

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

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

Examples

Code Examples