tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

MINOR Added documentation to various Text class methods for limiting field values

Browse Source 
ENHANCEMENT Added ability to define the ellipsis for LimitWordCount() setting "..." as the default

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/branches/2.3@69218 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Sean Harvey 2008-12-16 09:50:50 +00:00 committed by Sam Minnee
parent 5115c38355
commit 9ded3dfd1f
1 changed files with 38 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
core/model/fieldtypes/Text.php
View File

@ -17,16 +17,23 @@ class Text extends DBField {
return ($this->value || $this->value == '0'); return ($this->value || $this->value == '0');
} }
//useed for search results show only limited contents /**
function LimitWordCount($numWords = 26) { * Limit this field's content by a number of words.
* CAUTION: This is not XML safe. Please use
* {@link LimitWordCountXML()} instead.
*
* @param int $numWords Number of words to limit by
* @return string
*/
function LimitWordCount($numWords = 26, $add = '...') {
$this->value = Convert::xml2raw($this->value); $this->value = Convert::xml2raw($this->value);
$ret = explode(" ", $this->value, $numWords); $ret = explode(' ', $this->value, $numWords);
if( Count($ret) < $numWords-1 ){ if(count($ret) < $numWords - 1) {
$ret=$this->value; $ret = $this->value;
}else{ } else {
array_pop($ret); array_pop($ret);
$ret=implode(" ", $ret)."..."; $ret = implode(' ', $ret) . $add;
} }
return $ret; return $ret;
@ -43,11 +50,24 @@ class Text extends DBField {
return HTTP::absoluteURLs($this->value); return HTTP::absoluteURLs($this->value);
} }
/**
* Limit this field's content by a number of characters.
* Caution: This can be harmful on HTML, it can potentially
* malform your HTML if it limits halfway through a tag.
*
* @param int $limit Number of characters to limit by
* @param string $add Ellipsis to add to the end of limited string
* @return string
*/
function LimitCharacters($limit = 20, $add = "...") { function LimitCharacters($limit = 20, $add = "...") {
$value = trim($this->value); $value = trim($this->value);
return (strlen($value) > $limit) ? substr($value, 0, $limit) . $add : $value; return (strlen($value) > $limit) ? substr($value, 0, $limit) . $add : $value;
} }
/**
* @deprecated. Please use {@link LimitWordCount()}
* or {@link LimitWordCountXML()} instead.
*/
function LimitWordCountPlainText($numWords = 26) { function LimitWordCountPlainText($numWords = 26) {
$ret = $this->LimitWordCount( $numWords ); $ret = $this->LimitWordCount( $numWords );
// Use LimitWordCountXML() instead! // Use LimitWordCountXML() instead!
@ -55,11 +75,17 @@ class Text extends DBField {
return $ret; return $ret;
} }
function LimitWordCountXML( $numWords = 26 ) { /**
$ret = $this->LimitWordCount( $numWords ); * Limit the number of words of the current field's
$ret = Convert::raw2xml($ret); * content. This is XML safe, so characters like &
* are converted to &amp;
return $ret; *
* @param int $numWords Number of words to limit by
* @return string
*/
function LimitWordCountXML($numWords = 26) {
$ret = $this->LimitWordCount($numWords);
return Convert::raw2xml($ret);
} }
/** /**