SilverStripe

https://docs.silverstripe.org/en/6/
Admin
SilverStripe is a flexible PHP-based CMS and framework for building and managing websites with a...
Tokens:74,715
Snippets:1,293
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example File Structure

Source: https://docs.silverstripe.org/en/6/contributing/documentation

Illustrates a typical directory structure for documentation files, including how to organize how-to guides and main content.

```text
00_Model/
├─ How_Tos
   ├─ Dynamic_Default_Fields.md
   ├─ Grouping_DataObject_Sets.md
   └─ index.md
├─ 00_Data_Model_and_ORM.md
├─ 01_Relations.md
├─ ...
└─ index.md
```

--------------------------------

### Common Sake Commands

Source: https://docs.silverstripe.org/en/6/developer_guides/cli/sake

Examples of frequently used Sake commands for listing commands, tasks, building the database, flushing the cache, and getting help.

```bash
# list available commands
sake # or `sake list`

# list available tasks
sake tasks

# build the database
sake db:build

# flush the cache
sake flush # or use the `--flush` flag with any command

# get help info about a command (including tasks)
sake <command> --help # e.g. `sake db:build --help`

```

--------------------------------

### Install and use Node.js with nvm

Source: https://docs.silverstripe.org/en/6/contributing/build_tooling

Installs and uses the recommended version of Node.js via Node Version Manager (nvm). Ensure nvm is installed first.

```bash
nvm install && nvm use

```

--------------------------------

### Install Login Forms Module

Source: https://docs.silverstripe.org/en/6/optional_features/login-forms

Install the login-forms module using Composer.

```bash
composer require silverstripe/login-forms

```

--------------------------------

### Install Static Publish Queue Module

Source: https://docs.silverstripe.org/en/6/optional_features/staticpublishqueue

Install the staticpublishqueue module using Composer.

```bash
composer require silverstripe/staticpublishqueue

```

--------------------------------

### Install Silverstripe GraphQL

Source: https://docs.silverstripe.org/en/6/optional_features/graphql

Install the silverstripe/graphql package using Composer.

```bash
composer require silverstripe/graphql

```

--------------------------------

### Create Project with Latest Unstable Installer

Source: https://docs.silverstripe.org/en/6/getting_started/composer

Use this command to start a new Silverstripe project based on the latest unstable version of the silverstripe/installer. This is useful for contributing to the CMS or getting early access to changes.

```bash
composer create-project silverstripe/installer ./my-project 6.x-dev
```

--------------------------------

### Install UserForms Module

Source: https://docs.silverstripe.org/en/6/optional_features/userforms

Install the SilverStripe UserForms module using Composer.

```bash
composer require silverstripe/userforms

```

--------------------------------

### Install Dependencies and Lint Documentation

Source: https://docs.silverstripe.org/en/6/contributing/documentation

Run these commands to install necessary dependencies and lint the documentation locally. Use the `--fix` option to automatically resolve fixable linting issues.

```bash
yarn install
composer install
yarn lint

```

```bash
yarn lint --fix

```

--------------------------------

### Install TinyMCE Module

Source: https://docs.silverstripe.org/en/6/optional_features/htmleditor-tinymce

Install the TinyMCE module using Composer. This is the initial step to integrate the editor.

```bash
composer require silverstripe/htmleditor-tinymce

```

--------------------------------

### Install dependencies with Composer

Source: https://docs.silverstripe.org/en/6/getting_started/composer

Use `composer install` to install dependencies based on the `composer.lock` file for reproducible builds. For production, use `--no-dev` to exclude development dependencies and `-o` to optimize the autoloader for speed.

```bash
composer install --no-dev -o
```

--------------------------------

### Install TOTP Authenticator Module

Source: https://docs.silverstripe.org/en/6/optional_features/totp-authenticator

Install the TOTP authenticator module using Composer.

```bash
composer require silverstripe/totp-authenticator

```

--------------------------------

### Install Silverstripe CMS using Composer

Source: https://docs.silverstripe.org/en/6/getting_started

