1. class
  2. Illuminate
  3. \
  4. Log
  5. \
  6. Context
  7. \
  8. Repository

Repository

class Repository (View source)

Traits

Conditionable
Macroable
SerializesModels
SerializesAndRestoresModelIdentifiers

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected Dispatcher $events

The event dispatcher instance.
protected array<string,mixed> $data

The contextual data.
protected array<string,mixed> $hidden

The hidden contextual data.
static protected callable|null $handleUnserializeExceptionsUsing

The callback that should handle unserialize exceptions.

Methods

$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)

Get the property value prepared for serialization.

from  SerializesAndRestoresModelIdentifiers
mixed
getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

from  SerializesAndRestoresModelIdentifiers
Collection
restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

from  SerializesAndRestoresModelIdentifiers
Model
restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

from  SerializesAndRestoresModelIdentifiers
TModel>
getQueryForModelRestoration(TModel $model, array|int $ids)

Get the query for model restoration.

from  SerializesAndRestoresModelIdentifiers
array
__serialize()

Prepare the instance values for serialization.

from  SerializesModels
void
__unserialize(array $values)

Restore the model after serialization.

from  SerializesModels
mixed
getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

from  SerializesModels
__construct(Dispatcher $events)

Create a new Context instance.

bool
has(string $key)

Determine if the given key exists.

bool
missing(string $key)

Determine if the given key is missing.

bool
hasHidden(string $key)

Determine if the given key exists within the hidden context data.

bool
missingHidden(string $key)

Determine if the given key is missing within the hidden context data.

array<string,mixed>
all()

Retrieve all the context data.

array<string,mixed>
allHidden()

Retrieve all the hidden context data.

mixed
get(string $key, mixed $default = null)

Retrieve the given key's value.

mixed
getHidden(string $key, mixed $default = null)

Retrieve the given key's hidden value.

mixed
pull(string $key, mixed $default = null)

Retrieve the given key's value and then forget it.

mixed
pullHidden(string $key, mixed $default = null)

Retrieve the given key's hidden value and then forget it.

array<string,mixed>
only(array<int,string> $keys)

Retrieve only the values of the given keys.

array<string,mixed>
onlyHidden(array<int,string> $keys)

Retrieve only the hidden values of the given keys.

$this
add(string|array<string,mixed> $key, mixed $value = null)

Add a context value.

$this
addHidden(string|array<string,mixed> $key, mixed $value = null)

Add a hidden context value.

$this
forget(string|array<int,string> $key)

Forget the given context key.

$this
forgetHidden(string|array<int,string> $key)

Forget the given hidden context key.

$this
addIf(string $key, mixed $value)

Add a context value if it does not exist yet.

$this
addHiddenIf(string $key, mixed $value)

Add a hidden context value if it does not exist yet.

$this
push(string $key, mixed ...$values)

Push the given values onto the key's stack.

mixed
pop(string $key)

Pop the latest value from the key's stack.

$this
pushHidden(string $key, mixed ...$values)

Push the given hidden values onto the key's stack.

mixed
popHidden(string $key)

Pop the latest hidden value from the key's stack.

$this
increment(string $key, int $amount = 1)

Increment a context counter.

$this
decrement(string $key, int $amount = 1)

Decrement a context counter.

bool
stackContains(string $key, mixed $value, bool $strict = false)

Determine if the given value is in the given stack.

bool
hiddenStackContains(string $key, mixed $value, bool $strict = false)

Determine if the given value is in the given hidden stack.

bool
isStackable(string $key)

Determine if a given key can be used as a stack.

bool
isHiddenStackable(string $key)

Determine if a given key can be used as a hidden stack.

mixed
scope(callable $callback, array $data = [], array $hidden = [])

Run the callback function with the given context values and restore the original context state when complete.

bool
isEmpty()

Determine if the repository is empty.

$this
dehydrating(callable $callback)

Execute the given callback when context is about to be dehydrated.

$this
hydrated(callable $callback)

Execute the given callback when context has been hydrated.

Repository
handleUnserializeExceptionsUsing(callable|null $callback)

Handle unserialize exceptions using the given callback.

$this
flush()

Flush all context data.

?array
dehydrate()

Dehydrate the context data.

$this
hydrate(?array $context)

Hydrate the context instance.

Details

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in SerializesAndRestoresModelIdentifiers at line 22
protected mixed getSerializedPropertyValue(mixed $value, bool $withRelations = true)

Get the property value prepared for serialization.

Parameters

mixed $value
bool $withRelations

Return Value

mixed

in SerializesAndRestoresModelIdentifiers at line 55
protected mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

Parameters

mixed $value

Return Value

mixed

in SerializesAndRestoresModelIdentifiers at line 72
protected Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

Parameters

ModelIdentifier $value

Return Value

Collection

in SerializesAndRestoresModelIdentifiers at line 106
Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

Parameters

ModelIdentifier $value

Return Value

Model

in SerializesAndRestoresModelIdentifiers at line 122
protected TModel> getQueryForModelRestoration(TModel $model, array|int $ids)

Get the query for model restoration.

Parameters

TModel $model
array|int $ids

Return Value

TModel>

in SerializesModels at line 18
array __serialize()

Prepare the instance values for serialization.

Return Value

array

in SerializesModels at line 69
void __unserialize(array $values)

Restore the model after serialization.

Parameters

array $values

Return Value

void

in SerializesModels at line 104
protected mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

Parameters

ReflectionProperty $property

Return Value

mixed

at line 53
__construct(Dispatcher $events)

Create a new Context instance.

Parameters

