DOC Update syntax for callout blocks #452
Conversation
GuySartorelli
force-pushed
the
pulls/5/update-callout-syntax
branch
2 times, most recently
from
ce20619 to
5723016
Compare
| > [!NOTE] | ||
| > `exclude` directives will always supersede `include` directives. |
There was a problem hiding this comment.
Moved this from below to satisfy MD028 - can't have two block quotes immediately after one another.
| > [!NOTE] | ||
| > Note the use of the default arguments on `date`. Fields created from `DBFields` | ||
| > generate their own default sets of arguments. For more information, see | ||
| > [DBFieldArgs](query_plugins#dbfieldargs). |
There was a problem hiding this comment.
Moved this from below to satisfy MD028 - can't have two block quotes immediately after one another.
| > [!WARNING] | ||
| > It is critical that you end series of mutation calls with `getState()`. |
There was a problem hiding this comment.
Moved this from below to satisfy MD028 - can't have two block quotes immediately after one another.
| > [!WARNING] | ||
| > Because of the unique structure of the `form` middleware, you cannot register new services to `Injector.form`. |
There was a problem hiding this comment.
Moved this from below to satisfy MD028 - can't have two block quotes immediately after one another.
| > [!NOTE] | ||
| > Note that trying to call `$('div').bar();` would throw an uncaught `TypeError` saying something like "$(...).bar is not a function", because the `bar()` function was defined in a namespace, but we are trying to call that function from *outside* of that namespace. |
There was a problem hiding this comment.
Moved this from below to satisfy MD028 - can't have two block quotes immediately after one another.
| > [!TIP] | ||
| > Note that in the below examples we just return the `DataList` without executing it. We don't need to execute the query, the reading mode is attached to the `DataList` as soon as it's created via the [`augmentDataQueryCreation()`](api:SilverStripe\Versioned\Versioned::augmentDataQueryCreation()) extension hook implementation. |
There was a problem hiding this comment.
Moved this from below to satisfy MD028 - can't have two block quotes immediately after one another.
| > [!WARNING] | ||
| > Versioning only works if you are adding the extension to the base class. That is, the first subclass | ||
| > of `DataObject`. Adding this extension to children of the base class will have unpredictable behaviour. |
There was a problem hiding this comment.
Moved this from below to satisfy MD028 - can't have two block quotes immediately after one another.
| > [!WARNING] | ||
| > Because of the way the ORM interacts with class inheritance, some models will spread their data across multiple tables. See [Joining tables for a DataObject inheritance chain](#joins-for-inheritance) below for information about how to handle that scenario. |
There was a problem hiding this comment.
Moved this from below to satisfy MD028 - can't have two block quotes immediately after one another.
| > [!TIP] | ||
| > All of the below methods to get a single record will return `null` if there is no record to return. |
There was a problem hiding this comment.
Moved this from below to satisfy MD028 - can't have two block quotes immediately after one another.
| [hint] | ||
|
|
||
| - returning `$this` is the equivalent of returning an empty array. | ||
| - returning `$this->customise()` is the equivalent of returning an array with data. | ||
|
|
||
| [/hint] | ||
| > [!TIP] | ||
| > There are a couple of things to note here: | ||
| > | ||
| > - returning `$this` is the equivalent of returning an empty array. | ||
| > - returning `$this->customise()` is the equivalent of returning an array with data. |
There was a problem hiding this comment.
Added text above the list because we need a blank link before the list to satisfy MD032, and it would look weird with just a blank spot there.
GuySartorelli
force-pushed
the
pulls/5/update-callout-syntax
branch
from
5723016 to
83719af
Compare
|
Yes, oops. Cherry picked on top of 5.1 and resolved the few conflicts. |
GuySartorelli
force-pushed
the
pulls/5/update-callout-syntax
branch
from
83719af to
5917947
Compare
IMPORTANT
This should not be merged until all of the associated PRs have all been approved. Only merge when all of the PRs are ready to go, to minimise the amount of time spent with broken callout blocks.
Description
Converts all of the legacy callout blocks to the new syntax. Note that we're not doing CMS 3.
There is a separate PR for CMS 4. Lots of the changes will be the same, but there's been enough change between majors that a direct merge up will be a pain in the butt, so I've done two separate PRs. Once they're both merged the merge-up process will literally be to throw away the differences and keep the CMS 5 copy.
Note that most of the callout blocks will be converted as per silverstripe/doc.silverstripe.org#282 (comment) - but there are some which were intentionally changed. I will note those with comments.
If I haven't added a comment on something that has been converted differently than that table suggests, assume I messed up.
Issues
Pull request checklist