tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Update 04_Data_Types_and_Casting

Browse Source 
This is a suggestion to update the docs to use the actual type names used in code. All the examples use the non-DB type names (ie: 'Wheels' => 'Int') but the bulleted list suggests it should be 'Wheels' => 'DBInt'. This is a bit confusing for new SS developers. Could we change this?
This commit is contained in:
blueskies79 2019-05-23 12:09:59 +02:00 committed by GitHub
parent 5851979096
commit f08915ccf2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/en/02_Developer_Guides/00_Model/04_Data_Types_and_Casting.md
View File

@ -6,7 +6,7 @@ summary: Learn how how data is stored going in and coming out of the ORM and how
Each model in a SilverStripe [DataObject](api:SilverStripe\ORM\DataObject) will handle data at some point. This includes database columns such as Each model in a SilverStripe [DataObject](api:SilverStripe\ORM\DataObject) will handle data at some point. This includes database columns such as
the ones defined in a `$db` array or simply a method that returns data for the template. the ones defined in a `$db` array or simply a method that returns data for the template.
A Data Type is represented in SilverStripe by a [DBField](api:SilverStripe\ORM\FieldType\DBField) subclass. The class is responsible for telling the ORM A Data Type is represented in SilverStripe by a [Field](api:SilverStripe\ORM\FieldType\DBField) subclass. The class is responsible for telling the ORM
about how to store its data in the database and how to format the information coming out of the database, i.e. on a template. about how to store its data in the database and how to format the information coming out of the database, i.e. on a template.
In the `Player` example, we have four database columns each with a different data type (Int, Varchar). In the `Player` example, we have four database columns each with a different data type (Int, Varchar).
@ -29,21 +29,21 @@ class Player extends DataObject
## Available Types ## Available Types
* [DBBoolean](api:SilverStripe\ORM\FieldType\DBBoolean): A boolean field. * [Boolean](api:SilverStripe\ORM\FieldType\DBBoolean): A boolean field.
* [DBCurrency](api:SilverStripe\ORM\FieldType\DBCurrency): A number with 2 decimal points of precision, designed to store currency values. * [Currency](api:SilverStripe\ORM\FieldType\DBCurrency): A number with 2 decimal points of precision, designed to store currency values.
* [DBDate](api:SilverStripe\ORM\FieldType\DBDate): A date field * [Date](api:SilverStripe\ORM\FieldType\DBDate): A date field
* [DBDecimal](api:SilverStripe\ORM\FieldType\DBDecimal): A decimal number. * [Decimal](api:SilverStripe\ORM\FieldType\DBDecimal): A decimal number.
* [DBEnum](api:SilverStripe\ORM\FieldType\DBEnum): An enumeration of a set of strings * [Enum](api:SilverStripe\ORM\FieldType\DBEnum): An enumeration of a set of strings
* [DBHTMLText](api:SilverStripe\ORM\FieldType\DBHTMLText): A variable-length string of up to 2MB, designed to store HTML * [HTMLText](api:SilverStripe\ORM\FieldType\DBHTMLText): A variable-length string of up to 2MB, designed to store HTML
* [DBHTMLVarchar](api:SilverStripe\ORM\FieldType\DBHTMLVarchar): A variable-length string of up to 255 characters, designed to store HTML * [HTMLVarchar](api:SilverStripe\ORM\FieldType\DBHTMLVarchar): A variable-length string of up to 255 characters, designed to store HTML
* [DBInt](api:SilverStripe\ORM\FieldType\DBInt): An integer field. * [Int](api:SilverStripe\ORM\FieldType\DBInt): An integer field.
* [DBPercentage](api:SilverStripe\ORM\FieldType\DBPercentage): A decimal number between 0 and 1 that represents a percentage. * [Percentage](api:SilverStripe\ORM\FieldType\DBPercentage): A decimal number between 0 and 1 that represents a percentage.
* [DBDatetime](api:SilverStripe\ORM\FieldType\DBDatetime): A date / time field * [Datetime](api:SilverStripe\ORM\FieldType\DBDatetime): A date / time field
* [DBText](api:SilverStripe\ORM\FieldType\DBText): A variable-length string of up to 2MB, designed to store raw text * [Text](api:SilverStripe\ORM\FieldType\DBText): A variable-length string of up to 2MB, designed to store raw text
* [DBTime](api:SilverStripe\ORM\FieldType\DBTime): A time field * [Time](api:SilverStripe\ORM\FieldType\DBTime): A time field
* [DBVarchar](api:SilverStripe\ORM\FieldType\DBVarchar): A variable-length string of up to 255 characters, designed to store raw text. * [Varchar](api:SilverStripe\ORM\FieldType\DBVarchar): A variable-length string of up to 255 characters, designed to store raw text.
See the [API documentation](api:SilverStripe\ORM\FieldType\DBField) for a full list of available Data Types. You can define your own [DBField](api:SilverStripe\ORM\FieldType\DBField) instances if required as well. See the [API documentation](api:SilverStripe\ORM\FieldType\DBField) for a full list of available Data Types. You can define your own [Field](api:SilverStripe\ORM\FieldType\DBField) instances if required as well.
## Default Values ## Default Values