SilverStripe CMS

https://docs.silverstripe.org/en/3
Admin
SilverStripe CMS is an open-source content management system and web application framework that...
Tokens:333,153
Snippets:1,961
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### PHPUnit setUp() Method Example

Source: https://docs.silverstripe.org/en/3/developer_guides/testing/unit_testing

This PHP code demonstrates the use of the setUp() method within a SilverStripe test case. It sets up prerequisites for tests, such as creating and publishing multiple pages and configuring custom settings.

```php
	<?php

	class PageTest extends SapphireTest {

		function setUp() {
			parent::setUp();

			// create 100 pages
			for($i=0; $i<100; $i++) {
				$page = new Page(array('Title' => "Page $i"));
				$page->write();
				$page->publish('Stage', 'Live');
			}

			// set custom configuration for the test.
			Config::inst()->update('Foo', 'bar', 'Hello!');
		}

		public function testMyMethod() {
			// ..
		}

		public function testMySecondMethod() {
			// ..
		}
	}
```

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

### Nginx and HHVM Setup on Debian/Ubuntu

Source: https://docs.silverstripe.org/en/3/getting_started/installation/how_to

Guides users through the process of setting up Nginx and HHVM on Debian/Ubuntu systems using package installations for Silverstripe CMS.

```bash
# Bash script for installing Nginx and HHVM on Debian/Ubuntu
# Example commands would go here.
```

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

### PHPUnit setUpOnce() and tearDownOnce() Example

Source: https://docs.silverstripe.org/en/3/developer_guides/testing/unit_testing

This PHP code illustrates the usage of setUpOnce() and tearDownOnce() methods in SilverStripe test cases. These methods are executed once before and after all tests in the class, respectively, for setup and cleanup operations.

```php
	<?php

	class PageTest extends SapphireTest {

		function setUpOnce() {
			parent::setUpOnce();

			// ..
		}

		public function tearDownOnce() {
			parent::tearDownOnce();

			// ..
		}
	}
	
```

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

### Configure HHVM to Start on Boot

Source: https://docs.silverstripe.org/en/3/getting_started/installation/how_to/setup_nginx_and_hhvm

This command ensures that HHVM is set to start automatically when the system boots up by updating the run-level defaults.

```bash
sudo update-rc.d hhvm defaults
```

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

### Install SilverStripe CMS via Composer

Source: https://docs.silverstripe.org/en/3/getting_started/installation

This snippet outlines the process of installing SilverStripe CMS using Composer, a dependency manager for PHP. It assumes Composer is already installed and accessible.

```bash
composer create-project silverstripe/installer my-project-directory
cd my-project-directory
composer serve
```

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

### Nginx Server Configuration Example for Silverstripe

Source: https://docs.silverstripe.org/en/3/getting_started/installation/how_to/setup_nginx_and_hhvm

This example shows how to include the HHVM and Silverstripe-specific Nginx configuration files within a main Nginx server block to serve a Silverstripe website.

```nginx
server {
		listen 80;
		root /var/www/mysite;
		server_name www.mysite.com;

		error_log /var/log/nginx/mysite.error.log;
		access_log /var/log/nginx/mysite.access.log;

		include /etc/nginx/hhvm.conf;
		include /etc/nginx/silverstripe.conf;
	}
```

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

### Start Apache Server

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/mac_osx_homebrew

Starts the Apache web server using the system's service management.

```shell
sudo apachectl start
```

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

### Complete Composer.json with SSAutoGitIgnore

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

This is a full example of a `composer.json` file for a SilverStripe project that includes the SSAutoGitIgnore package under `require-dev` and configures the `post-update-cmd` script.

```json
{
		"name": "silverstripe/installer",
		"description": "The SilverStripe Framework Installer",
		"require": {
			"php": ">=5.3.2",
			"silverstripe/cms": "3.0.*",
			"silverstripe/framework": "3.0.*",
			"silverstripe-themes/simple": "*"
		},
		"require-dev": {
			"silverstripe/compass": "*",
			"silverstripe/docsviewer": "*",
			"gdmedia/ss-auto-git-ignore": "*"
		},
		"scripts": {
			"post-update-cmd": "GDM\SSAutoGitIgnore\UpdateScript::Go"
		},
		"minimum-stability": "dev"
	}
```

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

### Silverstripe CMS: Running PHPUnit Tests via CLI

Source: https://docs.silverstripe.org/en/3/developer_guides/testing/unit_testing

