[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/components/com_config/src/Model/ -> ModulesModel.php (summary)

(no description)

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

Defines 1 class

ModulesModel:: (7 methods):
  populateState()
  getForm()
  preprocessForm()
  getPositions()
  getActivePositions()
  createOption()
  createOptionGroup()


Class: ModulesModel  - X-Ref

Config Module model.

populateState()   X-Ref
Method to auto-populate the model state.

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

return: void

getForm($data = array()   X-Ref
Method to get the record form.

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: Form  A Form object on success, false on failure

preprocessForm(Form $form, $data, $group = 'content')   X-Ref
Method to preprocess the form

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

getPositions()   X-Ref
Method to get list of module positions in current template

return: array

getActivePositions($clientId, $editPositions = false)   X-Ref
Get a list of modules positions

param: integer  $clientId       Client ID
param: boolean  $editPositions  Allow to edit the positions
return: array  A list of positions

createOption($value = '', $text = '')   X-Ref
Create and return a new Option

param: string  $value  The option value [optional]
param: string  $text   The option text [optional]
return: object  The option as an object (stdClass instance)

createOptionGroup($label = '', $options = array()   X-Ref
Create and return a new Option Group

param: string  $label    Value and label for group [optional]
param: array   $options  Array of options to insert into group [optional]
return: array  Return the new group as an array



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