🚀
Model Metadata
  • Introduction V2
  • Requirements
  • Installation
  • Basics
    • Simple Usage
    • HasOneMetadata
      • 😎Use in Model
      • 🎃Create Metadata
      • 🍕Get Metadata
      • ✅Has Metadata
      • 💫Update Metadata
      • ☂️Sync Metadata
      • 💣Delete Metadata
      • 🐙Forget Metadata
    • HasManyMetadata
      • 😐Use in Model
      • 🍔Create Metadata
      • 🍟Get Metadata
      • 🥊Search Metadata
      • 📭Has Metadata
      • 🪭Update Metadata
      • ⛱️Sync Metadata
      • 🪣Delete Metadata
      • 🧽Forget Metadata
Powered by GitBook
On this page
  • 🔥 forgetMetadata
  • 🔥 forgetKeysMetadata
  • 🔥 forgetKeyMetadata
  1. Basics
  2. HasOneMetadata

Forget Metadata

Clear content of metadata make it null, or remove specific keys.

🔥 forgetMetadata

// Syntax
$model->forgetMetadata(): bool

Example Usage


// Forget the metadata
if ($model->forgetMetadata()) {
    echo "Metadata successfully forged";
} else {
    echo "No metadata to forget or forgetting failed";
}


$status = $model->forgetMetadata(); // return boolean
// Will be : []

Return Type ⇒ Boolean


🔥 forgetKeysMetadata

Delete specific values by keys from the metadata field.

// Syntax
$model->forgetKeysMetadata(array|Collection|string|int|null $keys = null): bool

Example Usage


// create metadata
$company->createMetadata(['theme' => 'dark', 'lang' => 'Arabic', 'year' => 1997]);

// Using array keys
$company->forgetKeysMetadata(['theme', 'year']);
// Will become: ['lang' => 'Arabic']

// Using Collection keys
$company->forgetKeysMetadata(collect(['theme', 'year']));

// Using individual key
$company->forgetKeysMetadata('theme');
$company->forgetKeysMetadata(3);   // if metadata list array not associative (keys)
Parameters
Data Types

keys

array, Collection, string, int, null

Return Type ⇒ Boolean


🔥 forgetKeyMetadata

It's an Alias of the `forgetKeysMetadata` method used for forgetting Individual Key

// Syntax
$model->forgetKeyMetadata(string|int|null $key = null): bool

Example usage

$company->forgetKeyMetadata('theme');

$company->forgetKeyMetadata(4);  // if metadata list array not associative (keys)
Parameters
Data Types

key

string, int, null

Return Type ⇒ Boolean

PreviousDelete MetadataNextHasManyMetadata

Last updated 4 months ago

🐙