Drupal 8  8.0.2
FilterNull Class Reference
Inheritance diagram for FilterNull:

Public Member Functions

 __construct (array $configuration, $plugin_id, $plugin_definition)
 
 process ($text, $langcode)
 
 getHTMLRestrictions ()
 
 tips ($long=FALSE)
 
- Public Member Functions inherited from FilterBase
 __construct (array $configuration, $plugin_id, $plugin_definition)
 
 setConfiguration (array $configuration)
 
 getConfiguration ()
 
 defaultConfiguration ()
 
 calculateDependencies ()
 
 getType ()
 
 getLabel ()
 
 getDescription ()
 
 settingsForm (array $form, FormStateInterface $form_state)
 
 prepare ($text, $langcode)
 
 getHTMLRestrictions ()
 
 tips ($long=FALSE)
 
- Public Member Functions inherited from PluginInspectionInterface
 getPluginId ()
 
 getPluginDefinition ()
 

Protected Attributes

 $logged = FALSE
 
- Protected Attributes inherited from FilterBase
 $plugin_id
 
 $collection
 

Additional Inherited Members

- Data Fields inherited from FilterBase
 $provider
 
 $status = FALSE
 
 $weight = 0
 
 $settings = array()
 
- Data Fields inherited from FilterInterface
const TYPE_MARKUP_LANGUAGE = 0
 
const TYPE_HTML_RESTRICTOR = 1
 
const TYPE_TRANSFORM_REVERSIBLE = 2
 
const TYPE_TRANSFORM_IRREVERSIBLE = 3
 

Detailed Description

Provides a fallback placeholder filter to use for missing filters.

The filter system uses this filter to replace missing filters (for example, if a filter module has been disabled) that are still part of defined text formats. It returns an empty string.

( id = "filter_null", title = ("Provides a fallback for missing filters. Do not use."), type = Drupal::TYPE_HTML_RESTRICTOR, weight = -10 )

Constructor & Destructor Documentation

__construct ( array  $configuration,
  $plugin_id,
  $plugin_definition 
)

{}

References Drupal\logger().

Here is the call graph for this function:

Member Function Documentation

getHTMLRestrictions ( )

{Returns HTML allowed by this filter's configuration.May be implemented by filters of the FilterInterface::TYPE_HTML_RESTRICTOR type, this won't be used for filters of other types; they should just return FALSE.This callback function is only necessary for filters that strip away HTML tags (and possibly attributes) and allows other modules to gain insight in a generic manner into which HTML tags and attributes are allowed by a format.

Returns
array|FALSE A nested array with either of the following keys:
  • 'allowed': (optional) the allowed tags as keys, and for each of those tags (keys) either of the following values:
    • TRUE to indicate any attribute is allowed
    • FALSE to indicate no attributes are allowed
    • an array to convey attribute restrictions: the keys must be attribute names (which may use a wildcard, e.g. "data-*"), the possible values are similar to the above:
      • TRUE to indicate any attribute value is allowed
      • FALSE to indicate the attribute is forbidden
      • an array to convey attribute value restrictions: the key must be attribute values (which may use a wildcard, e.g. "xsd:*"), the possible values are TRUE or FALSE: to mark the attribute value as allowed or forbidden, respectively
  • 'forbidden_tags': (optional) the forbidden tags

There is one special case: the "wildcard tag", "*": any attribute restrictions on that pseudotag apply to all tags.If no restrictions apply, then FALSE must be returned.Here is a concrete example, for a very granular filter:

array(
'allowed' => array(
// Allows any attribute with any value on the <div> tag.
'div' => TRUE,
// Allows no attributes on the <p> tag.
'p' => FALSE,
// Allows the following attributes on the <a> tag:
// - 'href', with any value;
// - 'rel', with the value 'nofollow' value.
'a' => array(
'href' => TRUE,
'rel' => array('nofollow' => TRUE),
),
// Only allows the 'src' and 'alt' attributes on the <alt> tag,
// with any value.
'img' => array(
'src' => TRUE,
'alt' => TRUE,
),
// Allow RDFa on <span> tags, using only the dc, foaf, xsd and sioc
// vocabularies/namespaces.
'span' => array(
'property' => array('dc:*' => TRUE, 'foaf:*' => TRUE),
'datatype' => array('xsd:*' => TRUE),
'rel' => array('sioc:*' => TRUE),
),
// Forbid the 'style' and 'on*' ('onClick' etc.) attributes on any
// tag.
'*' => array(
'style' => FALSE,
'on*' => FALSE,
),
)
)
A simpler example, for a very coarse filter:

array(
'forbidden_tags' => array('iframe', 'script')
)
The simplest example possible: a filter that doesn't allow any HTML:

array(
'allowed' => array()
)
And for a filter that applies no restrictions, i.e. allows any HTML:

FALSE
See Also
::getHtmlRestrictions()
}

Implements FilterInterface.

process (   $text,
  $langcode 
)

{Performs the filter processing.

Parameters
string$textThe text string to be filtered.
string$langcodeThe language code of the text to be filtered.
Returns
The filtered text, wrapped in a FilterProcessResult object, and possibly with associated assets, cacheability metadata and placeholders.
See Also
}

Implements FilterInterface.

tips (   $long = FALSE)

{Generates a filter's tip.A filter's tips should be informative and to the point. Short tips are preferably one-liners.

Parameters
bool$longWhether this callback should return a short tip to display in a form (FALSE), or whether a more elaborate filter tips should be returned for template_preprocess_filter_tips() (TRUE).
Returns
string|null Translated text to display as a tip, or NULL if this filter has no tip.
Todo:
Split into getSummaryItem() and buildGuidelines().
}

Implements FilterInterface.

References t().

Here is the call graph for this function:


The documentation for this class was generated from the following file: