TastyIgniter

https://tastyigniter.com/docs
Admin
TastyIgniter is an open-source online ordering and restaurant management platform built on Laravel...
Tokens:96,721
Snippets:1,447
Trust Score:9.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Run Installation Command

Source: https://tastyigniter.com/docs/upgrade-guide

Execute the installation command within the new directory to finalize setup and database migration.

```bash
cd mytasty-new
php artisan igniter:install
```

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

### Install Frontend Extension

Source: https://tastyigniter.com/docs/extensions/frontend

Use Composer to install the extension and run migrations to set up the database.

```bash
composer require tastyigniter/ti-ext-frontend -W
```

```bash
php artisan igniter:up
```

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

### Swap Installation Directories

Source: https://tastyigniter.com/docs/upgrade-guide

Replace the old installation directory with the newly upgraded one.

```bash
cd ..
mv mytasty mytasty-old
mv mytasty-new mytasty
```

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

### Retrieve menu items via API

Source: https://tastyigniter.com/docs/extensions/api

Example of a GET request to fetch all menu items from the API.

```bash
curl -X GET https://your-tastyigniter-site.com/api/menus
```

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

### Run TastyIgniter setup

Source: https://tastyigniter.com/docs/installation

Executes the interactive setup wizard to configure the database and administrator account.

```bash
php artisan igniter:install
```

```bash
php artisan igniter:install --no-interaction
```

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

### Install SchedulePro Extension

Source: https://tastyigniter.com/docs/extensions/schedulepro

Run this command in your terminal to install the extension via Composer.

```bash
composer require igniterlabs/ti-ext-schedulepro -W
```

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

### Install and Migrate Coupons Extension

Source: https://tastyigniter.com/docs/extensions/coupons

Use Composer to install the package and Artisan to run the necessary database migrations.

```bash
composer require tastyigniter/ti-ext-coupons -W
```

```bash
php artisan igniter:up
```

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

### Install Shipday Extension

Source: https://tastyigniter.com/docs/extensions/shipday

Use Composer to install the Shipday extension package.

```bash
composer require igniterlabs/ti-ext-shipday -W
```

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

### Install Extension via Composer

Source: https://tastyigniter.com/docs/extensions/docketprint

Run this command to install the DocketPrint extension package.

```bash
composer require igniterlabs/ti-ext-docketprint -W

```

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

### Install Import/Export Extension

Source: https://tastyigniter.com/docs/extensions/importexport

Use Composer to add the extension to your project.

```bash
composer require igniterlabs/ti-ext-importexport -W
```

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

### Install Extension via Composer

Source: https://tastyigniter.com/docs/extensions/multivendor

Execute the composer command to download and install the Multi Vendor extension package.

```bash
composer require igniterlabs/ti-ext-multivendor -W
```

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

### Install Group Order via Composer

Source: https://tastyigniter.com/docs/extensions/grouporder

Use this command to install the extension package in your project.

```bash
composer require igniterlabs/ti-ext-grouporder -W
```

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

### Install SEO Manager Extension

Source: https://tastyigniter.com/docs/extensions/seomanager

Run this command in your terminal to install the extension via Composer.

```bash
composer require igniterlabs/ti-ext-seomanager -W

```

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

### Install Extension via Composer

Source: https://tastyigniter.com/docs/extensions/loyaltypoints

Execute the composer command to download the loyalty points extension.

```bash
composer require igniterlabs/ti-ext-loyaltypoints -W
```

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

### Install TastyIgniter 4.0

Source: https://tastyigniter.com/docs/upgrade-guide

Create a new project instance using Composer.

```bash
composer create-project tastyigniter/tastyigniter mytasty-new
```

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

### Install Postmark dependencies

Source: https://tastyigniter.com/docs/advanced/mail

Install the required Symfony packages for the Postmark driver via Composer.

```bash
composer require symfony/postmark-mailer symfony/http-client
```

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

### Migrate Configuration

Source: https://tastyigniter.com/docs/upgrade-guide

Copy the environment configuration from the old installation to the new one.

```bash
cp mytasty/.env mytasty-new/
```

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

### Configure Authentication Credentials

Source: https://tastyigniter.com/docs/extensions/seomanager

Create an auth.json file to provide your Marketplace credentials for package installation.

```json
{
    "http-basic": {
        "composer.tastyigniter.com": {
            "username": "your-tastyigniter-account-email-address",
            "password": "your-tastyigniter-site-carte-key"
        }
    }
}

```

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

### Install Extension via Composer

Source: https://tastyigniter.com/docs/extensions/stripeconnect

Execute the composer command to download the Stripe Connect extension.

```bash
composer require igniterlabs/ti-ext-stripeconnect -W
```

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

### Install Debugbar via Composer

Source: https://tastyigniter.com/docs/extensions/debugbar

Run this command in your terminal to install the extension package.

```bash
composer require tastyigniter/ti-ext-debugbar -W
```

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

### Install Laravel Sanctum

Source: https://tastyigniter.com/docs/extensions/api

Use the Artisan command to set up database tables and the personal access client.

```bash
php artisan install:api
```

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

### Front-matter Section Example

Source: https://tastyigniter.com/docs/customize/themes

Basic YAML configuration used at the top of template files.

```yaml

---

title: Homepage
permalink: /
layout: default

'[helloBlock]':
    maxItems: 1

---

```

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