Use this command to create a new Silverstripe project. Ensure you have Composer installed.

```bash
composer create-project silverstripe/installer my-project

```

--------------------------------

### Install Silverstripe Taxonomy Module

Source: https://docs.silverstripe.org/en/6/optional_features/taxonomies

Use Composer to install the silverstripe/taxonomy module. Ensure your Silverstripe CMS installation is compatible.

```bash
composer require silverstripe/taxonomy

```

--------------------------------

### Example Tags for Branching Strategy

Source: https://docs.silverstripe.org/en/6/project_governance/repository_management

Illustrates existing tags to understand the context for branch naming conventions. These examples help determine which branches are for patch, minor, or major releases.

```text
1.1.17
1.2.0

```

--------------------------------

### Install Silverstripe CMS Project

Source: https://docs.silverstripe.org/en/6/contributing/code

Use this command to create a new Silverstripe project installation. Specify the desired version branch (e.g., 6.1.x-dev).

```bash
composer create-project --keep-vcs silverstripe/installer ./your-website-folder 6.1.x-dev

```

--------------------------------

### Check Composer Installation

Source: https://docs.silverstripe.org/en/6/getting_started/composer

Verify that the Composer command is installed and accessible globally on your system.

```bash
composer help

```

--------------------------------

### Install GridField Bulk Editing Tools

Source: https://docs.silverstripe.org/en/6/optional_features/gridfield-bulk-editing-tools

Install the GridField bulk editing tools module using Composer.

```bash
composer require colymba/gridfield-bulk-editing-tools

```

--------------------------------

### Install Module from GitHub using Composer

Source: https://docs.silverstripe.org/en/6/developer_guides/extending/modules

Use this command to install a module directly from a GitHub repository, ensuring local development files are kept. Adjust the branch name (e.g., 'dev-main') as needed.

```bash
composer require my_vendor/module_name:dev-main --prefer-source

```

--------------------------------

### Install JavaScript dependencies

Source: https://docs.silverstripe.org/en/6/contributing/build_tooling

Installs all JavaScript dependencies defined in package.json. Run this command in the root of the silverstripe/admin module and any other modules you are working on.

```bash
yarn install

```

--------------------------------

### Install RealMe Module

Source: https://docs.silverstripe.org/en/6/optional_features/realme

Install the RealMe module using Composer. This command adds the module to your Silverstripe project.

```bash
composer require silverstripe/realme

```

--------------------------------

### Install Elemental Module

Source: https://docs.silverstripe.org/en/6/optional_features/elemental

Install the Elemental module using Composer. This command adds the necessary package to your Silverstripe project.

```bash
composer require dnadesign/silverstripe-elemental

```

--------------------------------

### Install Text Extraction Module

Source: https://docs.silverstripe.org/en/6/optional_features/textextraction

Install the text extraction module using Composer. This command adds the necessary package to your project.

```bash
composer require silverstripe/textextraction
```

--------------------------------

### Create a Working Branch

Source: https://docs.silverstripe.org/en/6/contributing/code

Before starting work, ensure you are on the correct base branch (e.g., origin/6.1) and then create a new branch for your changes. Use a descriptive name, like 'pulls/6.1/fix-preview-modes'.

```bash
# make sure you're starting from the correct branch first
cd vendor/<org>/<module>
git checkout --track origin/6.1
# then create your working branch
git checkout -b <your-branch-name>

```

--------------------------------

### Install MFA module

Source: https://docs.silverstripe.org/en/6/optional_features/mfa

Use composer to add the MFA module to your Silverstripe project.

```bash
composer require silverstripe/mfa
```

--------------------------------

### Install Queued Jobs Module

Source: https://docs.silverstripe.org/en/6/optional_features/queuedjobs

Install the Queued Jobs module using Composer. This command adds the necessary package to your Silverstripe project.

```bash
composer require symbiote/silverstripe-queuedjobs

```

--------------------------------

### Page Metadata (Frontmatter) Example

Source: https://docs.silverstripe.org/en/6/contributing/documentation