Provides examples of using the PHPUnit binary from the Silverstripe CMS root directory to execute various test commands, including running all tests, tests for a specific module, specific test files, or specific tests with optional GET parameters.

```bash
phpunit
	# Runs all tests

	phpunit framework/tests/
	# Run all tests of a specific module

	phpunit framework/tests/filesystem
	# Run specific tests within a specific module

	phpunit framework/tests/filesystem/FolderTest.php
	# Run a specific test

	phpunit framework/tests/ '' flush=all
	# Run tests with optional `$_GET` parameters (you need an empty second argument)
```

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

### Create Project with Development Version

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

These commands demonstrate how to create a new SilverStripe project using the 'master-dev' or a specific development branch of the installer, ensuring you get the latest unstable versions.

```bash
composer create-project silverstripe/installer ./my/website/folder master-dev
```

```bash
composer create-project silverstripe/installer ./my/website/folder 3.0.x-dev
```

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

### Silverstripe CMS: Running Tests via Sake CLI

Source: https://docs.silverstripe.org/en/3/developer_guides/testing/unit_testing

Illustrates how to use the Silverstripe sake executable to run tests. This includes commands for running all tests, tests for specific modules, specific test classes, and tests with optional GET parameters or skipped tests.

```bash
sake dev/tests/all
	# Run all tests

	sake dev/tests/module/framework,cms
	# Run all tests of a specific module (comma-separated)

	sake dev/tests/FolderTest,OtherTest
	# Run specific tests (comma-separated)

	sake dev/tests/all "flush=all&foo=bar"
	# Run tests with optional `$_GET` parameters

	sake dev/tests/all SkipTests=MySkippedTest
	# Skip some tests
```

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

### Load Apache Launch Daemon

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/mac_osx_homebrew

Loads the Apache launch daemon, ensuring it starts automatically on system startup.

```shell
sudo launchctl load -w /System/Library/LaunchDaemons/org.apache.httpd.plist
```

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

### Install and Configure MariaDB

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/mac_osx_homebrew

Installs MariaDB, a popular open-source relational database, and performs initial setup and security configuration.

```shell
brew install mariadb
unset TMPDIR
mysql_install_db --user=`whoami` --basedir="$(brew --prefix mariadb)" --datadir=/usr/local/var/mysql --tmpdir=/tmp
mysql.server start
'/usr/local/opt/mariadb/bin/mysql_secure_installation'
```

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

### Manage MariaDB Launch Agents

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/mac_osx_homebrew

Creates a symbolic link to manage the MariaDB launch agent, allowing it to start automatically.

```shell
ln -sfv /usr/local/opt/mariadb/*.plist ~/Library/LaunchAgents
```

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

### Install HHVM Repositories on Ubuntu (Trusty)

Source: https://docs.silverstripe.org/en/3/getting_started/installation/how_to/setup_nginx_and_hhvm

This snippet demonstrates adding the HHVM repository and GPG key for Ubuntu (Trusty) to facilitate installation using apt-get.

```bash
wget -O - http://dl.hhvm.com/conf/hhvm.gpg.key | sudo apt-key add -

echo deb http://dl.hhvm.com/ubuntu trusty main | sudo tee /etc/apt/sources.list.d/hhvm.list
```

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

### Silverstripe CMS Installation via Composer

Source: https://docs.silverstripe.org/en/3/getting_started/installation/windows

Installs the latest stable version of Silverstripe CMS into a 'silverstripe' sub-folder using Composer. Requires PHP and Composer to be installed.

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

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

### Example Silverstripe Environment Configuration

Source: https://docs.silverstripe.org/en/3/contributing/making_a_silverstripe_core_release

Provides an example configuration for the `_ss_environment.php` file, which is crucial for setting up the Silverstripe CMS environment. It includes definitions for database credentials, environment type, trusted proxies, and CLI hostname.

```php
<?php
    // Environent
    define('SS_TRUSTED_PROXY_IPS', '*');
    define('SS_ENVIRONMENT_TYPE', 'dev');
    
    // DB Credentials
    define('SS_DATABASE_CLASS', 'MySQLDatabase');
    define('SS_DATABASE_SERVER', '127.0.0.1');
    define('SS_DATABASE_USERNAME', 'root');
    define('SS_DATABASE_PASSWORD', '');
    
    // Each release will have its own DB
    define('SS_DATABASE_CHOOSE_NAME', true);
    
    // So you can test releases
    define('SS_DEFAULT_ADMIN_USERNAME', 'admin');
    define('SS_DEFAULT_ADMIN_PASSWORD', 'password');
    
    // Basic CLI hostname
    global $_FILE_TO_URL_MAPPING;
    $_FILE_TO_URL_MAPPING[__DIR__] = "http://localhost";

```

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

