Laravel Metable

https://github.com/plank/laravel-metable
Admin
Laravel Metable is a package that allows you to easily attach arbitrary data to Eloquent models...
Tokens:12,781
Snippets:69
Trust Score:8.3
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Sphinx for Documentation

Source: https://github.com/plank/laravel-metable/blob/master/CONTRIBUTING.md

This command installs the Sphinx documentation generator using pip. Sphinx is required for building and viewing documentation changes locally.

```python
pip install Sphinx
```

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

### Install Laravel-Metable via Composer

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/intro.rst

This command installs the Laravel-Metable package using Composer, a dependency manager for PHP.

```bash
composer require plank/laravel-metable
```

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

### Run Tests with PHPUnit

Source: https://github.com/plank/laravel-metable/blob/master/CONTRIBUTING.md

This command executes the project's test suite using PHPUnit. Ensure PHPUnit is installed and configured in your environment.

```bash
phpunit
```

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

### Install Laravel-Metable via Composer (Bash)

Source: https://github.com/plank/laravel-metable/blob/master/README.md

Provides the Composer command to install the Laravel-Metable package into your Laravel project. This is the first step in integrating the package.

```Bash
composer require plank/laravel-metable

```

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

### Set Meta with Nested Arrays

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Provides an example of setting meta information with deeply nested arrays, demonstrating support for complex data structures.

```PHP
<?php
$metable->setMeta('information', [
    'address' => [
        'street' => '123 Somewhere Ave.',
        'city' => 'Somewhereville',
        'country' => 'Somewhereland',
        'postal' => '123456',
    ],
    'contact' => [
        'phone' => '555-555-5555',
        'email' => 'email@example.com'
    ]
]);
```

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

### Set Null Meta Value in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Provides an example of setting a null meta value. This type supports string query scopes and a specific 'whereMetaIsNull()' scope.

```php
<?php
$metable->setMeta('linked_model', null);

```

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

### Build Documentation with Sphinx

Source: https://github.com/plank/laravel-metable/blob/master/CONTRIBUTING.md

These commands navigate to the docs directory and build the HTML documentation using Sphinx. This allows for local preview of documentation changes.

```bash
cd docs/
make html
```

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

### Run Laravel Migrations

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/intro.rst

This command executes the database migrations required by Laravel-Metable to add necessary tables.

```bash
php artisan migrate
```

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

### Run Migrations (Bash)

Source: https://github.com/plank/laravel-metable/blob/master/README.md

Artisan command to run the package's database migrations, which are necessary for storing metadata.

```Bash
php artisan migrate

```

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

### Publish Configuration File (Bash)

Source: https://github.com/plank/laravel-metable/blob/master/README.md

Command to publish the package's configuration file using Artisan. This allows customization of the package's behavior.

```Bash
php artisan vendor:publish --provider="Plank\Metable\MetableServiceProvider"

```

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

### Publish Laravel-Metable Configuration

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/intro.rst

This Artisan command publishes the package's configuration file (config/metable.php) to your Laravel application.

```bash
php artisan vendor:publish --provider="Plank\Metable\MetableServiceProvider"
```

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

### Register Laravel-Metable Service Provider

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/intro.rst

This snippet shows how to register the MetableServiceProvider in the application's config/app.php file. This step is automatic for Laravel 5.5+ with auto-discovery enabled.

```php
<?php
    'providers' => [
        ...
        Plank\Metable\MetableServiceProvider::class,
        ...
    ];

```

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

### Set Meta with Serializable Objects

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Demonstrates setting meta information with objects that implement PHP's `Serializable` interface. Requires configuration for allowed classes.

```PHP
<?php
class Example implements \Serializable
{
    //...
}

$serializable = new Example;

$metable->setMeta('example', $serializable);
```

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

### Set Meta with Stringable

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Demonstrates setting meta information using Laravel's Stringable fluent interface for string manipulation.

```PHP
<?php
$metable->setMeta('address', Str::of('123 Somewhere St.'));
```

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

