TextareaField

TextareaField creates a multi-line text field, allowing more data to be entered than a standard text field. It creates the tag in the form HTML.</p> <p><code> new TextareaField( $name = "description", $title = "Description", $value = "This is the default description" ); </code></p> </div> <h2>Properties</h2> <table class="table table-condensed"> <tr> <td class="type" id="property_class"> string </td> <td>$class</td> <td class="last"></td> <td><small>from <a href='/3/ss_object#property_class'>SS_Object</a></small></td> </tr> <tr> <td class="type" id="property_dontEscape"> bool </td> <td>$dontEscape</td> <td class="last"></td> <td><small>from <a href='/3/formfield#property_dontEscape'>FormField</a></small></td> </tr> </table> <h2>Methods</h2> <div class="container-fluid underlined"> <div class="row"> <div class="col-md-2 type"> static <a href='/3/config_forclass'>Config_ForClass</a>|null </div> <div class="col-md-8 type"> <a href="#method_config">config</a>() <p>Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_config'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static <a href='/3/ss_object'>SS_Object</a> </div> <div class="col-md-8 type"> <a href="#method_create">create</a>() <p>An implementation of the factory method, allows you to create an instance of a class</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_create'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static <a href='/3/ss_object'>SS_Object</a> </div> <div class="col-md-8 type"> <a href="#method_singleton">singleton</a>() <p>Creates a class instance by the "singleton" design pattern.</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_singleton'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_create_from_string">create_from_string</a>($classSpec, $firstArg = null) <p>Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_create_from_string'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_parse_class_spec">parse_class_spec</a>($classSpec) <p>Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_parse_class_spec'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static <a href='/3/ss_object'>SS_Object</a> </div> <div class="col-md-8 type"> <a href="#method_strong_create">strong_create</a>() <p>Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_strong_create'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_useCustomClass">useCustomClass</a>(string $oldClass, string $newClass, bool $strong = false) <p>This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_useCustomClass'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static string </div> <div class="col-md-8 type"> <a href="#method_getCustomClass">getCustomClass</a>(string $class) <p>If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_getCustomClass'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static any </div> <div class="col-md-8 type"> <a href="#method_static_lookup">static_lookup</a>($class, $name, null $default = null) <p>Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_static_lookup'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_get_static">get_static</a>($class, $name, $uncached = false) <small>^{<span class="label label-danger">deprecated</span>}</small> <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_get_static'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_set_static">set_static</a>($class, $name, $value) <small>^{<span class="label label-danger">deprecated</span>}</small> <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_set_static'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_uninherited_static">uninherited_static</a>($class, $name, $uncached = false) <small>^{<span class="label label-danger">deprecated</span>}</small> <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_uninherited_static'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_combined_static">combined_static</a>($class, $name, $ceiling = false) <small>^{<span class="label label-danger">deprecated</span>}</small> <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_combined_static'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_addStaticVars">addStaticVars</a>($class, $properties, $replace = false) <small>^{<span class="label label-danger">deprecated</span>}</small> <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_addStaticVars'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_add_static_var">add_static_var</a>($class, $name, $value, $replace = false) <small>^{<span class="label label-danger">deprecated</span>}</small> <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_add_static_var'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_has_extension">has_extension</a>(string $classOrExtension, string $requiredExtension = null, boolean $strict = false) <p>Return TRUE if a class has a specified extension.</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_has_extension'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_add_extension">add_extension</a>(string $classOrExtension, string $extension = null) <p>Add an extension to a specific class.</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_add_extension'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_remove_extension">remove_extension</a>(string $extension) <p>Remove an extension from a class.</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_remove_extension'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static array </div> <div class="col-md-8 type"> <a href="#method_get_extensions">get_extensions</a>(string $class, bool $includeArgumentString = false) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_get_extensions'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static  </div> <div class="col-md-8 type"> <a href="#method_get_extra_config_sources">get_extra_config_sources</a>($class = null) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_get_extra_config_sources'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method___construct">__construct</a>(string $name, null|string $title = null, mixed $value = null) <p>Creates a new field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method___construct'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> mixed </div> <div class="col-md-8 type"> <a href="#method___call">__call</a>(string $method, array $arguments) <p>Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method___call'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_hasMethod">hasMethod</a>(string $method) <p>Return TRUE if a method exists on this object</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_hasMethod'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array </div> <div class="col-md-8 type"> <a href="#method_allMethodNames">allMethodNames</a>(bool $custom = false) <p>Return the names of all the methods available on this object</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_allMethodNames'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_stat">stat</a>($name, $uncached = false) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_stat'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_set_stat">set_stat</a>($name, $value) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_set_stat'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_uninherited">uninherited</a>($name) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_uninherited'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_exists">exists</a>() <p>Return true if this object "exists" i.e. has a sensible value</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_exists'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_parentClass">parentClass</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_parentClass'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_is_a">is_a</a>(string $class) <p>Check if this class is an instance of a specific class, or has that class as one of its parents</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_is_a'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method___toString">__toString</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method___toString'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> mixed </div> <div class="col-md-8 type"> <a href="#method_invokeWithExtensions">invokeWithExtensions</a>(string $method, mixed $argument = null) <p>Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_invokeWithExtensions'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array </div> <div class="col-md-8 type"> <a href="#method_extend">extend</a>(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null) <p>Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_extend'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/extension'>Extension</a> </div> <div class="col-md-8 type"> <a href="#method_getExtensionInstance">getExtensionInstance</a>(string $extension) <p>Get an extension instance attached to this object by name.</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_getExtensionInstance'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_hasExtension">hasExtension</a>(string $extension) <p>Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_hasExtension'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array </div> <div class="col-md-8 type"> <a href="#method_getExtensionInstances">getExtensionInstances</a>() <p>Get all extension instances for this specific object instance.</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_getExtensionInstances'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> mixed </div> <div class="col-md-8 type"> <a href="#method_cacheToFile">cacheToFile</a>(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array()) <p>Cache the results of an instance method in this object to a file, or if it is already cache return the cached results</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_cacheToFile'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_clearCache">clearCache</a>($method, $ID = false, $arguments = array()) <p>Clears the cache for the given cacheToFile call</p> </div> <div class="col-md-2"><small>from <a href='/3/ss_object#method_clearCache'>SS_Object</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static string </div> <div class="col-md-8 type"> <a href="#method_castingObjectCreator">castingObjectCreator</a>(string $fieldSchema) <p>Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_castingObjectCreator'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static array </div> <div class="col-md-8 type"> <a href="#method_castingObjectCreatorPair">castingObjectCreatorPair</a>(string $fieldSchema) <p>Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_castingObjectCreatorPair'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method___isset">__isset</a>(string $property) <p>Check if a field exists on this object or its failover.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method___isset'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> mixed </div> <div class="col-md-8 type"> <a href="#method___get">__get</a>(string $property) <p>Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method___get'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method___set">__set</a>(string $property, mixed $value) <p>Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method___set'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_setFailover">setFailover</a>(<a href='/3/viewabledata'>ViewableData</a> $failover) <p>Set a failover object to attempt to get data from if it is not present on this object.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_setFailover'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/viewabledata'>ViewableData</a>|null </div> <div class="col-md-8 type"> <a href="#method_getFailover">getFailover</a>() <p>Get the current failover object if set</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_getFailover'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_hasField">hasField</a>(string $field) <p>Check if a field exists on this object. This should be overloaded in child classes.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_hasField'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> mixed </div> <div class="col-md-8 type"> <a href="#method_getField">getField</a>(string $field) <p>Get the value of a field on this object. This should be overloaded in child classes.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_getField'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_setField">setField</a>(string $field, mixed $value) <p>Set a field on this object. This should be overloaded in child classes.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_setField'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_defineMethods">defineMethods</a>() <p>Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_defineMethods'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> unknown </div> <div class="col-md-8 type"> <a href="#method_deprecatedCachedCall">deprecatedCachedCall</a>($method, $args = null, $identifier = null) <p>Method to facilitate deprecation of underscore-prefixed methods automatically being cached.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_deprecatedCachedCall'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/viewabledata_customised'>ViewableData_Customised</a> </div> <div class="col-md-8 type"> <a href="#method_customise">customise</a>(array|<a href='/3/viewabledata'>ViewableData</a> $data) <p>Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_customise'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/viewabledata'>ViewableData</a> </div> <div class="col-md-8 type"> <a href="#method_getCustomisedObj">getCustomisedObj</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_getCustomisedObj'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_setCustomisedObj">setCustomisedObj</a>(<a href='/3/viewabledata'>ViewableData</a> $object) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_setCustomisedObj'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array </div> <div class="col-md-8 type"> <a href="#method_castingHelperPair">castingHelperPair</a>(string $field) <p>Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_castingHelperPair'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_castingHelper">castingHelper</a>(string $field) <p>Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_castingHelper'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_castingClass">castingClass</a>(string $field) <p>Get the class name a field on this object will be casted to</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_castingClass'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_escapeTypeForField">escapeTypeForField</a>(string $field) <p>Return the string-format type for the given field.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_escapeTypeForField'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_buildCastingCache">buildCastingCache</a>(reference $cache) <p>Save the casting cache for this object (including data from any failovers) into a variable</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_buildCastingCache'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/htmltext'>HTMLText</a> </div> <div class="col-md-8 type"> <a href="#method_renderWith">renderWith</a>(string|array|<a href='/3/ssviewer'>SSViewer</a> $template, array $customFields = null) <p>Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_renderWith'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_obj">obj</a>(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null) <p>Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_obj'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_cachedCall">cachedCall</a>(string $field, array $arguments = null, string $identifier = null) <p>A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_cachedCall'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_hasValue">hasValue</a>(string $field, array $arguments = null, bool $cache = true) <p>Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_hasValue'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_XML_val">XML_val</a>($field, $arguments = null, $cache = false) <p>Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_XML_val'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_RAW_val">RAW_val</a>($field, $arguments = null, $cache = true) <p>Return the value of the field without any escaping being applied.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_RAW_val'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_SQL_val">SQL_val</a>($field, $arguments = null, $cache = true) <p>Return the value of a field in an SQL-safe format.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_SQL_val'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_JS_val">JS_val</a>($field, $arguments = null, $cache = true) <p>Return the value of a field in a JavaScript-save format.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_JS_val'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_ATT_val">ATT_val</a>($field, $arguments = null, $cache = true) <p>Return the value of a field escaped suitable to be inserted into an XML node attribute.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_ATT_val'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array </div> <div class="col-md-8 type"> <a href="#method_getXMLValues">getXMLValues</a>($fields) <p>Get an array of XML-escaped values by field name</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_getXMLValues'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a target="_blank" href="http://php.net/ArrayIterator">ArrayIterator</a> </div> <div class="col-md-8 type"> <a href="#method_getIterator">getIterator</a>() <p>Return a single-item iterator so you can iterate over the fields of a single record.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_getIterator'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/viewabledata'>ViewableData</a> </div> <div class="col-md-8 type"> <a href="#method_Me">Me</a>() <p>When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_Me'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_ThemeDir">ThemeDir</a>(string $subtheme = false) <p>Return the directory if the current active theme (relative to the site root).</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_ThemeDir'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_CSSClasses">CSSClasses</a>(string $stopAtClass = 'ViewableData') <p>Get part of the current classes ancestry to be used as a CSS class.</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_CSSClasses'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/viewabledata_debugger'>ViewableData_Debugger</a> </div> <div class="col-md-8 type"> <a href="#method_Debug">Debug</a>() <p>Return debug information about this object that can be rendered into a template</p> </div> <div class="col-md-2"><small>from <a href='/3/viewabledata#method_Debug'>ViewableData</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_setDataModel">setDataModel</a>($model) <p>Set the DataModel for this request.</p> </div> <div class="col-md-2"><small>from <a href='/3/requesthandler#method_setDataModel'>RequestHandler</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/ss_httpresponse'>SS_HTTPResponse</a>|<a href='/3/requesthandler'>RequestHandler</a>|string|array </div> <div class="col-md-8 type"> <a href="#method_handleRequest">handleRequest</a>(<a href='/3/ss_httprequest'>SS_HTTPRequest</a> $request, <a href='/3/datamodel'>DataModel</a> $model) <p>Handles URL requests.</p> </div> <div class="col-md-2"><small>from <a href='/3/requesthandler#method_handleRequest'>RequestHandler</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array|null </div> <div class="col-md-8 type"> <a href="#method_allowedActions">allowedActions</a>(String $limitToClass = null) <p>Get a array of allowed actions defined on this controller, any parent classes or extensions.</p> </div> <div class="col-md-2"><small>from <a href='/3/requesthandler#method_allowedActions'>RequestHandler</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_hasAction">hasAction</a>(string $action) <p>Checks if this request handler has a specific action, even if the current user cannot access it.</p> </div> <div class="col-md-2"><small>from <a href='/3/requesthandler#method_hasAction'>RequestHandler</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_checkAccessAction">checkAccessAction</a>($action) <p>Check that the given action is allowed to be called from a URL.</p> </div> <div class="col-md-2"><small>from <a href='/3/requesthandler#method_checkAccessAction'>RequestHandler</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_httpError">httpError</a>(int $errorCode, string $errorMessage = null) <p>Throws a HTTP error response encased in a {@link SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.</p> </div> <div class="col-md-2"><small>from <a href='/3/requesthandler#method_httpError'>RequestHandler</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/ss_httprequest'>SS_HTTPRequest</a>|<a href='/3/nullhttprequest'>NullHTTPRequest</a> </div> <div class="col-md-8 type"> <a href="#method_getRequest">getRequest</a>() <p>Returns the SS_HTTPRequest object that this controller is using.</p> </div> <div class="col-md-2"><small>from <a href='/3/requesthandler#method_getRequest'>RequestHandler</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_setRequest">setRequest</a>(<a href='/3/ss_httprequest'>SS_HTTPRequest</a> $request) <p>Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.</p> </div> <div class="col-md-2"><small>from <a href='/3/requesthandler#method_setRequest'>RequestHandler</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_Link">Link</a>(string $action = null) <p>Return a link to this field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_Link'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static string </div> <div class="col-md-8 type"> <a href="#method_name_to_label">name_to_label</a>(string $fieldName) <p>Takes a field name and converts camelcase to spaced words. Also resolves combined field names with dot syntax to spaced words.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_name_to_label'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> static string </div> <div class="col-md-8 type"> <a href="#method_create_tag">create_tag</a>(string $tag, array $attributes, null|string $content = null) <p>Construct and return HTML tag.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_create_tag'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_ID">ID</a>() <p>Returns the HTML ID of the field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_ID'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_HolderID">HolderID</a>() <p>Returns the HTML ID for the form field holder element.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_HolderID'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/formtemplatehelper'>FormTemplateHelper</a> </div> <div class="col-md-8 type"> <a href="#method_getTemplateHelper">getTemplateHelper</a>() <p>Returns the current {@link FormTemplateHelper} on either the parent Form or the global helper set through the {@link Injector} layout.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getTemplateHelper'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_getName">getName</a>() <p>Returns the field name.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getName'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_Message">Message</a>() <p>Returns the field message, used by form validation.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_Message'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_MessageType">MessageType</a>() <p>Returns the field message type.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_MessageType'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> mixed </div> <div class="col-md-8 type"> <a href="#method_Value">Value</a>() <p>Return value with all values encoded in html entities</p> </div> <div class="col-md-2"></div> </div> <div class="row"> <div class="col-md-2 type"> </div> <div class="col-md-8 type"> <a href="#method_saveInto">saveInto</a>(<a href='/3/dataobjectinterface'>DataObjectInterface</a> $record) <p>Method to save this form field into the given {@link DataObject}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_saveInto'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> mixed </div> <div class="col-md-8 type"> <a href="#method_dataValue">dataValue</a>() <p>Returns the field value suitable for insertion into the data object.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_dataValue'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_Title">Title</a>() <p>Returns the field label - used by templates.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_Title'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setTitle">setTitle</a>(string $title) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setTitle'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_RightTitle">RightTitle</a>() <p>Gets the contextual label than can be used for additional field description.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_RightTitle'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setRightTitle">setRightTitle</a>(string $rightTitle) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setRightTitle'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_LeftTitle">LeftTitle</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_LeftTitle'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setLeftTitle">setLeftTitle</a>(string $leftTitle) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setLeftTitle'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_extraClass">extraClass</a>() <p>Compiles all CSS-classes. Optionally includes a "nolabel" class if no title was set on the FormField.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_extraClass'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_addExtraClass">addExtraClass</a>(string $class) <p>Add one or more CSS-classes to the FormField container.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_addExtraClass'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_removeExtraClass">removeExtraClass</a>(string $class) <p>Remove one or more CSS-classes from the FormField container.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_removeExtraClass'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setAttribute">setAttribute</a>(string $name, string $value) <p>Set an HTML attribute on the field element, mostly an input tag.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setAttribute'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> null|string </div> <div class="col-md-8 type"> <a href="#method_getAttribute">getAttribute</a>($name) <p>Get an HTML attribute defined by the field, or added through {@link setAttribute()}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getAttribute'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array </div> <div class="col-md-8 type"> <a href="#method_getAttributes">getAttributes</a>() <p>Allows customization through an 'updateAttributes' hook on the base class.</p> </div> <div class="col-md-2"></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_getAttributesHTML">getAttributesHTML</a>(array $attributes = null) <p>Custom attributes to process. Falls back to {@link getAttributes()}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getAttributesHTML'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_attrTitle">attrTitle</a>() <p>Returns a version of a title suitable for insertion into an HTML attribute.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_attrTitle'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_attrValue">attrValue</a>() <p>Returns a version of a title suitable for insertion into an HTML attribute.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_attrValue'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setValue">setValue</a>(mixed $value) <p>Set the field value.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setValue'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setName">setName</a>(string $name) <p>Set the field name.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setName'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setForm">setForm</a>(<a href='/3/form'>Form</a> $form) <p>Set the container form.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setForm'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/form'>Form</a> </div> <div class="col-md-8 type"> <a href="#method_getForm">getForm</a>() <p>Get the currently used form.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getForm'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_securityTokenEnabled">securityTokenEnabled</a>() <p>Return true if security token protection is enabled on the parent {@link Form}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_securityTokenEnabled'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setError">setError</a>(string $message, string $messageType) <p>Sets the error message to be displayed on the form field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setError'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setCustomValidationMessage">setCustomValidationMessage</a>(string $customValidationMessage) <p>Set the custom error message to show instead of the default format.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setCustomValidationMessage'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_getCustomValidationMessage">getCustomValidationMessage</a>() <p>Get the custom error message for this form field. If a custom message has not been defined then just return blank. The default error is defined on {@link Validator}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getCustomValidationMessage'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setTemplate">setTemplate</a>(string $template) <p>Set name of template (without path or extension).</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setTemplate'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_getTemplate">getTemplate</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getTemplate'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_getFieldHolderTemplate">getFieldHolderTemplate</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getFieldHolderTemplate'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setFieldHolderTemplate">setFieldHolderTemplate</a>(string $fieldHolderTemplate) <p>Set name of template (without path or extension) for the holder, which in turn is responsible for rendering {@link Field()}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setFieldHolderTemplate'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_getSmallFieldHolderTemplate">getSmallFieldHolderTemplate</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getSmallFieldHolderTemplate'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setSmallFieldHolderTemplate">setSmallFieldHolderTemplate</a>(string $smallFieldHolderTemplate) <p>Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering {@link Field()}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setSmallFieldHolderTemplate'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_Field">Field</a>(array $properties = array()) <p>Returns the form field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_Field'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_FieldHolder">FieldHolder</a>(array $properties = array()) <p>Returns a "field holder" for this field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_FieldHolder'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_SmallFieldHolder">SmallFieldHolder</a>(array $properties = array()) <p>Returns a restricted field holder used within things like FieldGroups.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_SmallFieldHolder'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array </div> <div class="col-md-8 type"> <a href="#method_getTemplates">getTemplates</a>() <p>Returns an array of templates to use for rendering {@link FieldHolder}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getTemplates'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array </div> <div class="col-md-8 type"> <a href="#method_getFieldHolderTemplates">getFieldHolderTemplates</a>() <p>Returns an array of templates to use for rendering {@link FieldHolder}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getFieldHolderTemplates'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> array </div> <div class="col-md-8 type"> <a href="#method_getSmallFieldHolderTemplates">getSmallFieldHolderTemplates</a>() <p>Returns an array of templates to use for rendering {@link SmallFieldHolder}.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getSmallFieldHolderTemplates'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_isComposite">isComposite</a>() <p>Returns true if this field is a composite field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_isComposite'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_hasData">hasData</a>() <p>Returns true if this field has its own data.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_hasData'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_isReadonly">isReadonly</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_isReadonly'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setReadonly">setReadonly</a>(bool $readonly) <p>Sets a read-only flag on this FormField.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setReadonly'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_isDisabled">isDisabled</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_isDisabled'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setDisabled">setDisabled</a>(bool $disabled) <p>Sets a disabled flag on this FormField.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setDisabled'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/formfield'>FormField</a> </div> <div class="col-md-8 type"> <a href="#method_performReadonlyTransformation">performReadonlyTransformation</a>() <p>Returns a read-only version of this field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_performReadonlyTransformation'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/formfield'>FormField</a> </div> <div class="col-md-8 type"> <a href="#method_performDisabledTransformation">performDisabledTransformation</a>() <p>Return a disabled version of this field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_performDisabledTransformation'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> mixed </div> <div class="col-md-8 type"> <a href="#method_transform">transform</a>(<a href='/3/formtransformation'>FormTransformation</a> $transformation) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_transform'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> int </div> <div class="col-md-8 type"> <a href="#method_hasClass">hasClass</a>(string $class) <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_hasClass'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_Type">Type</a>() <p>Returns the field type.</p> </div> <div class="col-md-2"></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_createTag">createTag</a>(string $tag, array $attributes, null|string $content = null) <small>^{<span class="label label-danger">deprecated</span>}</small> <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_createTag'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_validate">validate</a>(<a href='/3/validator'>Validator</a> $validator) <p>Abstract method each {@link FormField} subclass must implement, determines whether the field is valid or not based on the value.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_validate'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setDescription">setDescription</a>(string $description) <p>Describe this field, provide help text for it.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setDescription'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_getDescription">getDescription</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getDescription'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_debug">debug</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_debug'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> string </div> <div class="col-md-8 type"> <a href="#method_forTemplate">forTemplate</a>() <p>This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_forTemplate'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_Required">Required</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_Required'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/fieldlist'>FieldList</a> </div> <div class="col-md-8 type"> <a href="#method_setContainerFieldList">setContainerFieldList</a>(<a href='/3/fieldlist'>FieldList</a> $containerFieldList) <p>Set the FieldList that contains this field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_setContainerFieldList'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/fieldlist'>FieldList</a> </div> <div class="col-md-8 type"> <a href="#method_getContainerFieldList">getContainerFieldList</a>() <p>Get the FieldList that contains this field.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_getContainerFieldList'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> null|<a href='/3/fieldlist'>FieldList</a> </div> <div class="col-md-8 type"> <a href="#method_rootFieldList">rootFieldList</a>() <p class="no-description">No description</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_rootFieldList'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> <a href='/3/formfield'>FormField</a> </div> <div class="col-md-8 type"> <a href="#method_castedCopy">castedCopy</a>(mixed $classOrCopy) <p>Returns another instance of this field, but "cast" to a different class. The logic tries to retain all of the instance properties, and may be overloaded by subclasses to set additional ones.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_castedCopy'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> bool </div> <div class="col-md-8 type"> <a href="#method_canSubmitValue">canSubmitValue</a>() <p>Determine if the value of this formfield accepts front-end submitted values and is saveable.</p> </div> <div class="col-md-2"><small>from <a href='/3/formfield#method_canSubmitValue'>FormField</a></small></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setRows">setRows</a>(int $rows) <p>Set the number of rows in the textarea</p> </div> <div class="col-md-2"></div> </div> <div class="row"> <div class="col-md-2 type"> $this </div> <div class="col-md-8 type"> <a href="#method_setColumns">setColumns</a>(int $cols) <p>Set the number of columns in the textarea</p> </div> <div class="col-md-2"></div> </div> </div> <h2>Details</h2> <div id="method-details"> <div class="method-item"> <h3 id="method_config"> <div class="location">in <a href='/3/ss_object#method_config'>SS_Object</a> at line 60</div> <code> static <a href='/3/config_forclass'>Config_ForClass</a>|null <strong>config</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .</p> <p>....).</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/config_forclass'>Config_ForClass</a>|null</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_create"> <div class="location">in <a href='/3/ss_object#method_create'>SS_Object</a> at line 132</div> <code> static <a href='/3/ss_object'>SS_Object</a> <strong>create</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>An implementation of the factory method, allows you to create an instance of a class</p> <p>This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use {@link Object::useCustomClass()}</p> <p>This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/ss_object'>SS_Object</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_singleton"> <div class="location">in <a href='/3/ss_object#method_singleton'>SS_Object</a> at line 155</div> <code> static <a href='/3/ss_object'>SS_Object</a> <strong>singleton</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Creates a class instance by the "singleton" design pattern.</p> <p>It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/ss_object'>SS_Object</a></td> <td>The singleton instance</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_create_from_string"> <div class="location">in <a href='/3/ss_object#method_create_from_string'>SS_Object</a> at line 190</div> <code> static <strong>create_from_string</strong>($classSpec, $firstArg = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().</p> <p>Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.</p> <p><code>Object::create_from_string("Versioned('Stage','Live')")</code> will return the result of <code>Versioned::create('Stage', 'Live);</code></p> <p>It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.</p> <p>If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.</p> <p><code>Object::create_from_string("Varchar(50)", "MyField")</code> will return the result of <code>Vachar::create('MyField', '50');</code></p> <p>Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$classSpec</td> <td></td> </tr> <tr> <td></td> <td>$firstArg</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_parse_class_spec"> <div class="location">in <a href='/3/ss_object#method_parse_class_spec'>SS_Object</a> at line 215</div> <code> static <strong>parse_class_spec</strong>($classSpec) </code> </h3> <div class="details"> <div class="method-description"> <p>Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().</p> <p>Returns a 2-elemnent array, with classname and arguments</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$classSpec</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_strong_create"> <div class="location">in <a href='/3/ss_object#method_strong_create'>SS_Object</a> at line 341</div> <code> static <a href='/3/ss_object'>SS_Object</a> <strong>strong_create</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/ss_object'>SS_Object</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_useCustomClass"> <div class="location">in <a href='/3/ss_object#method_useCustomClass'>SS_Object</a> at line 361</div> <code> static <strong>useCustomClass</strong>(string $oldClass, string $newClass, bool $strong = false) </code> </h3> <div class="details"> <div class="method-description"> <p>This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$oldClass</td> <td>the class to replace</td> </tr> <tr> <td>string</td> <td>$newClass</td> <td>the class to replace it with</td> </tr> <tr> <td>bool</td> <td>$strong</td> <td>allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getCustomClass"> <div class="location">in <a href='/3/ss_object#method_getCustomClass'>SS_Object</a> at line 375</div> <code> static string <strong>getCustomClass</strong>(string $class) </code> </h3> <div class="details"> <div class="method-description"> <p>If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$class</td> <td>the class to check</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>the class that would be created if you called {@link Object::create()} with the class</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_static_lookup"> <div class="location">in <a href='/3/ss_object#method_static_lookup'>SS_Object</a> at line 396</div> <code> static any <strong>static_lookup</strong>($class, $name, null $default = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$class</td> <td><ul> <li>The class to get the static from</li> </ul> </td> </tr> <tr> <td></td> <td>$name</td> <td><ul> <li>The property to get from the class</li> </ul> </td> </tr> <tr> <td>null</td> <td>$default</td> <td><ul> <li>The value to return if property doesn't exist on class</li> </ul> </td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>any</td> <td><ul> <li>The value of the static property $name on class $class, or $default if that property is not defined</li> </ul> </td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_get_static"> <div class="location">in <a href='/3/ss_object#method_get_static'>SS_Object</a> at line 436</div> <code> static <strong>get_static</strong>($class, $name, $uncached = false) <small>^{<span class="label label-danger">deprecated</span>}</small></code> </h3> <div class="details"> <p> <small>^{<span class="label label-danger">deprecated</span>}</small> <tr> <td></td> <td></td> </tr> </p> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$class</td> <td></td> </tr> <tr> <td></td> <td>$name</td> <td></td> </tr> <tr> <td></td> <td>$uncached</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_set_static"> <div class="location">in <a href='/3/ss_object#method_set_static'>SS_Object</a> at line 444</div> <code> static <strong>set_static</strong>($class, $name, $value) <small>^{<span class="label label-danger">deprecated</span>}</small></code> </h3> <div class="details"> <p> <small>^{<span class="label label-danger">deprecated</span>}</small> <tr> <td></td> <td></td> </tr> </p> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$class</td> <td></td> </tr> <tr> <td></td> <td>$name</td> <td></td> </tr> <tr> <td></td> <td>$value</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_uninherited_static"> <div class="location">in <a href='/3/ss_object#method_uninherited_static'>SS_Object</a> at line 452</div> <code> static <strong>uninherited_static</strong>($class, $name, $uncached = false) <small>^{<span class="label label-danger">deprecated</span>}</small></code> </h3> <div class="details"> <p> <small>^{<span class="label label-danger">deprecated</span>}</small> <tr> <td></td> <td></td> </tr> </p> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$class</td> <td></td> </tr> <tr> <td></td> <td>$name</td> <td></td> </tr> <tr> <td></td> <td>$uncached</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_combined_static"> <div class="location">in <a href='/3/ss_object#method_combined_static'>SS_Object</a> at line 460</div> <code> static <strong>combined_static</strong>($class, $name, $ceiling = false) <small>^{<span class="label label-danger">deprecated</span>}</small></code> </h3> <div class="details"> <p> <small>^{<span class="label label-danger">deprecated</span>}</small> <tr> <td></td> <td></td> </tr> </p> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$class</td> <td></td> </tr> <tr> <td></td> <td>$name</td> <td></td> </tr> <tr> <td></td> <td>$ceiling</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_addStaticVars"> <div class="location">in <a href='/3/ss_object#method_addStaticVars'>SS_Object</a> at line 470</div> <code> static <strong>addStaticVars</strong>($class, $properties, $replace = false) <small>^{<span class="label label-danger">deprecated</span>}</small></code> </h3> <div class="details"> <p> <small>^{<span class="label label-danger">deprecated</span>}</small> <tr> <td></td> <td></td> </tr> </p> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$class</td> <td></td> </tr> <tr> <td></td> <td>$properties</td> <td></td> </tr> <tr> <td></td> <td>$replace</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_add_static_var"> <div class="location">in <a href='/3/ss_object#method_add_static_var'>SS_Object</a> at line 478</div> <code> static <strong>add_static_var</strong>($class, $name, $value, $replace = false) <small>^{<span class="label label-danger">deprecated</span>}</small></code> </h3> <div class="details"> <p> <small>^{<span class="label label-danger">deprecated</span>}</small> <tr> <td></td> <td></td> </tr> </p> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$class</td> <td></td> </tr> <tr> <td></td> <td>$name</td> <td></td> </tr> <tr> <td></td> <td>$value</td> <td></td> </tr> <tr> <td></td> <td>$replace</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_has_extension"> <div class="location">in <a href='/3/ss_object#method_has_extension'>SS_Object</a> at line 494</div> <code> static <strong>has_extension</strong>(string $classOrExtension, string $requiredExtension = null, boolean $strict = false) </code> </h3> <div class="details"> <div class="method-description"> <p>Return TRUE if a class has a specified extension.</p> <p>This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$classOrExtension</td> <td>if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test</td> </tr> <tr> <td>string</td> <td>$requiredExtension</td> <td>used only if 2 arguments supplied</td> </tr> <tr> <td>boolean</td> <td>$strict</td> <td>if the extension has to match the required extension and not be a subclass</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_add_extension"> <div class="location">in <a href='/3/ss_object#method_add_extension'>SS_Object</a> at line 536</div> <code> static <strong>add_extension</strong>(string $classOrExtension, string $extension = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Add an extension to a specific class.</p> <p>The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.</p> <p>As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$classOrExtension</td> <td>Class that should be extended - has to be a subclass of {@link Object}</td> </tr> <tr> <td>string</td> <td>$extension</td> <td>Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"</td> </tr> </table> <h4>See also</h4> <table class="table table-condensed"> <tr> <td>http://doc.silverstripe.org/framework/en/trunk/reference/dataextension</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_remove_extension"> <div class="location">in <a href='/3/ss_object#method_remove_extension'>SS_Object</a> at line 594</div> <code> static <strong>remove_extension</strong>(string $extension) </code> </h3> <div class="details"> <div class="method-description"> <p>Remove an extension from a class.</p> <p>Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$extension</td> <td>Classname of an {@link Extension} subclass, without parameters</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_get_extensions"> <div class="location">in <a href='/3/ss_object#method_get_extensions'>SS_Object</a> at line 633</div> <code> static array <strong>get_extensions</strong>(string $class, bool $includeArgumentString = false) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$class</td> <td></td> </tr> <tr> <td>bool</td> <td>$includeArgumentString</td> <td>Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td>Numeric array of either {@link DataExtension} classnames, or eval'ed classname strings with constructor arguments.</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_get_extra_config_sources"> <div class="location">in <a href='/3/ss_object#method_get_extra_config_sources'>SS_Object</a> at line 655</div> <code> static <strong>get_extra_config_sources</strong>($class = null) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$class</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method___construct"> <div class="location">in <a href='/3/formfield#method___construct'>FormField</a> at line 238</div> <code> <strong>__construct</strong>(string $name, null|string $title = null, mixed $value = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Creates a new field.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$name</td> <td>The internal field name, passed to forms.</td> </tr> <tr> <td>null|string</td> <td>$title</td> <td>The human-readable field label.</td> </tr> <tr> <td>mixed</td> <td>$value</td> <td>The value of the field.</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method___call"> <div class="location">in <a href='/3/ss_object#method___call'>SS_Object</a> at line 725</div> <code> mixed <strong>__call</strong>(string $method, array $arguments) </code> </h3> <div class="details"> <div class="method-description"> <p>Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located</p> <p>You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$method</td> <td></td> </tr> <tr> <td>array</td> <td>$arguments</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_hasMethod"> <div class="location">in <a href='/3/ss_object#method_hasMethod'>SS_Object</a> at line 792</div> <code> bool <strong>hasMethod</strong>(string $method) </code> </h3> <div class="details"> <div class="method-description"> <p>Return TRUE if a method exists on this object</p> <p>This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$method</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_allMethodNames"> <div class="location">in <a href='/3/ss_object#method_allMethodNames'>SS_Object</a> at line 802</div> <code> array <strong>allMethodNames</strong>(bool $custom = false) </code> </h3> <div class="details"> <div class="method-description"> <p>Return the names of all the methods available on this object</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td>$custom</td> <td>include methods added dynamically at runtime</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_stat"> <div class="location">in <a href='/3/ss_object#method_stat'>SS_Object</a> at line 963</div> <code> <strong>stat</strong>($name, $uncached = false) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$name</td> <td></td> </tr> <tr> <td></td> <td>$uncached</td> <td></td> </tr> </table> <h4>See also</h4> <table class="table table-condensed"> <tr> <td>SS_Object::get_static()</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_set_stat"> <div class="location">in <a href='/3/ss_object#method_set_stat'>SS_Object</a> at line 970</div> <code> <strong>set_stat</strong>($name, $value) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$name</td> <td></td> </tr> <tr> <td></td> <td>$value</td> <td></td> </tr> </table> <h4>See also</h4> <table class="table table-condensed"> <tr> <td>SS_Object::set_static()</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_uninherited"> <div class="location">in <a href='/3/ss_object#method_uninherited'>SS_Object</a> at line 977</div> <code> <strong>uninherited</strong>($name) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$name</td> <td></td> </tr> </table> <h4>See also</h4> <table class="table table-condensed"> <tr> <td>SS_Object::uninherited_static()</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_exists"> <div class="location">in <a href='/3/ss_object#method_exists'>SS_Object</a> at line 991</div> <code> bool <strong>exists</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Return true if this object "exists" i.e. has a sensible value</p> <p>This method should be overriden in subclasses to provide more context about the classes state. For example, a {@link DataObject} class could return false when it is deleted from the database</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_parentClass"> <div class="location">in <a href='/3/ss_object#method_parentClass'>SS_Object</a> at line 998</div> <code> string <strong>parentClass</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>this classes parent class</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_is_a"> <div class="location">in <a href='/3/ss_object#method_is_a'>SS_Object</a> at line 1008</div> <code> bool <strong>is_a</strong>(string $class) </code> </h3> <div class="details"> <div class="method-description"> <p>Check if this class is an instance of a specific class, or has that class as one of its parents</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$class</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method___toString"> <div class="location">in <a href='/3/ss_object#method___toString'>SS_Object</a> at line 1015</div> <code> string <strong>__toString</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>the class name</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_invokeWithExtensions"> <div class="location">in <a href='/3/ss_object#method_invokeWithExtensions'>SS_Object</a> at line 1030</div> <code> mixed <strong>invokeWithExtensions</strong>(string $method, mixed $argument = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$method</td> <td>the method name to call</td> </tr> <tr> <td>mixed</td> <td>$argument</td> <td>a single argument to pass</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_extend"> <div class="location">in <a href='/3/ss_object#method_extend'>SS_Object</a> at line 1058</div> <code> array <strong>extend</strong>(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed</p> <p>Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.</p> <p>The extension methods are defined during {@link __construct()} in {@link defineMethods()}.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$method</td> <td>the name of the method to call on each extension</td> </tr> <tr> <td>mixed</td> <td>$a1</td> <td></td> </tr> <tr> <td>mixed</td> <td>$a2</td> <td></td> </tr> <tr> <td>mixed</td> <td>$a3</td> <td></td> </tr> <tr> <td>mixed</td> <td>$a4</td> <td></td> </tr> <tr> <td>mixed</td> <td>$a5</td> <td></td> </tr> <tr> <td>mixed</td> <td>$a6</td> <td></td> </tr> <tr> <td>mixed</td> <td>$a7</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getExtensionInstance"> <div class="location">in <a href='/3/ss_object#method_getExtensionInstance'>SS_Object</a> at line 1097</div> <code> <a href='/3/extension'>Extension</a> <strong>getExtensionInstance</strong>(string $extension) </code> </h3> <div class="details"> <div class="method-description"> <p>Get an extension instance attached to this object by name.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$extension</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/extension'>Extension</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_hasExtension"> <div class="location">in <a href='/3/ss_object#method_hasExtension'>SS_Object</a> at line 1115</div> <code> bool <strong>hasExtension</strong>(string $extension) </code> </h3> <div class="details"> <div class="method-description"> <p>Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.</p> <p>Caution: Don't use singleton(<class>)->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$extension</td> <td>Classname of an {@link Extension} subclass without parameters</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getExtensionInstances"> <div class="location">in <a href='/3/ss_object#method_getExtensionInstances'>SS_Object</a> at line 1126</div> <code> array <strong>getExtensionInstances</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Get all extension instances for this specific object instance.</p> <p>See {@link get_extensions()} to get all applied extension classes for this class (not the instance).</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td>Map of {@link DataExtension} instances, keyed by classname.</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_cacheToFile"> <div class="location">in <a href='/3/ss_object#method_cacheToFile'>SS_Object</a> at line 1142</div> <code> mixed <strong>cacheToFile</strong>(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array()) </code> </h3> <div class="details"> <div class="method-description"> <p>Cache the results of an instance method in this object to a file, or if it is already cache return the cached results</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$method</td> <td>the method name to cache</td> </tr> <tr> <td>int</td> <td>$lifetime</td> <td>the cache lifetime in seconds</td> </tr> <tr> <td>string</td> <td>$ID</td> <td>custom cache ID to use</td> </tr> <tr> <td>array</td> <td>$arguments</td> <td>an optional array of arguments</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td>the cached data</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_clearCache"> <div class="location">in <a href='/3/ss_object#method_clearCache'>SS_Object</a> at line 1171</div> <code> <strong>clearCache</strong>($method, $ID = false, $arguments = array()) </code> </h3> <div class="details"> <div class="method-description"> <p>Clears the cache for the given cacheToFile call</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$method</td> <td></td> </tr> <tr> <td></td> <td>$ID</td> <td></td> </tr> <tr> <td></td> <td>$arguments</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_castingObjectCreator"> <div class="location">in <a href='/3/viewabledata#method_castingObjectCreator'>ViewableData</a> at line 72</div> <code> static string <strong>castingObjectCreator</strong>(string $fieldSchema) </code> </h3> <div class="details"> <div class="method-description"> <p>Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$fieldSchema</td> <td>The field spec</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_castingObjectCreatorPair"> <div class="location">in <a href='/3/viewabledata#method_castingObjectCreatorPair'>ViewableData</a> at line 83</div> <code> static array <strong>castingObjectCreatorPair</strong>(string $fieldSchema) </code> </h3> <div class="details"> <div class="method-description"> <p>Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$fieldSchema</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method___isset"> <div class="location">in <a href='/3/viewabledata#method___isset'>ViewableData</a> at line 95</div> <code> bool <strong>__isset</strong>(string $property) </code> </h3> <div class="details"> <div class="method-description"> <p>Check if a field exists on this object or its failover.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$property</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method___get"> <div class="location">in <a href='/3/viewabledata#method___get'>ViewableData</a> at line 117</div> <code> mixed <strong>__get</strong>(string $property) </code> </h3> <div class="details"> <div class="method-description"> <p>Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$property</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method___set"> <div class="location">in <a href='/3/viewabledata#method___set'>ViewableData</a> at line 138</div> <code> <strong>__set</strong>(string $property, mixed $value) </code> </h3> <div class="details"> <div class="method-description"> <p>Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$property</td> <td></td> </tr> <tr> <td>mixed</td> <td>$value</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setFailover"> <div class="location">in <a href='/3/viewabledata#method_setFailover'>ViewableData</a> at line 151</div> <code> <strong>setFailover</strong>(<a href='/3/viewabledata'>ViewableData</a> $failover) </code> </h3> <div class="details"> <div class="method-description"> <p>Set a failover object to attempt to get data from if it is not present on this object.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td><a href='/3/viewabledata'>ViewableData</a></td> <td>$failover</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getFailover"> <div class="location">in <a href='/3/viewabledata#method_getFailover'>ViewableData</a> at line 166</div> <code> <a href='/3/viewabledata'>ViewableData</a>|null <strong>getFailover</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Get the current failover object if set</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/viewabledata'>ViewableData</a>|null</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_hasField"> <div class="location">in <a href='/3/viewabledata#method_hasField'>ViewableData</a> at line 176</div> <code> bool <strong>hasField</strong>(string $field) </code> </h3> <div class="details"> <div class="method-description"> <p>Check if a field exists on this object. This should be overloaded in child classes.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$field</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getField"> <div class="location">in <a href='/3/viewabledata#method_getField'>ViewableData</a> at line 186</div> <code> mixed <strong>getField</strong>(string $field) </code> </h3> <div class="details"> <div class="method-description"> <p>Get the value of a field on this object. This should be overloaded in child classes.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$field</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setField"> <div class="location">in <a href='/3/viewabledata#method_setField'>ViewableData</a> at line 196</div> <code> <strong>setField</strong>(string $field, mixed $value) </code> </h3> <div class="details"> <div class="method-description"> <p>Set a field on this object. This should be overloaded in child classes.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$field</td> <td></td> </tr> <tr> <td>mixed</td> <td>$value</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_defineMethods"> <div class="location">in <a href='/3/viewabledata#method_defineMethods'>ViewableData</a> at line 206</div> <code> <strong>defineMethods</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.</p> </div> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_deprecatedCachedCall"> <div class="location">in <a href='/3/viewabledata#method_deprecatedCachedCall'>ViewableData</a> at line 236</div> <code> unknown <strong>deprecatedCachedCall</strong>($method, $args = null, $identifier = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Method to facilitate deprecation of underscore-prefixed methods automatically being cached.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$method</td> <td></td> </tr> <tr> <td></td> <td>$args</td> <td></td> </tr> <tr> <td></td> <td>$identifier</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>unknown</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_customise"> <div class="location">in <a href='/3/viewabledata#method_customise'>ViewableData</a> at line 255</div> <code> <a href='/3/viewabledata_customised'>ViewableData_Customised</a> <strong>customise</strong>(array|<a href='/3/viewabledata'>ViewableData</a> $data) </code> </h3> <div class="details"> <div class="method-description"> <p>Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.</p> <p>Note that any fields you specify will take precedence over the fields on this object.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>array|<a href='/3/viewabledata'>ViewableData</a></td> <td>$data</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/viewabledata_customised'>ViewableData_Customised</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getCustomisedObj"> <div class="location">in <a href='/3/viewabledata#method_getCustomisedObj'>ViewableData</a> at line 272</div> <code> <a href='/3/viewabledata'>ViewableData</a> <strong>getCustomisedObj</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/viewabledata'>ViewableData</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setCustomisedObj"> <div class="location">in <a href='/3/viewabledata#method_setCustomisedObj'>ViewableData</a> at line 279</div> <code> <strong>setCustomisedObj</strong>(<a href='/3/viewabledata'>ViewableData</a> $object) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td><a href='/3/viewabledata'>ViewableData</a></td> <td>$object</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_castingHelperPair"> <div class="location">in <a href='/3/viewabledata#method_castingHelperPair'>ViewableData</a> at line 296</div> <code> array <strong>castingHelperPair</strong>(string $field) </code> </h3> <div class="details"> <div class="method-description"> <p>Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).</p> <p>The returned array contains two keys: - className: the class the field would be casted to (e.g. "Varchar") - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$field</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_castingHelper"> <div class="location">in <a href='/3/viewabledata#method_castingHelper'>ViewableData</a> at line 308</div> <code> string <strong>castingHelper</strong>(string $field) </code> </h3> <div class="details"> <div class="method-description"> <p>Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$field</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_castingClass"> <div class="location">in <a href='/3/viewabledata#method_castingClass'>ViewableData</a> at line 331</div> <code> string <strong>castingClass</strong>(string $field) </code> </h3> <div class="details"> <div class="method-description"> <p>Get the class name a field on this object will be casted to</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$field</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_escapeTypeForField"> <div class="location">in <a href='/3/viewabledata#method_escapeTypeForField'>ViewableData</a> at line 346</div> <code> string <strong>escapeTypeForField</strong>(string $field) </code> </h3> <div class="details"> <div class="method-description"> <p>Return the string-format type for the given field.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$field</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>'xml'|'raw'</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_buildCastingCache"> <div class="location">in <a href='/3/viewabledata#method_buildCastingCache'>ViewableData</a> at line 357</div> <code> <strong>buildCastingCache</strong>(reference $cache) </code> </h3> <div class="details"> <div class="method-description"> <p>Save the casting cache for this object (including data from any failovers) into a variable</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>reference</td> <td>$cache</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_renderWith"> <div class="location">in <a href='/3/viewabledata#method_renderWith'>ViewableData</a> at line 394</div> <code> <a href='/3/htmltext'>HTMLText</a> <strong>renderWith</strong>(string|array|<a href='/3/ssviewer'>SSViewer</a> $template, array $customFields = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string|array|<a href='/3/ssviewer'>SSViewer</a></td> <td>$template</td> <td>the template to render into</td> </tr> <tr> <td>array</td> <td>$customFields</td> <td>fields to customise() the object with before rendering</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/htmltext'>HTMLText</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_obj"> <div class="location">in <a href='/3/viewabledata#method_obj'>ViewableData</a> at line 456</div> <code> <strong>obj</strong>(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$fieldName</td> <td></td> </tr> <tr> <td>array</td> <td>$arguments</td> <td></td> </tr> <tr> <td>bool</td> <td>$forceReturnedObject</td> <td>if TRUE, the value will ALWAYS be casted to an object before being returned, even if there is no explicit casting information</td> </tr> <tr> <td>bool</td> <td>$cache</td> <td>Cache this object</td> </tr> <tr> <td>string</td> <td>$cacheName</td> <td>a custom cache name</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_cachedCall"> <div class="location">in <a href='/3/viewabledata#method_cachedCall'>ViewableData</a> at line 503</div> <code> <strong>cachedCall</strong>(string $field, array $arguments = null, string $identifier = null) </code> </h3> <div class="details"> <div class="method-description"> <p>A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$field</td> <td></td> </tr> <tr> <td>array</td> <td>$arguments</td> <td></td> </tr> <tr> <td>string</td> <td>$identifier</td> <td>an optional custom cache identifier</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_hasValue"> <div class="location">in <a href='/3/viewabledata#method_hasValue'>ViewableData</a> at line 516</div> <code> bool <strong>hasValue</strong>(string $field, array $arguments = null, bool $cache = true) </code> </h3> <div class="details"> <div class="method-description"> <p>Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$field</td> <td></td> </tr> <tr> <td>array</td> <td>$arguments</td> <td></td> </tr> <tr> <td>bool</td> <td>$cache</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_XML_val"> <div class="location">in <a href='/3/viewabledata#method_XML_val'>ViewableData</a> at line 538</div> <code> <strong>XML_val</strong>($field, $arguments = null, $cache = false) </code> </h3> <div class="details"> <div class="method-description"> <p>Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$field</td> <td></td> </tr> <tr> <td></td> <td>$arguments</td> <td></td> </tr> <tr> <td></td> <td>$cache</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_RAW_val"> <div class="location">in <a href='/3/viewabledata#method_RAW_val'>ViewableData</a> at line 546</div> <code> <strong>RAW_val</strong>($field, $arguments = null, $cache = true) </code> </h3> <div class="details"> <div class="method-description"> <p>Return the value of the field without any escaping being applied.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$field</td> <td></td> </tr> <tr> <td></td> <td>$arguments</td> <td></td> </tr> <tr> <td></td> <td>$cache</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_SQL_val"> <div class="location">in <a href='/3/viewabledata#method_SQL_val'>ViewableData</a> at line 553</div> <code> <strong>SQL_val</strong>($field, $arguments = null, $cache = true) </code> </h3> <div class="details"> <div class="method-description"> <p>Return the value of a field in an SQL-safe format.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$field</td> <td></td> </tr> <tr> <td></td> <td>$arguments</td> <td></td> </tr> <tr> <td></td> <td>$cache</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_JS_val"> <div class="location">in <a href='/3/viewabledata#method_JS_val'>ViewableData</a> at line 560</div> <code> <strong>JS_val</strong>($field, $arguments = null, $cache = true) </code> </h3> <div class="details"> <div class="method-description"> <p>Return the value of a field in a JavaScript-save format.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$field</td> <td></td> </tr> <tr> <td></td> <td>$arguments</td> <td></td> </tr> <tr> <td></td> <td>$cache</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_ATT_val"> <div class="location">in <a href='/3/viewabledata#method_ATT_val'>ViewableData</a> at line 567</div> <code> <strong>ATT_val</strong>($field, $arguments = null, $cache = true) </code> </h3> <div class="details"> <div class="method-description"> <p>Return the value of a field escaped suitable to be inserted into an XML node attribute.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$field</td> <td></td> </tr> <tr> <td></td> <td>$arguments</td> <td></td> </tr> <tr> <td></td> <td>$cache</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getXMLValues"> <div class="location">in <a href='/3/viewabledata#method_getXMLValues'>ViewableData</a> at line 579</div> <code> array <strong>getXMLValues</strong>($fields) </code> </h3> <div class="details"> <div class="method-description"> <p>Get an array of XML-escaped values by field name</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$fields</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getIterator"> <div class="location">in <a href='/3/viewabledata#method_getIterator'>ViewableData</a> at line 599</div> <code> <a target="_blank" href="http://php.net/ArrayIterator">ArrayIterator</a> <strong>getIterator</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Return a single-item iterator so you can iterate over the fields of a single record.</p> <p>This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a target="_blank" href="http://php.net/ArrayIterator">ArrayIterator</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Me"> <div class="location">in <a href='/3/viewabledata#method_Me'>ViewableData</a> at line 611</div> <code> <a href='/3/viewabledata'>ViewableData</a> <strong>Me</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/viewabledata'>ViewableData</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_ThemeDir"> <div class="location">in <a href='/3/viewabledata#method_ThemeDir'>ViewableData</a> at line 627</div> <code> string <strong>ThemeDir</strong>(string $subtheme = false) </code> </h3> <div class="details"> <div class="method-description"> <p>Return the directory if the current active theme (relative to the site root).</p> <p>This method is useful for things such as accessing theme images from your template without hardcoding the theme page - e.g. <img src="$ThemeDir/images/something.gif">.</p> <p>This method should only be used when a theme is currently active. However, it will fall over to the current project directory.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$subtheme</td> <td>the subtheme path to get</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_CSSClasses"> <div class="location">in <a href='/3/viewabledata#method_CSSClasses'>ViewableData</a> at line 648</div> <code> string <strong>CSSClasses</strong>(string $stopAtClass = 'ViewableData') </code> </h3> <div class="details"> <div class="method-description"> <p>Get part of the current classes ancestry to be used as a CSS class.</p> <p>This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$stopAtClass</td> <td>the class to stop at (default: ViewableData)</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Debug"> <div class="location">in <a href='/3/viewabledata#method_Debug'>ViewableData</a> at line 671</div> <code> <a href='/3/viewabledata_debugger'>ViewableData_Debugger</a> <strong>Debug</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Return debug information about this object that can be rendered into a template</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/viewabledata_debugger'>ViewableData_Debugger</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setDataModel"> <div class="location">in <a href='/3/requesthandler#method_setDataModel'>RequestHandler</a> at line 133</div> <code> <strong>setDataModel</strong>($model) </code> </h3> <div class="details"> <div class="method-description"> <p>Set the DataModel for this request.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$model</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_handleRequest"> <div class="location">in <a href='/3/requesthandler#method_handleRequest'>RequestHandler</a> at line 158</div> <code> <a href='/3/ss_httpresponse'>SS_HTTPResponse</a>|<a href='/3/requesthandler'>RequestHandler</a>|string|array <strong>handleRequest</strong>(<a href='/3/ss_httprequest'>SS_HTTPRequest</a> $request, <a href='/3/datamodel'>DataModel</a> $model) </code> </h3> <div class="details"> <div class="method-description"> <p>Handles URL requests.</p> <p><ul> <li>ViewableData::handleRequest() iterates through each rule in {@link self::$url_handlers}. <ul> <li>If the rule matches, the named method will be called.</li> <li>If there is still more URL to be processed, then handleRequest() is called on the object that that method returns.</li> </ul></li> </ul> <p>Once all of the URL has been processed, the final result is returned. However, if the final result is an array, this array is interpreted as being additional template data to customise the 2nd to last result with, rather than an object in its own right. This is most frequently used when a Controller's action will return an array of data with which to customise the controller.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td><a href='/3/ss_httprequest'>SS_HTTPRequest</a></td> <td>$request</td> <td></td> </tr> <tr> <td><a href='/3/datamodel'>DataModel</a></td> <td>$model</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/ss_httpresponse'>SS_HTTPResponse</a>|<a href='/3/requesthandler'>RequestHandler</a>|string|array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_allowedActions"> <div class="location">in <a href='/3/requesthandler#method_allowedActions'>RequestHandler</a> at line 316</div> <code> array|null <strong>allowedActions</strong>(String $limitToClass = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Get a array of allowed actions defined on this controller, any parent classes or extensions.</p> <p>Caution: Since 3.1, allowed_actions definitions only apply to methods on the controller they're defined on, so it is recommended to use the $class argument when invoking this method.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>String</td> <td>$limitToClass</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array|null</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_hasAction"> <div class="location">in <a href='/3/requesthandler#method_hasAction'>RequestHandler</a> at line 358</div> <code> bool <strong>hasAction</strong>(string $action) </code> </h3> <div class="details"> <div class="method-description"> <p>Checks if this request handler has a specific action, even if the current user cannot access it.</p> <p>Includes class ancestry and extensions in the checks.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$action</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_checkAccessAction"> <div class="location">in <a href='/3/requesthandler#method_checkAccessAction'>RequestHandler</a> at line 413</div> <code> <strong>checkAccessAction</strong>($action) </code> </h3> <div class="details"> <div class="method-description"> <p>Check that the given action is allowed to be called from a URL.</p> <p>It will interrogate {@link self::$allowed_actions} to determine this.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$action</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_httpError"> <div class="location">in <a href='/3/requesthandler#method_httpError'>RequestHandler</a> at line 472</div> <code> <strong>httpError</strong>(int $errorCode, string $errorMessage = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Throws a HTTP error response encased in a {@link SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>int</td> <td>$errorCode</td> <td></td> </tr> <tr> <td>string</td> <td>$errorMessage</td> <td>Plaintext error message</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getRequest"> <div class="location">in <a href='/3/requesthandler#method_getRequest'>RequestHandler</a> at line 494</div> <code> <a href='/3/ss_httprequest'>SS_HTTPRequest</a>|<a href='/3/nullhttprequest'>NullHTTPRequest</a> <strong>getRequest</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the SS_HTTPRequest object that this controller is using.</p> <p>Returns a placeholder {@link NullHTTPRequest} object unless {@link handleAction()} or {@link handleRequest()} have been called, which adds a reference to an actual {@link SS_HTTPRequest} object.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/ss_httprequest'>SS_HTTPRequest</a>|<a href='/3/nullhttprequest'>NullHTTPRequest</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setRequest"> <div class="location">in <a href='/3/requesthandler#method_setRequest'>RequestHandler</a> at line 504</div> <code> <strong>setRequest</strong>(<a href='/3/ss_httprequest'>SS_HTTPRequest</a> $request) </code> </h3> <div class="details"> <div class="method-description"> <p>Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td><a href='/3/ss_httprequest'>SS_HTTPRequest</a></td> <td>$request</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Link"> <div class="location">in <a href='/3/formfield#method_Link'>FormField</a> at line 276</div> <code> string <strong>Link</strong>(string $action = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Return a link to this field.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$action</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_name_to_label"> <div class="location">in <a href='/3/formfield#method_name_to_label'>FormField</a> at line 188</div> <code> static string <strong>name_to_label</strong>(string $fieldName) </code> </h3> <div class="details"> <div class="method-description"> <p>Takes a field name and converts camelcase to spaced words. Also resolves combined field names with dot syntax to spaced words.</p> <p>Examples:</p> <ul> <li>'TotalAmount' will return 'Total Amount'</li> <li>'Organisation.ZipCode' will return 'Organisation Zip Code'</li> </ul> </p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$fieldName</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_create_tag"> <div class="location">in <a href='/3/formfield#method_create_tag'>FormField</a> at line 209</div> <code> static string <strong>create_tag</strong>(string $tag, array $attributes, null|string $content = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Construct and return HTML tag.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$tag</td> <td></td> </tr> <tr> <td>array</td> <td>$attributes</td> <td></td> </tr> <tr> <td>null|string</td> <td>$content</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_ID"> <div class="location">in <a href='/3/formfield#method_ID'>FormField</a> at line 290</div> <code> string <strong>ID</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the HTML ID of the field.</p> <p>The ID is generated as FormName_FieldName. All Field functions should ensure that this ID is included in the field.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_HolderID"> <div class="location">in <a href='/3/formfield#method_HolderID'>FormField</a> at line 299</div> <code> string <strong>HolderID</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the HTML ID for the form field holder element.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getTemplateHelper"> <div class="location">in <a href='/3/formfield#method_getTemplateHelper'>FormField</a> at line 312</div> <code> <a href='/3/formtemplatehelper'>FormTemplateHelper</a> <strong>getTemplateHelper</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the current {@link FormTemplateHelper} on either the parent Form or the global helper set through the {@link Injector} layout.</p> <p>To customize a single {@link FormField}, use {@link setTemplate} and provide a custom template name.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/formtemplatehelper'>FormTemplateHelper</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getName"> <div class="location">in <a href='/3/formfield#method_getName'>FormField</a> at line 325</div> <code> string <strong>getName</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the field name.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Message"> <div class="location">in <a href='/3/formfield#method_Message'>FormField</a> at line 336</div> <code> string <strong>Message</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the field message, used by form validation.</p> <p>Use {@link setError()} to set this property.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_MessageType"> <div class="location">in <a href='/3/formfield#method_MessageType'>FormField</a> at line 349</div> <code> string <strong>MessageType</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the field message type.</p> <p>Arbitrary value which is mostly used for CSS classes in the rendered HTML, e.g "required".</p> <p>Use {@link setError()} to set this property.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Value"> <div class="location">at line 105</div> <code> mixed <strong>Value</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Return value with all values encoded in html entities</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_saveInto"> <div class="location">in <a href='/3/formfield#method_saveInto'>FormField</a> at line 369</div> <code> <strong>saveInto</strong>(<a href='/3/dataobjectinterface'>DataObjectInterface</a> $record) </code> </h3> <div class="details"> <div class="method-description"> <p>Method to save this form field into the given {@link DataObject}.</p> <p>By default, makes use of $this->dataValue()</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td><a href='/3/dataobjectinterface'>DataObjectInterface</a></td> <td>$record</td> <td>DataObject to save data into</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_dataValue"> <div class="location">in <a href='/3/formfield#method_dataValue'>FormField</a> at line 380</div> <code> mixed <strong>dataValue</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the field value suitable for insertion into the data object.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Title"> <div class="location">in <a href='/3/formfield#method_Title'>FormField</a> at line 389</div> <code> string <strong>Title</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the field label - used by templates.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setTitle"> <div class="location">in <a href='/3/formfield#method_setTitle'>FormField</a> at line 398</div> <code> $this <strong>setTitle</strong>(string $title) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$title</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_RightTitle"> <div class="location">in <a href='/3/formfield#method_RightTitle'>FormField</a> at line 410</div> <code> string <strong>RightTitle</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Gets the contextual label than can be used for additional field description.</p> <p>Can be shown to the right or under the field in question.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>Contextual label text.</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setRightTitle"> <div class="location">in <a href='/3/formfield#method_setRightTitle'>FormField</a> at line 419</div> <code> $this <strong>setRightTitle</strong>(string $rightTitle) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$rightTitle</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_LeftTitle"> <div class="location">in <a href='/3/formfield#method_LeftTitle'>FormField</a> at line 428</div> <code> string <strong>LeftTitle</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setLeftTitle"> <div class="location">in <a href='/3/formfield#method_setLeftTitle'>FormField</a> at line 437</div> <code> $this <strong>setLeftTitle</strong>(string $leftTitle) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$leftTitle</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_extraClass"> <div class="location">in <a href='/3/formfield#method_extraClass'>FormField</a> at line 452</div> <code> string <strong>extraClass</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Compiles all CSS-classes. Optionally includes a "nolabel" class if no title was set on the FormField.</p> <p>Uses {@link Message()} and {@link MessageType()} to add validation error classes which can be used to style the contained tags.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_addExtraClass"> <div class="location">in <a href='/3/formfield#method_addExtraClass'>FormField</a> at line 490</div> <code> $this <strong>addExtraClass</strong>(string $class) </code> </h3> <div class="details"> <div class="method-description"> <p>Add one or more CSS-classes to the FormField container.</p> <p>Multiple class names should be space delimited.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$class</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_removeExtraClass"> <div class="location">in <a href='/3/formfield#method_removeExtraClass'>FormField</a> at line 507</div> <code> $this <strong>removeExtraClass</strong>(string $class) </code> </h3> <div class="details"> <div class="method-description"> <p>Remove one or more CSS-classes from the FormField container.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$class</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setAttribute"> <div class="location">in <a href='/3/formfield#method_setAttribute'>FormField</a> at line 536</div> <code> $this <strong>setAttribute</strong>(string $name, string $value) </code> </h3> <div class="details"> <div class="method-description"> <p>Set an HTML attribute on the field element, mostly an input tag.</p> <p>Some attributes are best set through more specialized methods, to avoid interfering with built-in behaviour:</p> <ul> <li>'class': {@link addExtraClass()}</li> <li>'title': {@link setDescription()}</li> <li>'value': {@link setValue}</li> <li>'name': {@link setName}</li> </ul> <p>Caution: this doesn't work on most fields which are composed of more than one HTML form field.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$name</td> <td></td> </tr> <tr> <td>string</td> <td>$value</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getAttribute"> <div class="location">in <a href='/3/formfield#method_getAttribute'>FormField</a> at line 549</div> <code> null|string <strong>getAttribute</strong>($name) </code> </h3> <div class="details"> <div class="method-description"> <p>Get an HTML attribute defined by the field, or added through {@link setAttribute()}.</p> <p>Caution: this doesn't work on all fields, see {@link setAttribute()}.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td></td> <td>$name</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>null|string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getAttributes"> <div class="location">at line 74</div> <code> array <strong>getAttributes</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Allows customization through an 'updateAttributes' hook on the base class.</p> <p>Existing attributes are passed in as the first argument and can be manipulated, but any attributes added through a subclass implementation won't be included.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getAttributesHTML"> <div class="location">in <a href='/3/formfield#method_getAttributesHTML'>FormField</a> at line 598</div> <code> string <strong>getAttributesHTML</strong>(array $attributes = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Custom attributes to process. Falls back to {@link getAttributes()}.</p> <p>If at least one argument is passed as a string, all arguments act as excludes, by name.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>array</td> <td>$attributes</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_attrTitle"> <div class="location">in <a href='/3/formfield#method_attrTitle'>FormField</a> at line 641</div> <code> string <strong>attrTitle</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns a version of a title suitable for insertion into an HTML attribute.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_attrValue"> <div class="location">in <a href='/3/formfield#method_attrValue'>FormField</a> at line 650</div> <code> string <strong>attrValue</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns a version of a title suitable for insertion into an HTML attribute.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setValue"> <div class="location">in <a href='/3/formfield#method_setValue'>FormField</a> at line 661</div> <code> $this <strong>setValue</strong>(mixed $value) </code> </h3> <div class="details"> <div class="method-description"> <p>Set the field value.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td>$value</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setName"> <div class="location">in <a href='/3/formfield#method_setName'>FormField</a> at line 674</div> <code> $this <strong>setName</strong>(string $name) </code> </h3> <div class="details"> <div class="method-description"> <p>Set the field name.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$name</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setForm"> <div class="location">in <a href='/3/formfield#method_setForm'>FormField</a> at line 689</div> <code> $this <strong>setForm</strong>(<a href='/3/form'>Form</a> $form) </code> </h3> <div class="details"> <div class="method-description"> <p>Set the container form.</p> <p>This is called automatically when fields are added to forms.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td><a href='/3/form'>Form</a></td> <td>$form</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getForm"> <div class="location">in <a href='/3/formfield#method_getForm'>FormField</a> at line 700</div> <code> <a href='/3/form'>Form</a> <strong>getForm</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Get the currently used form.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/form'>Form</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_securityTokenEnabled"> <div class="location">in <a href='/3/formfield#method_securityTokenEnabled'>FormField</a> at line 709</div> <code> bool <strong>securityTokenEnabled</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Return true if security token protection is enabled on the parent {@link Form}.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setError"> <div class="location">in <a href='/3/formfield#method_setError'>FormField</a> at line 729</div> <code> $this <strong>setError</strong>(string $message, string $messageType) </code> </h3> <div class="details"> <div class="method-description"> <p>Sets the error message to be displayed on the form field.</p> <p>Allows HTML content, so remember to use Convert::raw2xml().</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$message</td> <td></td> </tr> <tr> <td>string</td> <td>$messageType</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setCustomValidationMessage"> <div class="location">in <a href='/3/formfield#method_setCustomValidationMessage'>FormField</a> at line 745</div> <code> $this <strong>setCustomValidationMessage</strong>(string $customValidationMessage) </code> </h3> <div class="details"> <div class="method-description"> <p>Set the custom error message to show instead of the default format.</p> <p>Different from setError() as that appends it to the standard error messaging.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$customValidationMessage</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getCustomValidationMessage"> <div class="location">in <a href='/3/formfield#method_getCustomValidationMessage'>FormField</a> at line 757</div> <code> string <strong>getCustomValidationMessage</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Get the custom error message for this form field. If a custom message has not been defined then just return blank. The default error is defined on {@link Validator}.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setTemplate"> <div class="location">in <a href='/3/formfield#method_setTemplate'>FormField</a> at line 771</div> <code> $this <strong>setTemplate</strong>(string $template) </code> </h3> <div class="details"> <div class="method-description"> <p>Set name of template (without path or extension).</p> <p>Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$template</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getTemplate"> <div class="location">in <a href='/3/formfield#method_getTemplate'>FormField</a> at line 780</div> <code> string <strong>getTemplate</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getFieldHolderTemplate"> <div class="location">in <a href='/3/formfield#method_getFieldHolderTemplate'>FormField</a> at line 787</div> <code> string <strong>getFieldHolderTemplate</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setFieldHolderTemplate"> <div class="location">in <a href='/3/formfield#method_setFieldHolderTemplate'>FormField</a> at line 802</div> <code> $this <strong>setFieldHolderTemplate</strong>(string $fieldHolderTemplate) </code> </h3> <div class="details"> <div class="method-description"> <p>Set name of template (without path or extension) for the holder, which in turn is responsible for rendering {@link Field()}.</p> <p>Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$fieldHolderTemplate</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getSmallFieldHolderTemplate"> <div class="location">in <a href='/3/formfield#method_getSmallFieldHolderTemplate'>FormField</a> at line 811</div> <code> string <strong>getSmallFieldHolderTemplate</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setSmallFieldHolderTemplate"> <div class="location">in <a href='/3/formfield#method_setSmallFieldHolderTemplate'>FormField</a> at line 826</div> <code> $this <strong>setSmallFieldHolderTemplate</strong>(string $smallFieldHolderTemplate) </code> </h3> <div class="details"> <div class="method-description"> <p>Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering {@link Field()}.</p> <p>Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$smallFieldHolderTemplate</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Field"> <div class="location">in <a href='/3/formfield#method_Field'>FormField</a> at line 844</div> <code> string <strong>Field</strong>(array $properties = array()) </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the form field.</p> <p>Although FieldHolder is generally what is inserted into templates, all of the field holder templates make use of $Field. It's expected that FieldHolder will give you the "complete" representation of the field on the form, whereas Field will give you the core editing widget, such as an input tag.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>array</td> <td>$properties</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_FieldHolder"> <div class="location">in <a href='/3/formfield#method_FieldHolder'>FormField</a> at line 878</div> <code> string <strong>FieldHolder</strong>(array $properties = array()) </code> </h3> <div class="details"> <div class="method-description"> <p>Returns a "field holder" for this field.</p> <p>Forms are constructed by concatenating a number of these field holders.</p> <p>The default field holder is a label and a form field inside a div.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>array</td> <td>$properties</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> <h4>See also</h4> <table class="table table-condensed"> <tr> <td>FieldHolder.ss</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_SmallFieldHolder"> <div class="location">in <a href='/3/formfield#method_SmallFieldHolder'>FormField</a> at line 895</div> <code> string <strong>SmallFieldHolder</strong>(array $properties = array()) </code> </h3> <div class="details"> <div class="method-description"> <p>Returns a restricted field holder used within things like FieldGroups.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>array</td> <td>$properties</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getTemplates"> <div class="location">in <a href='/3/formfield#method_getTemplates'>FormField</a> at line 910</div> <code> array <strong>getTemplates</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns an array of templates to use for rendering {@link FieldHolder}.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getFieldHolderTemplates"> <div class="location">in <a href='/3/formfield#method_getFieldHolderTemplates'>FormField</a> at line 919</div> <code> array <strong>getFieldHolderTemplates</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns an array of templates to use for rendering {@link FieldHolder}.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getSmallFieldHolderTemplates"> <div class="location">in <a href='/3/formfield#method_getSmallFieldHolderTemplates'>FormField</a> at line 931</div> <code> array <strong>getSmallFieldHolderTemplates</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns an array of templates to use for rendering {@link SmallFieldHolder}.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_isComposite"> <div class="location">in <a href='/3/formfield#method_isComposite'>FormField</a> at line 972</div> <code> bool <strong>isComposite</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns true if this field is a composite field.</p> <p>To create composite field types, you should subclass {@link CompositeField}.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_hasData"> <div class="location">in <a href='/3/formfield#method_hasData'>FormField</a> at line 987</div> <code> bool <strong>hasData</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns true if this field has its own data.</p> <p>Some fields, such as titles and composite fields, don't actually have any data. It doesn't make sense for data-focused methods to look at them. By overloading hasData() to return false, you can prevent any data-focused methods from looking at it.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> <h4>See also</h4> <table class="table table-condensed"> <tr> <td>FieldList::collateDataFields()</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_isReadonly"> <div class="location">in <a href='/3/formfield#method_isReadonly'>FormField</a> at line 994</div> <code> bool <strong>isReadonly</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setReadonly"> <div class="location">in <a href='/3/formfield#method_setReadonly'>FormField</a> at line 1009</div> <code> $this <strong>setReadonly</strong>(bool $readonly) </code> </h3> <div class="details"> <div class="method-description"> <p>Sets a read-only flag on this FormField.</p> <p>Use performReadonlyTransformation() to transform this instance.</p> <p>Setting this to false has no effect on the field.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td>$readonly</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_isDisabled"> <div class="location">in <a href='/3/formfield#method_isDisabled'>FormField</a> at line 1018</div> <code> bool <strong>isDisabled</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setDisabled"> <div class="location">in <a href='/3/formfield#method_setDisabled'>FormField</a> at line 1033</div> <code> $this <strong>setDisabled</strong>(bool $disabled) </code> </h3> <div class="details"> <div class="method-description"> <p>Sets a disabled flag on this FormField.</p> <p>Use performDisabledTransformation() to transform this instance.</p> <p>Setting this to false has no effect on the field.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td>$disabled</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_performReadonlyTransformation"> <div class="location">in <a href='/3/formfield#method_performReadonlyTransformation'>FormField</a> at line 1044</div> <code> <a href='/3/formfield'>FormField</a> <strong>performReadonlyTransformation</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns a read-only version of this field.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/formfield'>FormField</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_performDisabledTransformation"> <div class="location">in <a href='/3/formfield#method_performDisabledTransformation'>FormField</a> at line 1066</div> <code> <a href='/3/formfield'>FormField</a> <strong>performDisabledTransformation</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Return a disabled version of this field.</p> <p>Tries to find a class of the class name of this field suffixed with "_Disabled", failing that, finds a method {@link setDisabled()}.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/formfield'>FormField</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_transform"> <div class="location">in <a href='/3/formfield#method_transform'>FormField</a> at line 1085</div> <code> mixed <strong>transform</strong>(<a href='/3/formtransformation'>FormTransformation</a> $transformation) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td><a href='/3/formtransformation'>FormTransformation</a></td> <td>$transformation</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_hasClass"> <div class="location">in <a href='/3/formfield#method_hasClass'>FormField</a> at line 1094</div> <code> int <strong>hasClass</strong>(string $class) </code> </h3> <div class="details"> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$class</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>int</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Type"> <div class="location">at line 90</div> <code> string <strong>Type</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the field type.</p> <p>The field type is the class name with the word Field dropped off the end, all lowercase.</p> <p>It's handy for assigning HTML classes. Doesn't signify the input type attribute.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_createTag"> <div class="location">in <a href='/3/formfield#method_createTag'>FormField</a> at line 1126</div> <code> string <strong>createTag</strong>(string $tag, array $attributes, null|string $content = null) <small>^{<span class="label label-danger">deprecated</span>}</small></code> </h3> <div class="details"> <p> <small>^{<span class="label label-danger">deprecated</span>}</small> <tr> <td>4.0</td> <td>Use FormField::create_tag()</td> </tr> </p> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$tag</td> <td></td> </tr> <tr> <td>array</td> <td>$attributes</td> <td></td> </tr> <tr> <td>null|string</td> <td>$content</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_validate"> <div class="location">in <a href='/3/formfield#method_validate'>FormField</a> at line 1142</div> <code> bool <strong>validate</strong>(<a href='/3/validator'>Validator</a> $validator) </code> </h3> <div class="details"> <div class="method-description"> <p>Abstract method each {@link FormField} subclass must implement, determines whether the field is valid or not based on the value.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td><a href='/3/validator'>Validator</a></td> <td>$validator</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setDescription"> <div class="location">in <a href='/3/formfield#method_setDescription'>FormField</a> at line 1155</div> <code> $this <strong>setDescription</strong>(string $description) </code> </h3> <div class="details"> <div class="method-description"> <p>Describe this field, provide help text for it.</p> <p>By default, renders as a span class="description" underneath the form field.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$description</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getDescription"> <div class="location">in <a href='/3/formfield#method_getDescription'>FormField</a> at line 1164</div> <code> string <strong>getDescription</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_debug"> <div class="location">in <a href='/3/formfield#method_debug'>FormField</a> at line 1171</div> <code> string <strong>debug</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_forTemplate"> <div class="location">in <a href='/3/formfield#method_forTemplate'>FormField</a> at line 1188</div> <code> string <strong>forTemplate</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Required"> <div class="location">in <a href='/3/formfield#method_Required'>FormField</a> at line 1195</div> <code> bool <strong>Required</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setContainerFieldList"> <div class="location">in <a href='/3/formfield#method_setContainerFieldList'>FormField</a> at line 1210</div> <code> <a href='/3/fieldlist'>FieldList</a> <strong>setContainerFieldList</strong>(<a href='/3/fieldlist'>FieldList</a> $containerFieldList) </code> </h3> <div class="details"> <div class="method-description"> <p>Set the FieldList that contains this field.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td><a href='/3/fieldlist'>FieldList</a></td> <td>$containerFieldList</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/fieldlist'>FieldList</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getContainerFieldList"> <div class="location">in <a href='/3/formfield#method_getContainerFieldList'>FormField</a> at line 1221</div> <code> <a href='/3/fieldlist'>FieldList</a> <strong>getContainerFieldList</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Get the FieldList that contains this field.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/fieldlist'>FieldList</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_rootFieldList"> <div class="location">in <a href='/3/formfield#method_rootFieldList'>FormField</a> at line 1228</div> <code> null|<a href='/3/fieldlist'>FieldList</a> <strong>rootFieldList</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>null|<a href='/3/fieldlist'>FieldList</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_castedCopy"> <div class="location">in <a href='/3/formfield#method_castedCopy'>FormField</a> at line 1256</div> <code> <a href='/3/formfield'>FormField</a> <strong>castedCopy</strong>(mixed $classOrCopy) </code> </h3> <div class="details"> <div class="method-description"> <p>Returns another instance of this field, but "cast" to a different class. The logic tries to retain all of the instance properties, and may be overloaded by subclasses to set additional ones.</p> <p>Assumes the standard FormField parameter signature with its name as the only mandatory argument. Mainly geared towards creating *_Readonly or *_Disabled subclasses of the same type, or casting to a {@link ReadonlyField}.</p> <p>Does not copy custom field templates, since they probably won't apply to the new instance.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>mixed</td> <td>$classOrCopy</td> <td>Class name for copy, or existing copy instance to update</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href='/3/formfield'>FormField</a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_canSubmitValue"> <div class="location">in <a href='/3/formfield#method_canSubmitValue'>FormField</a> at line 1288</div> <code> bool <strong>canSubmitValue</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Determine if the value of this formfield accepts front-end submitted values and is saveable.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setRows"> <div class="location">at line 52</div> <code> $this <strong>setRows</strong>(int $rows) </code> </h3> <div class="details"> <div class="method-description"> <p>Set the number of rows in the textarea</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>int</td> <td>$rows</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setColumns"> <div class="location">at line 65</div> <code> $this <strong>setColumns</strong>(int $cols) </code> </h3> <div class="details"> <div class="method-description"> <p>Set the number of columns in the textarea</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>int</td> <td>$cols</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>$this</td> <td></td> </tr> </table> </div> </div> </div> </div> </div> <div id="footer"> Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>. </div> </div> </div> <script src="js/bootstrap.min.js"></script> <script src="js/typeahead.min.js"></script> <script src="sami.js"></script> </body> </html>