Winter CMS

https://wintercms.com/docs/v1.2/docs
Admin
Winter CMS is a free, open-source content management system built on the Laravel PHP framework,...
Tokens:196,175
Snippets:2,902
Trust Score:9
Update:2 months ago
Show doc for...
Tokens:
Raw
### YAML Configuration Example

Source: https://wintercms.com/docs/v1.2/docs/services/parser

A basic example of YAML configuration syntax.

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

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

### INI Configuration Example

Source: https://wintercms.com/docs/v1.2/docs/services/parser

A basic example of INI configuration syntax.

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

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

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

### Configure GitHub Actions for unit testing

Source: https://wintercms.com/docs/v1.2/docs/plugin/unit-testing

Example workflow configuration for automating plugin tests using the Setup Winter Action.

```yaml
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
```

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

### Example backend URL

Source: https://wintercms.com/docs/v1.2/docs/backend/controllers-ajax

A concrete example of a generated backend URL.

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

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

### Install a theme

Source: https://wintercms.com/docs/v1.2/docs/console/theme-management

Downloads and installs a theme using its AuthorName.ThemeName code.

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

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

### Install a plugin

Source: https://wintercms.com/docs/v1.2/docs/console/plugin-management

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

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

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

### Install Winter CMS via CLI

Source: https://wintercms.com/docs/v1.2/docs/console/setup-maintenance

Initializes a new Winter CMS installation by prompting for database, URL, and admin credentials.

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

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

### Markdown Syntax Examples

Source: https://wintercms.com/docs/v1.2/docs/services/parser

Basic formatting examples for GitHub flavored markdown.

```markdown
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)
```

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

### List installed plugins

Source: https://wintercms.com/docs/v1.2/docs/console/plugin-management

Displays a table of all installed plugins, their versions, and their current status.

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

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

### Get the installed Winter version

Source: https://wintercms.com/docs/v1.2/docs/console/setup-maintenance

Displays the current version and verifies system file integrity. Use the --changes flag to list modified files or --only-version for script-friendly output.

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

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

### List installed themes

Source: https://wintercms.com/docs/v1.2/docs/console/theme-management

Displays all installed themes and their active status.

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

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

### Define Plugin Configuration File

Source: https://wintercms.com/docs/v1.2/docs/plugin/replacement

Example configuration file structure for a plugin.

```php
<?php

return [
    'foo' => 'bar'
];
```

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

### Theme Configuration Example

Source: https://wintercms.com/docs/v1.2/docs/themes/development

A sample theme.yaml file defining basic theme metadata.

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

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

### Initialize Domain-Driven Environment File

Source: https://wintercms.com/docs/v1.2/docs/setup/configuration

Starts the configuration file for mapping hostnames to specific environments.

```php
<?php
```

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

### Access Autocompletion Instructions

Source: https://wintercms.com/docs/v1.2/docs/console/introduction

View installation instructions for shell autocompletion support.

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

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

### Component partial override setup

Source: https://wintercms.com/docs/v1.2/docs/cms/components

Initial setup for a component to allow for partial overrides.

```Twig
url = "mypage"

[channel]
==
{% component "channel" %}
```

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

### Example index.php view file

Source: https://wintercms.com/docs/v1.2/docs/backend/controllers-ajax

A basic view file corresponding to an index action method.

```HTML
<h1>Hello World</h1>
```

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

### Bracket syntax example

Source: https://wintercms.com/docs/v1.2/docs/services/parser

Demonstrates the basic curly bracket syntax for variable rendering.

```html
<p>Hello there, {foo}</p>
```

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

### Button field examples

Source: https://wintercms.com/docs/v1.2/docs/backend/forms

Examples of buttons configured for AJAX requests, external links, and popup triggers.

```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
```

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

### Full Template Structure

Source: https://wintercms.com/docs/v1.2/docs/cms/themes

A complete example showing the separation of configuration, PHP logic, and Twig markup.

```Twig
url = "/blog"
layout = "default"
==
function onStart()
{
    $this['posts'] = ...;
}
==
<h3>Blog archive</h3>
{% for post in posts %}
    <h4>{{ post.title }}</h4>
    {{ post.content }}
{% endfor %}
```

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

### PHP Namespace Reference

Source: https://wintercms.com/docs/v1.2/docs/cms/themes

Example of using the 'use' keyword within the PHP section.

```PHP
url = "/blog"
layout = "default"
==
<?
use Acme\Blog\Classes\Post;

function onStart()
{
    $this['posts'] = Post::get();
}
?>
==
```

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