### Set Meta with Enums

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Shows how to set meta information using both pure Enums and backed Enums in PHP.

```PHP
<?php
$metable->setMeta('status', Status::ACTIVE);
```

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

### Configure Serializable Handler Security (PHP)

Source: https://github.com/plank/laravel-metable/blob/master/UPGRADING.md

For security, if using `SerializableHandler`, configure `metable.serializableHandlerAllowedClasses` to specify which classes are permitted for unserialization. Setting it to `true` disables the check but is not recommended. Failure to configure may result in `__PHP_Incomplete_Class` objects.

```PHP
$config['metable']['serializableHandlerAllowedClasses'] = [
    'App\Models\MyCustomClass',
    'Another\Allowed\Class',
    // Or true to allow all (not recommended)
    // true
];
```

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

### Attach Metadata to Eloquent Model

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/intro.rst

This PHP code demonstrates how to attach metadata to an Eloquent model instance using the setMeta method provided by the Metable trait.

```php
<?php
$post = Post::create($this->request->input());
$post->setMeta('color', 'blue');

```

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

### Custom Meta Model Extension in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/extending_meta.rst

Demonstrates how to extend the base Meta class to create custom meta models with different table names and how to associate these custom models with Metable entities in Laravel.

```php
<?php
class UserMeta extends Meta
{
    protected $table = 'user_meta';
}

class ProductMeta extends Meta
{
    protected $table = 'product_meta';
}

class User extends Model
{
    use Metable;

    protected function getMetaClassName(): string
    {
        return UserMeta::class;
    }
}

class Product extends Model
{
    use Metable;

    protected function getMetaClassName(): string
    {
        return ProductMeta::class;
    }
}
```

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

### Rename Migration File (Laravel)

Source: https://github.com/plank/laravel-metable/blob/master/UPGRADING.md

For version 3.X to 4.X upgrades, database migration files are now included within the package. Rename the existing `create_meta_table.php` migration file in your `/database/migrations` directory to `2017_01_01_000000_create_meta_table.php`. Any custom table modifications should be handled in separate `ALTER table` migrations.

```Shell
# Example command (actual renaming depends on your file system and current name)
# mv database/migrations/XXXX_XX_XX_XXXXXX_create_meta_table.php database/migrations/2017_01_01_000000_create_meta_table.php
```

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

### Query Eloquent Model by Metadata

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/intro.rst

This PHP code shows how to query Eloquent models based on their attached metadata using the whereMeta method.

```php
<?php
$post = Post::whereMeta('color', 'blue');

```

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

### Implement Metable Handler Interface Methods (PHP)

Source: https://github.com/plank/laravel-metable/blob/master/UPGRADING.md

Custom data type handlers must implement new methods from the `HandlerInterface`. `getNumericValue()` is for populating indexed numeric search columns, returning `null` if not applicable. `useHmacVerification()` should return `true` if HMAC verification is needed for data integrity.

```PHP
namespace App\Metable\Handlers;

use Plank\Metable\Contracts\Handler\HandlerInterface;

class MyCustomHandler implements HandlerInterface
{
    // ... existing methods

    public function getNumericValue(): ?float
    {
        // Return a numeric representation or null
        return (float) $this->value;
    }

    public function useHmacVerification(): bool
    {
        // Return true if HMAC verification is required
        return false;
    }

    // ... other methods
}
```

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

### Retrieve Metadata from Eloquent Model

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/intro.rst

This PHP code illustrates how to retrieve a specific piece of metadata from an Eloquent model instance using the getMeta method.

```php
<?php
$value = $post->getMeta('color');

```

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

### Set Meta with Serialized Objects and Arrays

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Illustrates setting meta information with arrays and custom objects, which are serialized using PHP's `serialize()` function and cryptographically signed.

```PHP
<?php
$metable->setMeta('data', ['key' => 'value']);
$metable->setMeta('data', new MyValueObject(123));
```

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

