[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

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

(no description)

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

Defines 1 class

TransitionModel:: (10 methods):
  populateState()
  canDelete()
  canEditState()
  getItem()
  save()
  generateNewTitle()
  getForm()
  loadFormData()
  getWorkflow()
  preprocessForm()


Class: TransitionModel  - X-Ref

Model class for transition

populateState()   X-Ref
Auto-populate the model state.

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

return: void

canDelete($record)   X-Ref
Method to test whether a record can be deleted.

param: object  $record  A record object.
return: boolean  True if allowed to delete the record. Defaults to the permission for the component.

canEditState($record)   X-Ref
Method to test whether a record can have its state changed.

param: object  $record  A record object.
return: boolean  True if allowed to change the state of the record. Defaults to the permission set in the component.

getItem($pk = null)   X-Ref
Method to get a single record.

param: integer  $pk  The id of the primary key.
return: \Joomla\CMS\Object\CMSObject|boolean  Object on success, false on failure.

save($data)   X-Ref
Method to save the form data.

param: array  $data  The form data.
return: boolean  True on success.

generateNewTitle($categoryId, $alias, $title)   X-Ref
Method to change the title

param: integer  $categoryId  The id of the category.
param: string   $alias       The alias.
param: string   $title       The title.
return: array  Contains the modified title and alias.

getForm($data = array()   X-Ref
Abstract method for getting the form from the model.

param: array    $data      Data for the form.
param: boolean  $loadData  True if the form is to load its own data (default case), false if not.
return: \Joomla\CMS\Form\Form|boolean  A Form object on success, false on failure

loadFormData()   X-Ref
Method to get the data that should be injected in the form.

return: mixed  The data for the form.

getWorkflow()   X-Ref
No description

preprocessForm(Form $form, $data, $group = 'content')   X-Ref
Trigger the form preparation for the workflow group

param: Form    $form   A Form object.
param: mixed   $data   The data expected for the form.
param: string  $group  The name of the plugin group to import (defaults to "content").
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer