Repository
class Repository (View source)
Traits
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. |
|
| $hidden | The hidden contextual data. |
||
| static protected callable|null | $handleUnserializeExceptionsUsing | The callback that should handle unserialize exceptions. |
Methods
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Get the property value prepared for serialization.
Get the restored property value after deserialization.
Get the query for model restoration.
Determine if the given key exists.
Determine if the given key exists within the hidden context data.
Retrieve all the context data.
Retrieve all the hidden context data.
Retrieve the given key's value.
Retrieve the given key's hidden value.
Retrieve the given key's value and then forget it.
Retrieve the given key's hidden value and then forget it.
Retrieve only the values of the given keys.
Retrieve only the hidden values of the given keys.
Add a context value.
Add a hidden context value.
Forget the given context key.
Forget the given hidden context key.
Add a context value if it does not exist yet.
Add a hidden context value if it does not exist yet.
Push the given values onto the key's stack.
Pop the latest value from the key's stack.
Push the given hidden values onto the key's stack.
Pop the latest hidden value from the key's stack.
Determine if the given value is in the given stack.
Determine if the given value is in the given hidden stack.
Determine if a given key can be used as a stack.
Determine if a given key can be used as a hidden stack.
Determine if the repository is empty.
Execute the given callback when context is about to be dehydrated.
Execute the given callback when context has been hydrated.
Handle unserialize exceptions using the given callback.
Flush all context data.
Dehydrate the context data.
Hydrate the context instance.
Details
$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.
$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.
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
protected mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Get the property value prepared for serialization.
protected mixed
getRestoredPropertyValue(mixed $value)
Get the restored property value after deserialization.
protected Collection
restoreCollection(ModelIdentifier $value)
Restore a queueable collection instance.
Model
restoreModel(ModelIdentifier $value)
Restore the model from the model identifier instance.
protected TModel>
getQueryForModelRestoration(TModel $model, array|int $ids)
Get the query for model restoration.
array
__serialize()
Prepare the instance values for serialization.
void
__unserialize(array $values)
Restore the model after serialization.
protected mixed
getPropertyValue(ReflectionProperty $property)
Get the property value for the given property.
__construct(Dispatcher $events)
Create a new Context instance.
bool
has(string $key)
Determine if the given key exists.
bool
hasHidden(string $key)
Determine if the given key exists 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.
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.
protected bool
isStackable(string $key)
Determine if a given key can be used as a stack.
protected bool
isHiddenStackable(string $key)
Determine if a given key can be used as a hidden stack.
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()
| internal |
Dehydrate the context data.
$this
hydrate(?array $context)
| internal |
Hydrate the context instance.