Grav

https://learn.getgrav.org/17
Admin
Grav is a fast, simple, and flexible file-based CMS platform with zero installation required.
Tokens:392,236
Snippets:4,002
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Clone Heroku PHP Getting Started Example

Source: https://learn.getgrav.org/17/webservers-hosting/paas/heroku

Clone the Heroku PHP getting started repository to your local machine. This serves as a base for your Grav deployment.

```bash
git clone https://github.com/heroku/php-getting-started.git your-folder

```

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

### Example Deployer Output for Package Upgrade

Source: https://learn.getgrav.org/17/cli-console/scripted-upgrades

This output demonstrates the process of Deployer upgrading a Grav package, showing download, installation, and cache clearing steps.

```text
Executing task packages

GPM Releases Configuration: Stable

Found 8 packages installed of which 1 need updating

01. Email           [v2.5.2 -> v2.5.3]

GPM Releases Configuration: Stable

Preparing to install Email [v2.5.3]
  |- Downloading package...   100%
  |- Checking destination...  ok
  |- Installing package...    ok
  '- Success!

Clearing cache

Cleared:  /home/username/public_html/deployer/grav/cache/twig/*
Cleared:  /home/username/public_html/deployer/grav/cache/doctrine/*
Cleared:  /home/username/public_html/deployer/grav/cache/compiled/*

Touched: /home/username/public_html/deployer/grav/user/config/system.yaml

```

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

### Start Grav Built-in Server

Source: https://learn.getgrav.org/17/webservers-hosting/servers/grav-built-in

Navigate to your Grav installation's root directory in the terminal and run this command to start the built-in web server.

```bash
➜ bin/grav server
```

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

### Start ddev Project

Source: https://learn.getgrav.org/17/webservers-hosting/local-development-with-ddev

After configuration, start the ddev project containers with 'ddev start'. This may require root privileges for host changes.

```bash
ddev start
```

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

### Run Grav with Built-in PHP Webserver

Source: https://learn.getgrav.org/17/basics/installation

Use this command to start Grav's development server. It's suitable for quick local development and provides SSL if Symfony CLI is installed.

```bash
➜ bin/grav server
```

```text
Grav Web Server
===============

Tailing Web Server log file (/Users/joeblow/.symfony/log/96e710135f52930318e745e901e4010d0907cec3.log)
Tailing PHP-FPM log file (/Users/joeblow/.symfony/log/96e710135f52930318e745e901e4010d0907cec3/53fb8ec204547646acb3461995e4da5a54cc7575.log)
Tailing PHP-FPM log file (/Users/joeblow/.symfony/log/96e710135f52930318e745e901e4010d0907cec3/53fb8ec204547646acb3461995e4da5a54cc7575.log)

[OK] Web server listening
The Web server is using PHP FPM 8.0.8
https://127.0.0.1:8000

[Web Server ] Jul 30 14:54:53 |DEBUG  | PHP    Reloading PHP versions
[Web Server ] Jul 30 14:54:54 |DEBUG  | PHP    Using PHP version 8.0.8 (from default version in $PATH)
[PHP-FPM    ] Jul  6 14:40:17 |NOTICE | FPM    fpm is running, pid 64992
[PHP-FPM    ] Jul  6 14:40:17 |NOTICE | FPM    ready to handle connections
[PHP-FPM    ] Jul  6 14:40:17 |NOTICE | FPM    fpm is running, pid 64992
[PHP-FPM    ] Jul  6 14:40:17 |NOTICE | FPM    ready to handle connections
[Web Server ] Jul 30 14:54:54 |INFO   | PHP    listening path="/usr/local/Cellar/php/8.0.8_2/sbin/php-fpm" php="8.0.8" port=65140
[PHP-FPM    ] Jul 30 14:54:54 |NOTICE | FPM    fpm is running, pid 73709
[PHP-FPM    ] Jul 30 14:54:54 |NOTICE | FPM    ready to handle connections
[PHP-FPM    ] Jul 30 14:54:54 |NOTICE | FPM    fpm is running, pid 73709
[PHP-FPM    ] Jul 30 14:54:54 |NOTICE | FPM    ready to handle connections

```

```text
https://127.0.0.1:8000
```

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

### Install a Grav resource (theme or plugin)

Source: https://learn.getgrav.org/17/advanced/grav-gpm

Use this command to install a theme or plugin from the Grav repository. It detects existing installations and prompts for confirmation.

```bash
bin/gpm install <slug>

```

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

### Install Apache on Ubuntu

Source: https://learn.getgrav.org/17/webservers-hosting/windows-subsystem-for-linux

Use this command in the WSL bash shell to install the Apache web server.

```bash
sudo apt install apache2

```

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

### Grav Folder Structure Example

Source: https://learn.getgrav.org/17/basics

Illustrates the top-level folder structure of a Grav installation. This structure is crucial for managing content and configuration in a flat-file CMS.

```bash
1/assets
2/backup
3/bin
4/cache
5/images
6/logs
7/pages
8/plugins
9/system
10/tmp
11/user
12/vendor
13/.htaccess
14/composer.json
15/composer.lock
16/error.html
17/favicon.ico
18/index.php
19/LICENSE.txt
20/README.md
21/robots.txt
22/sitemap.xml
```

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

### Install multiple Grav resources at once

Source: https://learn.getgrav.org/17/advanced/grav-gpm