Shows the standard frontmatter format used for page metadata, including title, summary, and icon.

```yaml
---
title: My page title
summary: This summary, the title, and the icon will all be used when rendering this page as a child.
icon: file-alt
---
```

--------------------------------

### Install GridField Extensions

Source: https://docs.silverstripe.org/en/6/optional_features/gridfieldextensions

Install the GridField extensions module using Composer. This command adds the necessary package to your Silverstripe project.

```bash
composer require symbiote/silverstripe-gridfieldextensions
```

--------------------------------

### Example Good Commit Message

Source: https://docs.silverstripe.org/en/6/contributing/code

Demonstrates the recommended format for commit messages, including a concise subject line and a detailed explanation of the changes.

```text
FIX Allow multiple iterations of eager-loaded DataLists

Previously, a second iteration would add every relation item to the
relation list a second time - so with each iteration your relation list
count doubled (though it was the same records time and again).

```

--------------------------------

### Navigate HTTP Route with Sake

Source: https://docs.silverstripe.org/en/6/changelogs/6.0.0

Use the `sake navigate` command to access an HTTP route within your project if needed. Example: `sake navigate about-us/teams`.

```bash
sake navigate about-us/teams
```

--------------------------------

### Install Advanced Workflow Module

Source: https://docs.silverstripe.org/en/6/optional_features/advancedworkflow

Use Composer to install the Advanced Workflow module. This command should be run in your project's root directory.

```bash
composer require symbiote/silverstripe-advancedworkflow

```

--------------------------------

### Public File Path Example

Source: https://docs.silverstripe.org/en/6/developer_guides/files/file_storage

Illustrates the expected file structure for public files within the assets directory and how it maps to a public URL. Files are stored in their respective folders by their filenames.

```text
assets/
    my-public-folder/
        my-public-file.jpg


```

--------------------------------

### Require a Module with Composer

Source: https://docs.silverstripe.org/en/6/getting_started/composer

Install a module using the standard Composer command. Composer will use the defined repositories to find and install the specified package, prioritizing forks or unreleased versions.

```bash
composer require silverstripe/cms

```

--------------------------------

### Basic Cache Operations (Get, Set, Has)

Source: https://docs.silverstripe.org/en/6/developer_guides/performance/object_caching

Demonstrates fundamental PSR-16 cache operations: retrieving a value, setting a value with a key, and checking for the existence of a cache item.

```php
use Psr\SimpleCache\CacheInterface;
use SilverStripe\Core\Injector\Injector;

$cache = Injector::inst()->get(CacheInterface::class . '.myCache');


// create a new item by trying to get it from the cache
$myValue = $cache->get('myCacheKey');

// set a value and save it via the adapter
$cache->set('myCacheKey', 1234);

// retrieve the cache item
if (!$cache->has('myCacheKey')) {
    // ... item does not exists in the cache
}
```

--------------------------------

### Configure Read-only Replica Databases

Source: https://docs.silverstripe.org/en/6/changelogs/6.0.0

Define read-only replica database servers by suffixing environment variable names with _REPLICA_<replica-number>. Replicas must be numbered sequentially starting from 01.

```env
SS_DATABASE_SERVER="primary-database-server-name"

SS_DATABASE_SERVER_REPLICA_01="read-only-server1"
SS_DATABASE_SERVER_REPLICA_02="read-only-server2"
#...
SS_DATABASE_SERVER_REPLICA_12="read-only-server12"

```

--------------------------------

### Build the Database

Source: https://docs.silverstripe.org/en/6/getting_started

Run this command to initialize your database schema after configuring the .env file. This command uses the Sake tool.

```bash
vendor/bin/sake db:build

```

--------------------------------

### Configure Environment Variables

Source: https://docs.silverstripe.org/en/6/getting_started

Set up your database credentials and admin user details in the .env file. Replace placeholders with your specific information.

