Documentation

Helper Text

Table des matières 

Présentation

Helper proposant plusieurs méthodes de manipulation de chaînes de caractères.

filenamize()

Convertit un texte en une chaîne de caractères qui puisse être utilisée comme nom de fichier.

Signature de la méthode :

filenamize(string $filename, bool $hyphenSpaces=true, bool $lowercase=true) : string

Paramètres :

  • $filename : Le texte à convertir.
  • $hyphenSpaces : true pour que les espaces soient remplacés par des tirets.
  • $lowercase : true pour que le texte soit tout en minuscules.

Valeur de retour : Le nom de fichier.

urlize()

Convertit un texte pour qu'il puisse être utilisé dans une URL.

Signature de la méthode :

urlize(?string $txt, bool $avoidUnderscores=true) : string

Paramètres :

  • $txt : Le texte à convertir.
  • $avoidUnderscores : true pour remplacer les underscores par des tirets.

Valeur de retour : Le texte converti.

isValidHtmlSyntax()

Cette méthode permet de savoir si un flux HTML est correct du point de vue de sa syntaxe.

Signature de la méthode :

isValidHtmlSyntax(string $html) : bool

Paramètre : Le flux HTML à valider.

Valeur de retour : true si le flux HTML est valide, sinon false.

htmlToText()

Cette méthode transforme un flux HTML en texte brut.

Signature de la méthode :

htmlToText(string $html, bool $cleanup=false) : string

Paramètres :

  • $html : Flux HTML à convertir.
  • $cleanup : true pour supprimer les contenus des balises <blockquote>, <pre> et <code>.

Valeur de retour : Le texte brut généré à partir du HTML.

encodingCompatible()

Cette méthode indique si une chaîne de caractères encodée en UTF-8 ne contient que des caractères compatibles avec l'encodage fourni en paramètre.

Signature de la méthode :

encodingCompatible(string $text, string $encoding) : bool

Paramètres :

  • $text : Le texte à analyser.
  • $encoding : L'encodage à utiliser.

Valeur de retour : True si le texte ne contient que des caractères compatibles avec l'encodage de caractères fourni en paramètre.

Précédent : Helper Term
Suivant : Helper Timer

Table des matières