### Example toolbar button configuration

Source: https://wintercms.com/docs/v1.2/docs/backend/relations

Demonstrates how to define toolbar buttons using a pipe-separated string or an associative array for custom labels.

```YAML
add|remove
```

```YAML
create: 'Assign User'
```

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

### Install Node dependencies via artisan

Source: https://wintercms.com/docs/v1.2/docs/console/asset-node-utilities

Use the npm:install command to add dependencies to a specific package or the project root.

```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
```

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

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

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

### Install Node dependencies

Source: https://wintercms.com/docs/v1.2/docs/console/asset-compilation-mix

Installs dependencies for registered Mix packages using the artisan command line interface.

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

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

### Example form fields file location

Source: https://wintercms.com/docs/v1.2/docs/backend/forms

Shows the directory structure for a plugin's model configuration.

```text
plugins
`-- acme
    `-- blog
        `-- models                # Plugin models directory
            |-- post              # Model configuration directory
            |   `-- fields.yaml   # Model form fields config file
            `-- Post.php          # model class
```

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

### get()

Source: https://wintercms.com/docs/v1.2/docs/snowboard/extras

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

```APIDOC
## get()

### Description
Retrieves the entire configuration as an object or a specific value if a key is provided. Values are resolved from local configuration, element data attributes, and defaults.

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

### Returns
- (Object|any) - Returns an object of all configuration options if no key is provided, or the value of the specific key if provided.
```

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

### Define localization file structure

Source: https://wintercms.com/docs/v1.2/docs/plugin/localization

Example directory structure for plugin localization files.

```text
plugins
`-- acme
    `-- todo                   # Plugin directory
        `-- lang               # Localization directory
            |-- en             # Language directory
            |   `-- lang.php   # Localization file
            `-- fr
                `-- lang.php
```

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

### Controller Naming Conventions

Source: https://wintercms.com/docs/v1.2/docs/architecture/developer-guide

Examples of pluralized controller names.

```text
People
Products
Categories
ProductCategories
```

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

### Install a plugin or theme via Composer

Source: https://wintercms.com/docs/v1.2/docs/architecture/using-composer

Use this command to add a published plugin or theme package to your project.

```bash
composer require <your package name>

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

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

### Create a new Winter CMS project with Composer

Source: https://wintercms.com/docs/v1.2/docs/architecture/using-composer

Use the create-project command to initialize a new installation directory with the Winter CMS core.

```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"
```

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

### Treeview File Structure Example

Source: https://wintercms.com/docs/v1.2/docs/architecture/developer-guide

Illustrates the treeview syntax used to represent file and folder hierarchies in documentation.

```treeview
folder/
|-- subfolder1/
|-- subfolder2/
|   |-- image.jpeg
|   |-- photo.png
|   `-- document.pdf
|-- subfolder3/
|   |-- sub2folder/
|   |    `-- sub3file    # A comment about this file
|   `-- sub2folder2/
|-- index.php
`-- .hidden_file        # This file is hidden and should be slightly transparent
```

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

### Get all configuration options

Source: https://wintercms.com/docs/v1.2/docs/snowboard/extras

Retrieves the entire configuration as an object containing defaults merged with data attributes.

```javascript
this.config.get(); // Returns an object of all configuration options and their values.
```

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

### Controller Directory Structure

Source: https://wintercms.com/docs/v1.2/docs/backend/controllers-ajax

Example of the standard directory layout for a backend controller within a plugin.

```text
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
```

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

### Theme Subdirectory Structure

Source: https://wintercms.com/docs/v1.2/docs/cms/themes

Example demonstrating the use of subdirectories within pages, partials, and content folders.

```text
themes
`-- website
    |-- pages
    |   |-- home.htm
    |   `-- blog                   # Subdirectory
    |       |-- archive.htm
    |       `-- category.htm
    |-- partials
    |   |-- sidebar.htm
    |   `-- blog                   # Subdirectory
    |       `-- category-list.htm
    `-- content
       |-- footer-contacts.txt
       `-- home                    # Subdirectory
           `-- intro.htm
```

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

### Initialize Components Dynamically

Source: https://wintercms.com/docs/v1.2/docs/plugin/components

Override the init method to perform setup logic, such as dynamically attaching other components, before the page lifecycle begins.

```php
public function init()
{
    $this->addComponent('Acme\Blog\Components\BlogPosts', 'blogPosts');
}
```

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

### Check string start