### Meta Attribute Operations in Laravel Metable

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Illustrates common operations for managing meta attributes on a Laravel Eloquent model using the Metable package. This includes setting, filling, retrieving, and unsetting meta attributes.

```PHP
$page = new Page();
$page->meta_likes = 5; // equivalent to $page->setMeta('likes', 5);
$page->fill(['meta_approved' => true, 'meta_published_at' => now()]); // equivalent to $page->setManyMeta([...]);
if ($page->meta_likes > 0) {}
unset($page->meta_likes); // equivalent to $page->removeMeta('likes');
```

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

### Compare String Meta Values (Laravel Metable)

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/querying_meta.rst

Use `whereMeta()` for string-based comparisons with operators like '=', '>', 'like'. Values are compared lexicographically. `whereMetaIn()` and `whereMetaNotIn()` check if a value is within a list of options.

```php
<?php
// omit the operator (defaults to '=')
$models = MyModel::whereMeta('status', 'success')->get();

// greater than
$models = MyModel::whereMeta('name', '>', 'M')->get();

// like
$models = MyModel::whereMeta('summary', 'like', 'Once upon a time%')->get();
```

```php
<?php
$models = MyModel::whereMetaIn('country', ['CA', 'US', 'MX'])->get();
$models = MyModel::whereMetaNotIn('currency', ['USD', 'GBP', 'EUR'])->get();
```

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

### Configure Metable Data Types (PHP)

Source: https://github.com/plank/laravel-metable/blob/master/UPGRADING.md

Update the `datatypes` configuration array in your Laravel application to include new handler classes for various data types. The order of handlers is important, especially for `DateTimeImmutableHandler` which must precede `DateTimeHandler`. It's recommended to add `SignedSerializeHandler` as the last handler for catch-all serialization.

```PHP
$config['metable']['datatypes'] = [
    // ... other handlers
    Plank\Metable\DateType\PureEnumHandler::class,
    Plank\Metable\DateType\BackedEnumHandler::class,
    Plank\Metable\DateType\DateTimeImmutableHandler::class, // Must be before DateTimeHandler
    Plank\Metable\DateType\StringableHandler::class,
    // ... potentially other handlers
    Plank\Metable\DateType\SignedSerializeHandler::class, // Recommended catch-all
    // Deprecated handlers (if migrating old data)
    Plank\Metable\DateType\SerializableHandler::class,
    Plank\Metable\DateType\ArrayHandler::class,
    Plank\Metable\DateType\ObjectHandler::class,
];
```

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

### Set Meta with Plain Objects

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Shows how to set meta information with plain objects, which are converted to `stdClass`. The `JsonSerializable` interface can control stored properties.

```PHP
<?php
$metable->setMeta('weight', new Weight(10, 'kg'));
$weight = $metable->getMeta('weight') // stdClass($amount = 10; $unit => 'kg');
```

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

### Attach Metadata to Eloquent Model (PHP)

Source: https://github.com/plank/laravel-metable/blob/master/README.md

Demonstrates how to attach metadata to an Eloquent model instance using the `setMeta` method. This is a core functionality for adding custom attributes to your models.

```PHP
<?php

use App\Post;

// Assuming $this->request->input() provides the necessary data
$post = Post::create($this->request->input());
$post->setMeta('color', 'blue');

```

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

### Retrieve Metadata from Eloquent Model (PHP)

Source: https://github.com/plank/laravel-metable/blob/master/README.md

Illustrates how to retrieve a specific metadata value from an Eloquent model instance using the `getMeta` method. This is useful for accessing previously stored custom data.

```PHP
<?php

// Assuming $post is an instance of a Metable model
$value = $post->getMeta('color');

```

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

### Compare Numeric Meta Values (Laravel Metable)

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/querying_meta.rst