### SilverStripe .gitignore Configuration

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

Example .gitignore file for a SilverStripe project using Composer. It ignores common SilverStripe cache files, environment configurations, IDE files, and the vendor directory, while specifically excluding the forum module from being committed directly.

```gitignore
assets/*
_ss_environment.php
tools/phing-metadata
silverstripe-cache
.buildpath
.project
.settings
.idea
.DS_Store
vendor/
# Don't include the forum module, as this will be installed with composer
forum
```

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

### Install Silverstripe Module with Composer (Specific Version)

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

Shows how to install a specific version of a Silverstripe module, using 'silverstripe/blog' version '1.1.0' as an example.

```bash
composer require "silverstripe/blog" "1.1.0"
```

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

### Create Silverstripe Site with Specific Version

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

This command creates a new Silverstripe CMS project, explicitly downloading a specific version (e.g., 3.0.3) of the installer.

```bash
composer create-project silverstripe/installer ./my/website/folder 3.0.3
```

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

### Silverstripe CMS: Basic PHP Unit Test Example

Source: https://docs.silverstripe.org/en/3/developer_guides/testing/unit_testing

Demonstrates a simple unit test for a PHP method in Silverstripe CMS. It shows how to create a test class that extends SapphireTest and asserts the expected output of a static method.

```php
<?php

	class Page extends SiteTree {

		public static function MyMethod() {
			return (1 + 1);
		}
	}
```

```php
<?php

	class PageTest extends SapphireTest {

		public function testMyMethod() {
			$this->assertEquals(2, Page::MyMethod());
		}
	}
```

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

### Install HHVM and Dependencies

Source: https://docs.silverstripe.org/en/3/getting_started/installation/how_to/setup_nginx_and_hhvm

This command installs HHVM along with required development libraries (libgmp-dev, libmemcached-dev) using apt-get after updating package lists.

```bash
sudo apt-get update

sudo apt-get install hhvm libgmp-dev libmemcached-dev
```

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

### Install IIS Administration Pack

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/windows_iis7

Guide to download and install the IIS Administration Pack, noting it's pre-installed on Windows Server 2008 R2 or Windows 7 (IIS 7.5).

```powershell
Download IIS Administration Pack
Run the downloaded file to enable the IIS Administration Pack (make sure it's x86 or x64 depending on your Windows version)
```

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

### Create New Silverstripe Site

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

This command creates a new Silverstripe CMS project using the installer template. It downloads the latest stable version by default and places it in the specified directory.

```bash
composer create-project silverstripe/installer ./my/website/folder
```

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

### Install SilverStripe with Composer

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

This snippet demonstrates the recommended method for installing SilverStripe CMS using Composer, a PHP package management tool. Composer provides flexibility for installing and upgrading SilverStripe and its modules.

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

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

### Install SilverStripe Forum Module

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

Installs the SilverStripe forum module using Composer. The '*' specifies the latest compatible version. Composer will also update other existing modules and install development dependencies by default.

```bash
composer require "silverstripe/forum:*"
```

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

### Install SQL Server Native Client

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/windows_iis7

Steps to install the SQL Server Native Client, which is required for connecting to a SQL Server database from PHP.

```powershell
Go to http://www.microsoft.com/en-nz/download/details.aspx?id=29065
Scroll down to "Native Client"
Choose x86 or x64 depending on whether you installed a x86 or x64 version of Windows
Run the downloaded file to install and enable the SQL Server Native Client
```

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

### Install Silverstripe Module with Composer (Stable)

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

Demonstrates the Composer command to install a Silverstripe module, specifically the 'silverstripe/blog' module, using the latest stable version.

```bash
composer require "silverstripe/blog" "*@stable"
```

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

### Install Sake CLI Wrapper

Source: https://docs.silverstripe.org/en/3/developer_guides/cli

This command installs the 'sake' wrapper script for easier access to the Silverstripe CMS CLI. It involves copying the 'sake' file to a system-wide executable path like '/usr/bin/sake'. This process is typically for UNIX-like systems.

