WpMVC

https://wpmvc.com/docs
Admin
WpMVC is an expressive MVC framework designed specifically for WordPress plugin development,...
Tokens:57,537
Snippets:658
Trust Score:4.6
Update:7 months ago
Show doc for...
Tokens:
Raw
### Initialize WpMVC Environment with Artisan CLI

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

Navigate to your newly created plugin directory and run the Artisan setup utility. This interactive command guides you through configuring essential plugin details like name, namespace, and API namespace.

```bash
cd plugin-name
php artisan app:setup
```

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

### Initialize Project with Composer Setup

Source: https://wpmvc.com/docs/commands

The `composer setup` command is the primary entry point for initializing a new WpMVC project. It handles dependency installation, namespace isolation using PHPScoper, and sets up necessary file permissions.

```bash
composer setup
```

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

### Setup Testing Environment with Composer Test:Setup

Source: https://wpmvc.com/docs/commands

The `composer test:setup` command is used to prepare the local WordPress testing environment. It handles the setup of the database and downloads the necessary WordPress core files for running tests.

```bash
composer test:setup
```

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

### Start Development Server with PNPM Start

Source: https://wpmvc.com/docs/commands

Run `pnpm start` to launch the development server for WordPress assets. This command is essential for live development and asset compilation.

```bash
pnpm start
```

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

### Scaffold New Plugin with Composer

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

Use Composer to create a new WordPress plugin project based on the WpMVC framework. This command initializes the project structure and installs initial dependencies. Replace 'plugin-name' with your desired directory name.

```bash
composer create-project wpmvc/wpmvc plugin-name
```

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

### Install WpMVC Components Package

Source: https://wpmvc.com/docs/jskit/components

Commands to install the @wpmvc/components package using various popular Node.js package managers.

```npm
npm install @wpmvc/components
```

```pnpm
pnpm add @wpmvc/components
```

```yarn
yarn add @wpmvc/components
```

```bun
bun add @wpmvc/components
```

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

### Install @wpmvc/colors package

Source: https://wpmvc.com/docs/jskit/colors

Commands to install the color management package using various Node.js package managers.

```bash
npm install @wpmvc/colors
```

```bash
pnpm add @wpmvc/colors
```

```bash
yarn add @wpmvc/colors
```

```bash
bun add @wpmvc/colors
```

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

### List Available Artisan CLI Commands

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

Execute the Artisan command without arguments to display a list of all available commands for managing your WpMVC application. This is the primary interface for development tasks.

```bash
php artisan
```

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

### Install WpMVC Queue with Composer

Source: https://wpmvc.com/docs/queue

Integrate the WpMVC Queue engine into your project by adding it as a dependency using Composer. This command fetches the latest version and sets it up for your project.

```bash
composer require wpmvc/queue
```

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

### Dependency Injection in a Controller (PHP)

Source: https://wpmvc.com/docs/architecture/container

Demonstrates how a controller can receive its dependencies via constructor injection. This example shows the PodcastController depending on the AppleMusic service, promoting loose coupling and testability.

```php
<?php

namespace MyPluginNamespace\App\Http\Controllers;

defined( "ABSPATH" ) || exit;

use MyPluginNamespace\Services\AppleMusic;
use MyPluginNamespace\WpMVC\Routing\Response;

class PodcastController extends Controller
{
    /**
     * The AppleMusic service instance.
     */
    protected AppleMusic $apple;

    /**
     * Create a new controller instance.
     *
     * @param  AppleMusic  $apple
     * @return void
     */
    public function __construct( AppleMusic $apple ) {
        $this->apple = $apple;
    }

    /**
     * Show information about the given podcast.
     *
     * @param  string  $id
     * @return mixed
     */
    public function show( $id ) {
        return Response::send(
            [
                'podcast' => $this->apple->find_podcast( $id )
            ]
        );
    }
}

```

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

### Install WpMVC Classic Editor package

Source: https://wpmvc.com/docs/jskit/classic-editor

Commands to install the @wpmvc/classic-editor dependency using popular JavaScript package managers.

```bash
npm install @wpmvc/classic-editor
```

```bash
pnpm add @wpmvc/classic-editor
```

```bash
yarn add @wpmvc/classic-editor
```

```bash
bun add @wpmvc/classic-editor
```

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

### Format Dates and Get Boundaries

Source: https://wpmvc.com/docs/helpers

Provides methods to format dates into various string representations, including ISO 8601 and a simple date string. It also allows retrieving the start of the day and the Unix timestamp.

```php
echo $date->start_of_day(); // "Wed Oct 25 2023 00:00:00 GMT+0000"
echo $date->to_iso8601();   // "2023-10-25T00:00:00+00:00"
echo $date->to_date_string(); // "2023-10-25"
echo $date->getTimestamp();   // 1698192000
```

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

### Install WpMVC Helpers via Composer

Source: https://wpmvc.com/docs/helpers

Integrates the WpMVC Helper library into your project using Composer. This is the primary method for adding the library's functionalities to your WordPress development environment.

```bash
composer require wpmvc/helpers
```

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

### Install JSKit Fields package

Source: https://wpmvc.com/docs/jskit/fields

Commands to install the @wpmvc/fields package using various JavaScript package managers.

```npm
npm install @wpmvc/fields
```

```pnpm
pnpm add @wpmvc/fields
```

```yarn
yarn add @wpmvc/fields
```

```bun
bun add @wpmvc/fields
```

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

### Create Polymorphic Relationships with Factory For Method (PHP)

Source: https://wpmvc.com/docs/database/factories-and-seeding

