JFilterInput: Difference between revisions
From Joomla! Documentation
m →User contributed notes: moving preparation |
m moving preparation |
||
| Line 14: | Line 14: | ||
|- | |- | ||
|public | |public | ||
|[[JFilterInput::__construct | |[[API17:JFilterInput::__construct|__construct]] | ||
|Constructor for inputFilter class. | |Constructor for inputFilter class. | ||
|- | |- | ||
|public static | |public static | ||
|[[JFilterInput::checkAttribute | |[[API17:JFilterInput::checkAttribute|checkAttribute]] | ||
|Function to determine if contents of an attribute are safe. | |Function to determine if contents of an attribute are safe. | ||
|- | |- | ||
|public | |public | ||
|[[JFilterInput::clean | |[[API17:JFilterInput::clean|clean]] | ||
|Method to be called by another php script. | |Method to be called by another php script. | ||
|- | |- | ||
|public | |public | ||
|[[JFilterInput::getInstance | |[[API17:JFilterInput::getInstance|getInstance]] | ||
|Returns an input filter object, only creating it if it doesn't already exist. | |Returns an input filter object, only creating it if it doesn't already exist. | ||
|- | |- | ||
|protected | |protected | ||
|[[JFilterInput::_cleanAttributes | |[[API17:JFilterInput::_cleanAttributes|_cleanAttributes]] | ||
|Internal method to strip a tag of certain attributes. | |Internal method to strip a tag of certain attributes. | ||
|- | |- | ||
|protected | |protected | ||
|[[JFilterInput::_cleanTags | |[[API17:JFilterInput::_cleanTags|_cleanTags]] | ||
|Internal method to strip a string of certain tags. | |Internal method to strip a string of certain tags. | ||
|- | |- | ||
|protected | |protected | ||
|[[JFilterInput::_decode | |[[API17:JFilterInput::_decode|_decode]] | ||
|Try to convert to plaintext. | |Try to convert to plaintext. | ||
|- | |- | ||
|protected | |protected | ||
|[[JFilterInput::_remove | |[[API17:JFilterInput::_remove|_remove]] | ||
|Internal method to iteratively remove all unwanted tags and attributes. | |Internal method to iteratively remove all unwanted tags and attributes. | ||
|- | |- | ||
|} | |} | ||
* '''Defined in''' libraries/joomla/filter/filterinput.php | * '''Defined in''' libraries/joomla/filter/filterinput.php | ||
* '''Extends''' [[JObject | * '''Extends''' [[API17:JObject|JObject]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.filter.filterinput' );</source> | <source lang="php">jimport( 'joomla.filter.filterinput' );</source> | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JFilterInput source code''' on [[jplatform:filter/filterinput.php|BitBucket]] | * {{JVer|11.1}} '''JFilterInput source code''' on [[jplatform:filter/filterinput.php|BitBucket]] | ||
* {{JVer|11.1}} Subpackage [[Subpackage Filter | * {{JVer|11.1}} Subpackage [[API17:Subpackage Filter|Filter]] | ||
* [[JFilterInput|Other versions of JFilterInput]] | * [[API17:JFilterInput|Other versions of JFilterInput]] | ||
{{SeeAlso:JFilterInput}} | {{SeeAlso:JFilterInput}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
Revision as of 01:40, 12 May 2013
JFilterInput
Description
Template:Description:JFilterInput [Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Constructor for inputFilter class. |
| public static | checkAttribute | Function to determine if contents of an attribute are safe. |
| public | clean | Method to be called by another php script. |
| public | getInstance | Returns an input filter object, only creating it if it doesn't already exist. |
| protected | _cleanAttributes | Internal method to strip a tag of certain attributes. |
| protected | _cleanTags | Internal method to strip a string of certain tags. |
| protected | _decode | Try to convert to plaintext. |
| protected | _remove | Internal method to iteratively remove all unwanted tags and attributes. |
- Defined in libraries/joomla/filter/filterinput.php
- Extends JObject
Importing
jimport( 'joomla.filter.filterinput' );
See also
- JFilterInput source code on BitBucket
- Subpackage Filter
- Other versions of JFilterInput
Template:SeeAlso:JFilterInput [Edit See Also]
User contributed notes
<CodeExamplesForm />