Text Formatter

The String Formatter is part of the Format Service and handles many common formatting needs for text-based content.

Usage

Accented Characters to Ascii

$written_check = ee('Format')->make('Text', 'über crème brûlée')->accentsToAscii();
// uber creme brulee

Attribute Escaping

$attr = ee('Format')->make('Text', 'A discussion about "Wonko the Sane"')->attributeEscape();
// A discussion about "Wonko the Sane"

Attribute Safe (escaping and other common utilities)

// this is the same as attributeEscape(), but allows character limiting, unicode punctuation, etc. Note: limiting keeps whole words
$str = 'A discussion about "Wonko the Sane"';
$attr = ee('Format')->make('Text', $str)->attributeSafe(['limit' => 20]);
// A discussion…

Censor

$text = ee('Format')->make('Text', 'A discussion about "Wonko the Sane"')->censor();
// A discussion about "Wonko the ####" (presuming "sane" is a configured naughty word)

Convert to Entities

$text = ee('Format')->make('Text', '"über" crème brûlée')->convertToEntities();
// "über" crème brûlée

Encode ExpressionEngine Tags

$str = '{exp:tag}{variable}{/exp:tag}';
$text = ee('Format')->make('Text', $str)->encodeEETags();
// {exp:tag}{variable}{/exp:tag}

Encrypt

$str = 'A discussion about "Wonko the Sane"';
$encrypted = ee('Format')->make('Text', $str)->encrypt();
// �1����j(QqS ���>}  ��1LU�䯏�u��u�%9�E0�3���tQhFsA�w[ZÈ�

$encrypted = ee('Format')->make('Text', $str)->encrypt(['encode' => TRUE]);
// UKEQBOdb+8DaznDlVTW1SHbrvTd2MsVNgoSJ7OxrIhqAYtyUfhOAih6ZvXXO0DTl+eV27tIV2bSrojMRYxA+4g==

Form Prep

$value = ee('Format')->make('Text', 'A discussion about "Wonko the Sane"')->formPrep();
// A discussion about "Wonko the Sane"

JSON

$value = ee('Format')->make('Text', 'A discussion about "Wonko the Sane"')->json();
// "A discussion about "Wonko the Sane""

Length

$length = ee('Format')->make('Text', 'A discussion about "Wonko the Sane"')->length();
// 35

Limit Characters

$text = ee('Format')->make('Text', '<h1>A <em>brief</em> discussion about "Wonko the Sane"</h1>')->limitChars(['characters' => 20]);
// A brief discussion a&#8230;

Replace

$str = 'A discussion about "Wonko the Sane"';
$text = ee('Format')->make('Text', $str)->replace(['find' => 'about', 'replace' => 'aboot']);
// A discussion aboot "Wonko the Sane"

$text = ee('Format')->make('Text', $str)->replace(['find' => '/ou?/', 'replace' => 'OH', 'regex' => TRUE]);
// A discussiOHn abOHt "WOHnkOH the Sane"

URL Decode

$text = ee('Format')->make('Text', 'A%20discussion%20about%20%22Wonko%20the%20Sane%22')->urlDecode();
// A discussion about "Wonko the Sane"

URL Encode

$str = 'A discussion about "Wonko the Sane"';
$text = ee('Format')->make('Text', $str)->urlEncode();
// A%20discussion%20about%20%22Wonko%20the%20Sane%22

$text = ee('Format')->make('Text', $str)->urlEncode(['plus_encoded_spaces' => TRUE]);
// A+discussion+about+%22Wonko+the+Sane%22

URL Normalization

$str = 'www.example.com';
$url = ee('Format')->make('Text', $str)->url();
// https://www.example.com

$str = 'https://';
$url = ee('Format')->make('Text', $str)->url();
// empty string, URL is invalid

URL Slug

$url_title = ee('Format')->make('Text', 'A discussion about "Wonko the Sane"')->urlSlug();
// a-discussion-about-wonko-the-sane

$url_title = ee('Format')->make('Text', 'A discussion about "Wonko the Sane"')->urlSlug(['remove_stopwords' => TRUE]);
// discussion-wonko-sane

API Reference

class ExpressionEngine\Service\Formatter\Formats\Text

accentsToAscii()

Converts accented / multi-byte characters, e.g. ü, é, ß to ASCII transliterations. Uses foreign_chars.php config, either the default or user override, as a map

attributeEscape($double_encode = TRUE)

Escapes a string for use in an HTML attribute.

attributeSafe($options = [])

Makes content safe to use in an HTML attribute. In addition to escaping like attributeEscape(), it allows for character limiting, and unicode punctuation—handy for meta tags where entities may not be parsed.

censor()

Censor naughty words, respects application preferences

convertToEntities($options = [])

Converts all applicable characters into HTML entities

encodeEETags($options = [])

Encode ExpressionEngine Tags. By default encodes all curly braces so variables are also protected.

encrypt($options = [])

Encrypt the text

formPrep()

Preps the content for use in a form field

getLength()

Replace the contents with the length of the string

json($options = [])

Encode as JSON

limitChars($options = [])

Limit to X characters, with an optional end character

replace($options = [])

Encrypt the text

url()

Normalize a URL for use in markup.

urlDecode($options = [])

URL encode the text

urlEncode($options = [])

URL encode the text

urlSlug($options = [])

Make a URL slug from the text

---

ExpressionEngine 7 Docs
©2002–2024 Packet Tide,LLC. Edit this page