[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Console/ -> SetConfigurationCommand.php (summary)

Joomla! Content Management System

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

Defines 1 class

SetConfigurationCommand:: (11 methods):
  configureIO()
  retrieveOptionsFromInput()
  validateOptions()
  setOptions()
  getOptions()
  getInitialConfigurationOptions()
  saveConfiguration()
  configure()
  checkDb()
  doExecute()
  sanitizeOptions()


Class: SetConfigurationCommand  - X-Ref

Console command Setting Configuration options

configureIO(InputInterface $input, OutputInterface $output)   X-Ref
Configures the IO

param: InputInterface   $input   Console Input
param: OutputInterface  $output  Console Output
return: void

retrieveOptionsFromInput(array $options)   X-Ref
Collects options from user input

param: array  $options  Options input by users
return: boolean

validateOptions()   X-Ref
Validates the options provided

return: boolean

setOptions($options)   X-Ref
No description

getOptions()   X-Ref
Collects the options array

return: array|mixed

getInitialConfigurationOptions()   X-Ref
Returns Default configuration Object

return: Registry

saveConfiguration($options)   X-Ref
Save the configuration file

param: array  $options  Options array
return: boolean

configure()   X-Ref
Initialise the command.

return: void

checkDb($options)   X-Ref
Verifies database connection

param: array  $options  Options array
return: boolean|\Joomla\Database\DatabaseInterface

doExecute(InputInterface $input, OutputInterface $output)   X-Ref
Internal function to execute the command.

param: InputInterface   $input   The input to inject into the command.
param: OutputInterface  $output  The output to inject into the command.
return: integer  The command exit code

sanitizeOptions(array $options)   X-Ref
Sanitize the options array for boolean

param: array  $options  Options array
return: array



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