275 lines
7.7 KiB
PHP
275 lines
7.7 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @package sapphire
|
|
* @subpackage model
|
|
*/
|
|
|
|
/**
|
|
* Represents a long text field.
|
|
* @package sapphire
|
|
* @subpackage model
|
|
*/
|
|
class Text extends DBField {
|
|
static $casting = array(
|
|
"AbsoluteLinks" => "HTMLText",
|
|
);
|
|
|
|
function requireField() {
|
|
DB::requireField($this->tableName, $this->name, "mediumtext character set utf8 collate utf8_general_ci");
|
|
}
|
|
|
|
//useed for search results show only limited contents
|
|
function LimitWordCount($numWords = 26) {
|
|
$this->value = Convert::xml2raw($this->value);
|
|
$ret = explode(" ", $this->value, $numWords);
|
|
|
|
if( Count($ret) < $numWords-1 ){
|
|
$ret=$this->value;
|
|
}else{
|
|
array_pop($ret);
|
|
$ret=implode(" ", $ret)."...";
|
|
}
|
|
|
|
return $ret;
|
|
}
|
|
|
|
function NoHTML() {
|
|
return strip_tags($this->value);
|
|
}
|
|
function EscapeXML() {
|
|
return str_replace(array('&','<','>','"'), array('&','<','>','"'), $this->value);
|
|
}
|
|
|
|
function Att() {
|
|
return Convert::raw2att($this->value);
|
|
}
|
|
|
|
function AbsoluteLinks() {
|
|
return HTTP::absoluteURLs($this->value);
|
|
}
|
|
|
|
function LimitCharacters($limit = 20, $add = "...") {
|
|
$value = trim($this->value);
|
|
return (strlen($value) > $limit) ? substr($value, 0, $limit) . $add : $value;
|
|
}
|
|
|
|
function LimitWordCountPlainText($numWords = 26) {
|
|
$ret = $this->LimitWordCount( $numWords );
|
|
// Use LimitWordCountXML() instead!
|
|
// return Convert::raw2xml($ret);
|
|
return $ret;
|
|
}
|
|
|
|
function LimitWordCountXML( $numWords = 26 ) {
|
|
$ret = $this->LimitWordCount( $numWords );
|
|
$ret = Convert::raw2xml($ret);
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Limit sentences, can be controlled by passing an integer.
|
|
* @param int $sentCount The amount of sentences you want.
|
|
*/
|
|
function LimitSentences($sentCount = 2) {
|
|
$data = Convert::xml2raw($this->value);
|
|
$sentences = explode('.', $data);
|
|
if(count($sentences) == 1) {
|
|
return $sentences[0] . '.';
|
|
} elseif(count($sentences) > 1) {
|
|
if(is_numeric($sentCount) && $sentCount != 0) {
|
|
if($sentCount == 1) {
|
|
$output = $sentences[0] . '. ';
|
|
} else {
|
|
for($i = 1; $i <= $sentCount-1; $i++) {
|
|
if($sentences[0]) {
|
|
$output .= $sentences[0] . '. ';
|
|
}
|
|
if($sentences[$i]) {
|
|
$output .= $sentences[$i] . '. ';
|
|
}
|
|
}
|
|
}
|
|
return $output;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Caution: Not XML/HTML-safe - does not respect closing tags.
|
|
*/
|
|
function FirstSentence() {
|
|
$data = Convert::xml2raw( $this->value );
|
|
|
|
$sentences = explode( '.', $data );
|
|
|
|
if( count( $sentences ) )
|
|
return $sentences[0] . '.';
|
|
else
|
|
return $this->Summary(20);
|
|
}
|
|
|
|
/**
|
|
* Caution: Not XML/HTML-safe - does not respect closing tags.
|
|
*/
|
|
function Summary($maxWords = 50) {
|
|
|
|
// get first sentence?
|
|
// this needs to be more robust
|
|
$data = Convert::xml2raw( $this->value /*, true*/ );
|
|
|
|
|
|
if( !$data )
|
|
return "";
|
|
|
|
// grab the first paragraph, or, failing that, the whole content
|
|
if( strpos( $data, "\n\n" ) )
|
|
$data = substr( $data, 0, strpos( $data, "\n\n" ) );
|
|
|
|
$sentences = explode( '.', $data );
|
|
|
|
$count = count( explode( ' ', $sentences[0] ) );
|
|
|
|
// if the first sentence is too long, show only the first $maxWords words
|
|
if( $count > $maxWords ) {
|
|
return implode( ' ', array_slice( explode( ' ', $sentences[0] ), 0, $maxWords ) ).'...';
|
|
}
|
|
// add each sentence while there are enough words to do so
|
|
$result = '';
|
|
do {
|
|
$result .= trim(array_shift( $sentences )).'.';
|
|
if(count($sentences) > 0) {
|
|
$count += count( explode( ' ', $sentences[0] ) );
|
|
}
|
|
|
|
// Ensure that we don't trim half way through a tag or a link
|
|
$brokenLink = (substr_count($result,'<') != substr_count($result,'>')) ||
|
|
(substr_count($result,'<a') != substr_count($result,'</a'));
|
|
|
|
} while( ($count < $maxWords || $brokenLink) && $sentences && trim( $sentences[0] ) );
|
|
|
|
if( preg_match( '/<a[^>]*>/', $result ) && !preg_match( '/<\/a>/', $result ) )
|
|
$result .= '</a>';
|
|
|
|
$result = Convert::raw2xml( $result );
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Performs the same function as the big summary, but doesnt trim new paragraphs off data.
|
|
* Caution: Not XML/HTML-safe - does not respect closing tags.
|
|
*/
|
|
function BigSummary($maxWords = 50, $plain = 1) {
|
|
|
|
// get first sentence?
|
|
// this needs to be more robust
|
|
if($plain) $data = Convert::xml2raw( $this->value, true );
|
|
|
|
if( !$data )
|
|
return "";
|
|
|
|
$sentences = explode( '.', $data );
|
|
|
|
$count = count( explode( ' ', $sentences[0] ) );
|
|
|
|
// if the first sentence is too long, show only the first $maxWords words
|
|
if( $count > $maxWords ) {
|
|
return implode( ' ', array_slice( explode( ' ', $sentences[0] ), 0, $maxWords ) ).'...';
|
|
}
|
|
// add each sentence while there are enough words to do so
|
|
do {
|
|
$result .= trim(array_shift( $sentences )).'. ' ;
|
|
$count += count( explode( ' ', $sentences[0] ) );
|
|
|
|
// Ensure that we don't trim half way through a tag or a link
|
|
$brokenLink = (substr_count($result,'<') != substr_count($result,'>')) ||
|
|
(substr_count($result,'<a') != substr_count($result,'</a'));
|
|
|
|
} while( ($count < $maxWords || $brokenLink) && $sentences && trim( $sentences[0] ) );
|
|
|
|
if( preg_match( '/<a[^>]*>/', $result ) && !preg_match( '/<\/a>/', $result ) )
|
|
$result .= '</a>';
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Caution: Not XML/HTML-safe - does not respect closing tags.
|
|
*/
|
|
function FirstParagraph($plain = 1) {
|
|
// get first sentence?
|
|
// this needs to be more robust
|
|
if($plain && $plain != 'html') {
|
|
$data = Convert::xml2raw( $this->value, true );
|
|
if( !$data ) return "";
|
|
|
|
// grab the first paragraph, or, failing that, the whole content
|
|
if( strpos( $data, "\n\n" ) )
|
|
$data = substr( $data, 0, strpos( $data, "\n\n" ) );
|
|
|
|
return $data;
|
|
|
|
} else {
|
|
if(strpos( $this->value, "</p>" ) === false) return $this->value;
|
|
|
|
$data = substr( $this->value, 0, strpos( $this->value, "</p>" ) + 4 );
|
|
|
|
|
|
if(strlen($data) < 20 && strpos( $this->value, "</p>", strlen($data) )) $data = substr( $this->value, 0, strpos( $this->value, "</p>", strlen($data) ) + 4 );
|
|
|
|
return $data;
|
|
}
|
|
}
|
|
|
|
function ContextSummary($characters = 500, $string = false, $striphtml = true, $highlight = true) {
|
|
if(!$string) {
|
|
// If no string is supplied, use the string from a SearchForm
|
|
$string = $_REQUEST['Search'];
|
|
}
|
|
|
|
// Remove HTML tags so we don't have to deal with matching tags
|
|
$text = $striphtml ? $this->NoHTML() : $this->value;
|
|
|
|
// Find the search string
|
|
$position = (int) stripos($text, $string);
|
|
|
|
// We want to search string to be in the middle of our block to give it some context
|
|
$position = max(0, $position - ($characters / 2));
|
|
|
|
|
|
if($position > 0) {
|
|
// We don't want to start mid-word
|
|
$position = max((int) strrpos(substr($text, 0, $position), ' '), (int) strrpos(substr($text, 0, $position), "\n"));
|
|
}
|
|
|
|
$summary = substr($text, $position, $characters);
|
|
|
|
if($highlight) {
|
|
// Add a span around all occurences of the search term
|
|
$summary = str_ireplace($string, "<span class=\"highlight\">$string</span>", $summary);
|
|
}
|
|
|
|
// trim it, because if we counted back and found a space then there will be an extra
|
|
// space at the front
|
|
return trim($summary);
|
|
}
|
|
|
|
/**
|
|
* Allows a sub-class of TextParser to be rendered. @see TextParser for implementation details.
|
|
*/
|
|
function Parse($parser = "TextParser") {
|
|
if($parser == "TextParser" || is_subclass_of($parser, "TextParser")) {
|
|
$obj = new $parser($this->value);
|
|
return $obj->parse();
|
|
} else {
|
|
// Fallback to using raw2xml and show a warning
|
|
// TODO Don't kill script execution, we can continue without losing complete control of the app
|
|
user_error("Couldn't find an appropriate TextParser sub-class to create (Looked for '$parser'). Make sure it sub-classes TextParser and that you've done ?flush=1.", E_USER_WARNING);
|
|
return Convert::raw2xml($this->value);
|
|
}
|
|
}
|
|
}
|
|
|
|
?>
|