Demonstrates how to create polymorphic relationships using the `for` method. This example creates a review with a polymorphic `reviewable` relationship to a product.

```php
<?php

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\App\Models\Product;
use MyPluginNamespace\App\Models\Review;

$product = Product::factory()->create();

$review = Review::factory()
    ->for( $product, 'reviewable' )
    ->create();
```

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

### Build Production Dependencies with Composer Build

Source: https://wpmvc.com/docs/commands

Use `composer build` to prepare PHP dependencies for a production environment. This command installs dependencies without development tools and optimizes the autoloader for better performance.

```bash
composer build
```

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

### Enable Hot Module Replacement with PNPM Start:Hot

Source: https://wpmvc.com/docs/commands

The `pnpm start:hot` command starts the development server with Hot Module Replacement (HMR) enabled. This allows for faster development cycles by updating modules in the browser without a full page reload.

```bash
pnpm start:hot
```

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

### Install WpMVC Admin Sidebar dependencies

Source: https://wpmvc.com/docs/jskit/admin-sidebar

Commands to install the @wpmvc/admin-sidebar package along with react-router-dom using various package managers.

```npm
npm install @wpmvc/admin-sidebar react-router-dom
```

```pnpm
pnpm add @wpmvc/admin-sidebar react-router-dom
```

```yarn
yarn add @wpmvc/admin-sidebar react-router-dom
```

```bun
bun add @wpmvc/admin-sidebar react-router-dom
```

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

### Implement a Custom Repository in PHP

Source: https://wpmvc.com/docs/repository

Example of implementing a custom repository by extending WpMVC's base Repository class. It requires defining the query builder and can include custom methods for specific data retrieval logic.

```php
<?php

namespace MyPluginNamespace\App\Repositories;

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\WpMVC\Repositories\Repository;
use MyPluginNamespace\WpMVC\Database\Query\Builder;
use MyPluginNamespace\App\Models\Post;

class PostRepository extends Repository
{
    /**
     * Define the query builder instance for this repository.
     */
    public function get_query_builder(): Builder
    {
        return Post::query();
    }

    /**
     * Custom method: Get all published posts.
     */
    public function get_published()
    {
        return $this->get_query_builder()
            ->where( 'post_status', 'publish' )
            ->get();
    }
}
```

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

### Implement a Newsletter Sequence in PHP

Source: https://wpmvc.com/docs/queue

Demonstrates how to implement a sequential queue for sending newsletters. This example extends the WpMVC\Queue\Sequence class, defining methods for task execution (`perform_sequence_task`) and item iteration (`get_item`), while also specifying a minimum time between tasks (`each_item_minimum_time`).

```php
namespace MyPlugin\App\Queues;

use WpMVC\Queue\Sequence;

class NewsletterSequence extends Sequence {
    /**
     * Unique identifier for the background process.
     */
    protected $action = 'send_newsletters';

    /**
     * Throughput Control: Defines the minimum duration (seconds) between tasks.
     * This mechanism ensures compliance with rate limits even across multiple requests.
     */
    protected function each_item_minimum_time(): int {
        return 30;
    }

    /**
     * Core Execution Logic: Processes an individual item within the sequence.
     */
    protected function perform_sequence_task( $item ) {
        return Mailer::send($item['email'], 'Welcome aboard!');
    }

    /**
     * Iterator Logic: Retrieves the next item in the processing sequence.
     */
    protected function get_item( $item ) {
        return Subscriber::next_after($item['id']);
    }
}
```

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

### Create Models with Relationships using Factory Has Method (PHP)

Source: https://wpmvc.com/docs/database/factories-and-seeding

Demonstrates how to create a model instance along with its related models using the `has` method of a factory. This example shows creating a customer with three associated products.

```php
<?php

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\App\Models\Product;
use MyPluginNamespace\App\Models\Customer;

$customer = Customer::factory()
    ->has( Product::factory()->count( 3 ) )
    ->create();
```

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

### Install @wpmvc/data package

Source: https://wpmvc.com/docs/jskit/data

Commands to add the @wpmvc/data dependency to a project using various package managers.

```npm
npm install @wpmvc/data
```

```pnpm
pnpm add @wpmvc/data
```

```yarn
yarn add @wpmvc/data
```

```bun
bun add @wpmvc/data
```

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

### Retrieve All Rows From A Table (PHP)

Source: https://wpmvc.com/docs/database/query-builder

Demonstrates how to retrieve all rows from a table using the query builder. It starts a query on an Eloquent model and fetches all results using the 'get' method. The results are returned as a collection, and individual column values can be accessed as properties of the model.

```php
<?php

defined( 'ABSPATH' ) || exit; 

use MyPluginNamespace\App\Models\User;

$users = User::query()->get();

foreach ( $users as $user ) {
    echo $user->display_name;
}

```

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

### Orchestrate Production Build with PNPM Build

Source: https://wpmvc.com/docs/commands

The `pnpm build` command initiates a comprehensive production build process. It includes installing PHP dependencies, minifying JavaScript and CSS assets, generating i18n JSON files, and compressing the final output.

```bash
pnpm build
```

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

### Eager Loading Relationships in PHP

Source: https://wpmvc.com/docs/database/relationships

Explains how to optimize database performance by eager loading relationships to solve the N+1 query problem. Includes examples for basic, nested, and constrained eager loading.

```php
$stores = Store::query()->with( 'owner' )->get();
$stores = Store::query()->with( 'owner.profile' )->get();

$customers = Customer::query()->with( [ 'orders' => function( $query ) {
    $query->where( 'status', 'completed' );
} ] )->get();
```

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