You can install multiple themes or plugins simultaneously by separating their slugs with a space.

```bash
bin/gpm install <slug1> <slug2> <slug3>

```

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

### Display Grav CLI Command Help

Source: https://learn.getgrav.org/17/advanced/grav-cli

To get detailed information about a specific command, use the 'help' command followed by the command name. For example, to get help for the 'install' command.

```bash
bin/grav help install
```

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

### PHP Built-in Web Server Output

Source: https://learn.getgrav.org/17/webservers-hosting/php-built-in-web-server

This is an example of the output you will see when starting the PHP built-in web server. It indicates the server version, listening address, document root, and instructions to quit.

```text
PHP 7.3.27 Development Server started at Thu Jun 17 09:24:46 2021
Listening on http://localhost:8080
Document root is /Users/somerandom/Desktop/quick-grav-test
Press Ctrl-C to quit.

```

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

### Verify PHP Version After Installation

Source: https://learn.getgrav.org/17/cli-console/command-line-intro

Confirm that PHP has been successfully added to your system's PATH environment variable. This output indicates a successful setup.

```bash
PHP 7.0.7 (cli) ...
```

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

### Return to Grav Root

Source: https://learn.getgrav.org/17/plugins/plugin-flex

Navigates back to the root directory of the Grav installation after completing plugin setup.

```bash
cd -

```

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

### Perform Composer Install

Source: https://learn.getgrav.org/17/cli-console/grav-cli

Executes the composer 'install' command for Grav dependencies.

```bash
bin/grav composer --install
```

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

### Install Grav Dependencies

Source: https://learn.getgrav.org/17/advanced/grav-cli

Use the 'grav install' command to download and install essential plugins and themes for your Grav project. Navigate to your project's root directory before running the command.

```bash
$ cd ~/webroot/my-grav-project
bin/grav install

```

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

### Manual Theme Inheritance Example

Source: https://learn.getgrav.org/17/themes/customization

This example shows the correct quoting for stream prefixes in mytheme.yaml when inheriting from another theme.

```text
- user/themes/mytheme
- user/themes/quark

```

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

### Install Grav resources, skipping prompts

Source: https://learn.getgrav.org/17/advanced/grav-gpm

The --all-yes (-y) option bypasses all confirmation prompts during installation. Existing resources will be overridden, and symbolic links will be skipped.

```bash
bin/gpm install --all-yes

```

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

### Install Grav Dependencies

Source: https://learn.getgrav.org/17/cli-console/command-line-intro

Install all necessary dependencies required for your current Grav installation to function correctly.

```bash
bin/grav install
```

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

### Cron Schedule Examples

Source: https://learn.getgrav.org/17/advanced/scheduler

Provides examples of common cron schedule configurations, such as running a job once an hour, once a day, once a month, or once a year.

```text
0 * * * *  // run once an hour (every hour at minute zero)
0 0 * * *  // run once a day (every day at midnight and minute zero)
0 0 1 * *  // run once a month (on the first day of every month at midnight and minute zero)
0 0 1 1 *  // run once a year (on the first day of the first month every year at midnight and minute zero)
*/5 * * * * // run every 5 minutes
```

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

### Install Dokku

Source: https://learn.getgrav.org/17/webservers-hosting/paas/dokku

Installs the latest stable release of Dokku on a VM. Ensure you have root access (sudo) and are connected via SSH.

```bash
wget https://raw.githubusercontent.com/dokku/dokku/v0.17.9/bootstrap.sh
sudo DOKKU_TAG=v0.17.9 bash bootstrap.sh

```

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

### Install a GPM Resource

Source: https://learn.getgrav.org/17/cli-console/command-line-intro

Install a theme or plugin from the Grav repository directly into your current Grav instance using a single command.

```bash
bin/gpm install
```

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

### Start Apache Service

Source: https://learn.getgrav.org/17/webservers-hosting/windows-subsystem-for-linux

Start the Apache service within the WSL environment. You may encounter a known error message upon starting, which can typically be ignored.

```bash
sudo service apache2 start

```

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

### PHP CLI Command Example

Source: https://learn.getgrav.org/17/cli-console/grav-cli-plugin

This example demonstrates how to create a basic CLI command for a Grav plugin. It defines arguments and options, and formats output with color. Save this as HelloCommand.php in your plugin's cli/ folder.

```php
<?php
namespace Grav\Plugin\Console;

use Grav\Console\ConsoleCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;

/**
 * Class HelloCommand
 *
 * @package Grav\Plugin\Console
 */
class HelloCommand extends ConsoleCommand
{
    /**
     * @var array
     */
    protected $options = [];

    /**
     * Greets a person with or without yelling
     */
    protected function configure()
    {
        $this
            ->setName("hello")
            ->setDescription("Greets a person.")
            ->addArgument(
                'name',
                InputArgument::REQUIRED,
                'The name of the person that should be greeted'
            )
            ->addOption(
                'yell',
                'y',
                InputOption::VALUE_NONE,
                'Wheter the greetings should be yelled or quieter'
            )
            ->setHelp('The <info>hello</info> greets someone.')
        ;
    }

    /**
     * @return int|null|void
     */
    protected function serve()
    {
        // Collects the arguments and options as defined
        $this->options = [
            'name' => $this->input->getArgument('name'),
            'yell' => $this->input->getOption('yell')
        ];

        // Prepare the strings we want to output and wraps the name into a cyan color
        // More colors available at:
        // https://github.com/getgrav/grav/blob/develop/system/src/Grav/Console/ConsoleTrait.php
        $greetings = 'Greetings, dear <cyan>' . $this->options['name'] . '</cyan>';

        // If the optional `--yell` or `-y` parameter are passed in, let's convert everything to uppercase
        if ($this->options['yell']) {
            $greetings = strtoupper($greetings);
        }

        // finally we write to the output the greetings
        $this->output->writeln($greetings);
    }
}

```

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