```bash
SS_DATABASE_CLASS="MySQLDatabase"
SS_DATABASE_NAME="<database>"
SS_DATABASE_SERVER="localhost"
SS_DATABASE_USERNAME="<user>"
SS_DATABASE_PASSWORD="<password>"
SS_DEFAULT_ADMIN_USERNAME="admin"
SS_DEFAULT_ADMIN_PASSWORD="password"
SS_ENVIRONMENT_TYPE="<dev|test|live>"

```

--------------------------------

### Create a development environment with Composer

Source: https://docs.silverstripe.org/en/6/getting_started/composer

Set up a development environment for contributing to Silverstripe CMS by using `composer create-project` with the `--keep-vcs` flag and specifying a development version. This ensures full git repository information and includes developer requirements.

```bash
composer create-project --keep-vcs silverstripe/installer ./my-project 6.x-dev --prefer-source
```

--------------------------------

### Manage Daemon Processes with systemctl

Source: https://docs.silverstripe.org/en/6/changelogs/6.0.0

The `sake -start` and `sake -stop` commands for managing daemon processes have been removed. Use a dedicated daemon tool like `systemctl` for process management.

```bash
sake -start my-process
systemctl start my-process.service
```

--------------------------------

### Install TagField Module

Source: https://docs.silverstripe.org/en/6/optional_features/tagfield

Install the TagField module using Composer. This command adds the module to your Silverstripe project.

```bash
composer require silverstripe/tagfield

```

--------------------------------

### Loading Local File into DBFile

Source: https://docs.silverstripe.org/en/6/developer_guides/files/file_storage

Demonstrates how to set a DBFile field from a local filesystem path, specifying a destination filename within the assets folder.

```php
use App\Model\Banner;

// Image could be assigned in other parts of the code using the below
$banner = Banner::create();
$banner->Image->setFromLocalFile($tempfile['path'], 'my-folder/my-file.jpg');
```

--------------------------------

### Update Installed Packages with Composer

Source: https://docs.silverstripe.org/en/6/getting_started/composer

Run this command after manually editing your composer.json file to update the installed packages and reflect your changes.

```bash
composer update
```

--------------------------------

### Run a Specific Test File

Source: https://docs.silverstripe.org/en/6/developer_guides/testing

Execute a single test file. Ensure you are in your webroot folder.

```bash
vendor/bin/phpunit vendor/silverstripe/framework/tests/filesystem/FolderTest.php
```

--------------------------------

### Common Sake Commands

Source: https://docs.silverstripe.org/en/6/changelogs/6.0.0

List of common commands available in the new Sake CLI. You may need to prepend these with `vendor/bin/`.

```bash
# list available commands
sake # or `sake list`

# list available tasks
sake tasks

# build the database
sake db:build

# flush the cache
sake flush # or use the `--flush` flag with any command

# get help info about a command (including tasks)
sake <command> --help # e.g. `sake db:build --help`
```

--------------------------------

### Install yarn globally

Source: https://docs.silverstripe.org/en/6/contributing/build_tooling

Installs the yarn package manager globally using npm, which comes with Node.js. This is a prerequisite for managing JavaScript dependencies.

```bash
npm install -g yarn

```

--------------------------------

### Install a Silverstripe Module

Source: https://docs.silverstripe.org/en/6/developer_guides/extending/modules

Use the Composer package manager to install a module into your Silverstripe CMS project. This command fetches the latest compatible stable version.

```bash
composer require silverstripe/linkfield

```

--------------------------------

### Run All Tests

Source: https://docs.silverstripe.org/en/6/developer_guides/testing

Execute all tests defined in the phpunit.xml configuration file. Ensure you are in your webroot folder.

```bash
vendor/bin/phpunit
```

--------------------------------

### Configure User Help Link

Source: https://docs.silverstripe.org/en/6/optional_features/totp-authenticator

Customize or disable the 'find out more' link shown during the multi-factor login process. Set to null to disable or provide a custom URL to your documentation.

```yaml
SilverStripe\TOTP\RegisterHandler:
  user_help_link: 'https://intranet.mycompany.com/help-docs/using-totp'

```

--------------------------------

### Get Database Connection (Replica or Primary)

Source: https://docs.silverstripe.org/en/6/changelogs/6.0.0