```bash
cd your-webroot/
sudo ./framework/sake installsake
```

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

### Install Transifex Client

Source: https://docs.silverstripe.org/en/3/contributing/making_a_silverstripe_core_release

Installs the Transifex client using pip. This client is used to interact with Transifex for managing translations and requires specific write permissions on various Silverstripe modules.

```bash
pip install transifex-client
```

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

### Install HHVM Repositories on Debian 7 (Wheezy)

Source: https://docs.silverstripe.org/en/3/getting_started/installation/how_to/setup_nginx_and_hhvm

This snippet shows how to add the HHVM repository and GPG key for Debian 7 (Wheezy) to enable installation via apt-get.

```bash
wget -O - http://dl.hhvm.com/conf/hhvm.gpg.key | sudo apt-key add -

echo deb http://dl.hhvm.com/debian wheezy main | sudo tee /etc/apt/sources.list.d/hhvm.list
```

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

### Install IIS 7.x on Windows

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/windows_iis7

Steps to install Internet Information Services (IIS) 7.x on Windows, including enabling features like CGI and Management Scripts.

```powershell
Start > Control Panel > Programs and Features
Click **Turn Windows features on or off**.
Click **Add Roles** under the Roles Summary section when Server Manager opens
Click Next >
Check **Web Server (IIS)**
Click Next >
Check CGI in the list - you'll find find it under Application Development
Scroll down and check **IIS Management Scripts and Tools**
OPTIONAL: For remote management capability, check **Management Service**
```

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

### Install IIS URL Rewrite Module

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/windows_iis7

Instructions for downloading and installing the IIS URL Rewrite Module from the official Microsoft IIS website.

```powershell
Go to http://www.iis.net/extensions/URLRewrite
Choose x86 or x64, depending on whether you installed a x86 or x64 version of Windows
Run the downloaded file to install and enable the URL Rewrite Module
```

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

### Install Silverstripe CMS using Composer

Source: https://docs.silverstripe.org/en/3/getting_started/installation/mac_osx

This command uses Composer to create a new Silverstripe CMS project. It specifies the installation directory and assumes the use of MAMP's web server environment.

```bash
composer create-project silverstripe/installer /Applications/MAMP/htdocs/silverstripe/
```

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

### Install Theme via Composer

Source: https://docs.silverstripe.org/en/3/developer_guides/templates/themes

This command installs a SilverStripe theme using Composer. Ensure you have Composer installed and configured for your project. After installation, clear the SilverStripe cache by appending '?flush=1' to your site's URL.

```bash
composer require "author/theme_name" "dev/master"
```

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

### Install Xcode Command Line Tools

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/mac_osx_homebrew

Installs the necessary build tooling for compiling PHP on macOS.

```shell
xcode-select --install
```

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

### Create Daemon Process with Sake

Source: https://docs.silverstripe.org/en/3/developer_guides/cli

This PHP code provides a template for creating a long-running daemon process using Silverstripe CMS controllers. The 'sake' tool can start and stop these processes. The example includes logic to manage memory usage and includes sleep intervals to prevent excessive resource consumption.

```php
<?php

class MyProcess extends Controller {

	private static $allowed_actions = array(
		'index'
	);

	function index() {
		set_time_limit(0);

		while(memory_get_usage() < 32*1024*1024) {
			if($this->somethingToDo()) {
				$this->doSomething();
				sleep(1)
			} else {
				sleep(300);
			}
		}
	}
}
```

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

### Silverstripe CMS Server Requirements

Source: https://docs.silverstripe.org/en/3/getting_started/installation/linux_unix

Silverstripe CMS requires a web server (like Apache or Nginx), a database (such as MariaDB, Postgres, or MySQL), and PHP to function correctly. These are the fundamental components needed for a successful installation.

```text
Web server e.g. Apache, Nginx
Database e.g. MariaDB, Postgres, MySQL
PHP
```

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

### Deploy SilverStripe Project with Composer

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

Installs project dependencies based on the composer.lock file, excluding development dependencies and optimizing the autoloader. This is the recommended command for production deployments to ensure consistent and tested code.

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

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

### Install Composer Dependency Manager

Source: https://docs.silverstripe.org/en/3/getting_started/installation/mac_osx

This section provides the commands to download and install the Composer dependency manager for PHP. It includes steps to make the 'composer' executable available globally.

```bash
curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer
```

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

### Run Tests with GET Parameters using sake

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