### Configure WpMVC Routing Service Provider

Source: https://wpmvc.com/docs/routing

Configures namespaces and directories for WpMVC routing when used independently. Requires a DI container with 'get' and 'set' methods, with 'wpmvc/container' recommended.

```php
<?php

namespace MyPluginNamespace\Providers;

defined( "ABSPATH" ) || exit;

use MyPluginNamespace\WpMVC\Container\Container;
use MyPluginNamespace\WpMVC\Routing\Providers\RouteServiceProvider as BaseProvider;

class RouteServiceProvider extends BaseProvider
{
    public function boot() {
        static::set_container( new Container );

        static::set_properties( [
            'rest'       => [
                'namespace' => 'my-plugin',
                'versions'  => [ 'v1' ]
            ],
            'ajax'       => [
                'namespace' => 'my-plugin',
                'versions'  => []
            ],
            'routes-dir' => ABSPATH . 'wp-content/plugins/my-plugin/routes'
        ] );

        parent::boot();
    }
}

```

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

### Create Models with Relationships using Factory Magic Method (PHP)

Source: https://wpmvc.com/docs/database/factories-and-seeding

Shows a convenient way to define factory relationships using magic methods, assuming the model has defined relationships. This example uses `has_products` to create a customer with products.

```php
$customer = Customer::factory()
    ->has_products( 3 )
    ->create();
```

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

### Define Database Seeder Logic

Source: https://wpmvc.com/docs/database/factories-and-seeding

Defines the `run` method within a seeder class to insert data into the database. This example uses Eloquent model factories or the query builder to insert customer data.

```php
<?php

namespace MyPluginNamespace\Database\Seeders;

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\WpMVC\Database\Seeder;
use MyPluginNamespace\App\Models\Customer;

class DatabaseSeeder extends Seeder
{
    /**
     * Seed the application's database.
     *
     * @return void
     */
    public function run()
    {
        Customer::query()->insert( [
            'first_name' => 'Admin',
            'email'      => 'admin@example.com',
        ] );
    }
}
```

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

### Use CRUD and Values Hooks in React

Source: https://wpmvc.com/docs/jskit/data

Examples of using React hooks to fetch data, perform actions, and manage query parameters in functional components.

```typescript
import { useCrudStoreData, useCrudStore, useValuesStoreData, useValuesStore, useCrudQueryParams } from '@wpmvc/data';

// CRUD Example
const ProductList = () => {
    const { data: products } = useCrudStoreData({ name: 'my-plugin/products', selector: 'get' });
    const { destroy } = useCrudStore({ name: 'my-plugin/products' });
    return <ul>{products.map(p => <li key={p.id}>{p.name} <button onClick={() => destroy(p.id)}>Delete</button></li>)}</ul>;
};

// Values Example
const Settings = () => {
    const { data: settings } = useValuesStoreData({ name: 'my-plugin/settings' });
    const { set, save } = useValuesStore({ name: 'my-plugin/settings' });
    return <input value={settings.api_key || ''} onChange={(e) => set('api_key', e.target.value)} />;
};

// Query Params Example
const Pagination = () => {
    const queryParams = useCrudQueryParams({ name: 'my-plugin/products' });
    return <div>Current Page: {queryParams.page}</div>;
};
```

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

### Generate SQL Preview for Table Creation with WpMVC Schema Builder (PHP)

Source: https://wpmvc.com/docs/database/schema-builder

Demonstrates how to get the generated SQL string for creating a table without actually executing it. By passing `true` as the last argument to Schema::create, the method returns the SQL query.

```PHP
<?php

defined( 'ABSPATH' ) || exit; 

use MyPluginNamespace\WpMVC\Database\Schema\Schema;
use MyPluginNamespace\WpMVC\Database\Schema\Blueprint;

$sql = Schema::create( 'customers', function( Blueprint $table ) {
    $table->big_increments( 'id' );
}, true );
```

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

### Generate New Service Provider with Artisan CLI

Source: https://wpmvc.com/docs/architecture/providers

This command uses the Artisan CLI to generate a new service provider file. It's a convenient way to start creating custom providers for your WpMVC application.

```shell
php artisan make:provider RiakServiceProvider
```

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

### Create Models with Belongs To Relationships using Factory For Method (PHP)

Source: https://wpmvc.com/docs/database/factories-and-seeding

Illustrates how to define a "belongs to" relationship when creating models using the `for` method. This example creates three review instances that belong to a single product.

```php
<?php

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\App\Models\Product;
use MyPluginNamespace\App\Models\Review;

$reviews = Review::factory()
    ->count( 3 )
    ->for( Product::factory()->create() )
    ->create();
```

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

### Create Database Table with WpMVC Schema Builder (PHP)

Source: https://wpmvc.com/docs/database/schema-builder

Demonstrates how to create a new database table named 'customers' using the Schema::create method. It defines columns like 'id', 'name', 'email', and timestamps within a closure. This is typically handled in a Setup class for plugin activation/updates.

```PHP
<?php

namespace MyPluginNamespace\Database;

defined( 'ABSPATH' ) || exit; 

use MyPluginNamespace\WpMVC\Database\Schema\Schema;
use MyPluginNamespace\WpMVC\Database\Schema\Blueprint;

class Setup 
{
    public function execute() 
    {
        Schema::create( 'customers', function( Blueprint $table ) {
            $table->big_increments( 'id' );
            $table->string( 'name' );
            $table->string( 'email' )->unique();
            $table->timestamps();
        } );
    }
}
```

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

