Class JHtmlString

HTML helper class for rendering manipulated strings.

Abstract
Package: Joomla\Libraries\HTML
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.6
Located at cms/html/string.php

Methods summary

`public static string`	# `truncate( string $text, integer $length = 0, boolean $noSplit = true, boolean $allowHtml = true )` Truncates text blocks over the specified character limit and closes all open HTML tags. The method will optionally not truncate an individual word, it will find the first space that is within the limit and truncate at that point. This method is UTF-8 safe. Truncates text blocks over the specified character limit and closes all open HTML tags. The method will optionally not truncate an individual word, it will find the first space that is within the limit and truncate at that point. This method is UTF-8 safe. Parameters `$text` `string` - $text The text to truncate. `$length` `integer` - $length The maximum length of the text. `$noSplit` `boolean` - $noSplit Don't split a word if that is where the cutoff occurs (default: true). `$allowHtml` `boolean` - $allowHtml Allow HTML tags in the output, and close any open tags (default: true). Returns `string` - The truncated text. Since 1.6
`public static string`	# `truncateComplex( string $html, integer $maxLength = 0, boolean $noSplit = true )` Method to extend the truncate method to more complex situations Method to extend the truncate method to more complex situations The goal is to get the proper length plain text string with as much of the html intact as possible with all tags properly closed. Parameters `$html` `string` - $html The content of the introtext to be truncated `$maxLength` `integer` - $maxLength The maximum number of characters to render `$noSplit` `boolean` - $noSplit Don't split a word if that is where the cutoff occurs (default: true). Returns `string` - The truncated string. If the string is truncated an ellipsis (...) will be appended. Since 3.1 Note If a maximum length of 3 or less is selected and the text has more than that number of characters an ellipsis will be displayed. This method will not create valid HTML from malformed HTML.
`public static string`	# `abridge( string $text, integer $length = 50, integer $intro = 30 )` Abridges text strings over the specified character limit. The behavior will insert an ellipsis into the text replacing a section of variable size to ensure the string does not exceed the defined maximum length. This method is UTF-8 safe. Abridges text strings over the specified character limit. The behavior will insert an ellipsis into the text replacing a section of variable size to ensure the string does not exceed the defined maximum length. This method is UTF-8 safe. For example, it transforms "Really long title" to "Really...title". Note that this method does not scan for HTML tags so will potentially break them. Parameters `$text` `string` - $text The text to abridge. `$length` `integer` - $length The maximum length of the text (default is 50). `$intro` `integer` - $intro The maximum length of the intro text (default is 30). Returns `string` - The abridged text. Since 1.6

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JHtmlString

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Note

Parameters

Returns

Since

Magic methods summary