### Download and Install Grav CMS

Source: https://learn.getgrav.org/17/webservers-hosting/vps/linode

These commands switch to the 'grav' user, navigate to the web directory, download the latest Grav zip archive, unzip it, and set up the 'html' directory for the Grav installation.

```bash
su - grav
cd ~/www
wget -O grav.zip https://getgrav.org/download/core/grav/latest
unzip grav.zip
rm -rf html
mv grav html
```

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

### Install Plugin Dependencies

Source: https://learn.getgrav.org/17/plugins/plugin-flex

Navigates to the new plugin's directory and installs its Composer dependencies, including the autoloader.

```bash
cd /home/pierre/project/grav/grav-admin/user/plugins/myflexplugin

```

```bash
composer update

```

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

### Install Devtools Plugin

Source: https://learn.getgrav.org/17/cookbook/twig-recipes

Install the devtools plugin to simplify the process of creating new plugins.

```bash
bin/gpm install devtools

```

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

### Install Deployer using Composer

Source: https://learn.getgrav.org/17/cli-console/scripted-upgrades

Installs the Deployer package using Composer in the current directory.

```bash
composer require deployer/deployer

```

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

### Install Grav CMS in Ubuntu

Source: https://learn.getgrav.org/17/webservers-hosting/windows-subsystem-for-linux

Downloads the latest Grav package, installs unzip if necessary, extracts Grav to the webroot, and renames the folder to 'mysite'.

```bash
wget -O grav.zip https://getgrav.org/download/core/grav/latest
sudo apt install unzip  # unzip is not installed by default on WSL/Ubuntu
unzip grav.zip -d /var/www/webroot
mv /var/www/webroot/grav /var/www/webroot/mysite

```

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

### Example: Setting Plugin Handler Priority

Source: https://learn.getgrav.org/17/advanced/plugin-prioritization

Example of how to set a specific priority for a plugin's event handler in `priorities.yaml`.

```yaml
essential:
    onPageInitialized:
        handlePage: 100

```

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

### Start PHP Built-in Web Server

Source: https://learn.getgrav.org/17/webservers-hosting/php-built-in-web-server

Use this command to start the PHP built-in web server from your Grav root directory. It listens on localhost:8080 and uses system/router.php for routing.

```bash
php -S localhost:8080 system/router.php
```

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

### Install Composer Locally via PHP

Source: https://learn.getgrav.org/17/cli-console/scripted-upgrades

Installs Composer locally in the current directory using PHP.

```bash
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php
php -r "unlink('composer-setup.php');"

```

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

### Verify Scheduler Installation

Source: https://learn.getgrav.org/17/advanced/scheduler

After installation, run this command to verify that the Grav scheduler has been successfully set up in your crontab.

```bash
bin/grav scheduler -i
```

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

### Install Composer Locally with SSH

Source: https://learn.getgrav.org/17/cli-console/scripted-upgrades

Installs Composer in the user's bin directory for local use via SSH.

```bash
export COMPOSERDIR=~/bin;mkdir bin
curl -sS https://getcomposer.org/installer | php -- --install-dir=$COMPOSERDIR --filename=composer

```

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

### Install Composer Dependencies

Source: https://learn.getgrav.org/17/basics/installation

After cloning the Grav repository, install the necessary vendor dependencies using Composer. Use the '--no-dev' flag for production environments.

```bash
cd ~/webroot/grav
composer install --no-dev -o

```

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

### Install Grav Development Dependencies

Source: https://learn.getgrav.org/17/advanced/grav-development

Run this command in the Grav root to install necessary development dependencies via Composer.

```bash
composer install

```

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

### Check PHP Installation on Windows

Source: https://learn.getgrav.org/17/cli-console/command-line-intro

Verify if PHP is installed and accessible in your Windows command prompt. This is a prerequisite for running Grav's CLI commands.

```bash
php -v
```

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

### Grav\Common\Config\Setup

Source: https://learn.getgrav.org/17/advanced/php-reference

Handles the setup and initialization of configuration streams and resource locators.

```APIDOC
## Class: \Grav\Common\Config\Setup

### Description
Handles the setup and initialization of configuration streams and resource locators.

### Methods
- **__construct(Container|array $container): void**
  Constructs the Setup object.
- **getStreams(): array**
  Get available streams and their types from the configuration.
- **init(): \Grav\Common\Config\$this**
  Initializes the setup.
- **initializeLocator(UniformResourceLocator $locator): void**
  Initialize resource locator by using the configuration.
```

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

### Install Grav Plugin and Theme Dependencies

Source: https://learn.getgrav.org/17/basics/installation

Use the Grav CLI to install plugin and theme dependencies after setting up the core Grav project. This command clones required assets from GitHub.