### Using Scoped Libraries in WpMVC Controller

Source: https://wpmvc.com/docs/architecture/isolation

This example shows how to use a dependency, Guzzle HTTP client, that has been automatically scoped by WpMVC. It highlights the need to use the fully qualified scoped namespace in `use` statements and when instantiating classes.

```php
<?php

namespace MyPluginNamespace\App\Http\Controllers;

defined( 'ABSPATH' ) || exit;

// WpMVC automatically scopes Guzzle to your namespace during build
use MyPluginNamespace\GuzzleHttp\Client;
use MyPluginNamespace\WpMVC\Routing\Response;

class IntegrationController extends Controller
{
    public function fetch_data()
    {
        $client = new Client();
        
        $response = $client->request( 'GET', 'https://api.example.com' );
        
        return Response::send( json_decode( $response->getBody() ) );
    }
}
```

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

### Rename and Drop Database Tables with WpMVC Schema Builder (PHP)

Source: https://wpmvc.com/docs/database/schema-builder

Provides examples for renaming and dropping database tables using the Schema::rename, Schema::drop, and Schema::drop_if_exists methods. These are essential for managing table lifecycles.

```PHP
Schema::rename( $from, $to );

Schema::drop( 'customers' );
 
Schema::drop_if_exists( 'customers' );
```

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

### Get Plugin Version using WpMVC Helpers

Source: https://wpmvc.com/docs/helpers

Retrieves the semantic version of an installed WordPress plugin. It returns the version string if the plugin is found and active, otherwise it returns null.

```php
$version = Helpers::get_plugin_version( 'woocommerce' );
// Output: "8.5.0"
```

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

### Define Custom Route Macros in WpMVC

Source: https://wpmvc.com/docs/routing

Makes the Route class 'macroable', allowing the definition of custom methods. This example defines a 'status' macro that registers a GET route returning a JSON status response.

```php
<?php

use MyPluginNamespace\WpMVC\Routing\Route;
use MyPluginNamespace\WpMVC\Routing\Response;

Route::macro( 'status', function ( $uri ) {
    return Route::get( $uri, function () {
        return Response::send( [ 'status' => 'OK' ] );
    } );
} );

// Usage
Route::status( 'system/status' );

```

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

### Defining a Singleton Service (PHP)

Source: https://wpmvc.com/docs/architecture/container

Demonstrates how to register a service as a singleton using the 'singleton' method. This ensures that the service is instantiated only once during the request lifecycle, and subsequent resolutions return the same instance.

```php
use MyPluginNamespace\Services\Transistor;
use MyPluginNamespace\Services\PodcastParser;

$this->app->singleton( Transistor::class, function ( $app ) {
    return new Transistor( $app->get( PodcastParser::class ) );
} );

```

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

### Inject Dependencies into Service Provider Boot Method

Source: https://wpmvc.com/docs/architecture/providers

Shows how to type-hint services in the boot method to allow the WpMVC container to automatically inject required dependencies.

```php
use MyPluginNamespace\Services\SettingsService;

public function boot( SettingsService $settings ) {
    if ( $settings->is_enabled( 'analytics' ) ) {
        add_action( 'wp_footer', [ $this, 'inject_footer_script' ] );
    }
}
```

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

### Initialize and Guard Plugin Dependencies

Source: https://wpmvc.com/docs/dependent-manager

Initialize the Manager instance and perform compatibility checks to prevent execution if requirements are not met.

```php
use WpMVC\DependentManager\Manager;

// Establish the current version of the extension
define( 'MY_ADDON_DEPENDENT_VERSION', '1.0.0' );

// Initialize the Guard with dynamic Core requirements
$dependent_manager = new Manager(
    MY_PLUGIN_DEPENDENT_VERSION,
    MY_ADDON_DEPENDENT_VERSION,
    'Main Plugin',
    'Pro Addon'
);

// Early lifecycle validation
if ( ! $dependent_manager->is_compatible() ) {
    return;
}

$app->boot();
```

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

### Orchestrate Bootstrapping with Production-Grade Guard

Source: https://wpmvc.com/docs/dependent-manager

A robust implementation using the 'plugins_loaded' hook to ensure all components are ready before performing dependency validation and application loading.

```php
add_action( 'plugins_loaded', function () use ( $application ): void {
    if ( ! defined( 'MY_PLUGIN_DEPENDENT_VERSION' ) ) {
        return;
    }

    define( 'MY_ADDON_DEPENDENT_VERSION', '1.0.0' );

    $dependent_manager = new Manager( 
        MY_PLUGIN_DEPENDENT_VERSION,
        MY_ADDON_DEPENDENT_VERSION,
        "Main Plugin",
        "Pro Addon"
    );

    if ( ! $dependent_manager->is_compatible() ) {
        return;
    }

    do_action( 'before_load_pro_addon' );

    require_once __DIR__ . '/app/Helpers/helper.php';
    $application->load();

    do_action( 'after_load_pro_addon' );
});
```

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

### Implement Constructor Dependency Injection in WpMVC

Source: https://wpmvc.com/docs/architecture/container

Demonstrates how to automatically resolve and inject service dependencies into controller constructors using type-hinting. This pattern ensures that services like AppleMusic are instantiated and available for use within the class.

```php
namespace MyPluginNamespace\App\Http\Controllers;

defined( "ABSPATH" ) || exit;

use MyPluginNamespace\Services\AppleMusic;
use MyPluginNamespace\WpMVC\Routing\Response;

class PodcastController extends Controller
{
    protected AppleMusic $apple;

    public function __construct( AppleMusic $apple ) {
        $this->apple = $apple;
    }

    public function show( $id ) {
        return Response::send([
            'podcast' => $this->apple->find_podcast( $id )
        ]);
    }
}
```

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