When replicas are configured, DB::get_conn() defaults to a replica. Use DB::get_conn(DB::CONN_PRIMARY) to explicitly get the primary database connection.

```php
DB::get_conn()
DB::get_conn(DB::CONN_PRIMARY)
```

--------------------------------

### Get a Cache Instance

Source: https://docs.silverstripe.org/en/6/developer_guides/performance/object_caching

Retrieve a configured cache instance using the Injector. Ensure the cache namespace matches your YAML configuration.

```php
use Psr\SimpleCache\CacheInterface;
use SilverStripe\Core\Injector\Injector;

$cache = Injector::inst()->get(CacheInterface::class . '.myCache');
```

--------------------------------

### Add a Module with a Specific Version Constraint

Source: https://docs.silverstripe.org/en/6/getting_started/composer

Install a specific version of a Silverstripe CMS module by providing a version constraint after the package name.

```bash
composer require dnadesign/silverstripe-elemental ^6

```

--------------------------------

### Run Module Tests

Source: https://docs.silverstripe.org/en/6/developer_guides/testing

Execute all tests within a specific module. Navigate to your webroot folder before running.

```bash
vendor/bin/phpunit vendor/silverstripe/framework/tests/
```

--------------------------------

### Enforce Password History Check

Source: https://docs.silverstripe.org/en/6/developer_guides/security/secure_coding

Configure the PasswordValidator to prevent users from reusing recent passwords. This example prevents the last 6 passwords from being reused.

```yaml
SilverStripe\Security\Validation\PasswordValidator:
  historic_count: 6

```

--------------------------------

### Versioned Cache Segmentation: Before

Source: https://docs.silverstripe.org/en/6/developer_guides/performance/object_caching

Demonstrates caching draft content that would be exposed on the live stage without proper checks. This approach is problematic with versioned data.

```php
// Before:
$cache = Injector::inst()->get(CacheInterface::class . '.myapp');
Versioned::set_stage(Versioned::DRAFT);
$cache->set('my_key', 'Some draft content. Not for public viewing yet.');
Versioned::set_stage(Versioned::LIVE);
// 'Some draft content. Not for public viewing yet'
$cache->get('my_key');

```

--------------------------------

### Re-install Module with Composer

Source: https://docs.silverstripe.org/en/6/contributing/code

If you have an existing project and need to implement changes in a module's context, use this command to ensure the full source is available. Replace <org>/<module> with the specific module identifier.

```bash
# re-install the module using prefer-source.
# replace <org>/<module> with the module you're making changes to (e.g. silverstripe/framework)
composer reinstall <org>/<module> --prefer-source

```

--------------------------------

### Nested Cached Blocks

Source: https://docs.silverstripe.org/en/6/developer_guides/templates/partial_template_caching

Demonstrates how nested cache blocks are processed independently. The example shows a header, body, and footer, with the body being cached separately.

```html
<% cached $PageKey %>
  <%-- Header goes here --%> 

  <% cached $BodyKey %>
    <%-- Body goes here --%> 
  <% end_cached %>

  <%-- Footer goes here --%> 
<% end_cached %>
```

--------------------------------

### Get Themed Resource URL in HTML

Source: https://docs.silverstripe.org/en/6/developer_guides/templates/requirements

Injects links to resources that respect cascading themes. Use this in your HTML templates to reference images or other assets.

```html
<img src="$themedResourceURL('images/my-image.jpg')">
<img src="$themedResourceURL('images')/$Image.jpg">

```

--------------------------------

### Using Debug and Backtrace utilities

Source: https://docs.silverstripe.org/en/6/developer_guides/debugging

Static methods for inspecting variables, displaying messages, and generating call stacks.

```php
use SilverStripe\Dev\Backtrace;
use SilverStripe\Dev\Debug;

Debug::show($myVariable);
// similar to print_r($myVariable) but shows it in a more useful format.

Debug::message("Wow, that's great");
// prints a short debugging message.

Backtrace::backtrace();
// prints a calls-stack
```
Tokens:
Raw