PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of LanguagesModel.php

(no description)

Copyright:	(C) 2008 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	234 lines (7 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

LanguagesModel:: (7 methods):
  __construct()
  populateState()
  getStoreId()
  getListQuery()
  setPublished()
  delete()
  cleanCache()

Class: LanguagesModel - X-Ref

Languages Model Class

__construct($config = array() X-Ref

Constructor.

param: array $config An optional associative array of configuration settings.
param: MVCFactoryInterface $factory The factory.

populateState($ordering = 'a.ordering', $direction = 'asc') X-Ref

Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

param: string $ordering An optional ordering field.
param: string $direction An optional direction (asc|desc).
return: void

getStoreId($id = '') X-Ref

Method to get a store id based on model 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: string $id A prefix for the store id.
return: string A store id.

getListQuery() X-Ref

Method to build an SQL query to load the list data.

return: string An SQL query

setPublished($cid, $value = 0) X-Ref

Set the published language(s).

param: array    $cid    An array of language IDs.
param: integer  $value  The value of the published state.
return: boolean  True on success, false otherwise.

delete($pks) X-Ref

Method to delete records.

param: array $pks An array of item primary keys.
return: boolean Returns true on success, false on failure.

cleanCache($group = null, $clientId = 0) X-Ref

Custom clean cache method, 2 places for 2 clients.

param: string $group Optional cache group name.
param: integer $clientId @deprecated 5.0 No longer used.
return: void

PHP Cross Reference of Joomla 4.2.2 documentation

/administrator/components/com_languages/src/Model/ -> LanguagesModel.php (summary)

Defines 1 class