### Install Dependent Manager via Composer

Source: https://wpmvc.com/docs/dependent-manager

Command to add the WpMVC Dependent Manager package to your project dependencies.

```bash
composer require wpmvc/dependent-manager
```

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

### File Validation Example

Source: https://wpmvc.com/docs/request-validator

Validates that a 'photo' field is a required file, accepts only PNG and JPG formats, and has a maximum size of 1024 KB.

```php
$request->validate([
    'photo' => 'required|file|mimes:png,jpg|max:1024',
]);
```

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

### Make Column Nullable in WpMVC

Source: https://wpmvc.com/docs/database/schema-builder

The `nullable` modifier allows a column to accept NULL values. This example shows how to make an 'email' column nullable.

```php
<?php

defined( 'ABSPATH' ) || exit; 

use MyPluginNamespace\WpMVC\Database\Schema\Schema;
use MyPluginNamespace\WpMVC\Database\Schema\Blueprint;

Schema::alter( 'users', function( Blueprint $table ) {
    $table->string( 'email' )->nullable();
} );
```

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

### Sequence Configuration Methods

Source: https://wpmvc.com/docs/queue

Configuration methods used within classes extending WpMVC\Queue\Sequence to control execution flow and resource utilization.

```APIDOC
## Configuration Methods

### Description
These methods are defined within the `Sequence` class to manage task throughput, execution windows, and resource throttling.

### Methods
- **each_item_minimum_time()** (int) - Defines the minimum duration (in seconds) between tasks to respect external rate limits. Default: 7s.
- **sleep_on_rest_time()** (bool) - When true, the engine uses `sleep()` to bridge the gap between task completion and the minimum time requirement within the current request. Default: false.
- **get_default_time_limit()** (int) - Defines the execution window allocated for a single request before state serialization occurs. Default: 20s.

### Implementation Example
```php
class MySequence extends WpMVC\Queue\Sequence {
    protected function each_item_minimum_time(): int {
        return 30;
    }

    protected function sleep_on_rest_time(): bool {
        return true;
    }
}
```
```

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

### Define field configuration objects

Source: https://wpmvc.com/docs/jskit/fields

Examples of various field configuration objects including text, number, switch, checkbox, tabs, and color picker types.

```javascript
// Text
{ type: 'text', label: 'Text Field', description: 'A simple text input', required: true }

// Number
{ type: 'number', label: 'Number Field', min: 0, max: 100, description: 'A number input' }

// Switch
{ type: 'switch', label: 'Switch Field', description: 'A toggle switch' }

// Checkbox
{ type: 'checkbox', label: 'Checkbox Field', description: 'A single checkbox' }

// Tabs
{ type: 'tabs', label: 'Tabs Field', items: { tab1: { label: 'Tab 1', fields: {} } } }

// Color
{ type: 'color', label: 'Color Picker', description: 'Pick a color' }
```

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

### Implement ClassicEditor in React

Source: https://wpmvc.com/docs/jskit/classic-editor

Example of importing and using the ClassicEditor component within a React functional component, including state management for editor content.

```tsx
import { useState } from '@wordpress/element';
import ClassicEditor from '@wpmvc/classic-editor';
 
const MyComponent = () => {
  const [content, setContent] = useState('Initial content here');
 
  return (
    <div>
      <h2> My Custom Editor</h2>
      <ClassicEditor
        value={content}
        onChange={(newContent) => setContent(newContent)}
        height={300}
        hasMedia={true}
        useExtendStyles={true}
      />
    </div>
  );
};
 
export default MyComponent;
```

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

### Date Validation Example

Source: https://wpmvc.com/docs/request-validator

Validates that a 'launched' field is required, a date in 'Y-m-d' format, and on or after January 1, 2022. Supports custom date formats and comparisons.

```php
$request->validate([
    'launched' => 'required|date:Y-m-d|after_or_equal:2022-01-01',
]);
```

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

### Register WordPress Hooks and Shortcodes in Service Provider

Source: https://wpmvc.com/docs/architecture/providers

Demonstrates how to use the boot method within a WpMVC Service Provider to register custom post types, shortcodes, and AJAX handlers. This ensures logic is initialized after the container is ready.

```php
namespace MyPluginNamespace\App\Providers;

defined( "ABSPATH" ) || exit;

use MyPluginNamespace\WpMVC\Contracts\Provider;

class DiscoveryServiceProvider extends Provider
{
    public function boot() {
        add_action( 'init', [ $this, 'register_custom_post_types' ] );
        add_shortcode( 'my_plugin_data', [ $this, 'render_shortcode' ] );
        add_action( 'wp_ajax_my_action', [ $this, 'handle_ajax' ] );
        add_action( 'wp_ajax_nopriv_my_action', [ $this, 'handle_ajax' ] );
    }

    public function register_custom_post_types() {
        register_post_type( 'book', [ 'public' => true, 'label' => 'Books' ] );
    }

    public function render_shortcode( $atts ) {
        return '<div>Shortcode Content</div>';
    }

    public function handle_ajax() {
        wp_send_json_success( [ 'message' => 'AJAX Success' ] );
    }
}
```

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

### Integrate JSKit Fields in Gutenberg InspectorControls

Source: https://wpmvc.com/docs/jskit/fields

Example of using JSKit Fields within a WordPress Gutenberg block to create a dynamic settings panel in the block editor.