```bash
cd ~/webroot/grav
bin/grav install

```

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

### Install Nginx, PHP 8.3, and Extensions

Source: https://learn.getgrav.org/17/webservers-hosting/vps/linode

Install Nginx, PHP 8.3 with FastCGI Process Manager (FPM), and essential PHP extensions required by Grav for image processing, caching, and other functionalities.

```bash
apt install -y vim zip unzip nginx git \
    php8.3-fpm php8.3-cli php8.3-gd php8.3-curl \
    php8.3-mbstring php8.3-xml php8.3-zip php8.3-intl php8.3-apcu
```

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

### Create Web Directory and Test File

Source: https://learn.getgrav.org/17/webservers-hosting/vps/rosehosting

Switch to the 'grav' user, create the web directory structure, and place a test PHP file to verify the setup. Exit back to the root user after completion.

```BASH
su - grav
mkdir -p ~/www/html
echo '<?php phpinfo();' > ~/www/html/info.php
exit
```

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

### Create Web Directory and Test File

Source: https://learn.getgrav.org/17/webservers-hosting/vps/linode

Switch to the 'grav' user, create the web directory structure, and place a test PHP file to verify the setup. The 'exit' command returns to the root user.

```bash
su - grav
mkdir -p ~/www/html

echo '<?php phpinfo();' > ~/www/html/info.php
exit
```

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

### Grav New Project Output Example

Source: https://learn.getgrav.org/17/advanced/grav-development

This output shows the successful creation of directories, initialization of pages, and symbolic linking of Grav dependencies when using the 'bin/grav new-project -s' command.

```text
rhukster@gibblets:~/Projects/Grav/grav(develop○) » bin/grav new-project -s ~/www/grav

Creating Directories
    /cache
    /logs
    /images
    /assets
    /user/accounts
    /user/config
    /user/pages
    /user/data
    /user/plugins
    /user/themes

Resetting Symbolic Links
    /index.php -> /Users/rhuk/www/grav/index.php
    /composer.json -> /Users/rhuk/www/grav/composer.json
    /bin -> /Users/rhuk/www/grav/bin
    /system -> /Users/rhuk/www/grav/system

Pages Initializing
    /Users/rhuk/Projects/Grav/grav/user/pages -> Created

File Initializing
    /.dependencies -> Created
    /.htaccess -> Created
    /user/config/site.yaml -> Created
    /user/config/system.yaml -> Created

Permissions Initializing
    bin/grav permissions reset to 755

read local config from /Users/rhuk/.grav/config

Symlinking Bits
===============

SUCCESS symlinked grav-plugin-problems -> user/plugins/problems

SUCCESS symlinked grav-plugin-error -> user/plugins/error

SUCCESS symlinked grav-theme-antimatter -> user/themes/antimatter


```

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

### PHP Setup File for Environment Variable Configuration

Source: https://learn.getgrav.org/17/advanced/multisite-setup

Use `user/setup.php` to load environment variables for initial configuration, such as database credentials or API keys. These settings can be overridden by plugin configurations.

```php
<?php

// Use following environment variables in your server configuration:
//
// DYNAMODB_SESSION_KEY: DynamoDb server key for the PHP session storage
// DYNAMODB_SESSION_SECRET: DynamoDb server secret
// DYNAMODB_SESSION_REGION: DynamoDb server region
// GOOGLE_MAPS_KEY: Google Maps secret key

return [
    'plugins' => [
        // This plugin does not exist
        'dynamodb_session' => [
            'credentials' => [
                'key' => getenv('DYNAMODB_SESSION_KEY') ?: null,
                'secret' => getenv('DYNAMODB_SESSION_SECRET') ?: null
            ],
            'region' => getenv('DYNAMODB_SESSION_REGION') ?: null
        ],
        // This plugin does not exist
        'google_maps' => [
            'key' => getenv('GOOGLE_MAPS_KEY') ?: null
        ]
    ]
];

```

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

### Grav Built-in Server Output

Source: https://learn.getgrav.org/17/webservers-hosting/servers/grav-built-in

This is an example of the output you will see when starting the Grav built-in web server. It shows log file tails and the server listening status.

```bash
➜ bin/grav server

Grav Web Server
===============

Tailing Web Server log file (/Users/joeblow/.symfony/log/96e710135f52930318e745e901e4010d0907cec3.log)
Tailing PHP-FPM log file (/Users/joeblow/.symfony/log/96e710135f52930318e745e901e4010d0907cec3/53fb8ec204547646acb3461995e4da5a54cc7575.log)
Tailing PHP-FPM log file (/Users/joeblow/.symfony/log/96e710135f52930318e745e901e4010d0907cec3/53fb8ec204547646acb3461995e4da5a54cc7575.log)

[OK] Web server listening
The Web server is using PHP FPM 8.0.8
https://127.0.0.1:8000


[Web Server ] Jul 30 14:54:53 |DEBUG  | PHP    Reloading PHP versions
[Web Server ] Jul 30 14:54:54 |DEBUG  | PHP    Using PHP version 8.0.8 (from default version in $PATH)
[PHP-FPM    ] Jul  6 14:40:17 |NOTICE | FPM    fpm is running, pid 64992
[PHP-FPM    ] Jul  6 14:40:17 |NOTICE | FPM    ready to handle connections
[PHP-FPM    ] Jul  6 14:40:17 |NOTICE | FPM    fpm is running, pid 64992
[PHP-FPM    ] Jul  6 14:40:17 |NOTICE | FPM    ready to handle connections
[Web Server ] Jul 30 14:54:54 |INFO   | PHP    listening path="/usr/local/Cellar/php/8.0.8_2/sbin/php-fpm" php="8.0.8" port=65140
[PHP-FPM    ] Jul 30 14:54:54 |NOTICE | FPM    fpm is running, pid 73709
[PHP-FPM    ] Jul 30 14:54:54 |NOTICE | FPM    ready to handle connections
[PHP-FPM    ] Jul 30 14:54:54 |NOTICE | FPM    fpm is running, pid 73709
[PHP-FPM    ] Jul 30 14:54:54 |NOTICE | FPM    ready to handle connections

```

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