Executes all tests while passing optional GET parameters, such as 'flush=all', through the 'sake' command.

```bash
sake dev/tests/all flush=all
```

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

### Create SilverStripe Project with Composer

Source: https://docs.silverstripe.org/en/3/getting_started/installation/other_installation_options/mac_osx_homebrew

Creates a new SilverStripe project using Composer. This command downloads the necessary files and sets up a new SilverStripe installation in the specified directory.

```shell
composer create-project silverstripe/installer /Users/<user>/Sites/silverstripe/
```

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

### Singleton Pattern with Injector

Source: https://docs.silverstripe.org/en/3/developer_guides/extending/injector

Illustrates using the Injector's get() method to implement the singleton pattern. The first call to get() creates and stores an instance, and all subsequent calls return the same instance.

```php
// sets up MyClassName as a singleton
$object = Injector::inst()->get('MyClassName');
$object2 = Injector::inst()->get('MyClassName');

echo ($object === $object2);

// returns true;
```

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

### QUnit Basic JavaScript Test Example

Source: https://docs.silverstripe.org/en/3/developer_guides/customising_the_admin_interface/javascript_development

An example of a basic unit test using QUnit, a JavaScript testing framework. It demonstrates assertion methods like 'ok' and 'equals' to verify code behavior.

```JavaScript
test("a basic test example", function() {
  ok( true, "this test is fine" );
  var value = "hello";
  equals( "hello", value, "We expect value to be hello" );
});
```

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

### Install SSAutoGitIgnore with Composer

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

This command adds the SSAutoGitIgnore package as a development dependency to your SilverStripe project using Composer. It ensures that the package is available for development purposes.

```bash
composer require gdmedia/ss-auto-git-ignore --dev
```

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

### Run Tests with GET Parameters using phpunit

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

Executes tests while passing optional GET parameters, like 'flush=all', using the phpunit binary. Requires an empty second argument to separate parameters.

```bash
phpunit framework/tests/ '' flush=all
```

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

### Require Module from Fork

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

This command installs a module (e.g., silverstripe/cms) using Composer, automatically utilizing the specified VCS repository (fork) defined in composer.json instead of the default packagist version.

```bash
composer require silverstripe/cms
```

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

### Configure Lighttpd for Multiple Silverstripe Installations

Source: https://docs.silverstripe.org/en/3/getting_started/installation/how_to/configure_lighttpd

This Lighttpd configuration allows running multiple Silverstripe CMS installations on the same host by using subdirectories. It defines separate rewrite rules and error handlers for each installation (e.g., /copy1/, /copy2/).

```lighttpd
$HTTP["host"] == "yoursite.com" {
   url.rewrite-once = (
      "(?i)(/copy1/.*\.([A-Za-z0-9]+))(.*?)$" => "$0",
      "(?i)(/copy2/.*\.([A-Za-z0-9]+))(.*?)$" => "$0",
      "^/copy1/(.*?)(?|$)(.*)" => "/copy1/framework/main.php?url=$1&$3",
      "^/copy2/(.*?)(?|$)(.*)" => "/copy2/framework/main.php?url=$1&$3"
   )
   $HTTP["url"] =~ "^/copy1/" {
      server.error-handler-404 = "/copy1/framework/main.php"
   }
   $HTTP["url"] =~ "^/copy2/" {
      server.error-handler-404 = "/copy2/framework/main.php"
   }
}
```

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

### Composer Help Command

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

This command displays the help information for Composer, providing an overview of its available commands and usage.

```bash
composer help
```

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

### Enable Nginx/Apache FastCGI Support

Source: https://docs.silverstripe.org/en/3/getting_started/installation/how_to/setup_nginx_and_hhvm

This script is used to enable FastCGI support for either Nginx or Apache web servers, depending on which are installed on the system.

```bash
sudo /usr/share/hhvm/install_fastcgi.sh
```

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

### Silverstripe CMS Custom Code Structure Example

Source: https://docs.silverstripe.org/en/3/getting_started/directory_structure

Illustrates the recommended structure for custom website code in Silverstripe CMS, using `<mysite>` as an example. This includes configuration, PHP code, templates, CSS, images, and JavaScript files.

```text
Directory| Description  
---|---  
`<mysite>/`| This directory contains all of your code that defines your website.  
`<mysite>/_config`| YAML configuration specific to your application  
`<mysite>/code`| PHP code for model and controller (subdirectories are optional)  
`<mysite>/templates`| HTML templates with *.ss-extension  
`<mysite>/css`| CSS files  
`<mysite>/images`| Images used in the HTML templates  
`<mysite>/javascript`| Javascript and other script files  
```

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