### Install AWS S3 dependencies

Source: https://tastyigniter.com/docs/customize/media-manager

Use Composer to install the necessary Flysystem adapter for Amazon S3 storage.

```bash
composer require league/flysystem-aws-s3-v3 "^3.0" --with-all-dependencies
```

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

### Install Kitchen Display Extension

Source: https://tastyigniter.com/docs/extensions/kitchendisplay

Use Composer to add the extension to your TastyIgniter project.

```bash
composer require igniterlabs/ti-ext-kitchendisplay -W
```

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

### Install Amazon SES dependencies

Source: https://tastyigniter.com/docs/advanced/mail

Install the AWS SDK for PHP to enable the Amazon SES mail driver.

```bash
composer require aws/aws-sdk-php
```

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

### Install Visitor Tracker Extension

Source: https://tastyigniter.com/docs/extensions/visitortracker

Use Composer to install the extension package into your TastyIgniter project.

```bash
composer require igniterlabs/ti-ext-visitortracker -W
```

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

### Install Pages Extension

Source: https://tastyigniter.com/docs/extensions/pages

Use Composer to add the Pages extension to your project.

```bash
composer require tastyigniter/ti-ext-pages -W
```

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

### Install and update dependencies

Source: https://tastyigniter.com/docs/contribution-guide

Commands to install project dependencies and clone TastyIgniter packages into the vendor directory for development.

```bash
composer install
```

```bash
composer update "tastyigniter/*" --prefer-source
```

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

### Install Language Pack via CLI

Source: https://tastyigniter.com/docs/advanced/localization

Use the Artisan command to install a language pack from the community translation project.

```bash
php artisan igniter:language-install es
```

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

### Install Uber Direct Extension

Source: https://tastyigniter.com/docs/extensions/uberdirect

Use Composer to install the extension package into your TastyIgniter project.

```bash
composer require igniterlabs/ti-ext-uberdirect -W
```

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

### Install Gift Up! extension via Composer

Source: https://tastyigniter.com/docs/extensions/giftup

Use this command to install the extension package into your TastyIgniter project.

```bash
composer require igniterlabs/ti-ext-giftup -W
```

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

### PHP Code Section Example

Source: https://tastyigniter.com/docs/customize/themes

Demonstrates defining logic within the PHP section of a template.

```php

---

<?php

function onStart() {
    $this['categories'] = ['Appetizer', 'Main Course', 'Dessert'];
}

?>

---

<h3>Categories</h3>
<ul>
    @foreach ($categories as $category) {
        <li>{{ $category }}</li>
    @endforeach
</ul>
```

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

### Install API extension via Composer

Source: https://tastyigniter.com/docs/extensions/api

Run this command in your terminal to add the API extension to your project.

```bash
composer require tastyigniter/ti-ext-api -W
```

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

### Controller Directory Structure

Source: https://tastyigniter.com/docs/extend/controllers

Example of the expected file structure for a controller and its associated views within an extension.

```text
author/
  extension/
    src/
      Http/
        Controllers/
          MyController.php          <=== Controller class
    resources/
      views/
        mycontroller/               <=== Controller view directory
          edit.blade.php            <=== Controller view file
```

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

### Define list columns in a definition file

Source: https://tastyigniter.com/docs/extend/lists

Example of a list controller configuration within a definition file.

```php
return [
    'list' => [
        'columns' => [
            'name' => [
                'label' => 'Name',
                'searchable' => true,
            ],
            'email' => [
                'label' => 'Email',
                'searchable' => true,
            ],
        ],
    ],
];
```

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

### Start a group order

Source: https://tastyigniter.com/docs/extensions/grouporder

Initiate a new group order by providing customer and location details.

```php
use IgniterLabs\GroupOrder\Actions\StartGroupOrder;
use IgniterLabs\GroupOrder\Models\GroupOrder;

$groupOrder = resolve(StartGroupOrder::class)->handle($customer, $location, [
    'split_bill' => true, // or false
    'spending_limit' => 20, // Optional, only used if split_bill is true
]);
```

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

### Install Translate Extension

Source: https://tastyigniter.com/docs/extensions/translate

Use Composer to add the extension to your TastyIgniter project.

```bash
composer require tastyigniter/ti-ext-translate -W
```

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

### Install Local Extension

Source: https://tastyigniter.com/docs/extensions/local

Use Composer to add the local extension to your TastyIgniter project.

```bash
composer require tastyigniter/ti-ext-local -W
```

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

### Configure Page Permalinks

Source: https://tastyigniter.com/docs/customize/pages

Examples of setting page URLs using the permalink variable in front matter.

```yaml
permalink: "/about"
```

```yaml
permalink: "/pages/:title" - this will match /pages/page-title
```

```yaml
permalink: "/pages/:title?" - this will match /pages/page-title OR /pages
```

```yaml
permalink: "/pages/:title?/:slug" - this will match /pages/page-title/page-slug
```

```yaml
permalink: "/pages/:title?default" - this will match /pages/page-title OR /pages/default
```

```yaml
permalink: "/pages/:title|^[a-z0-9\-]+$" - this will match /pages/page-title
```

```yaml
permalink: "/pages/:title*/:slug" - this will match /pages/page-title/child/page/page-slug
```

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

### Install TastyIgniter as a Laravel package