### Initialize Git Repository and Add Fortrabbit Remote

Source: https://learn.getgrav.org/17/webservers-hosting/paas/fortrabbit

Set up your Grav project for deployment by initializing a Git repository and adding the Fortrabbit remote. This is the first step in pushing your site to the Fortrabbit platform.

```bash
$ cd grav
$ git init .
$ git remote add fortrabbit git@deploy.eu2.frbit.com:your-app.git

```

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

### Custom Stream Configuration in Grav

Source: https://learn.getgrav.org/17/advanced/multisite-setup

Example of a custom streams.yaml configuration for a multisite setup. This allows you to define specific paths for accounts, pages, images, user data, cache, and logs, overriding default Grav stream behavior.

```yaml
schemes:
  account:
    type: ReadOnlyStream
    prefixes:
      '': ['environment://accounts']
  page:
    type: ReadOnlyStream
    prefixes:
      '': ['environment://user']
  image:
    type: Stream
    prefixes:
      '': ['environment://images', 'system://images/']
  'user-data':
    type: Stream
    prefixes:
      '': ['environment://data']
  cache:
    type: Stream
    prefixes:
      '': ['cache/domain.com']
      images: ['images/domain.com']
  log:
    type: Stream
    prefixes:
      '': ['logs/domain.com']

```

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

### Grav\Framework\Session\SessionInterface

Source: https://learn.getgrav.org/17/advanced/php-reference

Provides an interface for managing session variables, including getting, setting, checking existence, and unsetting. It also offers methods for clearing, closing, retrieving all variables, getting/setting session ID and name, invalidating the session, checking if it's started, and setting options.

```APIDOC
## Class: \Grav\Framework\Session\SessionInterface

### Description
Provides an interface for managing session variables, including getting, setting, checking existence, and unsetting. It also offers methods for clearing, closing, retrieving all variables, getting/setting session ID and name, invalidating the session, checking if it's started, and setting options.

### Methods

- **__get(string $name)**: Returns session variable.
- **__isset(string $name)**: Checks if session variable is defined.
- **__set(string $name, mixed $value)**: Sets session variable.
- **__unset(string $name)**: Removes session variable.
- **clear()**: Free all session variables.
- **close()**: Force the session to be saved and closed.
- **getAll()**: Returns all session variables.
- **getId()**: Get session ID.
- **getInstance()**: Get current session instance.
- **getIterator()**: Retrieve an external iterator.
- **getName()**: Get session name.
- **invalidate()**: Invalidates the current session.
- **isStarted()**: Checks if the session was started.
- **setId(string $id)**: Set session ID.
- **setName(string $name)**: Set session name.
- **setOptions(array $options)**: Sets session.* ini variables.
- **start(bool $readonly = false)**: Starts the session storage.
```

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

### Grav\Console\GravCommand::setupConsole

Source: https://learn.getgrav.org/17/advanced/php-reference

Sets up the console's color style definition for the formatter. This method configures how output is displayed.

```APIDOC
## Grav\Console\GravCommand::setupConsole

### Description
Sets up the console's color style definition for the formatter. This method configures how output is displayed.

### Method
public

### Signature
setupConsole(InputInterface $input, OutputInterface $output)

### Parameters
* **$input** (InputInterface) - The input interface.
* **$output** (OutputInterface) - The output interface.
```

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

### Get a Flex Collection object using the get() method

Source: https://learn.getgrav.org/17/advanced/flex/using/collection

The `get()` method provides an alternative way to retrieve an object by its key. It returns the object if found, or `null` otherwise.

```twig
{% set contacts = grav.get('flex').collection('contacts') %}

{% set contact = contacts.get('ki2ts4cbivggmtlj')

{# Do something #}
{% if contact %}
  {# Got Bruce Day #}
  Email for {{ contact.first_name|e }} {{ contact.last_name|e }} is {{ contact.email|e }}
{% else %}
  Oops, contact has been removed!
{% endif %}


```

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

### Install Plugin via GPM

Source: https://learn.getgrav.org/17/plugins/plugin-install

Use this command in your terminal to install a plugin using the Grav Package Manager (GPM). Navigate to your Grav installation's root directory before executing.

```bash
bin/gpm install NAME

```

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

### Configure Accounts Settings

Source: https://learn.getgrav.org/17/basics/grav-configuration

Set up account types and storage methods. Use 'regular' or 'flex' for type, and 'file' or 'folder' for storage.

```yaml
accounts:
  type: regular
  storage: file

```

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

### Install Admin Plugin

