Commit Graph

882 Commits

Author SHA1 Message Date
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
75f87ac409 DOCS Grammar fixes 2019-05-23 10:38:56 +12:00
Ingo Schommer
1cb22b665d DOCS Clarify different file access types
[ci-skip]
2019-05-23 09:25:46 +12:00
Ingo Schommer
74c869f362 DOCS Note about custom File->canView()
See https://github.com/silverstripe/silverstripe-framework/issues/8493

[ci-skip]
2019-05-23 09:14:36 +12:00
Ingo Schommer
c82c1520fc DOCS Clarified file permission control
[ci-skip]
2019-05-23 09:08:08 +12:00
Guy Marriott
b9a8f64ef0
Update wording in example in syntax docs 2019-05-20 16:38:55 +12:00
Federico Jaramillo Martínez
368c88d59a
Fix link to related lesson 2019-05-14 12:06:17 -05:00
Sebastian Kalicki
e83edf7e94
Update 00_Configuration.md 2019-05-09 11:28:11 +02:00
Vinnie
168a4fe489
Update docs for GridField_ActionMenuItem required parameters
I found these errors while going through this tutorial,
missing ```use use SilverStripe\Forms\GridField\GridField;```

interface GridField_ActionMenuItem required parameters on  getTitle() and getGroup()