Source: https://wintercms.com/docs/v1.2/docs/services/helpers

Determines if a string begins with a specific value.

```PHP
$value = starts_with('The cow goes moo', 'The');

// true
```

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

### Run migrations and regenerate public folder

Source: https://wintercms.com/docs/v1.2/docs/architecture/using-composer

Execute these commands after installing packages to ensure database and public assets are updated.

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

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

### Configuration Section

Source: https://wintercms.com/docs/v1.2/docs/cms/themes

Example of the INI-formatted configuration section for a page template.

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

[component]
parameter = "value"
```

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

### Typical Import Export YAML Configuration

Source: https://wintercms.com/docs/v1.2/docs/backend/import-export

Example of a standard configuration file defining both import and export settings.

```yaml
# ===================================
#  Import/Export Behavior Config
# ===================================

import:
    title: Import subscribers
    modelClass: Acme\Campaign\Models\SubscriberImport
    list: $/acme/campaign/models/subscriber/columns.yaml

export:
    title: Export subscribers
    modelClass: Acme\Campaign\Models\SubscriberExport
    list: $/acme/campaign/models/subscriber/columns.yaml
```

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

### Model Naming Conventions

Source: https://wintercms.com/docs/v1.2/docs/architecture/developer-guide

Examples of singular model names.

```text
Person
Product
Category
ProductCategory
```

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

### Define Component Directory Structure

Source: https://wintercms.com/docs/v1.2/docs/plugin/components

Example of the required file and directory layout for a component within a plugin.

```text
plugins
`-- acme
    `-- myplugin
        |-- components
        |   |-- componentname       # Component partials directory
        |   |   `-- default.htm     # Component default markup (optional)
        |   |-- partials            # Any partials shared by more than one component in the plugin
        |   |   `-- partialname.htm
        |   `-- ComponentName.php   # Component class file
        `-- Plugin.php
```

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

### Example Test Case Class

Source: https://wintercms.com/docs/v1.2/docs/plugin/unit-testing

Demonstrates how to extend the base TestCase and define test methods using prefixes or annotations.

```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()
    {
        // ...
    }
}
```

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

### Example popup title configuration

Source: https://wintercms.com/docs/v1.2/docs/backend/relations

Shows how to customize the popup title for specific modes using an associative array.

```YAML
form: acme.blog::lang.subcategory.FormTitle
```

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

### Install Node dependencies

Source: https://wintercms.com/docs/v1.2/docs/console/asset-compilation-vite

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>]
```

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

### SQL output for parameter grouping

Source: https://wintercms.com/docs/v1.2/docs/database/query

The resulting SQL generated by the parameter grouping example.

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

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

### get()

Source: https://wintercms.com/docs/v1.2/docs/services/helpers

Obtains an input item from the request (GET only).

```APIDOC
## get(string $key, mixed $default = null)

### Description
Obtains an input item from the request, restricted to GET variables.
```

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

### Install a development-only package

Source: https://wintercms.com/docs/v1.2/docs/architecture/using-composer

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://wintercms.com/docs/v1.2/docs/architecture/using-composer

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"
```

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

### Render Widget Input in Partial

Source: https://wintercms.com/docs/v1.2/docs/backend/widgets

Example of rendering an input element inside a widget partial using prepared variables.

```html
<input id="<?= $id ?>" name="<?= $name ?>" value="<?= e($value) ?>" />
```

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

### Console alert output example

Source: https://wintercms.com/docs/v1.2/docs/console/introduction

Visual representation of the rendered alert box output.

```text
*************************************************************
*  This will remove the database tables and files for the   *
*                 "Winter.Builder" plugin.                  *
*************************************************************
```

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

### Define Tables for Second Other Key Example

Source: https://wintercms.com/docs/v1.2/docs/database/relations

Table structure for a scenario requiring the use of secondOtherKey.

```text
departments
    id - integer
    code - string

employees
    id - integer
    department_code - string

records
    id - integer
    employee_id - integer