Use numeric query scopes like `whereMetaNumeric()`, `whereMetaInNumeric()`, `whereMetaNotInNumeric()`, `whereMetaBetweenNumeric()`, and `whereMetaNotBetweenNumeric()` for efficient numeric comparisons. These scopes utilize specialized indexes for performance.

```php
<?php
$models = MyModel::whereMetaNumeric('counter', '>', 42)->get();
$models = MyModel::whereMetaInNumeric('http_code', [401, 403])->get();
$models = MyModel::whereMetaNotInNumeric('department', [])->get();
$models = MyModel::whereMetaBetweenNumeric('completed_at', Carbon::yesterday(), Carbon::today())->get();
$models = MyModel::whereMetaNotBetweenNumeric('percentile', 90, 100)->get();
```

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

### Check for Meta Key Presence (Laravel Metable)

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/querying_meta.rst

Use `whereHasMeta()` to retrieve models that have a specific meta key. You can check for a single key or multiple keys. The `whereHasMetaKeys()` method ensures all specified keys are present.

```php
<?php
$models = MyModel::whereHasMeta('notes')->get();
$models = MyModel::whereHasMeta(['queued_at', 'sent_at'])->get();
```

```php
<?php
$models = MyModel::whereHasMetaKeys(['step1', 'step2', 'step3'])->get();
```

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

### Query Eloquent Model by Metadata (PHP)

Source: https://github.com/plank/laravel-metable/blob/master/README.md

Shows how to query Eloquent models based on their attached metadata using the `whereMeta` scope. This allows filtering records based on custom key-value pairs.

```PHP
<?php

// Query for posts where the 'color' metadata is 'blue'
$post = Post::whereMeta('color', 'blue')->get();

```

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

### Compare String Meta Value Ranges (Laravel Metable)

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/querying_meta.rst

Use `whereMetaBetween()` and `whereMetaNotBetween()` to filter models based on a string value falling within a specified range (inclusive).

```php
<?php
$models = MyModel::whereMetaBetween('country_code', 'AD', 'AZ')->get();
$models = MyModel::whereMetaNotBetween('name', 'a', 'm')->get();
```

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

### Retrieve Meta Data from a Model

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Retrieve meta data using the `getMeta()` method with the corresponding key. The returned value will match its stored format. Meta data is cached after retrieval for performance.

```php
$model->setMeta('age', 18);
$model->setMeta('approved', true);
$model->setMeta('accessed_at', Carbon::now());

//reload the model from the database
$model = $model->fresh();

$age = $model->getMeta('age'); //returns an integer
$approved = $model->getMeta('approved'); //returns a boolean
$accessDate = $model->getMeta('accessed_at'); //returns a Carbon instance
```

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

### Sync Meta Data on a Model

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

The `syncMeta()` method replaces all existing meta data with a new set of key-value pairs provided as an associative array or collection. Existing meta is removed before the new data is added.

```php
$model->syncMeta([
    'name' => 'John Doe',
    'age' => 18,
]);
```

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

### Set Default Meta Values

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Provide a default value to `getMeta()` as a second argument, which is returned if the key has no meta set. Alternatively, define a `$defaultMetaValues` property on the model for global defaults.

```php
$model->getMeta('status', 'draft');
```

```php
class ExampleMetable extends Model {
    use Metable;

    protected $defaultMetaValues = [
        'color' => '#000000'
    ];

    //...
}
```

```php
$model->getMeta('color'); // will return '#000000' if not set
$model->getMeta('color', null); // will return null if not set
$model->getMeta('color', '#ffffff'); // will return '#ffffff' if not set
```

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

### Order Models by Meta (Lexicographic and Numeric)

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/querying_meta.rst

Demonstrates ordering Eloquent models by meta values using `orderByMeta` for lexicographic sorting and `orderByMetaNumeric` for numeric sorting. Both methods accept the meta key and a direction ('asc' or 'desc').

```PHP
$models = MyModel::orderByMeta('nickname', 'asc')->get();

// numeric order
$models = MyModel::orderByMetaNumeric('score', 'desc')->get();
```

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