```javascript
import { InspectorControls } from '@wordpress/block-editor';
import { Fields } from '@wpmvc/fields';

const fields = {
  text: { type: 'text', label: 'Text Field' },
  color: { type: 'color', label: 'Color Picker' },
};

export default function Edit({ attributes, setAttributes }) {
  return (
    <>
      <InspectorControls>
          <Fields
            fields={fields}
            attributes={attributes}
            setAttributes={setAttributes}
          />
      </InspectorControls>
    </>
  );
}
```

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

### HTTP Verb Routing and Matching

Source: https://wpmvc.com/docs/routing

Illustrates how to register routes for specific HTTP verbs and how to use the match or any methods to handle multiple or all HTTP request types.

```php
Route::get( $uri, $callback );
Route::post( $uri, $callback );
Route::put( $uri, $callback );
Route::patch( $uri, $callback );
Route::delete( $uri, $callback );
Route::options( $uri, $callback );

Route::match( [ 'get', 'post' ], '/', function () {
    // ...
} );

Route::any( '/', function () {
    // ...
} );
```

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

### Registering a Standard Service Binding (PHP)

Source: https://wpmvc.com/docs/architecture/container

Shows how to register a service binding using the 'bind' method on the application container. This method accepts a class/interface name and a closure that returns the desired instance, allowing for nested dependency resolution.

```php
use MyPluginNamespace\Services\Transistor;
use MyPluginNamespace\Services\PodcastParser;

$this->app->bind( Transistor::class, function ( $app ) {
    return new Transistor( $app->get( PodcastParser::class ) );
} );

```

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

### Generate Middleware via Artisan

Source: https://wpmvc.com/docs/middleware

Use the Artisan command-line tool to scaffold a new middleware class in the app/Http/Middleware directory.

```bash
php artisan make:middleware EnsureTokenIsValid
```

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

### Create Single or Multiple Model Instances with Factory Create Method (PHP)

Source: https://wpmvc.com/docs/database/factories-and-seeding

Shows how to use the `create` method of a factory to instantiate model instances and persist them to the database. It covers creating a single instance and multiple instances using `count()`.

```php
<?php

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\App\Models\Customer;

// Create a single Customer instance...
$customer = Customer::factory()->create();

// Create three Customer instances...
$customers = Customer::factory()->count( 3 )->create();
```

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

### Inserting Record and Getting ID - PHP

Source: https://wpmvc.com/docs/database/query-builder

Inserts a record into a table with an auto-incrementing ID and retrieves the newly generated ID. Accepts an array of column names and values.

```php
$id = User::query()->insert_get_id( [
    'user_login' => 'john_doe',
    'user_email' => 'john@example.com'
] );
```

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

### Compress Assets with PNPM Compress

Source: https://wpmvc.com/docs/commands

Run `pnpm compress` to create a distribution-ready zip file of your project's assets. This command is part of the internal utilities and is usually called by other build scripts.

```bash
pnpm compress
```

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

### Set Default Value for Column (WpMVC)

Source: https://wpmvc.com/docs/database/schema-builder

The `default` modifier sets a default value for a column. If no value is provided during insertion, this default will be used. This example sets the default status to 'draft'.

```php
$table->string( 'status' )->default( 'draft' );
```

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

### Generate Factory via Artisan

Source: https://wpmvc.com/docs/database/factories-and-seeding

Use the Artisan command-line tool to scaffold a new factory class within the database/factories directory.

```bash
php artisan make:factory CustomerFactory
```

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

### Invoke Methods and Closures with Container Injection

Source: https://wpmvc.com/docs/architecture/container

Explains how to use the App::call method to execute class methods or closures while allowing the container to automatically resolve and inject required dependencies.

```php
use MyPluginNamespace\PodcastStats;
use MyPluginNamespace\WpMVC\App;

// Invoking a class method
$stats = App::call( [ new PodcastStats, 'generate' ] );

// Invoking a closure
$result = App::call( function ( AppleMusic $apple ) {
    // ...
} );
```

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

### Constrain Has-Many-Through Relationship by Morph Type (PHP)

Source: https://wpmvc.com/docs/database/relationships

Illustrates how to refine a 'has-many-through' relationship for polymorphic distant models. This example filters reviews to only include those associated with 'product' morph types, using `where_morph_type`.

```php
public function product_reviews(): HasManyThrough
{
    // In this example, the 'reviews' table uses 'reviewable_id' and 'reviewable_type'
    return $this->has_many_through( Review::class, Product::class, 'supplier_id', 'reviewable_id' )
                ->where_morph_type( 'reviewable_type', 'product' );
}
```

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

### Define a Basic Controller and Route in WpMVC

Source: https://wpmvc.com/docs/controllers

Demonstrates how to create a controller class to handle requests and map it to a specific route URI. The controller uses the Response class to return data, and the route links a URL pattern to the controller method.

```PHP
<?php

namespace MyPluginNamespace\App\Http\Controllers;

defined( "ABSPATH" ) || exit;

use MyPluginNamespace\WpMVC\RequestValidator\Request;
use MyPluginNamespace\WpMVC\Routing\Response;

class UserController
{
    public function show( Request $request ) {
        return Response::send( [
            'user' => [
                'id'   => $request->get_param( 'id' ),
                'name' => 'John Doe',
            ]
        ] );
    }
}
```

```PHP
use MyPluginNamespace\App\Http\Controllers\UserController;
use MyPluginNamespace\WpMVC\Routing\Route;

Route::get( 'user/{id}', [ UserController::class, 'show' ] );
```

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

