Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe SearchModel
+ Graphe d'héritage de SearchModel:

Fonctions membres publiques

 getItems ()
 
 getQuery ()
 
- Fonctions membres publiques hérités de ListModel
 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getIsEmptyState ()
 
 getActiveFilters ()
 
 getItems ()
 
 getPagination ()
 
 getTotal ()
 
 getStart ()
 
 getFilterForm ($data=array(), $loadData=true)
 
 getUserStateFromRequest ($key, $request, $default=null, $type='none', $resetPage=true)
 
- Fonctions membres publiques hérités de BaseDatabaseModel
 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getTable ($name='', $prefix='', $options=array())
 
 isCheckedOut ($item)
 
 getDbo ()
 
 setDbo (DatabaseInterface $db=null)
 
 __get ($name)
 
- Fonctions membres publiques hérités de BaseModel
 __construct ($config=array())
 
 getName ()
 
- Fonctions membres publiques hérités de CMSObject
 __construct ($properties=null)
 
 __toString ()
 
 def ($property, $default=null)
 
 get ($property, $default=null)
 
 getProperties ($public=true)
 
 getError ($i=null, $toString=true)
 
 getErrors ()
 
 set ($property, $value=null)
 
 setProperties ($properties)
 
 setError ($error)
 
- Fonctions membres publiques hérités de StatefulModelInterface
 getState ($property=null, $default=null)
 
 setState ($property, $value=null)
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 
- Fonctions membres publiques hérités de CurrentUserInterface
 setCurrentUser (User $currentUser)
 
- Fonctions membres publiques hérités de CacheControllerFactoryAwareInterface
 setCacheControllerFactory (CacheControllerFactoryInterface $factory)
 
- Fonctions membres publiques hérités de DatabaseAwareInterface
 setDatabase (DatabaseInterface $db)
 
- Fonctions membres publiques hérités de FormFactoryAwareInterface
 setFormFactory (FormFactoryInterface $factory)
 

Fonctions membres protégées

 getListQuery ()
 
 getStoreId ($id='', $page=true)
 
 populateState ($ordering=null, $direction=null)
 
- Fonctions membres protégées hérités de ListModel
 getEmptyStateQuery ()
 
 _getListQuery ()
 
 getListQuery ()
 
 getStoreId ($id='')
 
 loadFormData ()
 
 populateState ($ordering=null, $direction=null)
 
 refineSearchStringToRegex ($search, $regexDelimiter='/')
 
- Fonctions membres protégées hérités de BaseDatabaseModel
 _getList ($query, $limitstart=0, $limit=0)
 
 _getListCount ($query)
 
 _createTable ($name, $prefix='Table', $config=array())
 
 bootComponent ($component)
 
 dispatchEvent (EventInterface $event)
 

Attributs protégés

 $context = 'com_finder.search'
 
 $searchquery
 
 $excludedTerms = array()
 
 $includedTerms = array()
 
 $requiredTerms = array()
 
- Attributs protégés hérités de ListModel
 $cache = array()
 
 $context = null
 
 $filter_fields = array()
 
 $query = array()
 
 $lastQueryStoreId = null
 
 $filterFormName = null
 
 $htmlFormName = 'adminForm'
 
 $filterBlacklist = array()
 
 $filterForbiddenList = array()
 
 $listBlacklist = array('select')
 
 $listForbiddenList = array('select')
 
- Attributs protégés hérités de BaseDatabaseModel
 $option = null
 
 $event_clean_cache = null
 
- Attributs protégés hérités de BaseModel
 $name
 
- Attributs protégés hérités de CMSObject
 $_errors = array()
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de BaseModel
static addIncludePath ($path='', $prefix='')
 
- Attributs protégés statiques hérités de BaseModel
static $paths
 

Description détaillée

Search model class for the Finder package.

Depuis
2.5

Documentation des fonctions membres

◆ getItems()

getItems ( )

Method to get the results of the query.

Renvoie
array An array of Result objects.
Depuis
2.5
Exceptions

Implémente ListModelInterface.

Références $items, $result, $results, et null.

◆ getListQuery()

getListQuery ( )
protected

Method to build a database query to load the list data.

Renvoie
A database query.
Depuis
2.5

If we are not ordering by relevance, we just have to add the unique items to the set.

Références $c, $db, $direction, $groups, $i, $nowDate, $ordering, $query, $taxonomies, $user, elseif, Joomla\Database\getDatabase(), Factory\getDate(), Factory\getLanguage(), Joomla\CMS\MVC\Model\getState(), et Factory\getUser().

◆ getQuery()

getQuery ( )

Method to get the query object.

Renvoie
Query A query object.
Depuis
2.5

◆ getStoreId()

getStoreId (   $id = '',
  $page = true 
)
protected

Method to get a store id based on model the configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

Paramètres
string$idAn identifier string to generate the store id. [optional]
boolean$pageTrue to store the data paged, false to store all data. [optional]
Renvoie
string A store id.
Depuis
2.5

Références $id, $query, et Joomla\CMS\MVC\Model\getState().

◆ populateState()

populateState (   $ordering = null,
  $direction = null 
)
protected

Method to auto-populate the model state. Calling getState in this method will result in recursion.

Paramètres
string$orderingAn optional ordering field. [optional]
string$directionAn optional direction. [optional]
Renvoie
void
Depuis
2.5

Références $app, $input, $language, $options, $params, $user, Factory\getApplication(), Joomla\Database\getDatabase(), Factory\getLanguage(), Factory\getUser(), Multilanguage\isEnabled(), Joomla\CMS\MVC\Model\setState(), et StringHelper\strtolower().

Documentation des champs

◆ $context

$context = 'com_finder.search'
protected

◆ $excludedTerms

$excludedTerms = array()
protected

◆ $includedTerms

$includedTerms = array()
protected

◆ $requiredTerms

$requiredTerms = array()
protected

◆ $searchquery

$searchquery
protected

La documentation de cette classe a été générée à partir du fichier suivant :