Source: https://tastyigniter.com/docs/installation

Adds the TastyIgniter core package to an existing Laravel application.

```bash
composer require tastyigniter/core
```

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

### Define Naming Conventions

Source: https://tastyigniter.com/docs/resources/php-coding-guidelines

Examples of naming conventions for various components including controllers, models, and methods.

```text
ArticlesController
```

```text
ArticleController
```

```text
articles/1
```

```text
article/1
```

```text
User
```

```text
Users
```

```text
article_comments
```

```text
article_comment, articleComments
```

```text
article_user
```

```text
articles_users
```

```text
meta_title
```

```text
MetaTitle, article_meta_title
```

```text
article_id
```

```text
ArticleId, id_article, articles_id
```

```text
id
```

```text
custom_id
```

```text
2017_01_01_000000_create_articles_table
```

```text
2017_01_01_000000_articles
```

```text
getAll
```

```text
get_all
```

```text
abort_if
```

```text
abortIf
```

```text
testGuestCannotSeeArticle
```

```text
test_guest_cannot_see_article
```

```text
$model->model_property
```

```text
$model->modelProperty
```

```text
$anyOtherVariable
```

```text
$any_other_variable
```

```php
$activeUsers = User::active()->get()
```

```text
$active, $data
```

```php
$activeUser = User::active()->first()
```

```text
$users, $obj
```

```text
articles_enabled
```

```text
ArticlesEnabled, articles-enabled
```

```text
show-filtered.blade.php
```

```text
showFiltered.blade.php, show_filtered.blade.php
```

```text
google-calendar.php
```

```text
googleCalendar.php, google_calendar.php
```

```text
Authenticatable
```

```text
AuthenticationInterface, IAuthentication
```

```text
Notifiable
```

```text
NotificationTrait
```

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

### Migrate Media Assets

Source: https://tastyigniter.com/docs/upgrade-guide

Move or copy media assets to the storage directory of the new installation.

```bash
cp assets/media storage/
```

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

### GET /api/loyalty/{id}

Source: https://tastyigniter.com/docs/extensions/loyaltypoints

Get a specific loyalty history record by its ID.

```APIDOC
## GET /api/loyalty/{id}

### Description
Get a specific loyalty history record by its ID.

### Method
GET

### Endpoint
/api/loyalty/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the history record.
```

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

### Translatable Form Widgets

Source: https://tastyigniter.com/docs/extensions/translate

Configuration examples for various form widgets that support multi-locale input.

```php
'my_field' => [
    'label' => 'Name',
    'type' => 'trltext',
],
```

```php
'my_field' => [
    'label' => 'Description',
    'type' => 'trltextarea',
],
```

```php
'my_field' => [
    'label' => 'Content',
    'type' => 'trlricheditor',
],
```

```php
'my_field' => [
    'label' => 'Content',
    'type' => 'trlmarkdowneditor',
],
```

```php
'my_field' => [
    'label' => 'Items',
    'type' => 'trlrepeater',
],
```

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

### Define List Configuration File

Source: https://tastyigniter.com/docs/extend/lists

Create a file in the resources/models directory that returns an array containing toolbar, filter, and column definitions.

```php
return [
    'list' => [
        'toolbar' => [
            'buttons' => [
                // ...
            ],
        ],
        'filter' => [
            'search' => [
                'prompt' => 'Search records',
                'mode' => 'all',
            ],
            'scopes' => [
                // ...
            ],
        ],
        'columns' => [
            // ...
        ],
    ],
    // ...
];
```

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

### Install User extension via Composer

Source: https://tastyigniter.com/docs/extensions/user

Use this command to add the User extension to your project dependencies.

```bash
composer require tastyigniter/ti-ext-user -W
```

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

### Layout Template Structure

Source: https://tastyigniter.com/docs/customize/themes

Example of a layout template file defining the base HTML structure for pages.

```html

---

description: Default Layout

---

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{{ $this->page->title }}</title>
    @themeStyles
</head>
<body>
    @themePage
    @themeScripts
</body>
</html>
```

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

### Install Webhook Extension

Source: https://tastyigniter.com/docs/extensions/webhook

Use Composer to install the webhook extension package into your TastyIgniter project.

```bash
composer require igniterlabs/ti-ext-webhook -W
```

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

### Configure RewriteBase for Subdirectory Installs

Source: https://tastyigniter.com/docs/installation

Uncomment and set this directive in the public/.htaccess file when hosting the application in a subdirectory.

```apache
RewriteBase /subdirectory/
```

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

### Define Controller Action URL

Source: https://tastyigniter.com/docs/extend/controllers

Example URL structure for accessing a specific controller action within an extension.

```text
http://site.com/admin/author/extension/mycontroller/index
```

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

### Read from Settings Model

Source: https://tastyigniter.com/docs/extend/extensions

Use the get method to retrieve settings values, optionally providing a default.

```php
use Acme\HelloWorld\Models\Settings;

// Get a single value
$cartKey = Settings::get('cart_key');

// Get a value and return a default value if it doesn't exist
$abandonedCart = Settings::get('abandoned_cart', true);
```

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

### Hooking a PayRegister event

Source: https://tastyigniter.com/docs/extensions/payregister

Use the boot method of an extension class to listen for specific payment gateway events.