```

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

### Database Table Naming Conventions

Source: https://wintercms.com/docs/v1.2/docs/architecture/developer-guide

Examples of table naming prefixes and boolean column naming standards.

```text
acme_blog_xxx
```

```text
is_activated
is_visible
```

```text
acme_blog_category_id
```

```text
ab_category_id
```

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

### Component Naming Conventions

Source: https://wintercms.com/docs/v1.2/docs/architecture/developer-guide

Examples of naming components with suffixes for lists and details, or descriptive names.

```text
ProductList
ProductReviewList
CategoryList
```

```text
ProductDetails
CategoryDetails
```

```text
ProductReviews
CustomerCheckout
SeoDirectory
UserProfile
```

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

### Subscribing to global events

Source: https://wintercms.com/docs/v1.2/docs/plugin/extending

Use the boot method in a Plugin registration file to listen for global events.

```php
public function boot()
{
    Event::listen('winter.user.register', function ($user) {
        // Code to register $user->email to mailing list
    });
}
```

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

### Verify installation file removal

Source: https://wintercms.com/docs/v1.2/docs

Ensure these files are deleted after a web-based installation to maintain security.

```text
MyWinterFolder
|-- install        # Installation directory
`-- install.html   # Installation script
```

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

### php artisan npm:install

Source: https://wintercms.com/docs/v1.2/docs/console/asset-node-utilities

Installs Node dependencies for a specific package or the project root.

```APIDOC
## php artisan npm:install [package name] [dependencies...]

### Description
Installs specified Node dependencies. If a package name is provided, dependencies are installed into that package; otherwise, they are installed in the project root.

### Parameters
- **package name** (string) - Optional - The name of the plugin or theme package.
- **dependencies** (array) - Required - List of npm packages to install.
- **--dev** (flag) - Optional - Installs dependencies as devDependencies.
```

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

### Create a backend controller

Source: https://wintercms.com/docs/v1.2/docs/console/scaffolding

Generates controller, configuration, and view files, with an optional flag for sidebar layout.

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

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

### View File Naming Conventions

Source: https://wintercms.com/docs/v1.2/docs/architecture/developer-guide

Examples of view file naming where underscores represent directory separators and dashes represent spaces.

```php
index_fancy-layout.php       <== Index\Fancy layout
form-with-sidebar.php        <== Form with sidebar
_field-container.php         <== Field container (partial)
_field_baloon-selector.php   <== Field\Baloon Selector (partial)
```

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

### Markdown Code Block Example

Source: https://wintercms.com/docs/v1.2/docs/architecture/developer-guide

Demonstrates the syntax for multi-line Markdown code blocks with language highlighting.

```md
```md
This is a code block for the Markdown language.

**It should highlight parts of the language.**
```
```

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

### Default component markup example

Source: https://wintercms.com/docs/v1.2/docs/cms/components

Example of markup using the __SELF__ variable to reference the component object.

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

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

### View Command Help

Source: https://wintercms.com/docs/v1.2/docs/console/introduction

Access documentation, arguments, and options for a specific command using the help flag.

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

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

### Configuring tab options

Source: https://wintercms.com/docs/v1.2/docs/backend/forms

Example of configuring tab behavior, icons, and CSS classes within a YAML form definition.

```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
```

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

### Define Form Widget Directory Structure

Source: https://wintercms.com/docs/v1.2/docs/backend/widgets

Example directory structure for a form widget, including partials, assets, and the main class file.

```text
formwidgets
|-- form
|   |-- partials
|   |   `-- _form.php      # Widget partial file
|   `-- assets
|       |-- js
|       |   `-- form.js    # Widget JavaScript file
|       `-- css
|           `-- form.css   # Widget StyleSheet file
`-- Form.php               # Widget class
```

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

### Define Dynamic Syntax template

Source: https://wintercms.com/docs/v1.2/docs/services/parser

Example of a template using {text} tags for both view and editor mode properties.

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

```

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

### Create a partial with configuration

Source: https://wintercms.com/docs/v1.2/docs/cms/partials

A partial including an optional description parameter for the backend interface.

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

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

### env()

Source: https://wintercms.com/docs/v1.2/docs/services/helpers

Gets an environment variable.

```APIDOC
## env(string $key, mixed $default = null)

### Description
Retrieves the value of an environment variable or returns a default value if it does not exist.
```

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

### Route::get

Source: https://wintercms.com/docs/v1.2/docs/services/router

Registers a GET route to a specific URI.

```APIDOC
## GET [URI]

### Description
Registers a route that responds to GET requests.

### Method
GET

### Endpoint
[URI]

### Parameters
#### Path Parameters
- **{parameter}** (string) - Optional - Captured segments of the URI, optionally constrained by regex.
```

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

### Retrieve attachment URL

Source: https://wintercms.com/docs/v1.2/docs/database/attachments

Get the public URL for an attachment.

```PHP
echo $model->avatar->getPath();
```

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

### Create a settings model

Source: https://wintercms.com/docs/v1.2/docs/console/scaffolding

Generates files for a new Settings model, with an optional class name parameter.

```bash
php artisan create:settings <plugin code> [model name]
```

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

### Get class basename

Source: https://wintercms.com/docs/v1.2/docs/services/helpers

Returns the class name without the namespace.

```PHP
$class = class_basename('Foo\Bar\Baz');

