[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/joomla/input/src/ -> Input.php (summary)

Part of the Joomla Framework Input Package

Copyright: Copyright (C) 2005 - 2022 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 347 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Input:: (11 methods):
  __construct()
  __get()
  count()
  get()
  getArray()
  getInputForRequestMethod()
  set()
  def()
  exists()
  __call()
  getMethod()


Class: Input  - X-Ref

Joomla! Input Base Class

This is an abstracted input class used to manage retrieving data from the application environment.

__construct($source = null, array $options = [])   X-Ref
Constructor.

param: array|null  $source   Optional source data. If omitted, a copy of the server variable '_REQUEST' is used.
param: array       $options  An optional associative array of configuration parameters:

__get($name)   X-Ref
Magic method to get an input object

param: mixed  $name  Name of the input object to retrieve.
return: Input  The request input object

count()   X-Ref
Get the number of variables.

return: integer  The number of variables in the input.

get($name, $default = null, $filter = 'cmd')   X-Ref
Gets a value from the input data.

param: string  $name     Name of the value to get.
param: mixed   $default  Default value to return if variable does not exist.
param: string  $filter   Filter to apply to the value.
return: mixed  The filtered input value.

getArray(array $vars = [], $datasource = null)   X-Ref
Gets an array of values from the request.

param: array  $vars        Associative array of keys and filter types to apply.
param: mixed  $datasource  Array to retrieve data from, or null
return: mixed  The filtered input data.

getInputForRequestMethod()   X-Ref
Get the Input instance holding the data for the current request method

return: Input

set($name, $value)   X-Ref
Sets a value

param: string  $name   Name of the value to set.
param: mixed   $value  Value to assign to the input.
return: void

def($name, $value)   X-Ref
Define a value. The value will only be set if there's no value for the name or if it is null.

param: string  $name   Name of the value to define.
param: mixed   $value  Value to assign to the input.
return: void

exists($name)   X-Ref
Check if a value name exists.

param: string  $name  Value name
return: boolean

__call($name, $arguments)   X-Ref
Magic method to get filtered input data.

param: string  $name       Name of the filter type prefixed with 'get'.
param: array   $arguments  [0] The name of the variable [1] The default value.
return: mixed   The filtered input value.

getMethod()   X-Ref
Gets the request method.

return: string   The request method.



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