```php
use Illuminate\Support\Facades\Event;

public function boot()
{
    Event::listen('payregister.authorizenetaim.extendGateway', function ($gateway, $client) {
        // Do something...
    });
}
```

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

### Add Start Group Order Button

Source: https://tastyigniter.com/docs/extensions/grouporder

Insert this Livewire component into your menu page markup to display the group order initiation button.

```html
<div class="d-flex justify-content-end mt-3">
    <livewire:igniterlabs.grouporder::start-group-order/>
</div>
```

```html
<div class="col-lg-4 mt-4 mt-lg-0">
    <div class="d-flex justify-content-end">
        <div class="local-control p-3 border rounded">
            <div class="d-inline-block w-100 fw-bold text-sm-left text-md-center">
                <x-igniter-orange::fulfillment/>
            </div>
        </div>
    </div>
    <div class="d-flex justify-content-end mt-3">
        <livewire:igniterlabs.grouporder::start-group-order/>
    </div>
</div>
```

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

### Page Template Structure

Source: https://tastyigniter.com/docs/customize/themes

Example of a page template file containing front-matter, PHP, and HTML sections.

```php

---

title: Homepage
permalink: /
layout: default

'[helloBlock]':
    maxItems: 1

---

<?php
function onStart()
{
    //...
}
?>

---

<div>
    <p>Rendering a Theme component</p>
    @themeComponent('helloBlock')
    
    <p>Rendering a Livewire component</p>
    <livewire:hello-block />
    
    <p>Rendering sub views</p>
    @include('acme-purple::includes.sidebar')
</div>
```

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

### Install Mailgun dependencies

Source: https://tastyigniter.com/docs/advanced/mail

Install the required Symfony packages for the Mailgun driver via Composer.

```bash
composer require symfony/mailgun-mailer symfony/http-client
```

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

### Define File-based Configuration

Source: https://tastyigniter.com/docs/extend/extensions

Create a standard PHP configuration file returning an array of settings.

```php
<?php

return [
    'destroyOnLogout' => true,
    'cartSessionTtl' => 120
];
```

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

### Registering a Theme Page Menu Item Type

Source: https://tastyigniter.com/docs/extensions/pages

Example of registering a theme page menu item type and handling its resolution using event listeners.

```php
Event::listen('pages.menuitem.listTypes', function () {
    return [
        'theme-page' => 'igniter::main.pages.text_theme_page',
    ];
});

Event::listen('pages.menuitem.getTypeInfo', function ($type) {
    return Page::getMenuTypeInfo((string)$type);
});

Event::listen('pages.menuitem.resolveItem', function ($item, $url, $theme) {
    if ($item->type == 'theme-page' && $theme) {
        return Page::resolveMenuItem($item, $url, $theme);
    }
});
```

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

### Run database migrations

Source: https://tastyigniter.com/docs/extensions/api

Execute migrations to create the necessary tables for the API extension.

```bash
php artisan igniter:up
```

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

### Injecting Assets in Layouts

Source: https://tastyigniter.com/docs/customize/layouts

Use the onStart function within a layout's PHP section to register CSS and JavaScript files.

```php
<?php
function onStart()
{
    $this->addCss('assets/css/my-style.css');
    $this->addJs('assets/js/my-script.js');
}
```

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

### Create a new TastyIgniter project

Source: https://tastyigniter.com/docs/installation

Initializes a new stand-alone TastyIgniter project using Composer.

```bash
composer create-project tastyigniter/tastyigniter tastyigniter
```

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

### Final Language Installation Directory Structure

Source: https://tastyigniter.com/docs/advanced/localization

The required directory structure within the TastyIgniter installation for custom language files.

```text
lang/
  vendor/
    igniter/
      es_ES/                       <=== Language directory
        admin.php
        main.php
        system.php
```

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

### Generate IDE Helper Files

Source: https://tastyigniter.com/docs/extensions/debugbar

Execute this artisan command to improve IDE code completion and navigation.

```bash
php artisan ide-helper:generate
```

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

### Publish configuration file

Source: https://tastyigniter.com/docs/customize/media-manager

Run this artisan command to copy the default configuration to your local config directory for customization.

```bash
php artisan vendor:publish --tag="igniter-config"
```

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

### GET /api/loyalty/:id

Source: https://tastyigniter.com/docs/extensions/loyaltypoints

Retrieves a single loyalty history record by its ID.

```APIDOC
## GET /api/loyalty/:id

### Description
Retrieves a single loyalty history record. Requires the `loyalty:*` ability.

### Method
GET

### Endpoint
/api/loyalty/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the loyalty history record.

#### Query Parameters
- **include** (string) - Optional - What relations to include. Options: `customer`, `order`, `location`. Separate multiple with comma (e.g. `?include=customer,order`).

### Response
#### Success Response (200)
- **data** (object) - The loyalty history record object.

#### Response Example
{
    "data": {
        "type": "loyaltyhistory",
        "id": "1",
        "attributes": {
            "order_id": 104,
            "type": "order",
            "customer_id": 4,
            "location_id": null,
            "order_total": 199,
            "points_earned": 39,
            "points_used": 0,
            "date_used": "2026-01-08T08:16:50.000000Z",
            "valid_from": "2026-01-08T08:16:50.000000Z",
            "valid_to": "2027-01-08T08:16:50.000000Z",
            "status": true,
            "created_at": "2026-01-08T08:16:50.000000Z",
            "updated_at": "2026-01-08T08:16:50.000000Z",
            "customer_name": "John Doe",
            "available_points": 39,
            "date_used_formatted": "Jan 08, 2026",
            "points_earned_formatted": "39 ($0.39)",
            "points_used_formatted": "-",
            "order_total_formatted": "$199.00",
            "status_formatted": "Enabled",
            "type_formatted": "Order Earned",
            "points_value": 0.39
        },
        "relationships": {
            "customer": {
                "data": []
            },
            "order": {
                "data": []
            },
            "location": {
                "data": []
            }
        }
    },
    "included": []
}
```

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

