XOOPS API 2.5.11 Beta1  UI v0.5
Réalisé par monxoops.fr
Référence de la classe HTMLPurifier_URIFilter
+ Graphe d'héritage de HTMLPurifier_URIFilter:

Fonctions membres publiques

 prepare ($config)
 
 filter (&$uri, $config, $context)
 

Champs de données

 $name
 
 $post = false
 
 $always_load = false
 

Description détaillée

Chainable filters for custom URI processing.

These filters can perform custom actions on a URI filter object, including transformation or blacklisting. A filter named Foo must have a corresponding configuration directive URI.Foo, unless always_load is specified to be true.

The following contexts may be available while URIFilters are being processed:

 - EmbeddedURI: true if URI is an embedded resource that will
   be loaded automatically on page load
 - CurrentToken: a reference to the token that is currently
   being processed
 - CurrentAttr: the name of the attribute that is currently being
   processed
 - CurrentCSSProperty: the name of the CSS property that is
   currently being processed (if applicable)
Avertissement
This filter is called before scheme object validation occurs. Make sure, if you require a specific scheme object, you you check that it exists. This allows filters to convert proprietary URI schemes into regular ones.

Documentation des fonctions membres

◆ filter()

filter ( $uri,
  $config,
  $context 
)
abstract

Filter a URI object

Paramètres
HTMLPurifier_URI$uriReference to URI object variable
HTMLPurifier_Config$config
HTMLPurifier_Context$context
Renvoie
bool Whether or not to continue processing: false indicates URL is no good, true indicates continue processing. Note that all changes are committed directly on the URI object

Réimplémentée dans HTMLPurifier_URIFilter_Munge, HTMLPurifier_URIFilter_MakeAbsolute, HTMLPurifier_URIFilter_SafeIframe, HTMLPurifier_URIFilter_HostBlacklist, HTMLPurifier_URIFilter_DisableExternal, HTMLPurifier_URIFilter_DisableExternalResources, et HTMLPurifier_URIFilter_DisableResources.

◆ prepare()

prepare (   $config)

Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active.

Paramètres
HTMLPurifier_Config$config
Renvoie
bool

Réimplémentée dans HTMLPurifier_URIFilter_Munge, HTMLPurifier_URIFilter_SafeIframe, HTMLPurifier_URIFilter_MakeAbsolute, HTMLPurifier_URIFilter_HostBlacklist, et HTMLPurifier_URIFilter_DisableExternal.

Documentation des champs

◆ $always_load

$always_load = false

True if this filter should always be loaded. This permits a filter to be named Foo without the corresponding URI.Foo directive existing. @type bool

◆ $name

$name

Unique identifier of filter. @type string

◆ $post

$post = false

True if this filter should be run after scheme validation. @type bool


La documentation de cette classe a été générée à partir du fichier suivant :