// Baz
```

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

### Initialize properties from URL parameters

Source: https://wintercms.com/docs/v1.2/docs/cms/components

Use the {{ :paramName }} syntax to load property values from URL parameters.

```ini
[demoTodo]
maxItems = {{ :maxItems }}
==
...
```

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

### Get Request URL

Source: https://wintercms.com/docs/v1.2/docs/services/request-input

Retrieves the full URL of the current request.

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

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

### Get file size

Source: https://wintercms.com/docs/v1.2/docs/services/request-input

Retrieves the size of the uploaded file in bytes.

```PHP
$size = Input::file('photo')->getSize();
```

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

### Get file path

Source: https://wintercms.com/docs/v1.2/docs/services/request-input

Retrieves the absolute path to the uploaded file.

```PHP
$path = Input::file('photo')->getRealPath();
```

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

### Get all component properties

Source: https://wintercms.com/docs/v1.2/docs/plugin/components

Retrieve all defined component properties as an array.

```PHP
$properties = $this->getProperties();
```

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

### Get Node Nesting Level

Source: https://wintercms.com/docs/v1.2/docs/database/traits

Retrieve the current depth of a node.

```PHP
// 0 when root
$node->getLevel()
```

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

### SQL output for whereExists

Source: https://wintercms.com/docs/v1.2/docs/database/query

The resulting SQL generated by the whereExists example.

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

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

### Accessing the Snowboard instance

Source: https://wintercms.com/docs/v1.2/docs/snowboard/plugin-development

Demonstrates how to access the Snowboard framework globally or from within a custom 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();
  }
}
```

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

### Create a plugin

Source: https://wintercms.com/docs/v1.2/docs/console/scaffolding

Generates a plugin folder and basic files. The argument requires the author and plugin name in the format Author.Plugin.

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

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

### Sync Theme Files

Source: https://wintercms.com/docs/v1.2/docs/cms/themes

Use the console command to synchronize changes between the filesystem and the database.

```bash
theme:sync $themeDir
```

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

### Defining partial lifecycle methods

Source: https://wintercms.com/docs/v1.2/docs/cms/partials

Use onStart or onEnd in the PHP section to inject variables or load assets before the partial renders.

```PHP
==
function onStart()
{
    $this['hello'] = "Hello world!";

    /**
     * Variables that are already present on the page for Twig to use
     * can be accessed through the embedded controller instance.
     * If this partial was rendered by calling {% partial customVar="test" %}
     * then you could access that value with the following:
     */
    $this->controller->vars['customVar'];

    /**
     * Partial code sections also have access to the addJs() / addCss() asset
     * loading methods which include support for deduplicating asset references
     * which means that if you have a block-based system for editing theme content
     * using grouped repeaters and a particular block partial requires CSS or JS
     * dependencies, they can be loaded directly in the partial that uses them.
     */
    $this->addJs('https://cdn.example.com/js/vendor.js');
    $this->addCss('https://cdn.example.com/css/vendor.css');
}
==
<h3>{{ hello }}</h3>
```

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

### Get file MIME type

Source: https://wintercms.com/docs/v1.2/docs/services/request-input

Retrieves the MIME type of the uploaded file.

```PHP
$mime = Input::file('photo')->getMimeType();
```

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

### Define a belongsTo relationship

Source: https://wintercms.com/docs/v1.2/docs/database/relations

Example of defining a relationship within a model class.

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

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

### Mirror Public Files

Source: https://wintercms.com/docs/v1.2/docs/setup/configuration

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

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

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

### Remove a theme

Source: https://wintercms.com/docs/v1.2/docs/console/theme-management

Deletes theme files from the installation; this is a destructive action requiring confirmation.

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

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

### Get file extension

Source: https://wintercms.com/docs/v1.2/docs/services/request-input

Retrieves the file extension based on the original file name.

```PHP
$extension = Input::file('photo')->getClientOriginalExtension();
```

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

### Get original file name

Source: https://wintercms.com/docs/v1.2/docs/services/request-input

Retrieves the original name of the file as provided by the client.

```PHP
$name = Input::file('photo')->getClientOriginalName();
```

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