### Install Cart Extension

Source: https://tastyigniter.com/docs/extensions/cart

Use Composer to add the Cart extension to your TastyIgniter project.

```bash
composer require tastyigniter/ti-ext-cart -W
```

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

### Define layout lifecycle functions

Source: https://tastyigniter.com/docs/customize/layouts

Use the onStart function within the PHP section of a layout to initialize variables for use in the template.

```php
---
name: My First Layout
description: My first layout example

---

<?php
function onStart()
{
    $this['hello'] = "Hello world!";
}
?>

---

<h3>{{ $this->layout->hello }}</h3>
```

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

### LoginCustomer::handle()

Source: https://tastyigniter.com/docs/extensions/user

Authenticates a customer using the LoginCustomer action class.

```APIDOC
## LoginCustomer::handle()

### Description
Authenticates a customer using provided credentials. This process dispatches `igniter.user.beforeAuthenticate` and `igniter.user.login` events.

### Usage
```php
use Igniter\User\Actions\LoginCustomer;

$credentials = [
    'email' => 'email@domain.tld',
    'password' => 'password',
];

$loginCustomer = new LoginCustomer($credentials, $remember);
$loginCustomer->handle();
```
```

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

### Install Orange Theme

Source: https://tastyigniter.com/docs/themes/igniter-orange

Use Composer to add the Orange theme to your TastyIgniter project.

```bash
composer require tastyigniter/ti-theme-orange -W
```

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

### Install Reservation Extension

Source: https://tastyigniter.com/docs/extensions/reservation

Use Composer to add the reservation extension to your TastyIgniter project.

```bash
composer require tastyigniter/ti-ext-reservation -W
```

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

### Install Reports Extension

Source: https://tastyigniter.com/docs/extensions/reports

Use Composer to add the reports extension to your TastyIgniter project.

```bash
composer require igniterlabs/ti-ext-reports -W
```

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

### Use concise syntax for requests and sessions

Source: https://tastyigniter.com/docs/resources/php-coding-guidelines

Prefer shorter helper functions over verbose facade or request methods for improved readability.

```php
session('cart');
$request->name;
```

```php
$request->session()->get('cart');
$request->input('name');
```

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

### Install Automation Extension

Source: https://tastyigniter.com/docs/extensions/automation

Use Composer to add the automation extension to your TastyIgniter project.

```bash
composer require tastyigniter/ti-ext-automation -W
```

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

### Define Import Configuration

Source: https://tastyigniter.com/docs/extensions/importexport

Create a configuration file to define import columns and user-configurable fields.

```php
return [
    'columns' => [
        'id' => 'ID',
        'name' => 'Name',
        'description' => 'Description',
    ],
    'fields' => [
        'update_existing' => [
            'label' => 'Update existing items',
            'type' => 'switch',
            'default' => true,
        ],
    ],
];
```

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

### Install Broadcast Extension

Source: https://tastyigniter.com/docs/extensions/broadcast

Use Composer to add the broadcast extension to your TastyIgniter project.

```bash
composer require tastyigniter/ti-ext-broadcast -W
```

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

### Retrieve cart totals and conditions

Source: https://tastyigniter.com/docs/extensions/cart

Get subtotal, total, or applied conditions from the cart.

```php
use Igniter\Cart\Facades\Cart;

$subtotal = Cart::subtotal();
```

```php
use Igniter\Cart\Facades\Cart;

$total = Cart::total();
```

```php
use Igniter\Cart\Facades\Cart;

$conditions = Cart::conditions();
```

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

### GET /api/loyalty

Source: https://tastyigniter.com/docs/extensions/loyaltypoints

Retrieves a list of loyalty history records. Customers see only their own records.

```APIDOC
## GET /api/loyalty

### Description
Retrieves a list of loyalty history records. Customers see only their own records.

### Method
GET

### Endpoint
/api/loyalty

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number.
- **pageLimit** (integer) - Optional - The number of items per page (default: 20).
- **customer** (integer) - Optional - Filter by customer ID (admin only).
- **location** (integer) - Optional - Filter by location ID.
- **type** (string) - Optional - Filter by type. Options: order, review, registration.
- **enabled** (boolean) - Optional - Filter by status. Default: true.
- **valid** (boolean) - Optional - If true, only return non-expired points within their validity period.
- **include** (string) - Optional - What relations to include. Options: customer, order, location. Separate multiple with comma.

### Response
#### Success Response (200)
- **data** (array) - List of loyalty history objects.
- **meta** (object) - Pagination metadata.

#### Response Example
{
    "data": [
        {
            "type": "loyaltyhistory",
            "id": "1",
            "attributes": {
                "order_id": 104,
                "type": "order",
                "customer_id": 4,
                "location_id": null,
                "order_total": 199,
                "points_earned": 39,
                "points_used": 0,
                "date_used": "2026-01-08T08:16:50.000000Z",
                "valid_from": "2026-01-08T08:16:50.000000Z",
                "valid_to": "2027-01-08T08:16:50.000000Z",
                "status": true,
                "created_at": "2026-01-08T08:16:50.000000Z",
                "updated_at": "2026-01-08T08:16:50.000000Z",
                "customer_name": "John Doe",
                "available_points": 39,
                "date_used_formatted": "Jan 08, 2026",
                "points_earned_formatted": "39 ($0.39)",
                "points_used_formatted": "-",
                "order_total_formatted": "$199.00",
                "status_formatted": "Enabled",
                "type_formatted": "Order Earned",
                "points_value": 0.39
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 20,
            "current_page": 1,
            "total_pages": 1
        }
    }
}
```

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

