Class ForeignKey

A special type Int field used for foreign keys in has_one relationships.

Object

Extended by

ViewableData implements IteratorAggregate

Extended by

DBField

Extended by

Int

Extended by

ForeignKey

Package: sapphire\model
Uses: ImageField
Uses: SimpleImageField
Uses: FileIFrameField
Uses: DropdownField
Param: string $name
Param: DataOject $object The object that the foreign key is stored on (should have a relation with $name)
Located at sapphire/core/model/fieldtypes/ForeignKey.php

Methods summary

`public`	# `__construct( mixed $name, mixed $object = null )` Overrides `Int::__construct`
`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 `Int::scaffoldFormField`

Methods inherited from Int

Formatted(), Nice(), Times(), nullValue(), prepValueForDB(), requireField()

Methods inherited from DBField

ATT(), HTML(), HTMLATT(), JS(), LowerCase(), RAW(), RAWURLATT(), URLATT(), UpperCase(), XML(), addToQuery(), create(), debug(), defaultSearchFilter(), exists(), forTemplate(), getName(), getValue(), hasValue(), saveInto(), scaffoldSearchField(), 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

`protected DataObject`	`$object`	#
`public static string`	`$default_search_filter_class`	# Subclass of `SearchFilter` for usage in `DBField::defaultSearchFilter()`. Subclass of `SearchFilter` for usage in `DBField::defaultSearchFilter()`.

Properties inherited from Int

$decimal_sep, $thousand_sep

Properties inherited from DBField

$arrayValue, $defaultVal, $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. -