Source: https://learn.getgrav.org/17/admin-panel/introduction

Install the admin plugin using the Grav Package Manager (GPM). The command will prompt to install necessary dependencies like login, forms, and email plugins.

```bash
bin/gpm install admin

```

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

### Navigate to Project Directory

Source: https://learn.getgrav.org/17/webservers-hosting/paas/heroku

Change your current directory to the cloned project folder.

```bash
cd your-folder

```

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

### Install XDebug Extension

Source: https://learn.getgrav.org/17/webservers-hosting/windows-subsystem-for-linux

Installs the XDebug extension for PHP, which is useful for debugging.

```bash
sudo apt install php-xdebug

```

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

### Grav setup.php Configuration Structure

Source: https://learn.getgrav.org/17/advanced/multisite-setup

This is the basic structure for a setup.php file in Grav. It defines optional environment names and stream collections for multisite configurations. Be mindful of performance as this script runs on every page request.

```php
return [
  'environment' => '<name>',            // A name for the environment
  'streams' => [
    'schemes' => [
      '<stream_name>' => [              // The name of the stream
        'type' => 'ReadOnlyStream',     // Stream object e.g. 'ReadOnlyStream' or 'Stream'
        'prefixes' => [
          '<prefix>' => [
            '<path1>',
            '<path2>',
            '<etc>'
          ]
        ],
        'paths' => [                    // Paths (optional)
          '<paths1>',
          '<paths2>',
          '<etc>'
        ]
      ]
    ]
  ]
]

```

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

### Download and Install Base Plugin Updates

Source: https://learn.getgrav.org/17/advanced/grav-development/grav-15-upgrade-guide

Download and install updates for essential Grav plugins including Problems, Error, Form, Email, Login, and Admin. These commands use GPM for direct installation.

```bash
wget -q https://getgrav.org/download/plugins/problems/2.0.3 -O tmp/grav-plugin-problems-v2.0.3.zip
wget -q https://getgrav.org/download/plugins/error/1.7.1 -O tmp/grav-plugin-error-v1.7.1.zip
wget -q https://getgrav.org/download/plugins/form/4.3.0 -O tmp/grav-plugin-form-v4.3.0.zip
wget -q https://getgrav.org/download/plugins/email/3.1.0 -O tmp/grav-plugin-email-v3.1.0.zip
wget -q https://getgrav.org/download/plugins/login/3.3.8 -O tmp/grav-plugin-login-v3.3.8.zip
wget -q https://getgrav.org/download/plugins/admin/1.9.19 -O tmp/grav-plugin-admin-v1.9.19.zip


bin/gpm direct-install -y tmp/grav-plugin-problems-v2.0.3.zip
bin/gpm direct-install -y tmp/grav-plugin-error-v1.7.1.zip
bin/gpm direct-install -y tmp/grav-plugin-form-v4.3.0.zip
bin/gpm direct-install -y tmp/grav-plugin-email-v3.1.0.zip
bin/gpm direct-install -y tmp/grav-plugin-login-v3.3.8.zip
bin/gpm direct-install -y tmp/grav-plugin-admin-v1.9.19.zip
```

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

### Plugin Caching Example

Source: https://learn.getgrav.org/17/cookbook/plugin-recipes

Demonstrates how to use Grav's cache to store and retrieve data, improving performance.

```php
$cache = Grav::instance()['cache'];
$id = 'myplugin-data'
$list = [];

if ($data = $cache->fetch($id)) {
    return $data;
} else {
    $data = $this->gatherData();
    $cache->save($hash, $data);
    return $data;
}

```

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

### Scanning Plugin Blueprints and Templates

Source: https://learn.getgrav.org/17/plugins/event-hooks

This example demonstrates using both onGetPageBlueprints and onGetPageTemplates hooks to make plugin-provided resources available to Grav. It scans blueprint and template directories.

```php
$scanBlueprintsAndTemplates = function () use ($grav) {
    // Scan blueprints
    $event = new Event();
    $event->types = self::$types;
    $grav->fireEvent('onGetPageBlueprints', $event);

    self::$types->scanBlueprints('theme://blueprints/');

    // Scan templates
    $event = new Event();
    $event->types = self::$types;
    $grav->fireEvent('onGetPageTemplates', $event);

    self::$types->scanTemplates('theme://templates/');
};
```

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

### Install Sample Data for Contacts Directory

Source: https://learn.getgrav.org/17/advanced/flex/administration/introduction

Copies the sample JSON data for the Contacts directory to the appropriate location for use with the Flex Objects plugin.

```shell
$ cp user/plugins/flex-objects/data/flex-objects/contacts.json user/data/flex-objects/contacts.json

```

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

### Get a nested variable's value

Source: https://learn.getgrav.org/17/advanced/php-reference

Use the `get()` method to retrieve the value of a nested variable.

```php
$value = $this->get('this.is.my.nested.variable');
```

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

### Grav\Common\Themes::init

Source: https://learn.getgrav.org/17/advanced/php-reference

Initializes theme-related functionalities.

```APIDOC
## Grav\Common\Themes::init

### Description
Initializes theme-related functionalities.

### Method
public

### Signature
`init(): void`
```

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

### Examples of Resize Action

Source: https://learn.getgrav.org/17/content/media

Demonstrates the resize action applied to different media types like SVG, GIF, and video.

