Winter CMS

https://github.com/wintercms/docs
Admin
Winter CMS is a Laravel-based content management system designed to simplify development workflows...
Tokens:291,591
Snippets:3,901
Trust Score:8.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Winter CMS

Source: https://github.com/wintercms/docs/blob/develop/console/setup-maintenance.md

Run the `winter:install` command to initiate the setup process for a new Winter CMS instance. This command prompts for database credentials, application URL, encryption key, and administrator details.

```bash
php artisan winter:install
```

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

### YAML configuration example

Source: https://github.com/wintercms/docs/blob/develop/services/parser.md

A basic example of YAML configuration syntax.

```yaml
receipt: Acme Purchase Invoice
date: 2015-10-02
user:
    name: Joe
    surname: Blogs
```

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

### Install a Theme

Source: https://github.com/wintercms/docs/blob/develop/console/theme-management.md

Downloads and installs a theme using its theme code. Optionally specify a custom directory for installation.

```bash
php artisan theme:install <theme code> [directory]
```

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

### INI configuration example

Source: https://github.com/wintercms/docs/blob/develop/services/parser.md

A basic example of INI configuration syntax with sections.

```ini
receipt = "Acme Purchase Invoice"
date = "2015-10-02"

[user]
name = "Joe"
surname = "Blogs"
```

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

### Install a plugin

Source: https://github.com/wintercms/docs/blob/develop/console/plugin-management.md

Downloads and installs a plugin from the Winter marketplace using its AuthorName.PluginName code.

```bash
php artisan plugin:install <plugin code>
```

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

### Installing Supervisor

Source: https://github.com/wintercms/docs/blob/develop/services/queues.md

Command to install the Supervisor process monitor on Ubuntu.

```bash
sudo apt-get install supervisor
```

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

### Starting Supervisor processes

Source: https://github.com/wintercms/docs/blob/develop/services/queues.md

Commands to update the configuration and start the managed processes.

```bash
sudo supervisorctl reread

sudo supervisorctl update

sudo supervisorctl start winter-worker:*
```

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

### Install Winter CMS via Composer

Source: https://github.com/wintercms/docs/blob/develop/architecture/using-composer.md

Use the create-project command to initialize a new Winter CMS installation in a specified directory.

```bash
composer create-project wintercms/winter <your installation directory> [version]

# Example:
#   composer create-project wintercms/winter mywinter
# or
#   composer create-project wintercms/winter ./ "dev-develop"
```

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

### List installed plugins

Source: https://github.com/wintercms/docs/blob/develop/console/plugin-management.md

Displays a table of all installed plugins, their status, and version information.

```bash
php artisan plugin:list
```

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

### Example Plugin Registration File

Source: https://github.com/wintercms/docs/blob/develop/plugin/registration.md

This is a basic example of a Plugin registration file. It defines the plugin's name, description, author, icon, and registers a frontend component.

```php
<?php

namespace Acme\Blog;

class Plugin extends \System\Classes\PluginBase
{
    public function pluginDetails()
    {
        return [
            'name' => 'Blog Plugin',
            'description' => 'Provides some really cool blog features.',
            'author' => 'ACME Corporation',
            'icon' => 'icon-snowflake-o'
        ];
    }

    public function registerComponents()
    {
        return [
            'Acme\Blog\Components\Post' => 'blogPost'
        ];
    }
}
```

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

### Example backend URL

Source: https://github.com/wintercms/docs/blob/develop/backend/controllers-ajax.md

A concrete example of a generated URL for a backend controller action.

```text
https://example.com/backend/acme/blog/users/index
```

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

### Button Field Examples

Source: https://github.com/wintercms/docs/blob/develop/backend/forms.md

Examples of button configurations for AJAX requests, links, and popups.

```yaml
_sync_ics:
    label: Actions
    buttonLabel: Sync
    type: button
    request: onSyncICS
    icon: 'icon-rotate'
    loading: Syncing...
```

```yaml
places_url:
    type: button
    buttonType: primary
    buttonLabel: View on Google Maps
    icon: icon-map-location-dot
    target: _blank
```

```yaml
_btn_autofill:
    label: Autofill
    buttonLabel: Autofill Club Information
    type: button
    handler: onRenderAutofillPopup
    buttonType: primary
    icon: icon-map-location-dot
```

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

### Permission Key Example

Source: https://github.com/wintercms/docs/blob/develop/backend/users.md

A permission key is structured as author.plugin.feature. This is an example of a valid permission key.

```text
acme.blog.access_categories
```

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

### Configure GitHub Actions for unit tests

Source: https://github.com/wintercms/docs/blob/develop/plugin/unit-testing.md

Use the Setup Winter Action to automate the environment setup and test execution within a GitHub Actions workflow.

```yml
name: Tests

on:
  push:
  pull_request:

jobs:
  unitTests:
    runs-on: ubuntu-latest
    name: Unit Tests
    steps:
      - name: Setup Winter
        uses: wintercms/setup-winter-action@v1
        with:
          plugin-author: myauthor    # change this to your author name in lowercase
          plugin-name: myplugin      # change this to your plugin name in lowercase

      - name: Run unit tests
        run: php artisan winter:test -p MyAuthor.MyPlugin    # change this to the correct plugin code
```

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

### Verify Installation File Cleanup

Source: https://github.com/wintercms/docs/blob/develop/setup/installation.md

Ensure the installation directory and script are removed after a web-based installation.

```treeview
MyWinterFolder/
|-- install/       # Installation directory
`-- install.html   # Installation script
```

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

### Example Console Command Class

Source: https://github.com/wintercms/docs/blob/develop/console/introduction.md

This is a basic example of a console command class. It defines the command name, signature with arguments and options, a description, and the core logic in the handle method.

```php
<?php namespace MyAuthor\MyPlugin\Console;

