JHtmlString/abridge: Difference between revisions
From Joomla! Documentation
New page: ===Description===
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 do... |
m removing red link to edit, no existant pages |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 60: | Line 60: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Examples=== | ===Examples=== | ||
| Line 75: | Line 75: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API16]] | |||
Revision as of 02:58, 14 May 2013
Description
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.
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax
abridge($text, $length=50, $intro=30)
| Parameter Name | Default Value | Description |
|---|---|---|
| $text | $text The text to abridge. | |
| $length | 50 | $length The maximum length of the text. |
| $intro | 30 | $intro The maximum length of the intro text. |
Returns
string The abridged text.
Defined in
libraries/joomla/html/html/string.php
Importing
jimport( 'joomla.html.html.string' );
Source Body
function abridge($text, $length = 50, $intro = 30)
{
// Abridge the item text if it is too long.
if (JString::strlen($text) > $length) {
// Determine the remaining text length.
$remainder = $length - ($intro + 3);
// Extract the beginning and ending text sections.
$beg = JString::substr($text, 0, $intro);
$end = JString::substr($text, JString::strlen($text)-$remainder);
// Build the resulting string.
$text = $beg.'...'.$end;
}
return $text;
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
<CodeExamplesForm />