```markdown
![Sample Vector](sample-vector.svg?resize=300,300)
```

```markdown
![Animated Gif](sample-animated.gif?resize=300,300)
```

```markdown
![Sample Trailer](sample-trailer.mov?resize=400,200)
```

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

### Get a Flex Collection object using the get() method in PHP

Source: https://learn.getgrav.org/17/advanced/flex/using/collection

In PHP, use the `get()` method to fetch an object from a Flex Collection by its key. Always check the return value for `null` to handle cases where the object does not exist.

```php
use Grav\Common\Grav;
use Grav\Framework\Flex\Interfaces\FlexCollectionInterface;
use Grav\Framework\Flex\Interfaces\FlexObjectInterface;

/** @var FlexCollectionInterface|null $collection */
$collection = Grav::instance()->get('flex')->getCollection('contacts');
if ($collection) {

    /** @var FlexObjectInterface|null $object */
    $object = $collection->get('ki2ts4cbivggmtlj');
    if ($object) {
        // Object exists, do something with it...
    }

}


```

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

### Install Latest PHP Version

Source: https://learn.getgrav.org/17/webservers-hosting/windows-subsystem-for-linux

Installs the latest available PHP version using the apt package manager.

```bash
sudo apt install php

```

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

### Update Installed GPM Resources

Source: https://learn.getgrav.org/17/cli-console/command-line-intro

Check for and list available updates for all installed plugins and themes managed by GPM.

```bash
bin/gpm update
```

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

### Nginx Main Configuration (nginx.conf)

Source: https://learn.getgrav.org/17/webservers-hosting/servers

This is an example of an improved `/etc/nginx/nginx.conf` file, incorporating best practices for serving web content. It includes settings for worker processes, file limits, event handling, HTTP optimizations, gzip compression, and security headers.

```nginx
user www-data;
worker_processes auto;
worker_rlimit_nofile 8192; # should be bigger than worker_connections
pid /run/nginx.pid;

events {
    use epoll;
    worker_connections 8000;
    multi_accept on;
}

http {
    sendfile on;
    tcp_nopush on;
    tcp_nodelay on;
    keepalive_timeout 30; # longer values are better for each ssl client, but take up a worker connection longer
    types_hash_max_size 2048;
    server_tokens off;

    # maximum file upload size
    # update 'upload_max_filesize' & 'post_max_size' in /etc/php/fpm/php.ini accordingly
    client_max_body_size 32m;
    # client_body_timeout 60s; # increase for very long file uploads

    # set default index file (can be overwritten for each site individually)
    index index.html;

    # load MIME types
    include mime.types; # get this file from https://github.com/h5bp/server-configs-nginx
    default_type application/octet-stream; # set default MIME type

    # logging
    access_log /var/log/nginx/access.log;
    error_log /var/log/nginx/error.log;

    # turn on gzip compression
    gzip on;
    gzip_disable "msie6";
    gzip_vary on;
    gzip_proxied any;
    gzip_comp_level 5;
    gzip_buffers 16 8k;
    gzip_http_version 1.1;
    gzip_min_length 256;
    gzip_types
        application/atom+xml
        application/javascript
        application/json
        application/ld+json
        application/manifest+json
        application/rss+xml
        application/vnd.geo+json
        application/vnd.ms-fontobject
        application/x-font-ttf
        application/x-web-app-manifest+json
        application/xhtml+xml
        application/xml
        font/opentype
        image/bmp
        image/svg+xml
        image/x-icon
        text/cache-manifest
        text/css
        text/javascript
        text/plain
        text/vcard
        text/vnd.rim.location.xloc
        text/vtt
        text/x-component
        text/x-cross-domain-policy;

    # disable content type sniffing for more security
    add_header "X-Content-Type-Options" "nosniff";

```

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

### Configure ddev Project

Source: https://learn.getgrav.org/17/webservers-hosting/local-development-with-ddev

Use 'ddev config' to set up a new ddev project. It prompts for project name, docroot, and project type.

```bash
cd /home/USER/projects/grav
ddev config
```

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

### Grav\Common\Themes::initTheme

Source: https://learn.getgrav.org/17/advanced/php-reference

Initializes the current theme.

```APIDOC
## Grav\Common\Themes::initTheme

### Description
Initializes the current theme.

### Method
public

### Signature
`initTheme(): void`
```

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

### Example JSON Output from Grav Page

Source: https://learn.getgrav.org/17/content/content-types

This is an example of the JSON output generated by the `item.json.twig` template, containing frontmatter and content.

```json
{
  "frontmatter":{
     "title":"New Macbook Pros Arriving Soon",
     "date": "14:23 08/01/2016",
     "taxonomy":{
        "category":[
           "blog"
        ],
        "tag":[
           "apple",
           "mbpr",
           "laptops"
        ]
     }
  },
  "content":"<p>this has an -> arrow here and <strong>bold</strong> here</p>\n<blockquote>\n<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec ultricies tristique nulla et mattis. Phasellus id massa eget nisl congue blandit sit amet id ligula. Praesent et nulla eu augue tempus sagittis. Mauris faucibus nibh et nibh cursus in vestibulum sapien egestas. Curabitur ut lectus tortor. Sed ipsum eros, egestas ut eleifend non, elementum vitae eros.\n-- <cite> Ronald Wade</cite></p>\n</blockquote>\n<p>Mauris felis diam, pellentesque vel lacinia ac, dictum a nunc. Mauris mattis nunc sed mi sagittis et facilisis tortor volutpat. Etiam tincidunt urna mattis erat placerat placerat ac eu tellus.</p>\n<p>This is a new paragraph</p>\n<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec ultricies tristique nulla et mattis.</p>"
}
```

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