### Access Meta as Attributes in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Shows how to use the MetableAttributes trait to access meta data as if they were model attributes, prefixed with 'meta_'. This enhances IDE support and allows for type hinting and default values.

```PHP
<?php

namespace App;

use PlankMetableMetable;
use PlankMetableMetableAttributes;
use IlluminateDatabaseEloquentModel;

/**
 * @property bool $meta_approved
 * @property \Carbon\Carbon $meta_published_at
 */
class MyModel extends Model {
    use Metable, MetableAttributes;

    // ...
}
```

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

### Set Meta Data on a Model

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Use the `setMeta()` method to attach a single key-value pair to a model. The value can be of various types and will be converted to a string for storage. For multiple entries, use `setManyMeta()` with an associative array.

```php
$model->setMeta('key', 'value');
```

```php
$model->setManyMeta([
    'name' => 'John Doe',
    'age' => 18,
]);
```

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

### Eager Load Meta Relation in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Demonstrates how to eager load the 'meta' relation for Eloquent models to prevent N+1 query problems when working with collections. This includes loading from the query builder and lazy loading from a collection.

```PHP
<?php
$models = MyModel::with('meta')->where(...)->get();
```

```PHP
<?php
$models->load('meta');
```

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

### Refresh Metable Data (Artisan Command)

Source: https://github.com/plank/laravel-metable/blob/master/UPGRADING.md

After applying schema migrations and updating the `datatypes` configuration, run the `metable:refresh` Artisan command. This command updates existing meta values to use the new types and populates the index columns. Deprecated data types can be removed from configuration after this command is executed.

```Shell
php artisan metable:refresh
```

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

### Eloquent Model with Metable Trait

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Demonstrates the integration of the Metable and MetableAttributes traits into a Laravel Eloquent model. It shows how to define meta attribute casting and default values.

```PHP
namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Plank\Metable\Metable;
use Plank\Metable\MetableAttributes;

class Page extends Model
{
    use Metable, MetableAttributes;

    protected $metaCasts = [
        'approved' => 'boolean',
        'published_at' => 'datetime',
        'likes' => 'integer',
    ];

    protected $defaultMetaValues = [
        'approved' => false,
        'published_at' => null,
        'likes' => 0,
    ];

    // ...
}
```

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

### Use Metable Trait in Eloquent Model (PHP)

Source: https://github.com/plank/laravel-metable/blob/master/README.md

Shows how to apply the `PlankMetableMetable` trait to an Eloquent model class to enable metadata functionality. This makes the model capable of using `setMeta`, `getMeta`, and `whereMeta` methods.

```PHP
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Plank\Metable\Metable;

class Post extends Model
{
    use Metable;

    //...
}

```

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

### Order Models by Meta (Excluding Nulls)

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/querying_meta.rst

Shows how to order models by a numeric meta value while excluding records that do not have the specified meta key assigned. This is achieved by passing `true` as the third argument to `orderByMetaNumeric`, which performs an inner join.

```PHP
// sort by score, excluding models which have no score
$model = MyModel::orderByMetaNumeric('score', 'desc', true)->get();

//equivalent to, but more efficient than
$models = MyModel::whereHasMeta('score')
    ->orderByMetaNumeric('score', 'desc')->get();
```

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

### Query for Null Meta Values (Laravel Metable)

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/querying_meta.rst

Use `whereMetaNull()` to retrieve models where a specific meta key has been explicitly set to `null`.

```php
<?php
$models = MyModel::whereMetaNull('notes')->get();
```

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

### Retrieving and Hiding Meta Attributes in Laravel Metable

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Explains how to retrieve all meta attributes using `getMetaAttributes()` and how to hide meta attributes from the model's array representation using `makeMetaHidden()`.

```PHP
// To retrieve all meta values keyed by their attribute name:
$metaValues = $page->getMetaAttributes();

// To hide all currently assigned meta attributes from the array representation:
$page->makeMetaHidden();
```

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

