Class Boolean

Represents a boolean field.

Object

Extended by

ViewableData implements IteratorAggregate

Extended by

DBField

Extended by

Boolean

Package: sapphire\model
Located at sapphire/core/model/fieldtypes/Boolean.php

Methods summary

`public`	# `__construct( mixed $name, mixed $defaultVal = 0 )` Overrides `DBField::__construct`
`public`	# `requireField( )` Add the field to the underlying database. Add the field to the underlying database.
`public`	# `Nice( )`
`public`	# `NiceAsBoolean( )`
`public`	# `saveInto( mixed $dataObject )` Saves this field to the given data object. Saves this field to the given data object. Overrides `DBField::saveInto`
`public FormField`	# `scaffoldFormField( string $title = null, mixed $params = null )` Returns a FormField instance used as a default for form scaffolding. Returns a FormField instance used as a default for form scaffolding. Used by `SearchContext`, `ModelAdmin`, `DataObject::scaffoldFormFields()` Parameters `$title` string $title Optional. Localized title of the generated instance `$params` Returns `FormField` FormField Overrides `DBField::scaffoldFormField`
`public FormField`	# `scaffoldSearchField( string $title = null )` Returns a FormField instance used as a default for searchform scaffolding. Returns a FormField instance used as a default for searchform scaffolding. Used by `SearchContext`, `ModelAdmin`, `DataObject::scaffoldFormFields()`. Parameters `$title` string $title Optional. Localized title of the generated instance Returns `FormField` FormField Overrides `DBField::scaffoldSearchField`
`public string`	# `prepValueForDB( mixed $value )` Return an encoding of the given value suitable for inclusion in a SQL statement. If necessary, this should include quotes. Return an encoding of the given value suitable for inclusion in a SQL statement. If necessary, this should include quotes. Parameters `$value` $value mixed The value to check Returns `string` The encoded value Overrides `DBField::prepValueForDB`
`public`	# `nullValue( )` Returns the value to be set in the database to blank this field. Usually it's a choice between null, 0, and '' Returns the value to be set in the database to blank this field. Usually it's a choice between null, 0, and '' Overrides `DBField::nullValue`

Methods inherited from DBField

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

Methods inherited from ViewableData

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

Methods inherited from Object

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

Magic methods summary

Properties summary

Properties inherited from DBField

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

Properties inherited from ViewableData

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

Properties inherited from Object

$class, $extension_instances, $extensions

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -