# HtmlEntities

Retourne la chaine `$value` en convertissant les caractères en leur entité HTML équivalente si elle existe.

## Options gérées par Zend_Filter_HtmlEntities

Les options suivantes sont supportées par `Zend_Filter_HtmlEntities`:

- quotestyle: Equivalent au paramètre quote_style de la fonction PHP htmlentities. Ceci permet de définir ce qui sera fait avec les 'simples' et "doubles" quotes. Les constantes suivantes sont acceptées: `ENT_COMPAT`, `ENT_QUOTES` `ENT_NOQUOTES`, par défaut il s'agira de `ENT_COMPAT`.

- charset: Equivalent au paramètre charset de la fonction PHP htmlentities. Ceci indique le jeu de caractères à utiliser pour le filtre. Contrairement à la fonction PHP native, la valeur par défaut est 'UTF-8'. Voyez "http://php.net/htmlentities" pour la liste des jeux de caractères supportés.

  Cette option peut être passées via le paramètre `$options` comme un tableau ou objet `Zend_Config`. L'encodage ou le jeu de caractères seront reconnus.

- doublequote: Equivalent au paramètre double_encode de la fonction PHP htmlentities. Si passé à false, les entités html existantes ne seront pas encodées. Par défaut sur true (conversion totale).

  Cette option peut être passée via le paramètre `$options` ou la méthode `setDoubleEncode()`.

## Utilisation de base

Voyez l'exemple qui suit pour le comportement de ce filtre.

    $filter = new Zend_Filter_HtmlEntities();

    print $filter->filter('<');

## Styles de quote

`Zend_Filter_HtmlEntities` permet de changer les styles de quote à filtrer. Ceci est utile si vous voulez laisser intactes les doubles, simples ou les deux types de quotes. Voici un exemple:

    $filter = new Zend_Filter_HtmlEntities(array('quotestyle' => ENT_QUOTES));

    $input  = "A 'single' and " . '"double"';
    print $filter->filter($input);

Ceci affiche A 'single' and "double". Notez que les 'simples' et les "doubles" quotes ont été filtrées.

    $filter = new Zend_Filter_HtmlEntities(array('quotestyle' => ENT_COMPAT));

    $input  = "A 'single' and " . '"double"';
    print $filter->filter($input);

L'exemple ci-dessus affichera A 'single' and "double". Notez que seules les "doubles" quotes ont été filtrées.

    $filter = new Zend_Filter_HtmlEntities(array('quotestyle' => ENT_NOQUOTES));

    $input  = "A 'single' and " . '"double"';
    print $filter->filter($input);

L'exemple ci-dessus affichera A 'single' and "double". Notez qu'ici aucune des "doubles" ou 'simples' quotes n'ont été altérées.

## Méthodes d'aide

Pour changer ou récupérer la valeur de quotestyle après instantiation, les méthodes `setQuoteStyle()` et `getQuoteStyle()` peuvent être utilisées. `setQuoteStyle()` accepte un paramètre `$quoteStyle`. Les constantes suivantes sont autorisées: `ENT_COMPAT`, `ENT_QUOTES`, `ENT_NOQUOTES`

    $filter = new Zend_Filter_HtmlEntities();

    $filter->setQuoteStyle(ENT_QUOTES);
    print $filter->getQuoteStyle(ENT_QUOTES);

Pour changer ou récupérer la valeur de charset après instantiation, les méthodes `setCharSet()` et `getCharSet()` peuvent être utilisées. `setCharSet()` accepte un paramètre `$charSet`. Voyez "http://php.net/htmlentities" pour une liste des valeurs acceptées.

    $filter = new Zend_Filter_HtmlEntities();

    $filter->setQuoteStyle(ENT_QUOTES);
    print $filter->getQuoteStyle(ENT_QUOTES);

Pour changer ou récupérer la valeur de doublequote après instantiation, les méthodes `setDoubleQuote()` et `getDoubleQuote()` peuvent être utilisées. `setDoubleQuote()` accepte un booléen `$doubleQuote`.

    $filter = new Zend_Filter_HtmlEntities();

    $filter->setQuoteStyle(ENT_QUOTES);
    print $filter->getQuoteStyle(ENT_QUOTES);