use Winter\Storm\Console\Command;

class MyCommand extends Command
{
    /**
     * @var string|null The default command name for lazy loading.
     */
    protected static $defaultName = 'myauthor:mycommand';

    /**
     * @var string The name and signature of this command.
     */
    protected $signature = 'myauthor:mycommand
        {myArgument : Command argument avaible through $this->argument("myArgument")}
        {--myOptionFlag : Defines a custom path to the "npm" binary}';

    /**
     * @var string The console command description.
     */
    protected $description = 'Install Node.js dependencies required for mixed assets';

    /**
     * Execute the console command.
     * @return int
     */
    public function handle(): int
    {
        $this->output->writeln('Hello world!');

        return 0; // return 1 if an error occurs
    }
}
```

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

### Access autocompletion setup instructions

Source: https://github.com/wintercms/docs/blob/develop/console/introduction.md

View instructions for enabling shell autocompletion for console commands.

```bash
php artisan completion --help
```

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

### Complete Form Layout Example

Source: https://github.com/wintercms/docs/blob/develop/ui/controls/form.md

A comprehensive example demonstrating various form field types including text inputs, dropdowns, checkboxes, and switchers with layout classes.

```html
<!-- Form Elements -->
<form class="form-elements" role="form">

    <!-- Text Input (Left) -->
    <div class="form-group text-field span-left is-required">
        <label>Input Left</label>
        <input type="text" name="" value="" class="form-control" />
            <p class="help-block">Example below help text here.</p>
    </div>

    <!-- Text Input (Right) -->
    <div class="form-group text-field span-right is-required">
        <label>Input Right</label>
        <input type="text" name="" value="" class="form-control" />
        <p class="help-block">Example below help text here.</p>
    </div>

    <!-- Text Input (Full) -->
    <div class="form-group text-field span-full is-required">
        <label>Input Full</label>
        <p class="help-block before-field">Example above help text here.</p>
        <input type="text" name="" value="" class="form-control" />
    </div>

    <!-- Drop down -->
    <div class="form-group dropdown-field span-left">
        <label>Drop Down</label>
        <select class="form-control custom-select">
            <option selected="selected" value="2">Approved</option>
            <option value="3">Deleted</option>
            <option value="1">New</option>
        </select>
    </div>

    <!-- Grouped Drop down -->
    <div class="form-group dropdown-field span-right">
        <label>Grouped Drop Down</label>
        <select class="form-control custom-select">
            <optgroup label="NFC EAST">
                <option>Dallas Cowboys</option>
                <option>New York Giants</option>
                <option>Philadelphia Eagles</option>
                <option>Washington Redskins</option>
            </optgroup><optgroup>
            </optgroup><optgroup label="NFC NORTH">
                <option>Chicago Bears</option>
                <option>Detroit Lions</option>
                <option>Green Bay Packers</option>
                <option>Minnesota Vikings</option>
            </optgroup>
            <optgroup label="NFC SOUTH">
                <option>Atlanta Falcons</option>
                <option>Carolina Panthers</option>
                <option>New Orleans Saints</option>
                <option>Tampa Bay Buccaneers</option>
            </optgroup>
            <optgroup label="NFC WEST">
                <option>Arizona Cardinals</option>
                <option>St. Louis Rams</option>
                <option>San Francisco 49ers</option>
                <option>Seattle Seahawks</option>
            </optgroup>
            <optgroup label="AFC EAST">
                <option>Buffalo Bills</option>
                <option>Miami Dolphins</option>
                <option>New England Patriots</option>
                <option>New York Jets</option>
            </optgroup>
            <optgroup label="AFC NORTH">
                <option>Baltimore Ravens</option>
                <option>Cincinnati Bengals</option>
                <option>Cleveland Browns</option>
                <option>Pittsburgh Steelers</option>
            </optgroup>
            <optgroup label="AFC SOUTH">
                <option>Houston Texans</option>
                <option>Indianapolis Colts</option>
                <option>Jacksonville Jaguars</option>
                <option>Tennessee Titans</option>
            </optgroup>
            <optgroup label="AFC WEST">
                <option>Denver Broncos</option>
                <option>Kansas City Chiefs</option>
                <option>Oakland Raiders</option>
                <option>San Diego Chargers</option>
            </optgroup>
        </select>
    </div>

    <!-- Checkbox -->
    <div class="form-group checkbox-field span-left is-required">
        <div class="checkbox custom-checkbox">
            <input name="checkbox" value="1" type="checkbox" id="checkbox_1">
            <label for="checkbox_1">Enable Googie Berry Power-up</label>
            <p class="help-block">Use this checkbox to enable the Googie Berry power-up specifically for this page. You can configure the Googie Berry power-up on the System Settings and Dashboard page.</p>
        </div>
    </div>

    <!-- Switcher -->
    <div class="form-group switch-field span-right">
        <div class="field-switch">
            <label>Would you like fries with that?</label>
            <p class="help-block">Use this checkbox to enable the Googie Berry power-up specifically for this page. You can configure the Googie Berry power-up on the System Settings and Dashboard page.</p>
        </div>
        <label class="custom-switch">
            <input type="checkbox" />
            <span><span>On</span><span>Off</span></span>
            <a class="slide-button"></a>
        </label>
    </div>