### Add Comment to Column (WpMVC)

Source: https://wpmvc.com/docs/database/schema-builder

The `comment` modifier adds a descriptive comment to a database column, which can be helpful for documentation or understanding the column's purpose. This example adds a comment to a 'role' column.

```php
$table->string( 'role' )->comment( 'User role in the system' );
```

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

### Get User IP Address using WpMVC Helpers

Source: https://wpmvc.com/docs/helpers

A standardized method for retrieving the client's IP address, accounting for proxy headers like HTTP_X_FORWARDED_FOR to ensure accuracy in load-balanced environments.

```php
$ip = Helpers::get_user_ip_address();
```

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

### Define Resource Routes in WpMVC

Source: https://wpmvc.com/docs/controllers

Registers a full set of CRUD routes for a specific resource. It maps standard HTTP verbs like GET, POST, PATCH, and DELETE to corresponding controller methods.

```php
use MyPluginNamespace\App\Http\Controllers\PhotoController;
use MyPluginNamespace\WpMVC\Routing\Route;
 
Route::resource( 'photos', PhotoController::class );
```

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

### Specify Column Order with 'after' (WpMVC)

Source: https://wpmvc.com/docs/database/schema-builder

The `after` method, when used with MySQL, allows you to specify the exact position of a new column relative to an existing column. This example places the 'address' column after the 'email' column.

```php
$table->string( 'address' )->after( 'email' );
```

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

### Type-hinting Interfaces in Classes

Source: https://wpmvc.com/docs/architecture/container

Demonstrates how to consume a bound interface via constructor injection within a class.

```PHP
use MyPluginNamespace\Contracts\EventPusher;
 
defined( "ABSPATH" ) || exit;
 
class PodcastBanner
{
    protected EventPusher $pusher;
 
    public function __construct( EventPusher $pusher ) {
        $this->pusher = $pusher;
    }
}
```

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

### Integrate Repository with DTO in Controller

Source: https://wpmvc.com/docs/repository

Demonstrates how a controller can utilize a repository to create a new record using a Data Transfer Object (DTO). The repository's `create` method handles the data insertion logic.

```php
<?php

namespace MyPluginNamespace\App\Http\Controllers;

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\App\DTO\PostDTO;
use MyPluginNamespace\WpMVC\Routing\Response;

class PostController extends Controller
{
    public function store( PostDTO $dto )
    {
        // The create method accepts a DTO and handles the insertion logic
        $id = $this->posts->create( $dto );
        
        return Response::send( [ 'id' => $id ], 201 );
    }
}
```

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

### Handle Route Parameters with Method Injection

Source: https://wpmvc.com/docs/controllers

Illustrates how to combine dependency injection with route parameters in a controller method. Route arguments are passed after the injected dependencies.

```PHP
use MyPluginNamespace\App\Http\Controllers\UserController;
use MyPluginNamespace\WpMVC\Routing\Route;

Route::put( 'user/{id}', [ UserController::class, 'update' ] );
```

```PHP
public function update( Request $request, $id ) {
    return Response::send( [ 'status' => 'updated' ] );
}
```

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

### Alter Existing Database Table with WpMVC Schema Builder (PHP)

Source: https://wpmvc.com/docs/database/schema-builder

Illustrates how to modify an existing database table, such as 'customers', using the Schema::alter method. This example adds a nullable 'phone' column to the table.

```PHP
<?php

defined( 'ABSPATH' ) || exit; 

use MyPluginNamespace\WpMVC\Database\Schema\Schema;
use MyPluginNamespace\WpMVC\Database\Schema\Blueprint;

Schema::alter( 'customers', function( Blueprint $table ) {
    $table->string( 'phone' )->nullable();
} );
```

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

### Query Relationship Existence and Constraints

Source: https://wpmvc.com/docs/database/relationships

Provides examples for filtering model results based on the existence of related records. Includes basic existence checks, conditional filtering with where_has, and nested relationship querying using dot notation.

```php
$stores = Store::has( 'products' )->get();

$stores = Store::query()->where_has( 'products', function( $query ) {
    $query->where( 'price', '>', 100 );
} )->get();

$stores = Store::has( 'products.reviews' )->get();

$stores = Store::query()->where_has( 'products.reviews', function( $query ) {
    $query->where( 'rating', 5 );
} )->get();
```

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

### Generate Localization Files with Composer i18n

Source: https://wpmvc.com/docs/commands

Run `composer i18n` to generate `.pot` and `.po` files for localization. This command scans your project for translatable strings in PHP and JavaScript files.

```bash
composer i18n
```

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

### Automatic Service Resolution in Route Handler (PHP)

Source: https://wpmvc.com/docs/architecture/container

Illustrates WpMVC's auto-resolution capability where the service container can instantiate a class with no or concrete dependencies automatically. This example shows a Service class being injected into a route handler.

```php
<?php

namespace MyPluginNamespace;

defined( "ABSPATH" ) || exit;

class Service
{
    // ...
}

Route::get('/', function ( Service $service ) {
    die( get_class( $service ) );
});

```

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

### Bind Interface to Repository Implementation (PHP)

Source: https://wpmvc.com/docs/repository

Shows how to bind an interface to its concrete repository implementation within a Service Provider in WpMVC. This enhances flexibility by allowing dependency injection based on interfaces.

```php
<?php

namespace MyPluginNamespace\App\Providers;

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\WpMVC\Foundation\Support\Providers\ServiceProvider;
use MyPluginNamespace\App\Contracts\PostRepositoryInterface;
use MyPluginNamespace\App\Repositories\PostRepository;

class RepositoryServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->bind(
            PostRepositoryInterface::class,
            PostRepository::class
        );
    }
}
```

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