### Define Configuration File Naming

Source: https://tastyigniter.com/docs/resources/php-coding-guidelines

Configuration files must follow kebab-case naming conventions.

```text
config/
pdf-generator.php
```

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

### Get settings with location override

Source: https://tastyigniter.com/docs/extensions/loyaltypoints

Access loyalty settings while checking for location-specific overrides.

```php
use Igniter\Local\Models\Location;
use IgniterLabs\LoyaltyPoints\Classes\LoyaltyManager;

$location = Location::find(1);
$loyaltyManager = resolve(LoyaltyManager::class);

// Get a setting, checking location override first
$value = $loyaltyManager->getSetting('spending_minimum', 1, $location);

// Check if location has overrides enabled
$hasOverride = $loyaltyManager->hasLocationOverride($location);
```

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

### Register a customer

Source: https://tastyigniter.com/docs/extensions/user

Uses the CustomerRegister action class to create a customer and handle post-registration notifications based on activation status.

```php
use Igniter\User\Actions\CustomerRegister;

$customerData = [
    'first_name' => 'John',
    'last_name' => 'Doe',
    'email' => 'email@domain.tld',
    'password' => 'password',
];

$registerCustomer = new CustomerRegister();
$customer = $registerCustomer->handle($customerData);

if ($customer->is_activated) {
    // Registration successful
    $customer->mailSendRegistered(['account_login_link' => page_url('account.login')]);
} else {
    // Registration requires email verification
    $customer->mailSendEmailVerification([
        'account_activation_link' => page_url('account.register').'?code='.$customer->getActivationCode(),
    ]);
}
```

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

### Render Email Confirmation Form

Source: https://tastyigniter.com/docs/extensions/socialite

Example Blade template for the email confirmation form.

```html
<form method="post" wire:submit="onConfirmEmail">
    @csrf
    <input type="email" name="email" required>
    <button type="submit">Confirm Email</button>
</form>
```

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

### Implement clean method signatures

Source: https://tastyigniter.com/docs/resources/php-coding-guidelines

Avoid redundant docblocks when full type hinting is available.

```php
class Foo
{
    public static function fromString(string $bar): Foo
    {
        // ...
    }
}
```

```php
// Bad: The description is redundant, and the method is fully type-hinted.
class Foo
{
    /**
     * Create a url from a string.
     *
     * @param string $bar
     *
     * @return \Igniter\Flame\Foo
     */
    public static function fromString(string $bar): Foo
    {
        // ...
    }
}
```

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

### Component Lifecycle Hook

Source: https://tastyigniter.com/docs/extend/components

Example of injecting variables into the page using the onRun method.

```php
public function onRun()
{
    $this->page['var'] = 'value';
}
```

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

### Publish Theme Files

Source: https://tastyigniter.com/docs/extensions/grouporder

Use this command to copy the extension's theme files into your active theme directory.

```bash
php artisan igniter:theme-publish
```

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

### Create a Complete Page Template

Source: https://tastyigniter.com/docs/customize/pages

Demonstrates the structure of a page file containing front matter, an optional PHP onStart function, and HTML content.

```blade
---

title: My Home Page
description: "My home page example"
permalink: "/"
layout: default

---

<?php
function onStart()
{
    $this['hello'] = "Hello world!";
}
?>

---

<p>{{ $hello }}, this is the content of my page</p>
```

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

### Register global parameters for automation

Source: https://tastyigniter.com/docs/extensions/automation

Register global parameters within the boot method of the extension class to make them accessible to all automation rules.

```php
use Igniter\User\Facades\Auth;
use Igniter\Automation\Classes\EventManager;

public function boot()
{
    resolve(EventManager::class)->registerGlobalParams([
        'customer' => Auth::customer()
    ]);
}
```

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

### Install Socialite via Composer

Source: https://tastyigniter.com/docs/extensions/socialite

Use this command to add the Socialite extension to your TastyIgniter project.

```bash
composer require tastyigniter/ti-ext-socialite -W
```

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

### Generate extension directory

Source: https://tastyigniter.com/docs/extend/extensions

Run this command from the application root to scaffold the necessary files and directory structure for a new extension.

```bash
php artisan make:igniter-extension Acme.HelloWorld
```

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

### Configure S3 storage in .env

Source: https://tastyigniter.com/docs/customize/media-manager

Set the required environment variables to connect the Media Manager to an S3 bucket.