### Implement Custom Data Type Handler in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

This snippet demonstrates the core requirement for adding custom data types to Laravel Metable. You need to create a class that implements the `Plank\Metable\DataType\Handler` interface. This interface dictates methods for handling serialization and deserialization of custom data types, ensuring compatibility with the package's serialization mechanisms.

```PHP
<?php

namespace App\MetableHandlers;

use Plank\Metable\DataType\Handler;

class CustomDateTimeHandler implements Handler
{
    public function canHandleValue($value): bool
    {
        return $value instanceof \DateTime;
    }

    public function serializeValue($value)
    {
        return $value->format('Y-m-d H:i:s');
    }

    public function deserializeValue($value)
    {
        return \DateTime::createFromFormat('Y-m-d H:i:s', $value);
    }
}

```

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

### Set String Meta Value in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Demonstrates setting a string meta value for a Metable model. It supports string query scopes and numeric query scopes if the string is numeric.

```php
<?php
$metable->setMeta('attachment', '/var/www/html/public/attachment.pdf');

```

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

### Check for Meta Key Absence (Laravel Metable)

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/querying_meta.rst

Use `whereDoesntHaveMeta()` to retrieve models that do not have a specific meta key. This method accepts a single key or an array of keys.

```php
<?php 
$models = MyModel::whereDoesntHaveMeta('notes')->get();
$models = MyModel::whereDoesntHaveMeta(['queued_at', 'sent_at'])->get();
```

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

### Retrieve All Meta Data in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Retrieves all meta data associated with a model as a collection of key-value pairs. This method is useful for accessing all custom attributes stored for a model instance.

```PHP
<?php
$meta = $model->getAllMeta();
```

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

### Set DateTime Meta Value in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Shows how to set a DateTime meta value using a Carbon instance. The object will be converted to a Carbon instance upon unserialization and supports string and numeric (timestamp) query scopes.

```php
<?php
$metable->setMeta('last_viewed', \Carbon\Carbon::now());

```

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

### Attach Eloquent Model to Metable in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Shows how to attach an existing Eloquent model to a Metable model. The attached model will be reloaded from the database when retrieved.

```php
<?php
$page = App\Page::where(['title' => 'Welcome'])->first();
$metable->setMeta('linked_model', $page);

```

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

### Attach Eloquent Collection to Metable in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Demonstrates attaching a collection of Eloquent models to a Metable model. Both existing and unsaved model instances can be included in the collection.

```php
<?php
$users = App\User::where(['title' => 'developer'])->get();
$metable->setMeta('authorized', $users);

```

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

### Check for Meta Key Presence in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Checks if a specific meta key has been assigned a value on a model. This method returns true even if the assigned value is 'falsey' (e.g., 0, null, empty string).

```PHP
<?php
if ($model->hasMeta('background-color')) {
    // ...
}
```

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

### Attach Unsaved Eloquent Model to Metable in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Illustrates attaching a new, unsaved Eloquent model instance to a Metable model. A fresh instance will be created upon retrieval.

```php
<?php
$metable->setMeta('related', new App\Page);

```

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

### Set Float Meta Value in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Illustrates setting a float meta value for a Metable model. It supports string and numeric query scopes.

```php
<?php
$metable->setMeta('precision', 0.755);

```

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

### Add MetableAttributes Trait (PHP)

Source: https://github.com/plank/laravel-metable/blob/master/UPGRADING.md

Optionally, to access meta values using property access (e.g., `$model->meta_key`), add the `PlankMetableMetableAttributes` trait to your `Metable` model.

```PHP
namespace App\Models;

use Plank\Metable\Metable;
use Plank\Metable\MetableAttributes;

class YourModel extends Model
{
    use Metable, MetableAttributes;

    // ...
}
```

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

### Add Metable Trait to Eloquent Model

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

To attach meta data to an Eloquent model, you must first include the `Metable` trait in your model class. This enables the meta data functionality.