### Create Models with Belongs To Relationships using Factory Magic Method (PHP)

Source: https://wpmvc.com/docs/database/factories-and-seeding

Provides a shortcut for defining "belongs to" relationships using magic methods. This example uses `for_product` to create reviews associated with a product.

```php
$reviews = Review::factory()
    ->count( 3 )
    ->for_product( [ 'name' => 'Jessica' ] )
    ->create();
```

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

### Database Seeding Overview (PHP)

Source: https://wpmvc.com/docs/database/factories-and-seeding

Introduces the concept of database seeding in WpMVC, where seed classes are used to populate the database with test data. It mentions the default `DatabaseSeeder` and the `call` method for running other seeders.

```php
// Seed classes are stored in the MyPluginNamespace\App\Seeders namespace.
// The DatabaseSeeder class can use the call method to run other seed classes.
```

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

### Define Basic and REST Routes in WpMVC

Source: https://wpmvc.com/docs/routing

Demonstrates how to define basic URI routes using closures and REST API routes using controller class methods. These routes are typically placed in the plugin's routes directory.

```php
<?php

namespace MyPluginNamespace\App;

defined( "ABSPATH" ) || exit;

use MyPluginNamespace\WpMVC\Routing\Route;
use MyPluginNamespace\WpMVC\Routing\Response;

Route::get( 'greeting', function () {
    return Response::send( [ 'message' => 'Hello World' ] );
} );
```

```php
<?php

namespace MyPluginNamespace\App;

defined( "ABSPATH" ) || exit;

use MyPluginNamespace\WpMVC\Routing\Route;
use MyPluginNamespace\App\Http\Controllers\UserController;

Route::get( 'user', [ UserController::class, 'index' ] );
```

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

### Get Latest Related Model (has_one_of_many) in PHP

Source: https://wpmvc.com/docs/database/relationships

Defines a relationship to retrieve a single, specific related model, such as the latest order for a customer. The `has_one_of_many` method allows specifying ordering and constraints to fetch a particular record from a one-to-many relationship.

```php
<?php

namespace MyPluginNamespace\App\Models;

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\WpMVC\Database\Eloquent\Model;
use MyPluginNamespace\WpMVC\Database\Eloquent\Relations\HasOne;
use MyPluginNamespace\WpMVC\Database\Eloquent\Relations\HasOneOfMany;

class Customer extends Model
{
    /**
     * Get the customer's latest order using has_one_of_many.
     */
    public function latest_order(): HasOneOfMany
    {
        return $this->has_one_of_many( Order::class, 'customer_id', 'id', 'id', 'desc' );
    }

    /**
     * Alternatively, you can chain latest() on a normal has_one.
     */
    public function latest_order_alt(): HasOne
    {
        return $this->has_one( Order::class, 'customer_id', 'id' )->latest( 'id' );
    }
}
```

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

### Execute Database Seeders with Artisan

Source: https://wpmvc.com/docs/artisan

Runs database seeder classes to populate tables with initial or test data. By default, it executes the DatabaseSeeder, but supports the --class option to run specific seeders.

```bash
php artisan db:seed
```

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

### Cancel Eloquent Model Save Operation via WordPress Hook

Source: https://wpmvc.com/docs/database/eloquent-models

Provides an example of using the `wpmvc_model_saving_{table_name}` WordPress filter to halt a database save operation by returning `false`. This allows for conditional saving based on model data.

```php
<?php

// Prevent posts with empty titles from being saved
add_filter( 'wpmvc_model_saving_posts', function( $halt, $post ) {
    if ( empty( $post->post_title ) ) {
        return false; // Cancels the save operation
    }
    return $halt;
}, 10, 2 );
```

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

### Append Custom Attributes to Eloquent Model Serialization

Source: https://wpmvc.com/docs/database/eloquent-models

Shows how to append custom attributes, defined via accessors, to the model's array and JSON representations by adding them to the `$appends` property. Also includes an example of attribute casting with `$casts`.

```php
/**
 * The accessors to append to the model's array form.
 *
 * @var array
 */
protected array $appends = [ 'is_admin' ];

/**
 * The attributes that should be cast.
 *
 * @var array
 */
protected array $casts = [
    'user_status' => 'int',
    'user_registered' => 'datetime',
];
```

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

### Dependency Injection in Routes

Source: https://wpmvc.com/docs/routing

Demonstrates how to type-hint dependencies in route callbacks, allowing the WpMVC service container to automatically resolve and inject objects like the Request class.

```php
<?php

namespace MyPluginNamespace\App;

defined( "ABSPATH" ) || exit;

use MyPluginNamespace\WpMVC\Routing\Route;
use MyPluginNamespace\WpMVC\RequestValidator\Request;

Route::get( 'users', function ( Request $request ) {
    // ...
} );
```

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

### Recycle Related Models with Factory Recycle Method (PHP)

Source: https://wpmvc.com/docs/database/factories-and-seeding

Explains how to use the `recycle` method to ensure that multiple generated models use the same instance of a related model, preventing redundant creations. This example recycles a customer instance for multiple products.

```php
<?php

defined( 'ABSPATH' ) || exit;

use MyPluginNamespace\App\Models\Customer;
use MyPluginNamespace\App\Models\Product;

$customer = Customer::factory()->create();

$products = Product::factory()
    ->count( 10 )
    ->recycle( $customer )
    ->create();
```
Tokens:
Raw