```

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

### Supervisor configuration file

Source: https://github.com/wintercms/docs/blob/develop/services/queues.md

Example configuration for monitoring multiple queue worker processes.

```ini
[program:winter-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /path/to/winter/artisan queue:work --sleep=3 --tries=3
autostart=true
autorestart=true
user=winter
numprocs=8
redirect_stderr=true
stdout_logfile=/path/to/winter/worker.log
```

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

### Instantiate and use the Robot class

Source: https://github.com/wintercms/docs/blob/develop/services/behaviors.md

Example of initializing the class and calling methods provided by both the base class and the implemented behaviour.

```php
$robot = new Robot();
$robot->identify();
```

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

### Markdown Syntax Example

Source: https://github.com/wintercms/docs/blob/develop/services/parser.md

Demonstrates basic Markdown syntax for text formatting and headings.

```md
This text is **bold**, this text is *italic*, this text is ~~crossed out~~.

# The largest heading (an <h1> tag)
## The second largest heading (an <h2> tag)
...
###### The 6th largest heading (an <h6> tag)
```

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

### Associative array output example

Source: https://github.com/wintercms/docs/blob/develop/ui/controls/inspector.md

Shows the resulting data structure when a keyProperty is defined.

```json
{
    "people":{
        "john":{"fullName":"John Smith","address":"Palo Alto"},
        "bart":{"fullName":"Bart Simpson","address":"Springfield"}
    }
}
```

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

### systemd service configuration

Source: https://github.com/wintercms/docs/blob/develop/services/queues.md

Example configuration file for a systemd service unit.

```ini
[Unit]
Description=Runs a queue worker for Winter CMS
OnFailure=failure-notify@%n.service

[Service]
Restart=always
# You can also use "Restart=on-failure" to restart only on a failure in the queue worker.
WorkingDirectory=/var/www/html
ExecStart=/usr/bin/php artisan queue:work

[Install]
WantedBy=default.target
```

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

### LoginHandler Class Example

Source: https://github.com/wintercms/docs/blob/develop/events/introduction.md

A sample class that can be used as an event listener. It expects a 'handle' method.

```php
class LoginHandler
{
    public function handle($data)
    {
        // ...
    }
}
```

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

### Layout Template Example

Source: https://github.com/wintercms/docs/blob/develop/markup/tags/page.md

An example of a layout template using the `{% page %}` tag to render page content and the `{% placeholder %}` tag for head content.

```twig
description="example layout"
==
<html>
    <head>
        {% placeholder head %}
    </head>
    <body>
        {% page %}
        ...
```

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

### get()

Source: https://github.com/wintercms/docs/blob/develop/snowboard/extras.md

Retrieves the entire configuration object or a specific configuration value by key.

```APIDOC
## get(configName?: string)

### Description
Retrieves the entire configuration object or a specific configuration value. If a key is provided, it returns the value for that key; otherwise, it returns the full configuration object.

### Parameters
- **configName** (string) - Optional - The name of the configuration option to retrieve.
```

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

### Configuring Tab Options

Source: https://github.com/wintercms/docs/blob/develop/backend/forms.md

Example configuration for tab behavior, including lazy loading, CSS classes, and icons.

```yaml
tabs:
    stretch: true
    defaultTab: User
    cssClass: text-blue
    lazy:
        - Groups
    paneCssClass:
        0: first-tab
        1: second-tab
    icons:
        User: icon-user
        Groups: icon-group

    fields:
        username:
            type: text
            label: Username
            tab: User

        groups:
            type: relation
            label: Groups
            tab: Groups
```

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

### Run migrations and regenerate public folder

Source: https://github.com/wintercms/docs/blob/develop/architecture/using-composer.md

Execute these commands after installing packages to update the database and public assets.

```bash
php artisan migrate && php artisan winter:mirror public --relative
```

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

### Define Inspector Properties

Source: https://github.com/wintercms/docs/blob/develop/ui/controls/inspector.md

Example configuration for two string properties.

```json
[
    {
        "property": "firstName",
        "title": "First name",
        "type": "string"
    },
    {
        "property": "lastName",
        "title": "Last name",
        "type": "string"
    }
]
```

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

### Get Installed Winter CMS Version

Source: https://github.com/wintercms/docs/blob/develop/console/setup-maintenance.md

The `winter:version` command displays the installed Winter CMS version by querying a central build manifest and verifying system file integrity. It alerts if modifications are detected.

```bash
php artisan winter:version [--changes] [--only-version]
```

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

### Define template configuration

Source: https://github.com/wintercms/docs/blob/develop/cms/themes.md

Example of the INI-based configuration section for setting template parameters and components.

```ini
url = "/blog"
layout = "default"

[component]
parameter = "value"
```

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

### Get Theme Configuration Value

Source: https://github.com/wintercms/docs/blob/develop/markup/this/theme.md

Access configuration values defined in the theme's `theme.yaml` file. This example shows how to retrieve the theme's description.

```twig
<meta name="description" content="{{ this.theme.config.description }}">
```

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

### Run Project Unit Tests

Source: https://github.com/wintercms/docs/blob/develop/console/utilities.md

Executes unit tests for the entire Winter CMS project. No specific setup is required beyond a standard Winter installation.

```bash
php artisan winter:test
```

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

### Create a theme

Source: https://github.com/wintercms/docs/blob/develop/console/scaffolding.md

Generates a theme folder and basic files. Optionally specify a base scaffold like tailwind or less.

```bash
php artisan create:theme <theme code> [scaffold]
```

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

### Install Node Dependencies for a Package

Source: https://github.com/wintercms/docs/blob/develop/console/asset-node-utilities.md

Installs Node dependencies for a specified package. You can also specify individual dependencies to install.

```bash
php artisan npm:install <?package name> <dependencies[]>
```

```bash
php artisan npm:install acme.plugin is-odd
```

```bash
php artisan npm:install acme.plugin is-odd is-even
```

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

### Managing systemd service lifecycle

Source: https://github.com/wintercms/docs/blob/develop/services/queues.md

Commands to enable, reload, start, stop, and restart the systemd service.

```bash
systemctl --user enable queue-worker.service
```

```bash
systemctl --user daemon-reload
```

```bash
systemctl --user start queue-worker.service
```

```bash
systemctl --user stop queue-worker.service
```

```bash
systemctl --user restart queue-worker.service
```

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

### Install Node dependencies

Source: https://github.com/wintercms/docs/blob/develop/console/asset-compilation-vite.md

Installs Node dependencies for registered Vite packages by updating the root package.json and running npm install.

```bash
php artisan vite:install [-p <package name>] [--npm <path to npm>]
```

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

### Generate SQL for parameter grouping

Source: https://github.com/wintercms/docs/blob/develop/database/query.md

The resulting SQL output for the parameter grouping example.

```sql
select * from users where name = 'John' or (votes > 100 and title <> 'Admin')
```

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

### Install a plugin or theme via Composer

Source: https://github.com/wintercms/docs/blob/develop/architecture/using-composer.md

Use this command in the project root to add a published package to your Winter CMS project.

```bash
composer require <your package name>

# Example:
#   composer require winter/wn-pages-plugin
```

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

### Install a development-only package

Source: https://github.com/wintercms/docs/blob/develop/architecture/using-composer.md

Use the --dev flag to include packages only in development environments.

```bash
composer require --dev <your package name> "<version constraint>"

# Example:
#   composer require --dev winter/wn-builder-plugin "^2.0.0"
```

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

### Install a specific version of a package

Source: https://github.com/wintercms/docs/blob/develop/architecture/using-composer.md

Specify a version constraint to lock the package to a particular release.

```bash
composer require <your package name> "<version constraint>"

# Example:
#   composer require winter/wn-pages-plugin "^2.0.0"
```

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

### Theme Information Configuration

Source: https://github.com/wintercms/docs/blob/develop/themes/development.md

Example of a theme.yaml file defining metadata for a Winter CMS theme.

```yaml
name: "Winter CMS Demo"
description: "Demonstrates the basic concepts of the frontend theming."
author: "Winter CMS"
homepage: "https://wintercms.com"
code: "demo"
```

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

### Create a directory

Source: https://github.com/wintercms/docs/blob/develop/services/filesystem-cdn.md

Use the `makeDirectory` method to create a directory, including any necessary parent sub-directories, on the default disk.

```php
Storage::makeDirectory($directory);
```

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

### Attach XML Content-Type Header

Source: https://github.com/wintercms/docs/blob/develop/services/response-view.md

A practical example demonstrating how to attach a 'Content-Type' header for an XML response.

```php
return Response::make($xmlString)->header('Content-Type', 'text/xml');
```

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

### Typical form behavior configuration

Source: https://github.com/wintercms/docs/blob/develop/backend/forms.md

Example of a standard form behavior configuration file defining the model and basic page titles.

```yaml
# ===================================
#  Form Behavior Config
# ===================================

name: Blog Category
form: $/acme/blog/models/post/fields.yaml
modelClass: Acme\Blog\Post

create:
    title: New Blog Post

update:
    title: Edit Blog Post

preview:
    title: View Blog Post
```

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

### Implement a complete scoreboard

Source: https://github.com/wintercms/docs/blob/develop/ui/controls/scoreboard.md

A full example showing various scoreboard items including pie charts, bar charts, value displays, and goal meters.

```html
<div class="scoreboard">
    <div data-control="toolbar">
        <div class="scoreboard-item control-chart" data-control="chart-pie">
            <ul>
                <li data-color="#95b753">Published <span>84</span></li>
                <li data-color="#e5a91a">Drafts <span>12</span></li>
                <li data-color="#cc3300">Deleted <span>18</span></li>
            </ul>
        </div>

        <div class="scoreboard-item control-chart" data-control="chart-bar">
            <ul>
                <li data-color="#95b753">Published <span>84</span></li>
                <li data-color="#e5a91a">Drafts <span>12</span></li>
                <li data-color="#cc3300">Deleted <span>18</span></li>
            </ul>
        </div>

        <div class="scoreboard-item title-value">
            <h4>Weight</h4>
            <p>100</p>
            <p class="description">unit: kg</p>
        </div>

        <div class="scoreboard-item title-value">
            <h4>Comments</h4>
            <p class="positive">44</p>
            <p class="description">previous month: 32</p>
        </div>

        <div class="scoreboard-item title-value">
            <h4>Length</h4>
            <p class="negative">31</p>
            <p class="description">previous: 42</p>
        </div>

        <div class="scoreboard-item title-value">
            <h4>Latest commenter</h4>
            <p class="wn-icon-star">John Smith</p>
            <p class="description">registered: yes</p>
        </div>

        <div class="scoreboard-item title-value" data-control="goal-meter" data-value="88">
            <h4>goal meter</h4>
            <p>88%</p>
            <p class="description">37 posts remain</p>
        </div>

        <div class="scoreboard-item title-value goal-meter-inverse" data-control="goal-meter" data-value="88">
            <h4>goal meter</h4>
            <p>88%</p>
            <p class="description">37 posts remain</p>
        </div>
    </div>
</div>
```

```backend
<div class="scoreboard">
    <div data-control="toolbar">
        <div class="scoreboard-item control-chart" data-control="chart-pie">
            <ul>
                <li data-color="#95b753">Published <span>84</span></li>
                <li data-color="#e5a91a">Drafts <span>12</span></li>
                <li data-color="#cc3300">Deleted <span>18</span></li>
            </ul>
        </div>

        <div class="scoreboard-item control-chart" data-control="chart-bar">
            <ul>
                <li data-color="#95b753">Published <span>84</span></li>
                <li data-color="#e5a91a">Drafts <span>12</span></li>
                <li data-color="#cc3300">Deleted <span>18</span></li>
            </ul>
        </div>

        <div class="scoreboard-item title-value">
            <h4>Weight</h4>
            <p>100</p>
            <p class="description">unit: kg</p>
        </div>

        <div class="scoreboard-item title-value">
            <h4>Comments</h4>
            <p class="positive">44</p>
            <p class="description">previous month: 32</p>
        </div>

        <div class="scoreboard-item title-value">
            <h4>Length</h4>
            <p class="negative">31</p>
            <p class="description">previous: 42</p>
        </div>

        <div class="scoreboard-item title-value">
            <h4>Latest commenter</h4>
            <p class="wn-icon-star">John Smith</p>
            <p class="description">registered: yes</p>
        </div>

        <div class="scoreboard-item title-value" data-control="goal-meter" data-value="88">
            <h4>goal meter</h4>
            <p>88%</p>
            <p class="description">37 posts remain</p>
        </div>

        <div class="scoreboard-item title-value goal-meter-inverse" data-control="goal-meter" data-value="88">
            <h4>goal meter</h4>
            <p>88%</p>
            <p class="description">37 posts remain</p>
        </div>
    </div>
</div>
```

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

### Controller Directory Structure

Source: https://github.com/wintercms/docs/blob/develop/backend/controllers-ajax.md

Example of the standard directory layout for a Winter CMS backend controller.

```treeview
plugins/
`-- acme/
    `-- blog/
        |-- controllers/
        |   |-- users/                 # Controller view directory
        |   |   |-- _partial.php       # Controller partial file
        |   |   |-- config_form.yaml   # Controller config file
        |   |   `-- index.php          # Controller view file
        |   `-- Users.php              # Controller class
        `-- Plugin.php
```

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

### Define controller with FormController behavior

Source: https://github.com/wintercms/docs/blob/develop/backend/forms.md

Example of a controller class implementing the FormController behavior.

```php
class Categories extends \Backend\Classes\Controller
{
    /**
     * @var array List of behaviors implemented by this controller
     */
    public $implement = [
        \Backend\Behaviors\FormController::class,
    ];
}
```

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

### Booting Laravel package configurations

Source: https://github.com/wintercms/docs/blob/develop/architecture/using-composer.md

Call this method from the plugin's boot() method to dynamically load package configurations from the plugin's own configuration files.

```php
public function bootPackages()
{
    // Get the namespace code of the current plugin
    $pluginNamespace = str_replace('\', '.', strtolower(__NAMESPACE__));

    // Locate the packages to boot
    $packages = \Config::get($pluginNamespace . '::packages');

    // Boot each package
    foreach ($packages as $name => $options) {
        // Apply the configuration for the package
        if (
            !empty($options['config']) &&
            !empty($options['config_namespace'])
        ) {
            Config::set($options['config_namespace'], $options['config']);
        }
    }
}
```

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

### Define a partial with configuration

Source: https://github.com/wintercms/docs/blob/develop/cms/partials.md

Include an optional configuration section at the top of the file to provide a description for the backend interface.

```html
description = "Demo partial"
==
<p>This is a partial</p>
```

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

### Define index view file

Source: https://github.com/wintercms/docs/blob/develop/backend/controllers-ajax.md

Example content for an index.php view file associated with an index action method.

```html
<h1>Hello World</h1>
```

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

### Rendered HTML Output

Source: https://github.com/wintercms/docs/blob/develop/markup/tags/page.md

The resulting HTML output when the example page is rendered with the example layout.

```html
<html>
    <head>
        <meta name="foo" content="bar">
    </head>
    <body>
        <p>My content.</p>
        ...
```

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

### Default component markup example

Source: https://github.com/wintercms/docs/blob/develop/cms/components.md

Example of default component markup using the __SELF__ variable.

```twig
<h1>{{ __SELF__.post.title }}</h1>
<p>{{ __SELF__.post.description }}</p>
```

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

### get()

Source: https://github.com/wintercms/docs/blob/develop/services/helpers.md

Obtains an input item from the request, restricted to GET variables only. A default value can be provided.

```APIDOC
## get()

### Description
Obtains an input item from the request, restricted to GET variables only. A default value can be provided.

### Function Signature
`get(string $key, mixed $default = null): mixed`

### Parameters
#### Path Parameters
- **key** (string) - Required - The input key.
- **default** (mixed) - Optional - The default value to return if the key is not found.

### Request Example
```php
$value = get('key', $default = null);
```
```

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

### Page Template Example

Source: https://github.com/wintercms/docs/blob/develop/markup/tags/page.md

An example of a page template that injects content into the 'head' placeholder and defines its own raw markup.

```twig
description="example page"
==
{% put head %}
    <meta name="foo" content="bar">
{% endput %}

<p>My content.</p>
```

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

### Define a basic page template

Source: https://github.com/wintercms/docs/blob/develop/cms/pages.md

A minimal example of a page template including the required configuration and Twig markup.

```ini
url = "/"
==
<h1>Hello, world!</h1>
```

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

### Create a plugin

Source: https://github.com/wintercms/docs/blob/develop/console/scaffolding.md

Generates a plugin folder and basic files using the specified author and plugin name.

```bash
php artisan create:plugin <plugin code>
```

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

### Get All Directories

Source: https://github.com/wintercms/docs/blob/develop/services/filesystem-cdn.md

Get an array of all directories within a given directory using `directories` or recursively using `allDirectories`.

```APIDOC
## Get All Directories

### Description
Get an array of all directories within a given directory using `directories` or recursively using `allDirectories`.

### Methods
#### `directories(string $directory)`
Returns an array of all directories in the given directory (non-recursive).

#### `allDirectories(string $directory)`
Returns an array of all directories in the given directory and all sub-directories (recursive).

### Parameters
#### Path Parameters (for both methods)
- **directory** (string) - Required - The path to the directory.

### Example
```php
$directories = Storage::directories($directory);
$directories = Storage::allDirectories($directory);
```
```

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

### Configure a repeater in group mode

Source: https://github.com/wintercms/docs/blob/develop/backend/forms.md

Example of enabling group mode by referencing an external configuration file.

```yaml
content:
    type: repeater
    prompt: Add content block
    groups: $/acme/blog/config/repeater_fields.yaml
```

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

### Define a Dynamic Syntax template

Source: https://github.com/wintercms/docs/blob/develop/services/parser.md

Example of a template string using the {text} tag for both view and editor properties.

```text
<h1>{text name="websiteName" label="Website Name"}Our wonderful website{/text}</h1>
```

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

### List Installed Themes

Source: https://github.com/wintercms/docs/blob/develop/console/theme-management.md

Displays a list of all themes installed in the Winter CMS. Indicates whether each theme is currently active.

```bash
php artisan theme:list
```

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

### Manage singleton dependencies

Source: https://github.com/wintercms/docs/blob/develop/snowboard/plugin-development.md

Singletons defer their ready event until all specified dependencies are registered.

```js
class MySingleton extends Singleton {
  dependencies() {
    return ['myDependency'];
  }

  ready() {
    // This method won't fire until a plugin registers with the "myDependency" name
  }
}
```

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

### Install Node Dependencies for Project Root

Source: https://github.com/wintercms/docs/blob/develop/console/asset-node-utilities.md

Installs Node dependencies directly into the project's root package.json by omitting the package name.

```bash
php artisan npm:install is-odd is-even
```

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

### View command help documentation

Source: https://github.com/wintercms/docs/blob/develop/console/introduction.md

Append the help flag to any command to see available arguments and options.

```bash
php artisan [command] --help
```

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

### Install Node Dependencies with Dev Flag

Source: https://github.com/wintercms/docs/blob/develop/console/asset-node-utilities.md

Installs Node dependencies for a specified package, including devDependencies, by using the --dev flag.

```bash
php artisan npm:install acme.plugin is-odd is-even --dev
```

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

### Include Snowboard with all features

Source: https://github.com/wintercms/docs/blob/develop/snowboard/introduction.md

Loads the base framework and all available plugins.

```twig
{% snowboard all %}
```

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

### Get all directories in a directory

Source: https://github.com/wintercms/docs/blob/develop/services/filesystem-cdn.md

Use the `directories` method to get an array of all directories within a given directory. Use `allDirectories` for a recursive listing.

```php
$directories = Storage::directories($directory);

// Recursive...
$directories = Storage::allDirectories($directory);
```

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

### Get last modified timestamp

Source: https://github.com/wintercms/docs/blob/develop/services/filesystem-cdn.md

Use the `lastModified` method to get the UNIX timestamp of the last time a file was modified on the default disk.

```php
$time = Storage::lastModified('file1.jpg');
```

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

### Example JSON Structure from Paginator

Source: https://github.com/wintercms/docs/blob/develop/services/pagination.md

This is an example of the JSON structure generated when a paginator instance is returned from a route. It contains pagination metadata and the data array.

```json
{
    "total": 50,
    "per_page": 15,
    "current_page": 1,
    "last_page": 4,
    "next_page_url": "https://wintercms.app?page=2",
    "prev_page_url": null,
    "from": 1,
    "to": 15,
    "data": [
        {
            // Result Object
        },
        {
            // Result Object
        }
    ]
}
```

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

### Registering a command in a service provider

Source: https://github.com/wintercms/docs/blob/develop/console/introduction.md

Call the commands method from the boot method of a service provider.

```php
public function boot()
{
    $this->app->singleton('myauthor.mycommand', function () {
        return new \MyAuthor\MyCommand\Console\MyCommand;
    });

    $this->commands('myauthor.mycommand');
}
```

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

### Get all files in a directory

Source: https://github.com/wintercms/docs/blob/develop/services/filesystem-cdn.md

Use the `files` method to get an array of all files in a given directory. Use `allFiles` for a recursive listing including sub-directories.

```php
$files = Storage::files($directory);

$files = Storage::allFiles($directory);
```

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

### Create a Directory

Source: https://github.com/wintercms/docs/blob/develop/services/filesystem-cdn.md

Create a directory, including any necessary sub-directories, using the `makeDirectory` method.

```APIDOC
## Create a Directory

### Description
Create a directory, including any necessary sub-directories, using the `makeDirectory` method.

### Method
`makeDirectory(string $directory)`

### Parameters
#### Path Parameters
- **directory** (string) - Required - The path of the directory to create.

### Example
```php
Storage::makeDirectory($directory);
```
```

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

### Start Daemon Queue Worker

Source: https://github.com/wintercms/docs/blob/develop/services/queues.md

Start a queue worker in daemon mode by omitting the --once flag. You can configure sleep intervals and job retry attempts.

```bash
php artisan queue:work connection
```

```bash
php artisan queue:work connection --sleep=3
```

```bash
php artisan queue:work connection --sleep=3 --tries=3
```

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

### Define a plugin configuration file

Source: https://github.com/wintercms/docs/blob/develop/plugin/settings.md

Create a config.php file in the plugin's config directory returning an array of settings.

```php
<?php

return [
    'maxItems' => 10,
    'display' => 5
];
```

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

### Mirror public files using Artisan

Source: https://github.com/wintercms/docs/blob/develop/setup/configuration.md

Run the winter:mirror command to create a public directory for improved security in production environments.

```bash
php artisan winter:mirror public/
```

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

### Accessing the Snowboard instance

Source: https://github.com/wintercms/docs/blob/develop/snowboard/plugin-development.md

Demonstrates how to access the Snowboard framework globally or from within a plugin class.

```javascript
// All these should work to use Snowboard globally
Snowboard.getPlugins();
snowboard.getPlugins();
window.Snowboard.getPlugins();

// In your plugin, Snowboard can also be accessed as a property.
class MyPlugin extends PluginBase {
  myMethod() {
    this.snowboard.getPlugins();
  }
}
```

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

### Install Node Dependencies

Source: https://github.com/wintercms/docs/blob/develop/console/asset-compilation-mix.md

Installs Node dependencies for all registered Mix packages. Use the -p flag to specify individual packages or a custom path to npm with the --npm flag.

```bash
php artisan mix:install [-p <package name>] [--npm <path to npm>]
```

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

### Example Test Case Class Structure

Source: https://github.com/wintercms/docs/blob/develop/plugin/unit-testing.md

An example of a PHP test case class for a Winter CMS plugin. Test methods must be public and prefixed with 'test' or have a '@test' annotation. The class must extend System\Tests\Bootstrap\TestCase.

```php
<?php

namespace Acme\Blog\Tests\Cases\Models;

use System\Tests\Bootstrap\TestCase;

class BlogTest extends TestCase
{
    // Test adding a post
    public function testAddPost()
    {
        // ...
    }

    /**
     * This is still a test case, as it contains the following annotation.
     * @test
     */
    public function itCanDeleteAPost()
    {
        // ...
    }

    // This is NOT a test case, as the method is protected.
    protected function testNeverRuns()
    {
        // ...
    }
}
```

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

### Register Listener in init.php

Source: https://github.com/wintercms/docs/blob/develop/events/introduction.md

Use the `init.php` file in your plugin directory to register event listeners. This provides an alternative to the `boot` method for event setup.

```php
<?php

Event::listen(...);
```

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

### Example Commit Message for Merging Pull Requests

Source: https://github.com/wintercms/docs/blob/develop/architecture/maintainer-guide.md

This example demonstrates the recommended format for commit messages when merging pull requests. It includes a summary, detailed explanation, contributor credit, and links to fixed or referenced issues/PRs.

```git commit message
Fix some issues in the code (#1234)

This fixes a couple of issues spotted in the Backend. The changes are minor and should not affect backwards compatibility.

Credit to @bennothommo. Fixes #1212 and https://github.com/wintercms/wn-blog-plugin#432
```

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

### Create a New User with Model

Source: https://github.com/wintercms/docs/blob/develop/database/structure.md

Example of creating a new user record using a model within the 'run' method of a seeder class.

```php
<?php namespace Acme\Users\Updates;

use Seeder;
use Acme\Users\Models\User;

class SeedUsersTable extends Seeder
{
    public function run()
    {
        $user = User::create([
            'email'                 => 'user@example.com',
            'login'                 => 'user',
            'password'              => 'password123',
            'password_confirmation' => 'password123',
            'first_name'            => 'Actual',
            'last_name'             => 'Person',
            'is_activated'          => true
        ]);
    }
}
```

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

### slice()

Source: https://github.com/wintercms/docs/blob/develop/services/collections.md

Returns a slice of the collection starting at a given index.

```APIDOC
## slice(offset, length)

### Description
Returns a slice of the collection starting at the given index. Optionally accepts a length to limit the size of the returned slice.

### Parameters
- **offset** (int) - Required - The starting index.
- **length** (int) - Optional - The number of items to return.
```

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

### Update Winter CMS and Plugins

Source: https://github.com/wintercms/docs/blob/develop/console/setup-maintenance.md

Use the `winter:update` command to fetch and apply updates for the Winter CMS core and installed plugins. This includes updating files and running database migrations. Note the specific instructions for users managing their installation via Composer.

```bash
php artisan winter:update
```

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

### Configure Icon Picker Widget

Source: https://github.com/wintercms/docs/blob/develop/backend/forms.md

Sets up an icon picker using the default Font Awesome library configuration.

```yaml
icon:
    label: 'Icon'
    type: 'iconpicker'
    default: 'far icon-address-book'
    libraries: ~/modules/backend/formwidgets/iconpicker/meta/libraries.yaml
```

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

### Create Basic Mix Configuration

Source: https://github.com/wintercms/docs/blob/develop/console/asset-compilation-mix.md

Generates a basic `winter.mix.js` configuration file for a new package. This command sets up the foundation for asset compilation.

```bash
php artisan mix:create <package name> [--tailwind] [--vue]
```

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

### Descriptive Component Naming

Source: https://github.com/wintercms/docs/blob/develop/architecture/developer-guide.md

Examples of component names that do not require a suffix.

```text
ProductReviews
CustomerCheckout
SeoDirectory
UserProfile
```

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

### Create a Backend Controller

Source: https://github.com/wintercms/docs/blob/develop/console/scaffolding.md

Generates a controller, configuration, and view files for a backend controller. The optional --sidebar flag configures it to use the sidebar layout.

```bash
php artisan create:controller <plugin code> <controller name> [--sidebar]
```

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

### Rendered Verbatim Output

Source: https://github.com/wintercms/docs/blob/develop/markup/tags/verbatim.md

The resulting output of the basic verbatim example.

```twig
<p>Hello, {{ name }}</p>
```

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

### Generate SQL for whereExists

Source: https://github.com/wintercms/docs/blob/develop/database/query.md

The resulting SQL output for the whereExists example.

```php
select * from users where exists (
    select 1 from orders where orders.user_id = users.id
)
```

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

### Listen to an Event with a Class

Source: https://github.com/wintercms/docs/blob/develop/events/introduction.md

Register a class to listen for a specific event. The default 'handle' method will be called.

```php
Event::listen('auth.login', 'LoginHandler');
```

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

### Suggesting Values for Command Options

Source: https://github.com/wintercms/docs/blob/develop/console/introduction.md

Implement this method to provide dynamic suggestions for command options. This is useful for options that accept a predefined set of values, like package names.

```php
// ...

    /**
     * Example implementation of a suggestion method for the "package" option
     */
    public function suggestPackageOptions(string $value = null, array $allInput): array
    {
        return Package::all()->pluck('name')->all();
    }

// ...
```

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

### Get request URL

Source: https://github.com/wintercms/docs/blob/develop/services/request-input.md

Returns the full URL of the current request.

```php
$url = Request::url();
```

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

### Define environment in .env file

Source: https://github.com/wintercms/docs/blob/develop/setup/configuration.md

Set the application environment by creating a .env file in the root directory.

```ini
APP_ENV=dev
```

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

### Basic winter.mix.js Configuration

Source: https://github.com/wintercms/docs/blob/develop/console/asset-compilation-mix.md

Sets the public path for assets. Use `__dirname` for assets in the current directory or `__dirname + '/assets'` for assets in a subdirectory.

```javascript
const mix = require('laravel-mix');

// For assets in the current directory
// mix.setPublicPath(__dirname);

// For assets in a /assets subdirectory
mix.setPublicPath(__dirname + '/assets');

// Your mix configuration below
```

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

### Define a Model Relationship

Source: https://github.com/wintercms/docs/blob/develop/database/relations.md

Example of defining a belongsTo relationship in a Model class.

```php
class Book extends Model
{
    public $belongsTo = [
        'author' => ['Acme\Blog\Models\Author']
    ];
}
```

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

### Example List Behavior Configuration

Source: https://github.com/wintercms/docs/blob/develop/backend/lists.md

A typical `config_list.yaml` file for the List behavior, defining the list title, column definitions, model class, record URL, and records per page.

```yaml
# ===================================
#  List Behavior Config
# ===================================

title: Blog Posts
list: ~/plugins/acme/blog/models/post/columns.yaml
modelClass: Acme\Blog\Models\Post
recordUrl: acme/blog/posts/update/:id
recordsPerPage: 20
```

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

### Get application environment

Source: https://github.com/wintercms/docs/blob/develop/services/application.md

Returns the current application environment as defined in the configuration.

```php
// production
App::environment();
```

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

### Remove demo plugin and theme

Source: https://github.com/wintercms/docs/blob/develop/console/setup-maintenance.md

Removes the default demo plugin and theme from the installation.

```bash
php artisan winter:fresh
```

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

### Create a version-compatible BaseTestCase

Source: https://github.com/wintercms/docs/blob/develop/setup/upgrade-guide.md

Use this stub to maintain compatibility with both Winter 1.1 and 1.2 by dynamically extending the appropriate test case class.

```php
// Create a stub BaseTestCase that extends the correct plugin test case file depending on Winter version
if (class_exists('System	estsootstrap	estcase')) {
    class BaseTestCase extends \System\Tests\Bootstrap\PluginTestCase
    {
    }
} else {
    class BaseTestCase extends \PluginTestCase
    {
    }
}

class MyTestCase extends BaseTestCase
```

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

### Switch Active Theme

Source: https://github.com/wintercms/docs/blob/develop/console/theme-management.md

Changes the active theme for public-facing pages of the Winter installation.

```bash
php artisan theme:use <theme code>
```

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

### EnvFile::open

Source: https://github.com/wintercms/docs/blob/develop/services/parser.md

Initializes the EnvFile parser with the contents of a specified path. If no path is provided, it defaults to the base .env file.

```APIDOC
## EnvFile::open(string $path = null)

### Description
Initializes the EnvFile parser. If the path does not exist, it will be created upon calling the write() method.

### Parameters
- **$path** (string) - Optional - The file path to the .env file. Defaults to base_path('.env').
```

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

### Database Table Naming Convention

Source: https://github.com/wintercms/docs/blob/develop/architecture/developer-guide.md

Example of the required prefixing format for database tables.

```text
acme_blog_xxx
```

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

### Initializing a collection

Source: https://github.com/wintercms/docs/blob/develop/services/collections.md

Creates a new collection instance from a simple array.

```php
$collection = new Winter\Storm\Support\Collection([1, 2, 3]);
```

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

### Trigger with CSS selector

Source: https://github.com/wintercms/docs/blob/develop/ui/script/input-trigger.md

Example of using a CSS selector to target multiple checkboxes.

```html
<input type="button" class="btn disabled"
    data-trigger-action="enable"
    data-trigger="#cblist input[type=checkbox]"
    data-trigger-condition="checked" ... >
```

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

### Using a Custom Bundle with Vite Create Command

Source: https://github.com/wintercms/docs/blob/develop/console/asset-compilation.md

Example of how to use a registered custom bundle (e.g., 'winterjs') when creating a new plugin or theme configuration using the `vite:create` Artisan command.

```bash
php artisan vite:create Acme.Plugin --winterjs
```

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

### Define options via language file

Source: https://github.com/wintercms/docs/blob/develop/backend/forms.md

Reference a language key string in the configuration and define the options in a PHP language file.

```yaml
status_type:
    label: Blog Post Status
    type: dropdown
    default: published
    options: author.plugin::lang.status_types
```

```php
// lang.php
return [
    'status_types' => [
        'draft' => 'Draft',
        'published' => 'Published',
        'archived' => 'Archived',
    ],
];
```
Tokens:
Raw