### Create a Root Node

Source: https://wintercms.com/docs/v1.2/docs/database/traits

Create a new node as a root by default.

```PHP
$root = Category::create(['name' => 'Root category']);
```

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

### Create a theme

Source: https://wintercms.com/docs/v1.2/docs/console/scaffolding

Generates a theme folder and basic files. The optional scaffold argument allows choosing between tailwind (default) or less base themes.

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

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

### Override localization strings

Source: https://wintercms.com/docs/v1.2/docs/plugin/localization

Example of an override file containing only the specific strings to be replaced.

```php
<?php

return [
    'app' => [
        'name' => 'Winter CMS!'
    ]
];
```

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

### Registering commands in a service provider

Source: https://wintercms.com/docs/v1.2/docs/console/introduction

Call the commands method from the boot method of a service provider, passing the container binding.

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

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

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

### Remove the demo plugin and theme

Source: https://wintercms.com/docs/v1.2/docs/console/setup-maintenance

Deletes the default demo plugin and theme from the installation if they are present.

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

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

### Create a model

Source: https://wintercms.com/docs/v1.2/docs/console/scaffolding

Generates the necessary files for a new model within a specified plugin.

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

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

### Define onInit for pages or layouts

Source: https://wintercms.com/docs/v1.2/docs/snowboard/handlers

Use this function within a page or layout PHP section to execute code before every AJAX handler.

```PHP
function onInit()
{
    // From a page or layout PHP code section
}
```

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

### Get random items

Source: https://wintercms.com/docs/v1.2/docs/services/collections

Returns a random item or a collection of random items if an integer is provided.

```php
$collection = new Collection([1, 2, 3, 4, 5]);

$collection->random();

// 4 - (retrieved randomly)
```

```php
$random = $collection->random(3);

$random->all();

// [2, 4, 5] - (retrieved randomly)
```

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

### Create Response Instances

Source: https://wintercms.com/docs/v1.2/docs/services/helpers

Creates a response instance or accesses the response factory.

```PHP
return response('Hello World', 200, $headers);

return response()->json(['foo' => 'bar'], 200, $headers);
```

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

### Retrieve local filesystem path

Source: https://wintercms.com/docs/v1.2/docs/database/attachments

Get the absolute path of an uploaded file on the local server.

```PHP
echo $model->avatar->getLocalPath();
```

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

### Enable database templates

Source: https://wintercms.com/docs/v1.2/docs/cms/themes

Set the configuration flag in config/cms.php to allow virtual themes stored in the database.

```PHP
'databaseTemplates' => true,
```

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

### Define a hasMany relationship in a Model

Source: https://wintercms.com/docs/v1.2/docs/database/relations

Example of defining a one-to-many relationship within a Model class.

```PHP
class User extends Model
{
    public $hasMany = [
        'posts' => ['Acme\Blog\Models\Post']
    ];
}
```

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

### Singleton Dependency Handling

Source: https://wintercms.com/docs/v1.2/docs/snowboard/plugin-development

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

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

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

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

### Create a report widget

Source: https://wintercms.com/docs/v1.2/docs/console/scaffolding

Generates a backend report widget, view, and basic asset files.

```bash
php artisan create:reportwidget <plugin code> <widget name>
```

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

### Define init for components or widgets

Source: https://wintercms.com/docs/v1.2/docs/snowboard/handlers

Implement this method inside a component or backend widget class to run initialization logic.

```PHP
function init()
{
    // From a component or widget class
}
```

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

### Define parameterized localization string

Source: https://wintercms.com/docs/v1.2/docs/plugin/localization

Example of a localization string containing placeholders for parameter replacement.

```php
'app' => [
    'test' => 'Text text text :key1 text text :key2 text.',
],
```

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

### Create and delete directories

Source: https://wintercms.com/docs/v1.2/docs/services/filesystem-cdn

Manages directory creation and recursive deletion.

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

```PHP
Storage::deleteDirectory($directory);
```

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

### Invalid Vendor Names

Source: https://wintercms.com/docs/v1.2/docs/architecture/developer-guide

Examples of invalid vendor names that violate casing or character requirements.

```text
acme.blog
winterStorm.user
Happy_gilmore.Golf
```

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

### Configure Redis Connection

Source: https://wintercms.com/docs/v1.2/docs/services/cache

Sets up the Redis client and default server connection details in the database configuration file.

