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

(no description)

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

Defines 1 class

WorkflowsModel:: (7 methods):
  __construct()
  populateState()
  getTable()
  getItems()
  getFilterForm()
  countItems()
  getListQuery()

Class: WorkflowsModel - X-Ref

Model class for workflows

__construct($config = array() X-Ref

Constructor.

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

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

Method to auto-populate the model state.

This method should only be called once per instantiation and is designed
to be called on the first call to the getState() method unless the model
configuration flag to ignore the request is set.

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

getTable($type = 'Workflow', $prefix = 'Administrator', $config = array() X-Ref

Method to get a table object, load it if necessary.

param: string  $type    The table name. Optional.
param: string  $prefix  The class prefix. Optional.
param: array   $config  Configuration array for model. Optional.
return: \Joomla\CMS\Table\Table  A Table object

getItems() X-Ref

Method to get an array of data items.

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

getFilterForm($data = array() X-Ref

Get the filter form

param: array $data data
param: boolean $loadData load current data
return: \Joomla\CMS\Form\Form|bool the Form object or false

countItems($items) X-Ref

Add the number of transitions and states to all workflow items

param: array $items The workflow items
return: mixed An array of data items on success, false on failure.

getListQuery() X-Ref

Method to get the data that should be injected in the form.

return: string The query to database.

PHP Cross Reference of Joomla 4.2.2 documentation

/administrator/components/com_workflow/src/Model/ -> WorkflowsModel.php (summary)

Defines 1 class