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

(no description)

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

Defines 1 class

AssociationsModel:: (6 methods):
  __construct()
  populateState()
  getStoreId()
  getListQuery()
  purge()
  clean()

Class: AssociationsModel - X-Ref

Methods supporting a list of article records.

__construct($config = array() X-Ref

Override parent constructor.

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

populateState($ordering = '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

Build an SQL query to load the list data.

return: \Joomla\Database\DatabaseQuery|boolean

purge($context = '', $key = '') X-Ref

Delete associations from #__associations table.

param: string  $context  The associations context. Empty for all.
param: string  $key      The associations key. Empty for all.
return: boolean  True on success.

clean($context = '', $key = '') X-Ref

Delete orphans from the #__associations table.

param: string  $context  The associations context. Empty for all.
param: string  $key      The associations key. Empty for all.
return: boolean  True on success

PHP Cross Reference of Joomla 4.2.2 documentation

/administrator/components/com_associations/src/Model/ -> AssociationsModel.php (summary)

Defines 1 class