incorrect if statement on getExtraData() - $field is not defined
2019-05-09 09:01:54 +12:00
Ingo Schommer
1f78e8ae80 NEW Clean up secureassets module artefacts (#8948)
See https://github.com/silverstripe/silverstripe-assets/issues/231
2019-05-02 21:05:19 +12:00
Andre Kiste
48db515fbd NEW Fix folder permissions (#8950)
* Add `FixFilePermissionsHelper` subtask
* Changed name to folder permissions, added more loggin
2019-05-02 16:28:57 +12:00
Ingo Schommer
0696045e59 NEW Legacy thumbnail migration task (#8924)
* NEW Legacy thumbnail migration task

See https://github.com/silverstripe/silverstripe-assets/issues/235
Makes a start at https://github.com/silverstripe/silverstripe-assets/issues/219 as well

* API Removed migrate_legacy_file support

For the vast majority of sites, you really don't want to run your file migration as part of dev build.
The step is involved enough to warrant it's own task.
I don't think this is an API change, since the setting won't have affect
for anyone who has already enabled it - they would've already done the one-off migration.

See https://github.com/silverstripeltd/open-sourcerers/issues/91
and https://github.com/silverstripe/silverstripe-assets/issues/235
2019-05-02 09:33:53 +12:00
Adrian Humphreys
e648fd31f9 Docs: Update Dynamic_Default_Fields.md (#8941) 2019-04-30 09:00:09 +12:00
Garion Herman
5c4367f46b Use environment variables in example SMTP config
Currently the email documentation provides an example of how to use the SMTP adapter in SwiftMailer, but this example hardcodes the password in the config file which is a security issue. It is possible to reference environment variables instead, so we should document and encourage this.
2019-04-30 08:59:54 +12:00
Adrian Humphreys
212a99c904 Add info around namespacing with controllers 2019-04-30 08:59:29 +12:00
Ingo Schommer
da91f44c00 DOCS File migration changes for 4.4.0 (#8910)
* DOCS File migration changes for 4.4.0

See https://github.com/silverstripe/silverstripe-versioned/issues/177

* Update docs/en/02_Developer_Guides/14_Files/03_File_Security.md

Co-Authored-By: chillu <ingo@silverstripe.com>

* Corrected statements on archived/versioned files

* Corrected statement on filesystem paths of protected vs. public

* Update docs/en/02_Developer_Guides/14_Files/03_File_Security.md

Co-Authored-By: chillu <ingo@silverstripe.com>

* Clarify redirect behaviour
2019-04-30 08:59:25 +12:00
Erlend Mongstad
80b097eb68
Added missing Permission class to example
Following the example will give the following error;

```[Emergency] Uncaught Error: Class {my namespace}\Permission not found```

Added the missing class
2019-04-17 02:36:13 +02:00
Robbie Averill
6b07b2c47c Update docs/en/02_Developer_Guides/01_Templates/How_Tos/03_Disable_Anchor_Links.md
Fix code styling

Co-Authored-By: DorsetDigital <DorsetDigital@users.noreply.github.com>
2019-04-16 22:32:55 +01:00
DorsetDigital
321ef827b8
Update 03_Disable_Anchor_Links.md
Update example code for disabling anchors on a per-instance basis.  The previous code was unclear and statically called a non-static method on SSViewer  (presumably this was SS3 code)
2019-04-16 21:22:27 +01:00
Robbie Averill
8a06682e31 Merge branch '4.3' into 4
# Conflicts:
 #	src/ORM/Connect/DBSchemaManager.php
2019-04-11 11:24:17 +12:00
Ingo Schommer
fcdc146996 DOCS Limitations of publishall
Fixes https://github.com/silverstripe/silverstripe-cms/issues/2406
2019-04-10 10:42:49 +12:00
Al
9a43952385
Fix formatting
Last code block was not closed
2019-04-10 08:22:51 +12:00
Guy Marriott
a9d57f5bfb
Merge pull request #8241 from creative-commoners/pulls/4.3/separate-logging
Separate core error logging from standard LoggerInterface
2019-04-05 08:49:09 +13: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
Anton Smith
167881cc38 Update path 2019-04-02 12:46:19 +13:00
Andre Kiste
f3535972e4 DOC Add more clear instructions on handling upgrade conflicts (#8836)
* Add more clear instructions on handling upgrade conflicts

* More module upgrading info

* Make it make sense

* Tweak sentence
2019-03-26 16:20:53 +13:00
DorsetDigital
abe76e9b29
Update 02_RSSFeed.md
Change file name to PageController to match code.
Change example code to use parameter in `Link()` method rather than using concatenation
2019-03-23 13:22:37 +00:00
Joe Chenevey
af34fab461
Update 00_CSV_Import.md
Fix reference in `$model_importers` to use `Player::class` for namespaced model reference.
2019-03-18 10:55:41 -04:00
Ingo Schommer
71c32fea20 DOCS Clarify legacy_filenames=true tradeoffs 2019-02-28 08:56:53 +13:00
Ingo Schommer
1f08ed3765 DOCS Note about replaced files on keep_archived_files flag 2019-02-28 08:27:29 +13:00
Ingo Schommer
b4b2f576f0 DOCS Clarify file migration and mention known bug 2019-02-26 09:44:32 +13:00
Scott Hutchinson
57184c245c
DOCS Update HTTP Cache headers docs to include note about testing in dev mode [ci skip] 2019-02-22 10:16:11 +13:00
Robbie Averill
3e90fdf42f Merge branch '4.3' into 4 2019-02-19 08:41:05 +07:00
Robbie Averill
ed74549c4f Merge branch '4.2' into 4.3 2019-02-19 08:39:59 +07:00
Maxime Rainville
5a4a36a79e
Merge pull request #8791 from open-sausages/pulls/4/file-migration-estimates
Add file migration system requirements
2019-02-18 11:56:19 +13:00
Maxime Rainville
5c5d8639c6
DOCS Encourage peopel to contact the CWP/SSP helpdesk if they need to run the migration from the CLI 2019-02-14 15:38:00 +13:00
Maxime Rainville
62e3a2f582
"Approximate" makes it clearer the expected memory usage may vary
Co-Authored-By: bergice <bergice@users.noreply.github.com>
2019-02-13 15:01:04 +01:00
Maxime Rainville
2e84e9a18f
Round up expected memory usage
Co-Authored-By: bergice <bergice@users.noreply.github.com>
2019-02-13 15:00:08 +01:00
Robbie Averill
95b44d840d DOCS Add example for disabling emails in dev mode via configuration
[ci skip]
2019-02-13 15:37:55 +07:00
bergice
a245d0c98f Add file migration system requirements.
See https://github.com/silverstripeltd/open-sourcerers/issues/45 for more information on how these estimates were obtained.
2019-02-09 05:19:25 +01:00
Jonathon Menz
0cbc02add1 DOCS Added 'Modifying Meta Tags' entry 2019-02-01 09:33:20 -08:00
Andre Kiste
2378d75bc1
Merge pull request #8746 from open-sausages/pulls/4/doc-file-migration-for-big-files
DOCS Add more info about migrations huge number files
2019-01-30 09:26:00 +13:00
wernerkrauss
2d257ae3df explain resource url usage for add_i18n_javascript (#8761)
see #8748
2019-01-29 09:00:04 +02:00
Andre Kiste
6f180574a5
Update 05_File_Migration.md
Fixed typos.
2019-01-29 18:58:58 +13:00
Maxime Rainville
c4bf06f600 NEW Add new execmetric debug URL parameter to print out exection time and peak memory usage 2019-01-29 17:28:28 +13:00
Loz Calver
568be8e29b FIX: Misconfiguration for versioned cache segmentation (fixes #8754) 2019-01-25 09:33:21 +00:00
DorsetDigital
17b55fea5e Update 03_Form_Templates.md - form template locations (#8751)
Update guidance on form template location.  They don't necessarily have to be placed in /app/templates and will work in the theme directory too.    The current text also seems to suggest that they can be placed in the core directory - something which I don't believe should be advised,
2019-01-24 14:55:52 +02:00
DorsetDigital
8ae9c7c07c
Update 03_Form_Templates.md
Add default location of default form template to help people who wish to copy it.
2019-01-24 10:27:38 +00:00
Maxime Rainville
6ad780e217 DOCS Add more info about migrations huge number files 2019-01-23 19:29:03 +13:00
Robbie Averill
50c074964d
Merge pull request #8730 from sachajudd/docs/page-icons
DOCS Add how to customise page icons in the site tree
2019-01-16 10:00:08 +01:00
Sacha Judd
95c6ba67df DOCS Add how to customise page icons in the site tree
[ci skip]
2019-01-16 21:57:43 +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
Maxime Rainville
f34f1ec7ee
Update docs/en/02_Developer_Guides/14_Files/01_File_Management.md
Co-Authored-By: jinjie <jinjie@swiftdev.sg>
2019-01-10 14:10:07 +08:00
Maxime Rainville
7d23928fde
Update docs/en/02_Developer_Guides/14_Files/01_File_Management.md
Co-Authored-By: jinjie <jinjie@swiftdev.sg>
2019-01-10 14:10:02 +08:00
Kong Jin Jie
a3f7aca851 Add documentation for additional file types 2019-01-10 13:16:18 +08:00
Maxime Rainville
728c982de2 DOCS Retroactively apply proposed change to vendor-expose doc 2019-01-09 16:28:40 +13:00
Maxime Rainville
1e01deea39 NEW Make resources dir configurable (#8519)
* NEW Make resources dir configurable.

* Removing reference to old `resources` and updating doc #8519

* Rrtarget to 4.4 release.

* DOC Reference SS_RESOURCES_DIR in Environment doc.

* API Add a Resources method to SilverStripe\Core\Manifest\Module to read the resources-dir from composer.json

* Clean up reference to SS_RESOURCES_DIR env var

* Set default resources-dir

* Update test to use RESOURCES_DIR const in expected resource url method

* Correcting typos

Co-Authored-By: maxime-rainville <maxime@rainville.me>

* MINOR Correctubg minor typos

* DOCS Document the intricacies of exposing static assets.
2019-01-09 15:35:45 +13:00
Ingo Schommer
783b104039 DOC Clarify testing cache behaviour changes in 4.3 2018-12-18 16:19:36 +13:00
Robbie Averill
79887cbea7
Merge pull request #8585 from zzdjk6/patch-1
DOC: Update documentation on `How to extend the CMS interface`
2018-12-12 19:53:18 +00:00
Robbie Averill
466e7cf142
DOCS Fix FCQN in CsvBulkLoader example code
[ci skip]
2018-12-06 12:21:08 +00:00
Robbie Averill
5d7c5ffb07 Merge branch '4.3' into 4 2018-12-06 09:40:40 +00:00
Hans Philip Eide
f9cd6d9a15
Update 02_Images.md
If the default is that resampling is off, shouldn't the example be that force_resample is set to true to enable resample?
2018-12-01 13:36:52 +01:00
Ed Linklater
cc7aa7b68b
FIX incorrect composer module type
Was silverstripe/vendormodule, should be silverstripe-vendormodule
2018-12-01 07:53:21 +13:00
Guy Marriott
32d096d9e5
DOCS Moving interface subscription to the abstract and adding a changelog entry 2018-11-30 15:40:45 +13:00
Guy Marriott
aace1da1f0
DOCS Adding notes on configuring the storage method for GridField_FormActions 2018-11-30 15:40:45 +13:00
Aled Brown
5d15d20f0f ModelAdmin Menu Icon Class Documentation Added + Namespace Permissions (#8646) 2018-11-28 18:23:37 +01:00
Robbie Averill
fa26ead0f6
DOCS Add namespaces to PHP i18n examples, and reference __CLASS__ and self::class as options 2018-11-26 17:15:17 +01:00
Robbie Averill
1f1c344272 Merge branch '4.3' into 4
# Conflicts:
 #	tests/php/Forms/ConfirmedPasswordFieldTest.php
2018-11-26 12:15:17 +01:00
Robbie Averill
41dc9229bf FIX Reverting ExtensionTestState and Extensible extra methods modifications to prevent PHP 5.6 segfault (#8581)
* API Revert addition of Extensible::flush_extra_methods_cache() and change to ExtensionTestState

This reverts the changes from #8465 and #8505 that relate to ExtensionTestState and the
tracking of extra methods between unit tests. The existing test from #8465 testing
overloaded Extensions after extra_methods are populated has been updated to show that you
must re-add the extension to flush the extra_methods cache if you need this behaviour.

* Revert change to InjectorTest::testExtendedExtensions

* Revert "Add failing test to show that overloaded extensions are broken in Extensible"

This reverts commit 55e79ffdfd.

* DOCS Add docs for extending extensions, and upgrade guide note to 4.3 to avoid using PHP config to do so
2018-11-26 12:00:02 +13:00
Aled Brown
ff1a0dd6fc
renderWith Namespace for Template Loading
Just calling MyCustomTemplate does not work in SS 4.2.X. Adding the full Namespace as a path is now required.
2018-11-21 15:28:12 +00:00
Guy Marriott
d19c7f2a2d
DOCS Updating HistoryViewer documentation to specify the rollback mutation instead of copyToStage 2018-11-19 14:08:02 +13:00
Andre Kiste
cc712892a9 NEW Port betterbuttons to framework (#8569)
* MINOR: Add `Previous`, `Next` and `Create New` actions in edit form

If the form is opened via a grid field, the filters will be retained so the previous/next record opened will be correct

* MINOR: Add ability to customise the visibility of the `Previous`, `Next` and `Add` buttons at a `GridField` level

* Fix invalid action when pressing the `New` button in an edit form unless `betterbuttons` module was installed

* - Merge `showPrevious` and `showNext` to `showPagination` for grid fields
- Update documentation
- Improve performance for next/previous buttons by not fetching all list records
- Refactoring

* Refactor to fail gracefully on GridFieldPaginator
2018-11-19 11:06:47 +13:00
Christopher Darling
c186c8ea68
DOCS fix link to XHProf article 2018-11-14 21:56:57 +00:00
Robbie Averill
71eeaa090e DOCS Add documentation for configuring a HistoryViewerField for custom DataObjects
[ci skip]
2018-11-14 14:08:06 +02:00
Robbie Averill
cbea5006b3 DOCS Fix incorrect injector class reference in "replacing the logger" 2018-11-13 11:08:28 +02:00
Robbie Averill
731c865684 DOCS Clarify that the file path in stream logging is relative to index.php folder 2018-11-13 11:08:28 +02:00
Robbie Averill
18293f7afe FIX Rename pushHandler to pushLogger 2018-11-13 11:08:28 +02:00
Robbie Averill
1faf59fc54 DOCS Update documentation for separated logging interfaces 2018-11-13 11:08:28 +02:00
Robbie Averill
af8d268cc7 DOCS Update documentation for password validation rule configuration 2018-11-13 10:55:26 +02:00
Thor Chen
bda7653ae3 DOC: Fix outdated information and make enhancements for 2018-11-12 18:24:37 +13:00
Sam Minnee
0cc39af382 DOC: Added documentation for strict type changes 2018-11-09 11:08:36 +13:00
Robbie Averill
64c2938c96 Merge branch '4.3' into 4 2018-11-06 11:05:22 +01: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
Andre Kiste
bed1906f73
Fix typo 2018-10-25 15:59:02 +13:00
Daniel Hensby
b47d9abd7c
Merge pull request #8488 from open-sausages/pulls/4/update-pattern-lib-doc
MINOR Update doc to explain how to use and build the pattern lib
2018-10-24 17:33:46 +01:00
Aaron Carlino
a3a4f48cb7 MINOR Update doc to explain how to use and build the pattern lib 2018-10-24 16:48:29 +13:00
Maxime Rainville
40e542de2d DOC Remove buggy example form the _Show Help Text on CMS Form Fields_ article 2018-10-23 16:04:54 +13:00
Robbie Averill
9ceef59e1b Merge branch '4.3' into 4 2018-10-20 18:31:04 +02:00
Aaron Carlino
3fcbeaddef Reverse argument signature of pathed query properties 2018-10-18 11:22:51 +13:00
Aaron Carlino
1f6a84bd8b Add docs for new args/fields API 2018-10-18 11:22:51 +13:00
DorsetDigital
97091db863
Update admin example code
Added an additional config block to the example code to set the AdminRootController.url_base config option as well and updated the description.
2018-10-16 11:45:02 +01:00
DorsetDigital
b4201fcf74
Fix example code
Add namespace to sample code for updating the CMS url.
Remove code highlighting from links to API
2018-10-16 08:45:24 +01:00
Federico Jaramillo Martínez
8e5ca9be38
Change rule names in array example 2018-10-11 10:12:38 -05:00
Federico Jaramillo Martínez
b9222cf421
Example to override a value that is an array.
Add an example for how to override a configuration value that has is array.
2018-10-11 10:09:40 -05: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
Loz Calver
554c34eff7
DOCS: Add YAML example for including extra JS in the CMS 2018-10-11 12:33:53 +01:00
Maxime Rainville
d68f02ad25
Merge pull request #8393 from sachajudd/pulls/4/document-help-menu
DOCS Add docs for CMS help menu links
2018-10-05 14:02:14 +13:00
Sacha Judd
f5b6ce01cf DOCS Add docs for CMS help menu links
[ci skip]
2018-10-04 10:50:57 +13:00