diff --git a/docs/en/02_Developer_Guides/01_Templates/03_Requirements.md b/docs/en/02_Developer_Guides/01_Templates/03_Requirements.md index 9f8e545e9..ee7bb4298 100644 --- a/docs/en/02_Developer_Guides/01_Templates/03_Requirements.md +++ b/docs/en/02_Developer_Guides/01_Templates/03_Requirements.md @@ -440,7 +440,7 @@ Requirements::set_write_js_to_body(false); ## Direct resource urls -In templates you can use the `$resourcePath()` or `$resourceURL()` helper methods to inject links to +In templates, you can use the `$resourcePath()` or `$resourceURL()` helper methods to inject links to resources directly. If you want to link to resources within a specific module you can use the `vendor/module:some/path/to/file.jpg` syntax. diff --git a/docs/en/02_Developer_Guides/14_Files/02_Images.md b/docs/en/02_Developer_Guides/14_Files/02_Images.md index 14ae4b1bd..79dad333d 100644 --- a/docs/en/02_Developer_Guides/14_Files/02_Images.md +++ b/docs/en/02_Developer_Guides/14_Files/02_Images.md @@ -214,9 +214,7 @@ SilverStripe\Core\Injector\Injector: ## Storage -Manipulated images are stored as "file variants" in the same -folder structure as the original image. The storage mechanism is described -in the ["File Storage" guide](file_storage). +Manipulated images are stored as "file variants" in the same folder structure as the original image. The storage mechanism is described in the ["File Storage" guide](file_storage). ## API Documentation diff --git a/src/ORM/ArrayList.php b/src/ORM/ArrayList.php index ac4bb5839..c1231fb6b 100644 --- a/src/ORM/ArrayList.php +++ b/src/ORM/ArrayList.php @@ -604,10 +604,10 @@ class ArrayList extends ViewableData implements SS_List, Filterable, Sortable, L } /** - * Filter the list to include items with these charactaristics + * Filter the list to include items with these characteristics * * @return ArrayList - * @see SS_List::filter() + * @see Filterable::filter() * @example $list->filter('Name', 'bob'); // only bob in the list * @example $list->filter('Name', array('aziz', 'bob'); // aziz and bob in list * @example $list->filter(array('Name'=>'bob, 'Age'=>21)); // bob with the Age 21 in list @@ -642,7 +642,7 @@ class ArrayList extends ViewableData implements SS_List, Filterable, Sortable, L } /** - * Return a copy of this list which contains items matching any of these charactaristics. + * Return a copy of this list which contains items matching any of these characteristics. * * @example // only bob in the list * $list = $list->filterAny('Name', 'bob'); @@ -765,7 +765,7 @@ class ArrayList extends ViewableData implements SS_List, Filterable, Sortable, L } /** - * Exclude the list to not contain items with these charactaristics + * Exclude the list to not contain items with these characteristics * * @return ArrayList * @see SS_List::exclude() diff --git a/src/ORM/DataList.php b/src/ORM/DataList.php index b017c110c..b494c7441 100644 --- a/src/ORM/DataList.php +++ b/src/ORM/DataList.php @@ -365,7 +365,7 @@ class DataList extends ViewableData implements SS_List, Filterable, Sortable, Li /** * Return a copy of this list which only includes items with these characteristics * - * @see SS_List::filter() + * @see Filterable::filter() * * @example $list = $list->filter('Name', 'bob'); // only bob in the list * @example $list = $list->filter('Name', array('aziz', 'bob'); // aziz and bob in list @@ -422,7 +422,7 @@ class DataList extends ViewableData implements SS_List, Filterable, Sortable, Li } /** - * Return a copy of this list which contains items matching any of these charactaristics. + * Return a copy of this list which contains items matching any of these characteristics. * * @example // only bob in the list * $list = $list->filterAny('Name', 'bob'); diff --git a/src/ORM/Filterable.php b/src/ORM/Filterable.php index 4686d432c..c8d907861 100644 --- a/src/ORM/Filterable.php +++ b/src/ORM/Filterable.php @@ -22,7 +22,7 @@ interface Filterable extends SS_List public function canFilterBy($by); /** - * Return a new instance of this list that only includes items with these charactaristics + * Return a new instance of this list that only includes items with these characteristics * * @return Filterable * @example $list = $list->filter('Name', 'bob'); // only bob in the list @@ -35,7 +35,7 @@ interface Filterable extends SS_List public function filter(); /** - * Return a copy of this list which contains items matching any of these charactaristics. + * Return a copy of this list which contains items matching any of these characteristics. * * @example // only bob in the list * $list = $list->filterAny('Name', 'bob'); @@ -59,7 +59,7 @@ interface Filterable extends SS_List public function filterAny(); /** - * Return a new instance of this list that excludes any items with these charactaristics + * Return a new instance of this list that excludes any items with these characteristics * * @return Filterable * @example $list = $list->exclude('Name', 'bob'); // exclude bob from list @@ -72,7 +72,7 @@ interface Filterable extends SS_List public function exclude(); /** - * Return a new instance of this list that excludes any items with these charactaristics + * Return a new instance of this list that excludes any items with these characteristics * Filter this List by a callback function. The function will be passed each record of the List in turn, * and must return true for the record to be included. Returns the filtered list. * diff --git a/src/ORM/ListDecorator.php b/src/ORM/ListDecorator.php index 8620168ff..64d9e613c 100644 --- a/src/ORM/ListDecorator.php +++ b/src/ORM/ListDecorator.php @@ -182,7 +182,7 @@ abstract class ListDecorator extends ViewableData implements SS_List, Sortable, } /** - * Filter the list to include items with these charactaristics + * Filter the list to include items with these characteristics * * @example $list->filter('Name', 'bob'); // only bob in list * @example $list->filter('Name', array('aziz', 'bob'); // aziz and bob in list @@ -195,7 +195,7 @@ abstract class ListDecorator extends ViewableData implements SS_List, Sortable, } /** - * Return a copy of this list which contains items matching any of these charactaristics. + * Return a copy of this list which contains items matching any of these characteristics. * * @example // only bob in the list * $list = $list->filterAny('Name', 'bob'); @@ -275,7 +275,7 @@ abstract class ListDecorator extends ViewableData implements SS_List, Sortable, } /** - * Exclude the list to not contain items with these charactaristics + * Exclude the list to not contain items with these characteristics * * @example $list->exclude('Name', 'bob'); // exclude bob from list * @example $list->exclude('Name', array('aziz', 'bob'); // exclude aziz and bob from list diff --git a/src/includes/constants.php b/src/includes/constants.php index e9c73a5b8..37d915fda 100644 --- a/src/includes/constants.php +++ b/src/includes/constants.php @@ -15,7 +15,8 @@ use SilverStripe\Core\TempFolder; * - BASE_URL: Full URL to the webroot, e.g. "http://my-host.com/my-webroot" (no trailing slash). * - BASE_PATH: Absolute path to the webroot, e.g. "/var/www/my-webroot" (no trailing slash). * See Director::baseFolder(). Can be overwritten by Config::modify()->set(Director::class, 'alternate_base_folder', ). - * - TEMP_PATH: Absolute path to temporary folder, used for manifest and template caches. Example: "/var/tmp" + * - TEMP_PATH: Absolute path to temporary folder, used as base for $TEMP_FOLDER. Example: "/var/tmp" + * - TEMP_FOLDER: folder name for manifest and template caches. Example: "silverstripe-cache-php7.2" * See getTempFolder(). No trailing slash. * - ASSETS_DIR: Dir for assets folder. e.g. "assets" * - ASSETS_PATH: Full path to assets folder. e.g. "/var/www/my-webroot/assets"