Commit Graph

163 Commits

Author SHA1 Message Date
cloph
13725d2f92
DOC HistoryViewer: explain "magic names" (#9670)
DOC HistoryViewer: explain "magic names"
GraphQL scaffolding uses names consisting of the first part of the namespace and the classname, but to inject it to the HistoryViewer field you need to use the database table name.
Co-authored-by: Steve Boyd <emteknetnz@gmail.com>
2020-09-12 12:56:23 +12:00
Maxime Rainville
9f94c739c1 DOC Correct the example for getters/setters 2020-08-06 10:15:14 +12:00
James Cocker
b4a3cc700a
Fixes getCMSFields TabSet example
Current example results in: "[Emergency] Uncaught InvalidArgumentException: TabSet can only contain instances of other Tab or Tabsets"
2020-06-29 16:37:26 +01:00
Jackson Darlow
6813c0f7e8 Added documentation regarding some cached ORM scenarios 2020-06-17 17:17:04 +12:00
Michal Kleiner
21129b1624
Use short array syntax across the framework's codebase 2020-05-16 10:34:45 +01:00
Maxime Rainville
7da77be5ce Merge branch '4.5' into 4 2020-04-15 08:22:27 +12:00
mattclegg
6a640f1498
DOCS: Example should show how to disable VersionedGridfieldDetailForm as it's enabled by default 2020-04-13 17:34:55 +05:45
Matt Clegg
101c189c16
[DOCS] Missing line termination in example 2020-03-14 15:19:17 +05:45
Conny Nyman
2bd5f8cbcf DOC Updated search filter modifiers documentation to mention that they only work on data lists 2020-01-11 11:09:24 +02:00
Tristan
aad33e36d7
Change from "Team" to Team::class
To be consistent with the rest of the doc
2019-11-28 11:34:41 +13:00
Nicolaas
d1fc27d03a
MINOR: clearer distinction between class names and actual names 2019-11-26 15:57:45 +13:00
Aaron Carlino
6888901468
NEW: Update docs to be compliant with Gatsby site (#9314)
* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon
2019-11-18 17:58:33 +13:00
Loz Calver
daf995da63
Fix syntax error in DataList docs 2019-09-30 09:36:12 +01:00
Christopher Darling
c8f274de80
DOCS fix DataList::exclude() code example 2019-09-15 20:34:18 +01:00
Serge Latyntsev
296dc6a489 DOC Fix versioned snapshot image markdown (#9209) 2019-09-02 13:29:08 +12:00
Ingo Schommer
732dfe5aaa DOCS Clarify cascade publish/delete perm checks
We decided during implementation not to check permissions explicitly on cascading objects due to performance concerns.
For example, when publishing a page with embedded images, publish permissions on the image are implied - even if Image->canPublish() would return false for this author.

See https://github.com/silverstripe-security/security-issues/issues/57
2019-06-18 16:27:29 +12:00
Guy Marriott
bb5b610636
Merge branch '4.4' into 4 2019-06-17 08:58:50 +12:00
Serge Latyntsev
2e33456e46 Mention versioned snapshots in the versions documentation (#9057)
* Mention versioned snapshots in the versions documentation

* Add screenshot
2019-06-16 23:52:30 +12:00
Juan Molina
ef5f2a526f
Minor revision, broken link
Minor typos and broken link corrected, added some typographic consistency.
2019-06-10 18:46:14 +02:00
blueskies79
c7eede1d66
Reverted DBField & list both [Field] and [DBField]
I changed the list of types to the suggested format for clarity and changed Field back to DBField as suggested.
2019-05-26 15:40:25 +02:00
blueskies79
f08915ccf2
Update 04_Data_Types_and_Casting
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?
2019-05-23 12:09:59 +02:00
Ingo Schommer
c82c1520fc DOCS Clarified file permission control
[ci-skip]
2019-05-23 09:08:08 +12:00
Adrian Humphreys
e648fd31f9 Docs: Update Dynamic_Default_Fields.md (#8941) 2019-04-30 09:00:09 +12:00
Adrian Humphreys
4155b9f483 Docs: Update Dynamic_Default_Fields.md (#8941) 2019-04-29 10:21:13 +12:00
Robbie Averill
8a06682e31 Merge branch '4.3' into 4
# Conflicts:
 #	src/ORM/Connect/DBSchemaManager.php
2019-04-11 11:24:17 +12:00
Al
9a43952385
Fix formatting
Last code block was not closed
2019-04-10 08:22:51 +12:00
Hayden Shaw
30775aa428
DOCS HistoryViewerField updates
* Add missing rollback operation in scaffolding example
* Update block_id references to id  to allow query to read query to run successfully in conjunction with HistoryViewerField
2019-04-02 16:59:52 +13:00
Joe Chenevey
87cc52f3e0
Update 04_Data_Types_and_Casting.md
Fixed missing closing single-quote in Car class example.
2019-01-15 10:50:37 -05:00
Robbie Averill
1f1c344272 Merge branch '4.3' into 4
# Conflicts:
 #	tests/php/Forms/ConfirmedPasswordFieldTest.php
2018-11-26 12:15:17 +01:00
Guy Marriott
d19c7f2a2d
DOCS Updating HistoryViewer documentation to specify the rollback mutation instead of copyToStage 2018-11-19 14:08:02 +13:00
Robbie Averill
71eeaa090e DOCS Add documentation for configuring a HistoryViewerField for custom DataObjects
[ci skip]
2018-11-14 14:08:06 +02:00
Sam Minnee
0cc39af382 DOC: Added documentation for strict type changes 2018-11-09 11:08:36 +13:00
Michael Strong
55f95b7bc8 BUGFIX many many through not sorting by join table (#8534)
* BUGFIX many many through not sorting by join table

* #8534 added docs to support many many sorting fix

* #8534 added test cases for many_many default sorting
2018-11-01 14:17:15 +13:00
Michael Strong
7086f2ea3a BUGFIX many many through not sorting by join table (#8534)
* BUGFIX many many through not sorting by join table

* #8534 added docs to support many many sorting fix

* #8534 added test cases for many_many default sorting
2018-11-01 13:42:27 +13:00
John Milmine
1fb4c6f39f Correcting docs around summary field relabelling
Although this is weird that it doesn't use the same logic and searchable fields.
2018-10-11 12:49:32 +01:00
Luke Edwards
a33866ff4c
Merge pull request #8353 from open-sausages/pulls/4.2/2227-show-link-tracking
API: Add Link Tracking section to Relations developer guide
2018-09-13 14:23:34 +12:00
bergice
01db5c9e98 API: Add Link Tracking section to Relations developer guide and describe show_sitetree_link_tracking, show_file_link_tracking.
Refactor form scaffolder.
2018-09-13 11:02:09 +12:00
maks
b9922a7314
$has_one docs
The ` $has_one` can be used both for `1-to-1` and `many-to-1` relations, depending on how is configured the inverse mapping on the related class. The documentation seems to suggest that `$has_one` implies a `1-to-1` relation, but then it gives an example of a `many-to-1` relationship. Since we are focusing on `$has_one` I would also put the `Player` class before the `Team` class.
2018-08-18 15:06:08 +02:00
Andrew Aitken-Fincham
a97e22c8f1
Update 07_Permissions.md
Added `$context` to `canCreate()` to reflect actual method signature.
2018-08-17 13:46:29 +12:00
Loz Calver
ef335a8a30 Update many-many-through docs (closes #8290) 2018-07-27 09:30:13 +01:00
Ingo Schommer
dd9b8c94a5 DOCS Minor versioned edits
[ci skip]
2018-07-02 15:55:09 +12:00
Maxime Rainville
6108fbf2b4 Correct typo 2018-07-02 15:41:48 +12:00
Maxime Rainville
e0762d5a95 Complete version doc rewrite. 2018-07-02 15:41:48 +12:00
Maxime Rainville
d0a16bacd2 Documenting how to rollback and restore versioned DataObjects. 2018-07-02 15:41:47 +12:00
Maxime Rainville
81d27fcf9c Redrafting versioning doc WIP. 2018-07-02 15:41:47 +12:00
Maxime Rainville
bc7ada58b3 Restructure iversioning doc. 2018-07-02 15:41:47 +12:00
Ingo Schommer
2e1e8e07b9 DOCS Consistent app/ folder and composer use
- Stronger wording around "use composer"
- Consistent domain and email address naming
- Removed example for publishing non-composer modules (those shouldn't be encouraged)
- Removed instructions for installing modules from archives

[ci skip]
2018-06-25 10:40:19 +12:00
blueskies79
84ae5ba321
Added FQCN for Image and File in use statements
Sorry, first pull request. I added the Image and File use statements as requested. And surrounded the has_many example with the class name so it makes more sense.
2018-04-24 10:49:45 +02:00
blueskies79
8b36a2ceae
Add documentation on relating to core classes
Adding a relationship to core classes brings some extra syntax issues. I think it would be usefull to not that core classes are realted through Image::class and that a has-one-relationship needed on a core class when relating them thru has_many, can be set up through yml.
2018-04-23 15:33:07 +02:00
Maxime Rainville
4585b0b382 Fix a broken link to the versioning page. 2018-04-19 10:53:36 +12:00