Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes various typos with codespell #10177

Merged
merged 4 commits into from
Dec 13, 2021
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ env:
global:
- REQUIRE_RECIPE="4.x-dev"

# Using a manual matrix to exlude PHPUNIT_COVERAGE_TEST for now because it was causing some strange issues
# Using a manual matrix to exclude PHPUNIT_COVERAGE_TEST for now because it was causing some strange issues
# e.g. https://travis-ci.com/github/silverstripe/silverstripe-framework/jobs/457096837
jobs:
fast_finish: true
2 changes: 1 addition & 1 deletion docs/en/00_Getting_Started/00_Server_Requirements.md
Original file line number Diff line number Diff line change
@@ -263,7 +263,7 @@ $email->send();

Using the code snippet above also tests that the ability to set the "from" address is working correctly.

See the [email section](/developer_guides/email) for futher details, including how to set the administrator "from" email address, change the `sendmail` binary location and how to use SMTP or other mail transports instead of sendmail.
See the [email section](/developer_guides/email) for further details, including how to set the administrator "from" email address, change the `sendmail` binary location and how to use SMTP or other mail transports instead of sendmail.


## PHP Requirements for older Silverstripe CMS releases {#php-support}
2 changes: 1 addition & 1 deletion docs/en/00_Getting_Started/02_Composer.md
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ for [installing modules with Composer](/developer_guides/extending/modules).

Before installing Composer you should ensure your system has the version control
system, [Git installed](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git). Composer uses Git to check out
the code dependancies you need to run your Silverstripe CMS website from the code repositories maintained on GitHub.
the code dependencies you need to run your Silverstripe CMS website from the code repositories maintained on GitHub.

