Actions

API17

Difference between revisions of "JFilterInput"

From Joomla! Documentation

(Layout updates)
m (User contributed notes: bad link repair)
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JFilterInput==
 +
===Description===
 +
{{Description:JFilterInput}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JFilterInput|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JFilterInput|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JFilterInput}}
 
===Defined in===
 
libraries/joomla/filter/filterinput.php
 
* see source code in [[jplatform:filter/filterinput.php|BitBucket]]
 
===Subpackage===
 
[[Subpackage Filter/11.1|Filter]]
 
===Extends===
 
[[JObject/11.1|JObject]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JFilterInput::__construct/11.1|__construct]]
 
|[[JFilterInput::__construct/11.1|__construct]]
 
|Constructor for inputFilter class.  
 
|Constructor for inputFilter class.  
 
|-
 
|-
 +
|public static
 
|[[JFilterInput::checkAttribute/11.1|checkAttribute]]
 
|[[JFilterInput::checkAttribute/11.1|checkAttribute]]
|Function to determine if contents of an attribute is safe.  
+
|Function to determine if contents of an attribute are safe.  
 
|-
 
|-
 +
|public
 
|[[JFilterInput::clean/11.1|clean]]
 
|[[JFilterInput::clean/11.1|clean]]
 
|Method to be called by another php script.  
 
|Method to be called by another php script.  
 
|-
 
|-
 +
|public 
 
|[[JFilterInput::getInstance/11.1|getInstance]]
 
|[[JFilterInput::getInstance/11.1|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
 
|[[JFilterInput::_cleanAttributes/11.1|_cleanAttributes]]
 
|[[JFilterInput::_cleanAttributes/11.1|_cleanAttributes]]
 
|Internal method to strip a tag of certain attributes.  
 
|Internal method to strip a tag of certain attributes.  
 
|-
 
|-
 +
|protected
 
|[[JFilterInput::_cleanTags/11.1|_cleanTags]]
 
|[[JFilterInput::_cleanTags/11.1|_cleanTags]]
 
|Internal method to strip a string of certain tags.  
 
|Internal method to strip a string of certain tags.  
 
|-
 
|-
 +
|protected
 
|[[JFilterInput::_decode/11.1|_decode]]
 
|[[JFilterInput::_decode/11.1|_decode]]
 
|Try to convert to plaintext.  
 
|Try to convert to plaintext.  
 
|-
 
|-
 +
|protected
 
|[[JFilterInput::_remove/11.1|_remove]]
 
|[[JFilterInput::_remove/11.1|_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
 +
* '''Extends''' [[JObject/11.1|JObject]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.filter.filterinput' );</source>
 
<source lang="php">jimport( 'joomla.filter.filterinput' );</source>
 
===See also===
 
===See also===
* JFilterInput source code in [[jplatform:filter/filterinput.php|BitBucket]]
+
* {{JVer|11.1}} '''JFilterInput source code''' on [[jplatform:filter/filterinput.php|BitBucket]]
* [[JFilterInput|Other versions of this class]]
+
* {{JVer|11.1}} Subpackage [[Subpackage Filter/11.1|Filter]]
 +
* [[JFilterInput|Other versions of JFilterInput]]
 
{{SeeAlso:JFilterInput}}
 
{{SeeAlso:JFilterInput}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JFilterInput|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JFilterInput|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 60: Line 66:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JFilterInput]]</noinclude>
+
<noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JFilterInput]]</noinclude>

Revision as of 13:43, 29 August 2012

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JFilterInput

Description

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

SeeAlso:JFilterInput [Edit See Also]

User contributed notes

<CodeExamplesForm />