```php
'redis' => [

    'client' => env('REDIS_CLIENT', 'phpredis'),

    'default' => [
        'host'     => '127.0.0.1',
        'password' => null,
        'port'     => 6379,
        'database' => 0,
    ],

],
```

```php
'redis' => [

    'client' => 'predis',
    'options' => [
        'cluster' => 'redis',
        'prefix'  => '',
    ],
    'default' => [
        'host'     => '127.0.0.1',
        'password' => null,
        'port'     => 6379,
        'database' => 0,
    ],

],
```

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

### Render a Hint Partial

Source: https://wintercms.com/docs/v1.2/docs/backend/views-partials

Create informative panels that users can hide. Pass a unique key to track visibility, or null to make the hint permanent.

```PHP
<?= $this->makeHintPartial('my_hint_key', 'my_hint_partial', ['foo' => 'bar']) ?>
```

```PHP
<?= $this->makeHintPartial(null, 'my_hint_partial') ?>
```

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

### Theme Preview Image Path

Source: https://wintercms.com/docs/v1.2/docs/themes/development

Place the theme-preview.png file in the assets/images directory.

```text
themes
`-- example-theme
    `-- assets
       `-- images
           `-- theme-preview.png    # Theme Preview Image
```

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

### Define Form Fields in YAML

Source: https://wintercms.com/docs/v1.2/docs/backend/import-export

Example structure for a fields.yaml file used in import/export forms.

```yaml
# ===================================
#  Form Field Definitions
# ===================================

fields:
    auto_create_lists:
        label: Automatically create lists
        type: checkbox
        default: true
```

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

### Generate Mix Configuration

Source: https://wintercms.com/docs/v1.2/docs/console/asset-compilation-mix

Use the mix:create command to generate a basic winter.mix.js configuration file for a package.

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

```bash
php artisan mix:create acme.example --tailwind
```

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

### Slice a collection

Source: https://wintercms.com/docs/v1.2/docs/services/collections

Returns a portion of the collection starting at a specific index, optionally limited by size.

```PHP
$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);

$slice = $collection->slice(4);

$slice->all();

// [5, 6, 7, 8, 9, 10]
```

```PHP
$slice = $collection->slice(4, 2);

$slice->all();

// [5, 6]
```

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

### Create a form widget

Source: https://wintercms.com/docs/v1.2/docs/console/scaffolding

Generates a backend form widget, view, and basic asset files.

```bash
php artisan create:formwidget <plugin code> <widget name>
```

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

### Define a toolbar partial

Source: https://wintercms.com/docs/v1.2/docs/backend/lists

Create a partial file to define the toolbar buttons, such as a link to a create action.

```php
<div data-control="toolbar">
    <a
        href="<?= Backend::url('acme/blog/posts/create') ?>"
        class="btn btn-primary wn-icon-plus">New Post</a>
</div>
```

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

### Get variables from EnvFile

Source: https://wintercms.com/docs/v1.2/docs/services/parser

Retrieve an associative array of current variables, excluding comments and empty lines.

```PHP
$envVariables = EnvFile::open()->set([
    'APP_NAME' => 'Winter CMS',
])->getVariables();

echo $envVariables['APP_NAME']; // echos "Winter CMS"
```

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

### Initialize Default Settings Values

Source: https://wintercms.com/docs/v1.2/docs/plugin/settings

Implement the initSettingsData method to define default values used when no database record exists.

```php
class Settings extends Model
{
    public function initSettingsData()
    {
        $this->files_per_post = 5;
        $this->file_extensions = 'jpg, jpeg, png, gif, webp';
    }
}
```

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

### Create a version-compatible BaseTestCase

Source: https://wintercms.com/docs/v1.2/docs/setup/upgrade-guide

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

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

class MyTestCase extends BaseTestCase
```

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

### Retrieve public directory path

Source: https://wintercms.com/docs/v1.2/docs/services/helpers

Use public_path to get the fully qualified path to the public directory.

```php
$path = public_path();
```

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

### Retrieve database directory path

Source: https://wintercms.com/docs/v1.2/docs/services/helpers

Use database_path to get the fully qualified path to the database directory.

```php
$path = database_path();
```

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

### Retrieve all rows from a table

Source: https://wintercms.com/docs/v1.2/docs/database/query

Use the table method on the Db facade to initiate a query and get all records.

```PHP
$users = Db::table('users')->get();
```

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

### Standard INI Depth Limitation

Source: https://wintercms.com/docs/v1.2/docs/services/parser

Example of the standard 3-level depth limitation in traditional INI parsing.

```INI
level1Value = "foo"
level1Array[] = "bar"