Dispatcher $events

at line 64
bool has(string $key)

Determine if the given key exists.

Parameters

string $key

Return Value

bool

at line 75
bool missing(string $key)

Determine if the given key is missing.

Parameters

string $key

Return Value

bool

at line 86
bool hasHidden(string $key)

Determine if the given key exists within the hidden context data.

Parameters

string $key

Return Value

bool

at line 97
bool missingHidden(string $key)

Determine if the given key is missing within the hidden context data.

Parameters

string $key

Return Value

bool

at line 107
array<string,mixed> all()

Retrieve all the context data.

Return Value

array<string,mixed>

at line 117
array<string,mixed> allHidden()

Retrieve all the hidden context data.

Return Value

array<string,mixed>

at line 129
mixed get(string $key, mixed $default = null)

Retrieve the given key's value.

Parameters

string $key
mixed $default

Return Value

mixed

at line 141
mixed getHidden(string $key, mixed $default = null)

Retrieve the given key's hidden value.

Parameters

string $key
mixed $default

Return Value

mixed

at line 153
mixed pull(string $key, mixed $default = null)

Retrieve the given key's value and then forget it.

Parameters

string $key
mixed $default

Return Value

mixed

at line 167
mixed pullHidden(string $key, mixed $default = null)

Retrieve the given key's hidden value and then forget it.

Parameters

string $key
mixed $default

Return Value

mixed

at line 180
array<string,mixed> only(array<int,string> $keys)

Retrieve only the values of the given keys.

Parameters

array<int,string> $keys

Return Value

array<string,mixed>

at line 191
array<string,mixed> onlyHidden(array<int,string> $keys)

Retrieve only the hidden values of the given keys.

Parameters

array<int,string> $keys

Return Value

array<string,mixed>

at line 203
$this add(string|array<string,mixed> $key, mixed $value = null)

Add a context value.

Parameters

string|array<string,mixed> $key
mixed $value

Return Value

$this

at line 220
$this addHidden(string|array<string,mixed> $key, mixed $value = null)

Add a hidden context value.

Parameters

string|array<string,mixed> $key
mixed $value

Return Value

$this

at line 236
$this forget(string|array<int,string> $key)

Forget the given context key.

Parameters

string|array<int,string> $key

Return Value

$this

at line 251
$this forgetHidden(string|array<int,string> $key)

Forget the given hidden context key.

Parameters

string|array<int,string> $key

Return Value

$this

at line 267
$this addIf(string $key, mixed $value)

Add a context value if it does not exist yet.

Parameters

string $key
mixed $value

Return Value

$this

at line 283
$this addHiddenIf(string $key, mixed $value)

Add a hidden context value if it does not exist yet.

Parameters

string $key
mixed $value

Return Value

$this

at line 301
$this push(string $key, mixed ...$values)

Push the given values onto the key's stack.

Parameters

string $key
mixed ...$values

Return Value

$this

Exceptions

RuntimeException

at line 323
mixed pop(string $key)

Pop the latest value from the key's stack.

Parameters

string $key

Return Value

mixed

Exceptions

RuntimeException

at line 341
$this pushHidden(string $key, mixed ...$values)

Push the given hidden values onto the key's stack.

Parameters

string $key
mixed ...$values

Return Value

$this

Exceptions

RuntimeException

at line 363
mixed popHidden(string $key)

Pop the latest hidden value from the key's stack.

Parameters

string $key

Return Value

mixed

Exceptions

RuntimeException

at line 379
$this increment(string $key, int $amount = 1)

Increment a context counter.

Parameters

string $key
int $amount

Return Value

$this

at line 396
$this decrement(string $key, int $amount = 1)

Decrement a context counter.

Parameters

string $key
int $amount

Return Value

$this

at line 411
bool stackContains(string $key, mixed $value, bool $strict = false)

Determine if the given value is in the given stack.

Parameters

string $key
mixed $value
bool $strict

Return Value

bool

Exceptions

RuntimeException

at line 438
bool hiddenStackContains(string $key, mixed $value, bool $strict = false)

Determine if the given value is in the given hidden stack.

Parameters

string $key
mixed $value
bool $strict

Return Value

bool

Exceptions

RuntimeException

at line 461
protected bool isStackable(string $key)

Determine if a given key can be used as a stack.

Parameters

string $key

Return Value

bool

at line 473
protected bool isHiddenStackable(string $key)

Determine if a given key can be used as a hidden stack.

Parameters

string $key

Return Value

bool

at line 487
mixed scope(callable $callback, array $data = [], array $hidden = [])

Run the callback function with the given context values and restore the original context state when complete.

Parameters

callable $callback
array $data
array $hidden

Return Value

mixed

at line 513
bool isEmpty()

Determine if the repository is empty.

Return Value

bool

at line 524
$this dehydrating(callable $callback)

Execute the given callback when context is about to be dehydrated.

Parameters

callable $callback

Return Value

$this

at line 537
$this hydrated(callable $callback)

Execute the given callback when context has been hydrated.

Parameters

callable $callback

Return Value

$this

at line 550
Repository handleUnserializeExceptionsUsing(callable|null $callback)

Handle unserialize exceptions using the given callback.

Parameters

callable|null $callback

Return Value

Repository

at line 562
$this flush()

Flush all context data.

Return Value

$this

at line 577
?array dehydrate()

internal  
 

Dehydrate the context data.

Return Value

?array

at line 603
$this hydrate(?array $context)

internal  
 

Hydrate the context instance.

Parameters

?array $context

Return Value

$this

Exceptions

RuntimeException