```text
FILESYSTEM_DISK=s3
AWS_ACCESS_KEY_ID=<your-key-id>
AWS_SECRET_ACCESS_KEY=<your-secret-access-key>
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=<your-bucket-name>
AWS_USE_PATH_STYLE_ENDPOINT=false
```

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

### Hook Coupon Events

Source: https://tastyigniter.com/docs/extensions/coupons

Listen for coupon-related events within the boot method of an extension class.

```php
use Illuminate\Support\Facades\Event;

public function boot()
{
    Event::listen('igniter.cart.beforeApplyCoupon', function ($code) {
        // ...
    });
}
```

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

### GET /api/loyalty

Source: https://tastyigniter.com/docs/extensions/loyaltypoints

List loyalty history. Customers see their own history, while admins can see all records.

```APIDOC
## GET /api/loyalty

### Description
List loyalty history. Customers see their own history, while admins can see all records.

### Method
GET

### Endpoint
/api/loyalty
```

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

### Create a Widget Class

Source: https://tastyigniter.com/docs/extend/widgets

Extend BaseWidget to define widget behavior and render partials.

```php
namespace Author\Extension\Widgets;

class MyWidget extends \Igniter\Admin\Classes\BaseWidget
{
    public string $defaultAlias = 'mywidget';

    public function render()
    {
        $this->vars['var'] = 'value';
        
        return $this->makePartial('mywidget');
    }
}
```

```php
return $this->makePartial('mywidget', ['var' => 'value']);
```

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

### Define Component Class

Source: https://tastyigniter.com/docs/extend/components

Example of a component class extending BaseComponent with defined properties and methods.

```php
namespace Acme\HelloWorld\Components;

class HelloBlock extends \Igniter\System\Classes\BaseComponent
{
    public function defineProperties(): array
    {
        return [];
    }
    
    public function alerts(): array
    {
        return ['Success Alert', 'Warning Alert', 'Danger Alert'];
    }
}
```

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

### Create database seeder for extension

Source: https://tastyigniter.com/docs/extend/extensions

Implement a seeder class in the extension's database/seeds directory to populate tables with initial data.

```php
namespace Acme\HelloWorld\Database\Seeds;

use Illuminate\Database\Seeder;

class MessagesTableSeeder extends Seeder
{
    public function run()
    {
        DB::table('acme_helloworld_messages')->insert([
            'subject' => 'Hello World',
            'message' => 'Welcome to the world of TastyIgniter!',
        ]);
    }
}
```

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

### Activate a theme via CLI

Source: https://tastyigniter.com/docs/customize/themes

Use the artisan command to set the active theme from the terminal.

```bash
php artisan igniter:util set theme --theme=your-theme
```

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

### Use fully qualified class names for Facades

Source: https://tastyigniter.com/docs/resources/php-coding-guidelines

Always import the full namespace for facades to ensure clarity.

```php
use Illuminate	Support	Facades	Config;
```

```php
use Config;
```

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

### Authenticate a customer

Source: https://tastyigniter.com/docs/extensions/user

Use the LoginCustomer action class to authenticate a customer with credentials.

```php
use Igniter\User\Actions\LoginCustomer;

$credentials = [
    'email' => 'email@domain.tld',
    'password' => 'password',
];

$loginCustomer = new LoginCustomer($credentials, $remember);

$loginCustomer->handle();
```

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

### Language Pack Directory Structure

Source: https://tastyigniter.com/docs/advanced/localization

The expected folder and file structure for a downloaded language pack before installation.

```text
tastyigniter/
  v4-admin/
    es/
      4.x/
        admin.php
  v4-main/
    es/
      4.x/
      main.php
  v4-system/
    es/
      4.x/
      system.php
```

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

### Implement defineProperties Method

Source: https://tastyigniter.com/docs/extend/components

Define component properties for the admin interface by returning an array of configuration settings.

```php
public function defineProperties(): array
{
    return [
        'maxItems' => [
            'label' => 'Max items',
            'type' => 'number',
        ]
    ];
}
```

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

### Create database migration for extension

Source: https://tastyigniter.com/docs/extend/extensions

Define a migration class in the extension's database/migrations directory to manage table schema.

```php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up()
    {
        Schema::create('acme_helloworld_messages', function (Blueprint $table) {
            $table->increments('id');
            $table->string('subject');
            $table->text('message');
            $table->timestamps();
        });
    }

    public function down()
    {
        Schema::dropIfExists('acme_helloworld_messages');
    }
};
```

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

### List loyalty history endpoint

Source: https://tastyigniter.com/docs/extensions/loyaltypoints

Retrieves a list of loyalty history records via a GET request.

```http
GET /api/loyalty
```

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

### Configure multiple instances in front-matter

Source: https://tastyigniter.com/docs/extend/components

Define separate configurations for multiple component instances using unique aliases in the front-matter.

```yaml
---

title: My first page
permalink: "/page"

'[acme.helloworld::hello-block]':
  maxItems: 20

'[acme.helloworld::hello-block unique-key]':
  maxItems: 5

---
```

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

### GET /api/loyalty_balance

Source: https://tastyigniter.com/docs/extensions/loyaltypoints

Retrieves the authenticated customer's loyalty points balance. Requires the loyalty:* ability.

