SilverStripe 2.4 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
Version: master
  • master
  • 3.1
  • 3.0
  • 2.4
  • tagfield

Packages

  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • publishers
    • reports
    • security
    • tasks
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • installer
  • None
  • PHP
  • sapphire
    • api
    • bulkloading
    • control
    • core
    • cron
    • dev
    • email
    • fields-formattedinput
    • filesystem
    • formatters
    • forms
    • i18n
    • integration
    • misc
    • model
    • parsers
    • search
    • security
    • tasks
    • testing
    • tools
    • validation
    • view
    • widgets

Classes

  • Boolean
  • ComponentSet
  • Currency
  • DatabaseAdmin
  • DataObject
  • DataObjectDecorator
  • DataObjectLog
  • DataObjectSet
  • DataObjectSet_Iterator
  • Date
  • DB
  • DBField
  • Decimal
  • Double
  • Enum
  • Float
  • ForeignKey
  • Hierarchy
  • HTMLText
  • HTMLVarchar
  • Int
  • Money
  • MultiEnum
  • MySQLDatabase
  • MySQLQuery
  • Percentage
  • PrimaryKey
  • SiteTreeDecorator
  • SQLMap
  • SQLMap_Iterator
  • SQLQuery
  • SS_Database
  • SS_Datetime
  • SS_Query
  • SS_Transliterator
  • StringField
  • Text
  • Time
  • Transliterator
  • Varchar
  • Versioned
  • Versioned_Version
  • Year

Interfaces

  • CompositeDBField
  • CurrentPageIdentifier
  • DataObjectInterface

Class Text

Represents a variable-length string of up to 2 megabytes, designed to store raw text

Example definition via DataObject::$db:

static $db = array(
        "MyDescription" => "Text",
);
Object
Extended by ViewableData implements IteratorAggregate
Extended by DBField
Extended by StringField
Extended by Text

Direct known subclasses

HTMLText

Package: sapphire\model
See: HTMLText
See: HTMLVarchar
See: Varchar
Located at sapphire/core/model/fieldtypes/Text.php

Methods summary

public
# requireField( )

(non-PHPdoc)

(non-PHPdoc)

See

DBField::requireField()
public string
# LimitWordCount( integer $numWords = 26, string $add = '...' )

Limit this field's content by a number of words. CAUTION: This is not XML safe. Please use Text::LimitWordCountXML() instead.

Limit this field's content by a number of words. CAUTION: This is not XML safe. Please use Text::LimitWordCountXML() instead.

Parameters

$numWords
integer
$numWords Number of words to limit by
$add
string
$add Ellipsis to add to the end of truncated string

Returns

string
public string
# NoHTML( )

Return the value of the field stripped of html tags

Return the value of the field stripped of html tags

Returns

string
public string
# EscapeXML( )

Return the value of the field with XML tags escaped.

Return the value of the field with XML tags escaped.

Returns

string
public string
# AbsoluteLinks( )

Return the value of the field with relative links converted to absolute urls.

Return the value of the field with relative links converted to absolute urls.

Returns

string
public string
# LimitCharacters( integer $limit = 20, string $add = "..." )

Limit this field's content by a number of characters. CAUTION: Does not take into account HTML tags, so it has the potential to return malformed HTML.

Limit this field's content by a number of characters. CAUTION: Does not take into account HTML tags, so it has the potential to return malformed HTML.

Parameters

$limit
integer
$limit Number of characters to limit by
$add
string
$add Ellipsis to add to the end of truncated string

Returns

string
public string
# LimitWordCountXML( integer $numWords = 26, string $add = '...' )

Limit the number of words of the current field's content. This is XML safe, so characters like & are converted to &

Limit the number of words of the current field's content. This is XML safe, so characters like & are converted to &

Parameters

$numWords
integer
$numWords Number of words to limit by
$add
string
$add Ellipsis to add to the end of truncated string

Returns

string
public
# LimitSentences( integer $sentCount = 2 )

Limit sentences, can be controlled by passing an integer.

Limit sentences, can be controlled by passing an integer.

Parameters