Next, [install composer](https://getcomposer.org/download/). For our documentation we assume the `composer` command is
installed globally. You should now be able to run the command:
Original file line number Diff line number Diff line change
@@ -125,7 +125,7 @@ $player = Player::create();
```

[notice]
Using the `create()` method provides chainability, which can add elegance and brevity to your code, e.g. `Player::create()->write()`. More importantly, however, it will look up the class in the [Injector](../extending/injector) so that the class can be overriden by [dependency injection](http://en.wikipedia.org/wiki/Dependency_injection).
Using the `create()` method provides chainability, which can add elegance and brevity to your code, e.g. `Player::create()->write()`. More importantly, however, it will look up the class in the [Injector](../extending/injector) so that the class can be overridden by [dependency injection](http://en.wikipedia.org/wiki/Dependency_injection).
[/notice]


12 changes: 6 additions & 6 deletions docs/en/02_Developer_Guides/00_Model/10_Versioning.md
Original file line number Diff line number Diff line change
@@ -106,7 +106,7 @@ Items can be added to a changeset in two ways -- *implicitly* and *explicitly*.

An *implicit* inclusion occurs when a record is added to a changeset by virtue of another object declaring ownership of it via the `$owns` setting. Implicit inclusion of owned objects ensures that when a changeset is published, the action cascades through not only all of the items explicitly added to the changeset, but also all of the records that each of those items owns.

An *explicit* inclusion is much more direct, occurring only when a user has opted to include a record in a changeset either through the UI or programatically.
An *explicit* inclusion is much more direct, occurring only when a user has opted to include a record in a changeset either through the UI or programmatically.

It is possible for an item to be included both implicitly and explicitly in a changeset. For instance, if a page owns a file, and the page gets added to a changeset, the file is implicitly added. That same file, however, can still be added to the changeset explicitly through the file editor. In this case, the file is considered to be *explicitly* added. If the file is later removed from the changeset, it is then considered *implicitly* added, due to its owner page still being in the changeset.

@@ -367,7 +367,7 @@ To write your changes without creating new version, call [writeWithoutVersion()]
```php
<?php

$record = MyRecord::get()->byID(99); // This wil retrieve the latest draft version of record ID 99.
$record = MyRecord::get()->byID(99); // This will retrieve the latest draft version of record ID 99.
echo $record->Version; // This will output the version ID. Let's assume it's 13.


@@ -386,7 +386,7 @@ Similarly, an "unpublish" operation does the reverse, and removes a record from

There's two main methods used to publish a versioned DataObject:
* `publishSingle()` publishes this record to live from the draft
* `publishRecursive()` publishes this record, and any dependant objects this record may refer to.
* `publishRecursive()` publishes this record, and any dependent objects this record may refer to.

In most regular cases, you'll want to use `publishRecursive`.

@@ -425,7 +425,7 @@ $record->delete();
Note that `doUnpublish()` and `doArchive()` do not work recursively. If you wish to unpublish or archive dependants records, you have to do it manually.

### Rolling back to an older version
Rolling back allows you to return a DataObject to a previous state. You can rollback a single DataObject using the `rollbackSingle()` method. You can also rollback all dependant records using the `rollbackRecursive()` method.
Rolling back allows you to return a DataObject to a previous state. You can rollback a single DataObject using the `rollbackSingle()` method. You can also rollback all dependent records using the `rollbackRecursive()` method.

Both `rollbackSingle()` and `rollbackRecursive()` expect a single argument, which may be a specific version ID or a stage name.

@@ -596,11 +596,11 @@ Any links presented on the view produced with `?stage=Stage` need to have the sa
to retain the stage. If you are using the `SiteTree->Link()` and `Controller->Link()` methods,
this is automatically the case for `DataObject` links, controller links and form actions.
Note that this behaviour applies for unversioned objects as well, since the views
these are presented in might still contain dependant objects that are versioned.
these are presented in might still contain dependent objects that are versioned.

You can opt for a session base stage setting through the `Versioned.use_session` setting.
Warning: This can lead to leaking of unpublished information, if a live URL is viewed in draft mode,
and the result is cached due to agressive cache settings (not varying on cookie values).
and the result is cached due to aggressive cache settings (not varying on cookie values).

*app/src/MyObject.php*

6 changes: 3 additions & 3 deletions docs/en/02_Developer_Guides/01_Templates/01_Syntax.md
Original file line number Diff line number Diff line change
@@ -100,7 +100,7 @@ If you wish to pass parameters to getter functions, you must use the full method

[note]
For more detail around how variables are inserted and formatted into a template see
[Formating, Modifying and Casting Variables](casting)
[Formatting, Modifying and Casting Variables](casting)
[/note]

Variables can come from your database fields, or custom methods you define on your objects.
@@ -444,7 +444,7 @@ $Foo // returns "3"
```

[hint]
For more information on formatting and casting variables see [Formating, Modifying and Casting Variables](casting)
For more information on formatting and casting variables see [Formatting, Modifying and Casting Variables](casting)
[/hint]

## Scope
@@ -498,7 +498,7 @@ Given the following structure, it will output the text.
Page 'Child 2' is a child of 'MyPage'
```
[notice]
Additional selectors implicitely change the scope so you need to put additional `$Up` to get what you expect.
Additional selectors implicitly change the scope so you need to put additional `$Up` to get what you expect.
[/notice]

```ss
Original file line number Diff line number Diff line change
@@ -22,7 +22,7 @@ extensions.
[/notice]

Outputting these variables is only the start, if you want to format or manipulate them before adding them to the template
have a read of the [Formating, Modifying and Casting Variables](casting) documentation.
have a read of the [Formatting, Modifying and Casting Variables](casting) documentation.

[alert]
Some of the following only apply when you have the `CMS` module installed. If you're using the `Framework` alone, this
@@ -391,7 +391,7 @@ Placing it just below `$Content` is a good default.

## Related Documentation

* [Casting and Formating Variables](casting)
* [Casting and Formatting Variables](casting)
* [Template Inheritance](template_inheritance)

## API Documentation
4 changes: 2 additions & 2 deletions docs/en/02_Developer_Guides/01_Templates/03_Requirements.md
Original file line number Diff line number Diff line change
@@ -291,7 +291,7 @@ and production environments.
### Combined CSS Files

You can also combine CSS files into a media-specific stylesheets as you would with the `Requirements::css` call - use
the third paramter of the `combine_files` function:
the third parameter of the `combine_files` function:

```php
$loader = SilverStripe\View\ThemeResourceLoader::inst();
@@ -316,7 +316,7 @@ the destination location of the resulting combined CSS.
### Combined JS Files

You can also add the 'async' and/or 'defer' attributes to combined Javascript files as you would with the
`Requirements::javascript` call - use the third paramter of the `combine_files` function:
`Requirements::javascript` call - use the third parameter of the `combine_files` function:

```php
$loader = SilverStripe\View\ThemeResourceLoader::inst();
Original file line number Diff line number Diff line change
@@ -84,7 +84,7 @@ Here is how it works in detail:
All keys of `$CacheKey` are processed, concatenated and the final value is hashed.
If there are no values defined, this step is skipped.

4. Make the final key vaule
4. Make the final key value

A string produced by concatenation of all the values mentioned above is used as the final value.

Original file line number Diff line number Diff line change
@@ -181,7 +181,7 @@ public function Link($action = null)
```

## Connecting Pages to Controllers
By default, a controller for a page type must reside in the same namespace as its page. If you find that your controllers are in a different namespace then you'll need to overide SiteTree::getControllerName().
By default, a controller for a page type must reside in the same namespace as its page. If you find that your controllers are in a different namespace then you'll need to override SiteTree::getControllerName().

Example controller:
```php
2 changes: 1 addition & 1 deletion docs/en/02_Developer_Guides/02_Controllers/02_Routing.md
Original file line number Diff line number Diff line change
@@ -111,7 +111,7 @@ A rule must always start with alphabetical ([A-Za-z]) characters or a $Variable

| Pattern | Description |
| ----------- | --------------- |
| `$` | **Param Variable** - Starts the name of a paramater variable, it is optional to match this unless ! is used |
| `$` | **Param Variable** - Starts the name of a parameter variable, it is optional to match this unless ! is used |
| `!` | **Require Variable** - Placing this after a parameter variable requires data to be present for the rule to match |
| `//` | **Shift Point** - Declares that only variables denoted with a $ are parsed into the $params AFTER this point in the regex |

Original file line number Diff line number Diff line change
@@ -47,7 +47,7 @@ private static $url_handlers = [
];
```

For more information on `$url_handlers` see the [Routing](routing) documenation.
For more information on `$url_handlers` see the [Routing](routing) documentation.

## API Documentation

Original file line number Diff line number Diff line change
@@ -118,7 +118,7 @@ $config->addComponent(new GridFieldCustomAction());

$gridField = new GridField('Teams', 'Teams', $this->Teams(), $config);

// option 2: adding the CustomAction to an exisitng GridField
// option 2: adding the CustomAction to an existing GridField
$gridField->getConfig()->addComponent(new GridFieldCustomAction());
```

Original file line number Diff line number Diff line change
@@ -43,7 +43,7 @@ class ContactPageController extends PageController

```

To create a form, we instanciate a `Form` object on a function on our page controller. We'll call this function `Form()`. You're free to choose this name, but it's standard practice to name the function `Form()` if there's only a single form on the page.
To create a form, we instantiate a `Form` object on a function on our page controller. We'll call this function `Form()`. You're free to choose this name, but it's standard practice to name the function `Form()` if there's only a single form on the page.

There's quite a bit in this function, so we'll step through one piece at a time.

2 changes: 1 addition & 1 deletion docs/en/02_Developer_Guides/05_Extending/01_Extensions.md
Original file line number Diff line number Diff line change
@@ -359,7 +359,7 @@ populated.

* [DataExtensions and SiteConfig](https://www.silverstripe.org/learn/lessons/v4/data-extensions-and-siteconfig-1)

## Related Documentaion
## Related Documentation

* [Injector](injector/)

2 changes: 1 addition & 1 deletion docs/en/02_Developer_Guides/06_Testing/04_Fixtures.md
Original file line number Diff line number Diff line change
@@ -189,7 +189,7 @@ test.

### Fixtures for namespaced classes

As of Silverstripe CMS 4 you will need to use fully qualfied class names in your YAML fixture files. In the above examples, they belong to the global namespace so there is nothing requires, but if you have a deeper DataObject, or it has a relationship to models that are part of the framework for example, you will need to include their namespaces:
As of Silverstripe CMS 4 you will need to use fully qualified class names in your YAML fixture files. In the above examples, they belong to the global namespace so there is nothing requires, but if you have a deeper DataObject, or it has a relationship to models that are part of the framework for example, you will need to include their namespaces:


```yml
Original file line number Diff line number Diff line change
@@ -106,7 +106,7 @@ The final part of our test is an assertion command, `assertEquals`. An assertion
in our test methods (in this case we are testing if two values are equal). A test method can have more than one
assertion command, and if any one of these assertions fail, so will the test method.

The example **phpunit.xml** file should be placed in the root folder of your project. PHPUnit 5.7 should be included by default, as a dev dependancy, in the **composer.json** file.
The example **phpunit.xml** file should be placed in the root folder of your project. PHPUnit 5.7 should be included by default, as a dev dependency, in the **composer.json** file.

## Caching

2 changes: 1 addition & 1 deletion docs/en/02_Developer_Guides/08_Performance/01_Caching.md
Original file line number Diff line number Diff line change
@@ -72,7 +72,7 @@ Caches are namespaced, which might allow granular clearing of a particular cache
In our example, the namespace is "myCache", expressed in the service name as
`Psr\SimpleCache\CacheInterface.myCache`. We recommend the `::class` short-hand to compose the full service name.

Clearing caches by namespace is dependant on the used adapter: While the `FilesystemCache` adapter clears only the namespaced cache,
Clearing caches by namespace is dependent on the used adapter: While the `FilesystemCache` adapter clears only the namespaced cache,
a `MemcachedCache` adapter will clear all caches regardless of namespace, since the underlying memcached
service doesn't support this. See "Invalidation" for alternative strategies.

Original file line number Diff line number Diff line change
@@ -49,7 +49,7 @@ It comes with methods which let developers safely interact with the `Cache-Contr

Simple way to set cache control header to a non-cacheable state.
Use this method over `privateCache()` if you are unsure about caching details.
Takes precendence over unforced `enableCache()`, `privateCache()` or `publicCache()` calls.
Takes precedence over unforced `enableCache()`, `privateCache()` or `publicCache()` calls.

Removes all state and replaces it with `no-cache, no-store, must-revalidate`. Although `no-store` is sufficient
the others are added under [recommendation from Mozilla](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#Examples)
Original file line number Diff line number Diff line change
@@ -468,7 +468,7 @@ given variable is done safely, with the assumption that it's an integer.

To cast the variable as an integer, place `(int)` or `(integer)` before the variable.

For example: a page with the URL paramaters *example.com/home/add/1* requires that ''Director::urlParams['ID']'' be an
For example: a page with the URL parameters *example.com/home/add/1* requires that ''Director::urlParams['ID']'' be an
integer. We cast it by adding `(int)` - ''(int)Director::urlParams['ID']''. If a value other than an integer is
passed, such as *example.com/home/add/dfsdfdsfd*, then it returns 0.

2 changes: 1 addition & 1 deletion docs/en/02_Developer_Guides/12_Search/01_Searchcontext.md
Original file line number Diff line number Diff line change
@@ -190,7 +190,7 @@ Results.PaginationSummary(4) defines how many pages the search will show in the
<% if $Results %>
<ul>
<% loop $Results %>
<li>$Title, $Autor</li>
<li>$Title, $Author</li>
<% end_loop %>
</ul>
<% else %>
2 changes: 1 addition & 1 deletion docs/en/02_Developer_Guides/13_i18n/index.md
Original file line number Diff line number Diff line change
@@ -124,7 +124,7 @@ By default, URLs for pages in Silverstripe CMS (the `SiteTree->URLSegment` prope
are automatically reduced to the allowed allowed subset of ASCII characters.
If characters outside this subset are added, they are either removed or (if possible) "transliterated".
This describes the process of converting from one character set to another
while keeping characters recognizeable. For example, vowels with french accents
while keeping characters recognizable. For example, vowels with french accents
are replaced with their base characters, `pâté` becomes `pate`.

It is advisable to set the `SS_Transliterator.use_iconv` setting to true via config for systems
4 changes: 2 additions & 2 deletions docs/en/02_Developer_Guides/14_Files/01_File_Management.md
Original file line number Diff line number Diff line change
@@ -68,7 +68,7 @@ In order to ensure that assets are made public you should check the following:

## File shortcodes

Shortcodes represent an embeded asset within a block of HTML text. For instance, this is the content
Shortcodes represent an embedded asset within a block of HTML text. For instance, this is the content
of a page with a shortcode image:

```html
@@ -275,7 +275,7 @@ or embed those images.
By default files which do not exist on either the live or draft stage (but do have a version history)
are removed from the filesystem.

In order to permanantly keep a record of all past physical files you can set the `File.keep_archived_assets`
In order to permanently keep a record of all past physical files you can set the `File.keep_archived_assets`
config option to true. This will ensure that historic files can always be restored, albeit at a cost to disk
storage.

6 changes: 3 additions & 3 deletions docs/en/02_Developer_Guides/14_Files/03_File_Security.md
Original file line number Diff line number Diff line change
@@ -77,7 +77,7 @@ Custom implementations (e.g. APIs or custom file viewers) can have
further restrictions in your project.

[warning]
When implenting your own `canView()` logic through [extensions](/developer_guides/extending/extensions),
When implementing your own `canView()` logic through [extensions](/developer_guides/extending/extensions),
existing unprotected files are not retroactively moved to the protected asset store.
While those new permissions are honoured in the CMS, protected files through custom `canView()`
can still be downloaded through a public URL until a `write()` operation is triggered on them.
@@ -406,7 +406,7 @@ SilverStripe\Assets\Flysystem\FlysystemAssetStore:
By default, the default extension `AssetControlExtension` will control the disposal of assets
attached to objects when those objects are archived or replaced. For example, unpublished versioned objects
will automatically have their attached assets moved to the protected store. The archive of
draft or (or deletion of unversioned objects) will have those assets permanantly deleted
draft or (or deletion of unversioned objects) will have those assets permanently deleted
(along with all variants).

Note that regardless of this setting, the database record will still be archived in the
@@ -469,7 +469,7 @@ bypasses PHP requests for files that do exist. The default template
(declared by `PublicAssetAdapter_HTAccess.ss`) has the following section, which may be customised in your project:

```
# Non existant files passed to requesthandler
# Non existent files passed to requesthandler
RewriteCond %{REQUEST_URI} ^(.*)$
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule .* ../index.php [QSA]
Loading