### Install AWS CLI Tools

Source: https://docs.silverstripe.org/en/3/contributing/making_a_silverstripe_core_release

Installs the AWS Command Line Interface tools using pip. These tools are necessary for interacting with AWS services, specifically for managing releases stored in S3 buckets.

```bash
pip install awscli
```

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

### Install Silverstripe Cow Release Tool

Source: https://docs.silverstripe.org/en/3/contributing/making_a_silverstripe_core_release

Installs the Silverstripe 'cow' release tool globally using Composer. This tool is essential for managing the release process of Silverstripe core modules.

```bash
composer global require silverstripe/cow dev-master
```

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

### Add TemplateGlobalProvider to Installer (SilverStripe)

Source: https://docs.silverstripe.org/en/3/changelogs/beta/3

Includes the TemplateGlobalProvider in the installer, which is a requirement for i18n functionality, ensuring proper internationalization setup.

```php
63d5927 Added TemplateGlobalProvider include to installer, as required by i18n. (Ryan O'Hara)
```

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

### Silverstripe ClassInfo API Examples

Source: https://docs.silverstripe.org/en/3/developer_guides/execution_pipeline/manifests

Provides examples of using the Silverstripe CMS ClassInfo API to retrieve information about class hierarchies and interface implementations. These methods are useful for introspection and module discovery.

```php
// Get all subclasses of a given class
ClassInfo::subclassesFor('MyBaseClass');

// Get the class name and all its parent classes
ClassInfo::ancestry('MySubClass');

// Get all classes implementing a specific interface
ClassInfo::implementorsOf('MyInterface');
```

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

### Search SilverStripe Packages

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

Searches for available SilverStripe packages on Composer. This command helps discover modules and libraries within the SilverStripe ecosystem.

```bash
composer search silverstripe
```

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

### Remove Session Start in Installer

Source: https://docs.silverstripe.org/en/3/changelogs/beta/3

Removes the `session_start()` call from the installer script. This change aligns with the `requireFunction` check for `session_start`, preventing potential conflicts or redundant calls.

```php
3d62832 Removed session_start() call in installer, as it contradicts the requireFunction check for session_start as part of the installer (Sean Harvey)
```

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

### SilverStripe 3 Bootstrap Process

Source: https://docs.silverstripe.org/en/3/developer_guides/execution_pipeline

The main.php script initializes the SilverStripe environment by locating configuration files, setting constants, normalizing URLs, connecting to the database, setting up error handlers, managing sessions, loading manifests, and executing configuration files.

```php
<?php
// framework/main.php

// 1. Locate _ss_environment.php
// 2. Set constants (BASE_URL, BASE_PATH, TEMP_FOLDER)
// 3. Normalize 'url' parameter
// 4. Connect to database using $databaseConfig
// 5. Setup error handlers
// 6. Optionally continue session
// 7. Load manifests (PHP classes, templates, YAML)
// 8. Optionally regenerate manifests (?flush=1)
// 9. Execute procedural configuration from _config.php
// 10. Load Composer autoloader
// 11. Hand control to Director
?>
```

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

### Use Better Syntax for DataList Querying in Upgrade Guide

Source: https://docs.silverstripe.org/en/3/changelogs/rc/3

Updates the 3.0 upgrading guide with improved syntax examples for querying `DataList`. This ensures that the documentation reflects best practices for data retrieval.

```php
/* Use better syntax for querying DataList in 3.0 upgrading guide */
```

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

### Create SilverStripe Project with Development Dependencies

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

This Composer command creates a new SilverStripe project in a specified directory, including version control history (`--keep-vcs`) and development dependencies (`--dev`). It's used for setting up a new project or contributing to SilverStripe.

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

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

### JSpec Shopping Cart Behavior Test Example

Source: https://docs.silverstripe.org/en/3/developer_guides/customising_the_admin_interface/javascript_development

A behavior-driven testing example using JSpec for a ShoppingCart. It illustrates defining test suites, setup blocks ('before_each'), and individual test cases ('it') to describe expected behavior.

```Ruby
describe 'ShoppingCart'
  before_each
    cart = new ShoppingCart
  end
  describe 'addProduct'
    it 'should add a product'
      cart.addProduct('cookie')
      cart.addProduct('icecream')
      cart.should.have 2, 'products'
    end
  end
end
```

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