$sentCount
integer
$sentCount The amount of sentences you want.
public
# FirstSentence( )

Caution: Not XML/HTML-safe - does not respect closing tags.

Caution: Not XML/HTML-safe - does not respect closing tags.
public
# Summary( mixed $maxWords = 50 )

Caution: Not XML/HTML-safe - does not respect closing tags.

Caution: Not XML/HTML-safe - does not respect closing tags.
public
# BigSummary( mixed $maxWords = 50, mixed $plain = 1 )

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.

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.
public
# FirstParagraph( mixed $plain = 1 )

Caution: Not XML/HTML-safe - does not respect closing tags.

Caution: Not XML/HTML-safe - does not respect closing tags.
public string
# ContextSummary( integer $characters = 500, boolean $string = false, boolean $striphtml = true, boolean $highlight = true, String $prefix = "... ", String $suffix = "..." )

Perform context searching to give some context to searches, optionally highlighting the search term.

Perform context searching to give some context to searches, optionally highlighting the search term.

Parameters

$characters
integer
$characters Number of characters in the summary
$string
boolean
$string Supplied string ("keywords")
$striphtml
boolean
$striphtml Strip HTML?
$highlight
boolean
$highlight Add a highlight <span> element around search query?
$prefix
String
prefix text
$suffix
String
suffix

Returns

string
public string
# Parse( mixed $parser = "TextParser" )

Allows a sub-class of TextParser to be rendered.

Allows a sub-class of TextParser to be rendered.

Returns

string

See

TextParser for implementation details.
public FormField
# scaffoldFormField( string $title = null, mixed $params = null )

(non-PHPdoc)

(non-PHPdoc)

Parameters

$title
string
$title Optional. Localized title of the generated instance
$params

Returns

FormField

See

DBField::scaffoldFormField()

Overrides

DBField::scaffoldFormField
public FormField
# scaffoldSearchField( string $title = null, mixed $params = null )

(non-PHPdoc)

(non-PHPdoc)

Parameters

$title
string
$title Optional. Localized title of the generated instance
$params

Returns

FormField

See

DBField::scaffoldSearchField()

Overrides

DBField::scaffoldSearchField

Methods inherited from StringField

Lower(), Upper(), __construct(), getNullifyEmpty(), hasValue(), prepValueForDB(), setNullifyEmpty(), setOptions()

Methods inherited from DBField

ATT(), HTML(), HTMLATT(), JS(), LowerCase(), RAW(), RAWURLATT(), URLATT(), UpperCase(), XML(), addToQuery(), create(), debug(), defaultSearchFilter(), exists(), forTemplate(), getName(), getValue(), nullValue(), saveInto(), setName(), setTable(), setValue(), writeToManipulation()

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), Top(), TotalItems(), XML_val(), __get(), __isset(), __set(), buildCastingCache(), cachedCall(), castingClass(), castingHelper(), castingHelperPair(), castingObjectCreator(), castingObjectCreatorPair(), customise(), defineMethods(), escapeTypeForField(), getField(), getIterator(), getSecurityID(), getXMLValues(), hasField(), i18nLocale(), iteratorProperties(), obj(), renderWith(), setCustomisedObj(), setField()

Methods inherited from Object

__call(), __toString(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), createMethod(), create_from_string(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

public static array $casting
#

An array of objects to cast certain fields to. This is set up as an array in the format:

An array of objects to cast certain fields to. This is set up as an array in the format:

public static $casting = array (
    'FieldName' => 'ClassToCastTo(Arguments)'
);

Properties inherited from StringField

$nullifyEmpty

Properties inherited from DBField

$arrayValue, $defaultVal, $default_search_filter_class, $escape_type, $name, $tableName, $value

Properties inherited from ViewableData

$customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances, $extensions

Comments

Comment policy: Please use comments for tips and corrections about the described functionality. Comments are moderated, we reserve the right to remove comments that are inappropriate or are no longer relevant.
Use the Silverstripe Forum to ask questions.
blog comments powered by Disqus
SilverStripe 2.4 API Docs API documentation generated by ApiGen 2.8.0