[level1Object]
level2Value = "hello"
level2Array[] = "world"
level2Object[level3Value] = "stop here"
```

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

### Render a View

Source: https://wintercms.com/docs/v1.2/docs/services/response-view

Use the View::make method to return a view to the browser with data.

```php
return View::make('acme.blog::greeting', ['name' => 'Charlie']);
```

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

### Mail View Without Plain Text

Source: https://wintercms.com/docs/v1.2/docs/services/mail

Example of a mail view containing only configuration and HTML markup.

```twig
subject = "Your product has been added to Winter CMS project"
==

<p>Hi {{ name }},</p>

<p>This email does not support plain text.</p>

<p>Sorry about that!</p>
```

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

### List registered Mix packages

Source: https://wintercms.com/docs/v1.2/docs/console/asset-compilation-mix

Displays all registered Mix packages, their directories, and configuration files.

```bash
php artisan mix:list [--json]
```

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

### response()

Source: https://wintercms.com/docs/v1.2/docs/services/helpers

Creates a response instance.

```APIDOC
## response(mixed $content, int $status, array $headers)

### Description
Creates a response instance or obtains an instance of the response factory.
```

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

### PHP Code Section with Tags

Source: https://wintercms.com/docs/v1.2/docs/cms/themes

Example of the PHP section using optional open and close tags.

```Twig
url = "/blog"
layout = "default"
==
<?
function onStart()
{
    $this['posts'] = ...;
}
?>
==
<h3>Blog archive</h3>
{% for post in posts %}
    <h4>{{ post.title }}</h4>
    {{ post.content }}
{% endfor %}
```

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

### Register a new administrator

Source: https://wintercms.com/docs/v1.2/docs/backend/users

Use the register method to create a new backend user account.

```php
$user = BackendAuth::register([
    'first_name' => 'Some',
    'last_name' => 'User',
    'login' => 'someuser',
    'email' => 'some@website.tld',
    'password' => 'changeme',
    'password_confirmation' => 'changeme'
]);
```

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

### Subscribe to events with different handlers

Source: https://wintercms.com/docs/v1.2/docs/events/introduction

Demonstrates various ways to define event listeners, including simple names, closures with arguments, and callable objects.

```PHP
Event::listen('acme.blog.myevent', ...);
```

```PHP
Event::listen('acme.blog.myevent', function ($arg1, $arg2) {
    // Do something
});
```

```PHP
Event::listen('auth.login', [$this, 'LoginHandler']);
```

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

### Configure Create Page

Source: https://wintercms.com/docs/v1.2/docs/backend/forms

Define redirection and flash message settings for the Create page within the YAML configuration.

```yaml
create:
    title: New Blog Post
    redirect: acme/blog/posts/update/:id
    redirectClose: acme/blog/posts
    flashSave: Post has been created!
```

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

### Initialize configuration in Snowboard plugin

Source: https://wintercms.com/docs/v1.2/docs/snowboard/extras

Use the snowboard.dataConfig method to extract and initialize configuration values from the element's data attributes.

```javascript
class Gallery extends Snowboard.PluginBase {

    constructor(snowboard, element) {
        super(snowboard);
        this.element = element;

        // Initialise the configuration, and make it available in the plugin as "this.config"
        this.config = this.snowboard.dataConfig(this, element);

        this.createGallery();
    }

    defaults() {
        return {
            numImages: 5,
            showCaption: false,
        };
    }

    createGallery() {
        const numImages = this.config.get('numImages'); // Will return 3 since the attribute has been set by the default value defined in the PHP component class
        const showCaption = this.config.get('showCaption'); // Will be true, since the attribute has been set by the default value defined in the PHP component class
    }
}
```

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

### Take items from collection

Source: https://wintercms.com/docs/v1.2/docs/services/collections

Returns a new collection containing a specified number of items from the start or end.

```PHP
$collection = new Collection([0, 1, 2, 3, 4, 5]);

$chunk = $collection->take(3);

$chunk->all();

// [0, 1, 2]
```

```PHP
$collection = new Collection([0, 1, 2, 3, 4, 5]);

$chunk = $collection->take(-2);

$chunk->all();

// [4, 5]
```

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

### Configure environment file

Source: https://wintercms.com/docs/v1.2/docs/console/setup-maintenance

Generates a .env file and updates configuration files to use environment variables. Recommended for secure deployment workflows.

```bash
php artisan winter:env
```
Tokens:
Raw