### Create New Grav Project

Source: https://learn.getgrav.org/17/advanced/grav-cli

Initialize a new Grav project in a specified destination directory. This command downloads all necessary dependencies for a clean Grav instance.

```bash
bin/grav new-project ~/webroot/portfolio
```

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

### Download and Unzip Grav

Source: https://learn.getgrav.org/17/webservers-hosting/shared/rochen

Navigate to the webroot, download the latest Grav version, and unzip it into a subfolder. Ensure the URL is correctly configured to access Grav.

```bash
cd ~\/www
wget https://getgrav.org/download/core/grav/latest
unzip grav-v1.7.52.zip

```

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

### Create Symbolically Linked Grav Project

Source: https://learn.getgrav.org/17/advanced/grav-development

Set up a new Grav project using symbolic links to connect your webroot to the cloned Grav core. This ensures changes in your webroot are reflected in your cloned repositories.

```bash
cd ~/Projects/Grav/grav
bin/grav new-project -s ~/www/grav

```

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

### Install Required PHP Extensions

Source: https://learn.getgrav.org/17/webservers-hosting/windows-subsystem-for-linux

Installs essential PHP extensions required by Grav, such as mbstring, gd, curl, xml, and zip.

```bash
sudo apt install php-mbstring php-gd php-curl php-xml php-zip

```

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

### Multisite Setup for Subdirectories

Source: https://learn.getgrav.org/17/advanced/multisite-setup

This PHP script is for `setup.php` to configure Grav for subsites accessed via subdirectories or path-based URLs. It extracts the subsite name from the request path.

```php
<?php
/**
 * Multisite setup for sub-directories or path based
 * URLs for subsites.
 *
 * DO NOT EDIT UNLESS YOU KNOW WHAT YOU ARE DOING!
 */

use Grav\Common\Filesystem\Folder;

// Get relative path from Grav root.
$path = isset($_SERVER['PATH_INFO'])
   ? $_SERVER['PATH_INFO']
   : Folder::getRelativePath($_SERVER['REQUEST_URI'], ROOT_DIR);

// Extract name of subsite from path
$name = Folder::shift($path);
$folder = "env/{$name}";
$prefix = "/{$name}";

if (!$name || !is_dir(ROOT_DIR . "user/{$folder}")) {
    return [];
}

// Prefix all pages with the name of the subsite
$container['pages']->base($prefix);

return [
    'environment' => $name,
    'streams' => [
        'schemes' => [
            'user' => [
               'type' => 'ReadOnlyStream',
               'prefixes' => [
                   '' => ["user/{$folder}"],
               ]
            ]
        ]
    ]
];

```

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

### Add Grav Install Script to composer.json

Source: https://learn.getgrav.org/17/webservers-hosting/paas/heroku

Configure the 'scripts' section in composer.json to include a post-deploy command for installing Grav and its dependencies.

```json
{
  "scripts": {
    "compile": [
      "bin/grav install",
      "bin/gpm install quark -y"
    ]
  }
}

```

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

### Install Composer on Azure Web App

Source: https://learn.getgrav.org/17/webservers-hosting/paas/azure

Steps to install the Composer dependency manager on an Azure Web App through the Extensions setting.

```bash
- Open up your Web App
- Click on the Extensions setting
- Click on Add
- Select Composer
- Click OK

```

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

### Install Bleeding Edge Grav with Composer

Source: https://learn.getgrav.org/17/basics/installation

Install the latest development version of Grav using Composer by specifying the '1.x-dev' branch.

```bash
composer create-project getgrav/grav ~/webroot/grav 1.x-dev

```

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

### Get help for a specific GPM command

Source: https://learn.getgrav.org/17/advanced/grav-gpm

To get detailed help for any specific GPM command, append 'help' before the command name.

```bash
bin/gpm help install

```

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

### Create Nginx Server Block File

Source: https://learn.getgrav.org/17/webservers-hosting/vps/digitalocean

Opens the Nginx configuration file for the Grav site using the vim editor.

```bash
vim /etc/nginx/sites-available/grav
```

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

### Get Collection of Objects in PHP

Source: https://learn.getgrav.org/17/advanced/flex/using/directory

Retrieve a collection of objects from a Flex directory using PHP. This involves getting the directory and then its collection.

```php
use Grav\Common\Grav;
use Grav\Framework\Flex\Interfaces\FlexDirectoryInterface;
use Grav\Framework\Flex\Interfaces\FlexCollectionInterface;

/** @var FlexDirectoryInterface|null $directory */
$directory = Grav::instance()->get('flex')->getDirectory('contacts');
if ($directory) {

    /** @var FlexCollectionInterface $collection */
    $collection = $directory->getCollection();

    // Do something with the collection...

}

```

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

### Create a New Dokku App

Source: https://learn.getgrav.org/17/webservers-hosting/paas/dokku

Creates a new application instance on your Dokku server. This command is run from the VM's terminal after Dokku installation.

```bash
dokku apps:create my-grav-site

```
Tokens:
Raw