Version: current

# Package sapphire\model

## Classes summary

AdditionalMenuWidget_Item | A single database record & abstract class for the data-access-model.
AdvancedSliderHomepageWidget_Item | A single database record & abstract class for the data-access-model.
AssetManagerFolder | Plug-ins for additional functionality in your DataObjects.
BannerWidget_Item | A single database record & abstract class for the data-access-model.
BaseObjectDecorator | Plug-ins for additional functionality in your DataObjects.
BookingOrder | A single database record & abstract class for the data-access-model.
BookingPaymentMethod | A single database record & abstract class for the data-access-model.
BookingService | A single database record & abstract class for the data-access-model.
Boolean | Represents a boolean field.
ButtonsBlockHomepageWidget_Item | A single database record & abstract class for the data-access-model.
CarouselHomepageWidget_Item | A single database record & abstract class for the data-access-model.
CatalogFilter | A single database record & abstract class for the data-access-model.
CatalogRubricsHomepageWidget_CatalogDecorator | Plug-ins for additional functionality in your DataObjects.
ClientEmailOrderNotification | Plug-ins for additional functionality in your DataObjects.
ClientVKOrderNotification | Plug-ins for additional functionality in your DataObjects.
ComponentSet | This is a special kind of DataObjectSet used to represent the items linked to in a 1-many or many-many join. It provides add and remove methods that will update the database.
Currency | Represents a decimal field containing a currency amount. Currency the currency class only supports single currencies.
DatabaseAdmin | DatabaseAdmin class
DataObject | A single database record & abstract class for the data-access-model.
DataObjectDecorator | Plug-ins for additional functionality in your DataObjects.
DataObjectLog | A DataObjectLog is a log of changes that have been made to the database in this session. It was designed to help with updates to the CMS tree, and could be used wherever an Ajax call needs to update a complex on-screen representation of your data.
DataObjectSet | This class represents a set of `ViewableData` subclasses (mostly `DataObject` or `ArrayData`). It is used by the ORM-layer of Silverstripe to return query-results from `SQLQuery`.
DataObjectSet_Iterator | An Iterator for a DataObjectSet
Date | Represents a date field. The field currently supports New Zealand date format (DD/MM/YYYY), or an ISO 8601 formatted date (YYYY-MM-DD). Alternatively you can set a timestamp that is evaluated through PHP's built-in date() function according to your system locale.
DB | Global database interface, complete with static methods. Use this class for interacting with the database.
DBField | Single field in the database. Every field from the database is represented as a sub-class of DBField.
Decimal | Single field in the database. Every field from the database is represented as a sub-class of DBField.
DocumentItem | A single database record & abstract class for the data-access-model.
DocumentPage_File | A single database record & abstract class for the data-access-model.
Double |
Enum | Represents an enumeration field.
ErrorPageSubsite | Plug-ins for additional functionality in your DataObjects.
FileDataObjectTrackingDecorator | Plug-ins for additional functionality in your DataObjects.
FileImportDecorator | Plug-ins for additional functionality in your DataObjects.
Float | Represents a floating point field.
FlowerGarden_Size | A single database record & abstract class for the data-access-model.
ForeignKey | A special type Int field used for foreign keys in has_one relationships.
Hierarchy | DataObjects that use the Hierachy decorator can be be organised as a hierachy, with children and parents. The most obvious example of this is SiteTree.
HouseCatalogProductDecorator | Plug-ins for additional functionality in your DataObjects.
HTMLText | Represents a large text field that contains HTML content.
HTMLVarchar | Represents a short text field that is intended to contain HTML content.
Import1CLog | A single database record & abstract class for the data-access-model.
Import1CLog_File | A single database record & abstract class for the data-access-model.
Import1CLog_Item | A single database record & abstract class for the data-access-model.
Import1CLog_Task | A single database record & abstract class for the data-access-model.
ImportCatalog1C_PriceType | A single database record & abstract class for the data-access-model.
ImportCatalog1C_ProductProp | A single database record & abstract class for the data-access-model.
Int | Represents an integer field.
ManagerEmailOrderNotification | Plug-ins for additional functionality in your DataObjects.
Material3D_File | A single database record & abstract class for the data-access-model.
MediawebPage_File | A single database record & abstract class for the data-access-model.
MediawebPage_Photo | A single database record & abstract class for the data-access-model.
MobileContentDecorator | Plug-ins for additional functionality in your DataObjects.
Money | Implements the "Money" pattern.
MonumentGalleryItem | A single database record & abstract class for the data-access-model.
MonumentPhotoGallery | A single database record & abstract class for the data-access-model.
MultiEnum | Represents an multi-select enumeration field.
MySQLDatabase | MySQL connector class.
MySQLQuery | A result-set from a MySQL database.
Notification | A single database record & abstract class for the data-access-model.
OrderDataObject | A single database record & abstract class for the data-access-model.
OrderDecorator | Plug-ins for additional functionality in your DataObjects.
OrderHandlersDecorator | Plug-ins for additional functionality in your DataObjects.
OrderItemDecorator | Plug-ins for additional functionality in your DataObjects.
OrderItemVariationDecorator | Plug-ins for additional functionality in your DataObjects.
Orders1CExchange_OrdersDecorator | Plug-ins for additional functionality in your DataObjects.
OrderService | A single database record & abstract class for the data-access-model.
OrderServiceOrder | A single database record & abstract class for the data-access-model.
PageIcon | Plug-ins for additional functionality in your DataObjects.
PageWidgets | Plug-ins for additional functionality in your DataObjects.
Payment | A single database record & abstract class for the data-access-model.
PaymentMethodShippingDecorator | Plug-ins for additional functionality in your DataObjects.
PaymentOrderExtension | Plug-ins for additional functionality in your DataObjects.
Percentage | Represents a decimal field from 0-1 containing a percentage value.
Person | A single database record & abstract class for the data-access-model.
PhotoAlbumItem | A single database record & abstract class for the data-access-model.
PhotoAlbumProductLinkDecorator | Plug-ins for additional functionality in your DataObjects.
PhotoAlbumWidgetLinkDecorator | Plug-ins for additional functionality in your DataObjects.
PhotoGalleryHomepageWidget_Item | A single database record & abstract class for the data-access-model.
PortraitType | A single database record & abstract class for the data-access-model.
PrimaryKey | A special type Int field used for primary keys.
Product3DDecorator | Plug-ins for additional functionality in your DataObjects.
ProductCatalogCatalogLinkedDecorator | Plug-ins for additional functionality in your DataObjects.
ProductImportLog | A single database record & abstract class for the data-access-model.
ProductImportLog_Item | A single database record & abstract class for the data-access-model.
ProductParam | A single database record & abstract class for the data-access-model.
ProductParamValue | A single database record & abstract class for the data-access-model.
ProductVariation | A single database record & abstract class for the data-access-model.
RatePeriod | A single database record & abstract class for the data-access-model.
RealtyImportLog | A single database record & abstract class for the data-access-model.
RealtyImportLog_Item | A single database record & abstract class for the data-access-model.
RedirectEntry | A single database record & abstract class for the data-access-model.
RoomOrder | A single database record & abstract class for the data-access-model.
RoomOrderPerson | A single database record & abstract class for the data-access-model.
RoomRate | A single database record & abstract class for the data-access-model.
RoomService | A single database record & abstract class for the data-access-model.
RoomServiceOrder | A single database record & abstract class for the data-access-model.
SberbankPaymentDecorator | Plug-ins for additional functionality in your DataObjects.
SeoOpenGraphPageDecorator | Plug-ins for additional functionality in your DataObjects.
ServiceOrder | A single database record & abstract class for the data-access-model.
ShippingMethodPaymentDecorator | Plug-ins for additional functionality in your DataObjects.
ShopCountry | Represents a short text field.
SimpleOrderCatalogDecorator | Plug-ins for additional functionality in your DataObjects.
SimpleOrderProductDecorator | Plug-ins for additional functionality in your DataObjects.
SiteConfigWidgets | Plug-ins for additional functionality in your DataObjects.
SiteTreeDecorator | Plug-ins for additional functionality in your SiteTree classes.
SiteTreeImportDecorator | Plug-ins for additional functionality in your DataObjects.
SliderHomepageWidget_Item | A single database record & abstract class for the data-access-model.
SMSCOrderNotification | Plug-ins for additional functionality in your DataObjects.
SMSOrderNotification | Plug-ins for additional functionality in your DataObjects.
SortableDataObject | Plug-ins for additional functionality in your DataObjects.
SQLMap | This is a class used to represent key->value pairs generated from database queries. The query isn't actually executed until you need it.
SQLMap_Iterator |
SQLQuery | Object representing a SQL query. The various parts of the SQL query can be manipulated individually.
SS_Database | Abstract database connectivity class. Sub-classes of this implement the actual database connection libraries
SS_Datetime | Represents a date-time field. The field currently supports New Zealand date format (DD/MM/YYYY), or an ISO 8601 formatted date and time (Y-m-d H:i:s). Alternatively you can set a timestamp that is evaluated through PHP's built-in date() and strtotime() function according to your system locale.
SS_Query | Abstract query-result class. Once again, this should be subclassed by an actual database implementation. It will only ever be constructed by a subclass of SS_Database. The result of a database query - an iteratable object that's returned by DB::SS_Query
StringField | An abstract base class for the string field types (i.e. Varchar and Text)
SubsiteDomain | A single database record & abstract class for the data-access-model.
Text | Represents a long text field.
TextAnonsWidget_Item | A single database record & abstract class for the data-access-model.
Texture3D_File | A single database record & abstract class for the data-access-model.
Time | Represents a column in the database with the type 'Time'.
Varchar | Represents a short text field.
Versioned | The Versioned decorator allows your DataObjects to have several versions, allowing you to rollback changes and view history. An example of this is the pages used in the CMS.
Versioned_Version | Represents a single version of a record.
VideoCategory | A single database record & abstract class for the data-access-model.
VideoEntry | A single database record & abstract class for the data-access-model.
VKNotificationQueue | A single database record & abstract class for the data-access-model.
WebylonWidget_Item | A single database record & abstract class for the data-access-model.
YaMoneyPaymentDecorator | Plug-ins for additional functionality in your DataObjects.
Year | Represents a single year field.

## Interfaces summary

CompositeDBField | Apply this interface to any `DBField` that doesn't have a 1-1 mapping with a database field. This includes multi-value fields and transformed fields
CurrentPageIdentifier | This interface lets us set up objects that will tell us what the current page is.
DataObjectInterface | DataObjectInterface is an interface that other data systems in your application can implement in order to behave in a manner similar to DataObject.

[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. -