```php
<?php

namespace App;

use PlankMetableMetable;
use IlluminateDatabaseEloquentModel;

class Page extends Model
{
    use Metable;

    // ...
}
```

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

### Query Meta by Model Reference (Laravel Metable)

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/querying_meta.rst

Use `whereMetaIsModel()` to find models that reference a specific model instance or class. This is useful for querying relationships stored within meta data.

```php
<?php
// find models that reference a particular model ID
$models = MyModel::whereMetaIsModel(AppMyOtherModel::class, $id)->get();
$models = MyModel::whereMetaIsModel($otherModelInstance)->get();

// find models that reference a any instance of a model class
$models = MyModel::whereMetaIsModel(AppMyOtherModel::class)->get();
```

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

### Always Eager Load Meta in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Configures a model to always eager load the 'meta' relationship by adding 'meta' to the model's $with property. This ensures the meta relation is loaded automatically whenever the model is retrieved.

```PHP
<?php

class MyModel extends Model {
    use Metable;

    protected $with = ['meta'];
}
```

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

### Encrypt Meta Data

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Sensitive meta data can be encrypted using `setMetaEncrypted()` or by passing `true` as the third argument to `setMeta()`. Encrypted values are automatically decrypted upon retrieval but are not searchable or sortable via query scopes.

```php
$model->setMetaEncrypted('secret', 'sensitive data');
```

```php
$model->setMeta('secret', 'sensitive data', true);
```

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

### Define Meta Casts in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Defines the meta data casting behavior for Eloquent models. It specifies how different attributes should be cast, such as boolean, integer, encrypted strings, model classes, or collections. This configuration ensures data integrity and proper serialization.

```PHP
protected function metaCasts(): array
{
    return [
        'optin' => 'boolean',
        'age' => 'integer',
        'secret' => 'encrypted:string',
        'parent' => ExampleMetable::class,
        'children' => 'collection:\App\ExampleMetable',
    ];
}
```

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

### Define Meta Data Casting

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Enforce data types for meta attributes by defining a `$metaCasts` property or a `metaCasts()` method on the model. This ensures meta values are always of the specified type upon retrieval.

```php
class ExampleMetable extends Model {
    use Metable;

    protected $metaCasts = [
        'optin' => 'boolean',
        'age' => 'integer',
        'secret' => 'encrypted:string',
        'parent' => ExampleMetable::class,

```

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

### Remove Multiple Meta Keys in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Removes multiple meta data entries from a model by providing an array of keys. This allows for batch deletion of meta information.

```PHP
<?php
$model->removeManyMeta([
    'preferred_language',
    'store_currency',
    'user_timezone',
]);
```

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

### Set Boolean Meta Value in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Demonstrates how to set a boolean meta value for a Metable model using the setMeta method. This data type supports both string and numeric query scopes.

```php
<?php
$metable->setMeta('accepted_promotion', true);

```

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

### Purge All Meta Data in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Removes all meta data entries associated with a model. This action effectively clears all custom attributes stored for the model instance.

```PHP
<?php
$model->purgeMeta();
```

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

### Set Integer Meta Value in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Shows how to set an integer meta value for a Metable model. This type supports string and numeric query scopes for filtering.

```php
<?php
$metable->setMeta('likes', 9001);

```

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

### Set DateTimeImmutable Meta Value in Laravel

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/datatypes.rst

Illustrates setting a DateTimeImmutable meta value using a CarbonImmutable instance. It supports string and numeric (timestamp) query scopes and converts to CarbonImmutable upon unserialization.

```php
<?php
$metable->setMeta('completed_at', \Carbon\CarbonImmutable::now());

```

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

### Remove Single Meta Key in PHP

Source: https://github.com/plank/laravel-metable/blob/master/docs/source/handling_meta.rst

Removes a single meta data entry from a model using its key. This operation deletes the specified meta key and its associated value.

```PHP
<?php
$model->removeMeta('preferred_language');
```
Tokens:
Raw