### Getting Attributes from XML with RestfulService

Source: https://docs.silverstripe.org/en/3/developer_guides/integration/restfulservice

This example shows how to retrieve attributes from XML nodes using the `getAttributes` method. It targets the 'id' attribute of 'entry' nodes within the 'entries' element.

```php
$this->getAttributes($xml, "entries", "entry");

	// array(array('id' => 12), array('id' => '15'), ..)
```

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

### Silverstripe CMS: Simple Contact Form

Source: https://docs.silverstripe.org/en/3/developer_guides/forms/how_tos

Create a form that submits a message via email using Silverstripe CMS. This guide covers the basic setup for a functional contact form.

```php
<?php

use SilverStripe\Forms\Form;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\TextField;
use SilverStripe\Forms\TextareaField;
use SilverStripe\Forms\FormAction;
use SilverStripe\Control\Email;

class ContactForm extends Form {
    public function __construct($controller) {
        $fields = FieldList::create([
            TextField::create('Name', 'Your Name'),
            TextField::create('Email', 'Your Email'),
            TextareaField::create('Message', 'Message')
        ]);

        $actions = FieldList::create([
            FormAction::create('submit', 'Send Message')
        ]);

        parent::__construct($controller, 'ContactForm', $fields, $actions);
    }

    public function submit($data, $form) {
        $email = Email::create();
        $email->setFrom($data['Email']);
        $email->setTo('admin@example.com'); // Replace with your admin email
        $email->setSubject('New Contact Form Submission');
        $email->setBody(
            "Name: " . $data['Name'] . "\n" .
            "Email: " . $data['Email'] . "\n" .
            "Message: " . $data['Message']
        );

        $email->send();

        return $this->controller->redirect('/contact/thankyou/');
    }
}
?>
```

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

### Rebase Branch onto Master (Conceptual Example)

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

Illustrates the command used to rebase a specific branch ('212-my-new-plugin') onto another branch ('master'). This rewrites the commit history of the feature branch as if it started from the latest commit of the target branch.

```git
git rebase master 212-my-new-plugin
```

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

### Configure SQLite In-Memory Database

Source: https://docs.silverstripe.org/en/3/developer_guides/testing/unit_testing

This PHP code configures SilverStripe to use an in-memory SQLite database for testing, significantly improving performance compared to disk-based databases. It requires the 'silverstripe/sqlite3' package and can be toggled via a GET parameter.

```php
if(Director::isDev()) {
    	if(isset($_GET['db']) && ($db = $_GET['db'])) {
        		global $databaseConfig;
        		if($db == 'sqlite3') {
        			$databaseConfig['type'] = 'SQLite3Database';
        			$databaseConfig['path'] = ':memory:';
        		}
    	}
	}
```

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

### Start and Stop Daemon Processes with Sake

Source: https://docs.silverstripe.org/en/3/developer_guides/cli

These commands demonstrate how to manage daemon processes created with Silverstripe CMS controllers using the 'sake' tool. 'sake -start <ProcessName>' initiates the daemon, and 'sake -stop <ProcessName>' terminates it.

```bash
sake -start MyProcess
```

```bash
sake -stop MyProcess
```

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

### Searching XML Nodes using XPath with RestfulService

Source: https://docs.silverstripe.org/en/3/developer_guides/integration/restfulservice

This example shows how to use XPath to search for specific nodes within an XML document, particularly useful for namespaced nodes. It searches for 'media:entry' nodes within 'media:guide'.

```php
$this->searchValue($response, "//media:guide/media:entry");

	// array('video');
```

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

### PHP Input Casting Example

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

This PHP code demonstrates casting user input from URL parameters and GET variables to integers to ensure safe processing. It shows how to cast Director::urlParam['ID'] and $_GET['category'] to integers before using them in calculations or database queries.

```php
public function CaseStudies() {
    // cast an ID from URL parameters e.g. (mysite.com/home/action/ID)
    $anotherID = (int)Director::urlParam['ID'];

    // perform a calculation, the prerequisite being $anotherID must be an integer
    $calc = $anotherID + (5 - 2) / 2;

    // cast the 'category' GET variable as an integer
    $categoryID = (int)$_GET['category'];

    // perform a byID(), which ensures the ID is an integer before querying
    return CaseStudy::get()->byID($categoryID);
}
```
Tokens:
Raw