```APIDOC
## GET /api/loyalty_balance

### Description
Retrieves the authenticated customer's loyalty points balance.

### Method
GET

### Endpoint
/api/loyalty_balance

### Parameters
#### Query Parameters
- **location_id** (integer) - Optional - Get balance for a specific location.

### Response
#### Success Response (200)
- **data** (object) - The loyalty balance object containing customer_id, location_id, available_points, points_value, and spending_settings.

#### Response Example
{
    "data": {
        "customer_id": 4,
        "location_id": null,
        "available_points": 150,
        "points_value": 1.50,
        "spending_settings": {
            "points_per_currency": 0.01,
            "minimum_points": 20,
            "maximum_points": 80,
            "minimum_order_total": 0,
            "is_location_specific": false
        }
    }
}
```

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

### Configure Nginx Server

Source: https://tastyigniter.com/docs/installation

Include the bundled configuration file and define the server block for Nginx.

```nginx
include /path/to/tastyigniter/.nginx.conf;
```

```nginx
server {
    listen 80;

    root /path/to/tastyigniter;
    index index.php;

    server_name mytastysite.com;

    include /path/to/tastyigniter/.nginx.conf;
}
```

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

### Define Configuration Key Naming

Source: https://tastyigniter.com/docs/resources/php-coding-guidelines

Configuration keys must use snake_case.

```php
// config/pdf-generator.php
return [
    'chrome_path' => env('CHROME_PATH'),
];
```

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

### Loyalty balance API response

Source: https://tastyigniter.com/docs/extensions/loyaltypoints

Example response status and JSON body for the loyalty balance request.

```http
Status: 200 OK
```

```json
{
    "data": {
        "customer_id": 4,
        "location_id": null,
        "available_points": 150,
        "points_value": 1.50,
        "spending_settings": {
            "points_per_currency": 0.01,
            "minimum_points": 20,
            "maximum_points": 80,
            "minimum_order_total": 0,
            "is_location_specific": false
        }
    }
}
```

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

### Create a Validator instance

Source: https://tastyigniter.com/docs/extend/validation

Initialize a validator with input data and an array of validation rules.

```php
$validator = Validator::make($data, [
    'name' => ['required', 'min:5'] // Array
]);
```

```php
$validator = Validator::make($data, [
    'name' => 'required',
    'password' => ['required', 'min:8'],
    'email' => ['required', 'email', 'unique:users']
]);
```

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

### Create Sliders Programmatically

Source: https://tastyigniter.com/docs/extensions/frontend

Create a slider and associate media files with it.

```php
use Igniter\Frontend\Models\Slider;

$slider = Slider::create([
    'name' => 'Slider Name',
    'code' => 'unique-code',
]);

$slideOne = $model->newMediaInstance();
$slideOne->addFromFile('path/to/file.jpg', 'images')

$slideTwo = $model->newMediaInstance();
$slideTwo->addFromFile('path/to/file-2.jpg', 'images')

$slider->media()->saveMany([$slide, $slideTwo]);
```

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

### Load extension view

Source: https://tastyigniter.com/docs/extend/extensions

Use the view helper with the author.extension::view syntax to render views stored in the extension's resources/views directory.

```php
return view('acme.helloworld::hello');
```

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

### Define export columns configuration

Source: https://tastyigniter.com/docs/extensions/importexport

Create a configuration file to map database columns to export labels.

```php
return [
    'columns' => [
        'id' => 'ID',
        'name' => 'Name',
        'description' => 'Description',
    ],
];
```

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

### Apply concise syntax patterns

Source: https://tastyigniter.com/docs/resources/php-coding-guidelines

Common replacements for verbose Laravel/Flame framework patterns.

```php
Session::get('foo')
$request->session()->get('foo')
Session::put('foo', $data)
$request->input('name'),Request::get('name')
return Redirect::back()
is_null($object->relation) ? $object->relation->id : null;
return view('index')->with('title', $title)->with('client', $client)
$request->has('value') ? $request->value : 'default';
Carbon::now(), Carbon::today()
App::make('Class')
->where('column', '=', 1)
->orderBy('created_at', 'desc')
->orderBy('age', 'desc')
->orderBy('created_at', 'asc')
->select('id', 'name')->get()
->first()->name
```

```php
session('foo')
session('foo')
session(['foo' => $data])
$request->name,request('name')
return redirect()->back()
optional($object->relation)->id
return view('index', compact('title', 'client'))
$request->get('value','default')
now(), today()
app('Class')
->where('column', 1)
->latest()
->latest('age')
->oldest()
->get(['id', 'name'])
->value('name')
```

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

### Install SMS Notify via Composer

Source: https://tastyigniter.com/docs/extensions/smsnotify

Use this command to add the SMS Notify extension to your TastyIgniter project.

```bash
composer require igniterlabs/ti-ext-smsnotify -W
```

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

### Register Settings Navigation Link

Source: https://tastyigniter.com/docs/extend/extensions

Add a system settings item to the admin panel by implementing registerSettings.

```php
public function registerSettings(): array
{
    return [
        'settings' => [
            'label' => 'Extension Settings',
            'description' => 'Manage extension settings.',
            'icon' => 'fa fa-plugin',
            'model' => Acme\HelloWorld\Models\Settings::class,
            'permissions' => ['Acme.HelloWorld.Settings'],
        ],
    ];
}
```
Tokens:
Raw