1. interface
  2. Hypervel
  3. \
  4. Data
  5. \
  6. Contracts
  7. \
  8. IncludeableData

IncludeableData

interface IncludeableData

Methods

object
include(string ...$includes)

Include the given properties.

object
includePermanently(string ...$includes)

Include the given properties for every transformation.

object
exclude(string ...$excludes)

Exclude the given properties.

object
excludePermanently(string ...$excludes)

Exclude the given lazy properties for every transformation.

object
only(string ...$only)

Include only the given properties.

object
onlyPermanently(string ...$only)

Include only the given properties for every transformation.

object
except(string ...$except)

Include every property except the given properties.

object
exceptPermanently(string ...$except)

Exclude the given properties for every transformation.

object
includeWhen(string $include, bool|Closure $condition, bool $permanent = false)

Include a property when the condition passes.

object
excludeWhen(string $exclude, bool|Closure $condition, bool $permanent = false)

Exclude a property when the condition passes.

object
onlyWhen(string $only, bool|Closure $condition, bool $permanent = false)

Include only a property when the condition passes.

object
exceptWhen(string $except, bool|Closure $condition, bool $permanent = false)

Exclude a property when the condition passes.

bool
hasPartialsDefinition()

Determine whether this object has partial definitions.

PartialsDefinition
getPartialsDefinition()

Get the current partial definitions.

Details

at line 15
object include(string ...$includes)

Include the given properties.

Parameters

string ...$includes

Return Value

object

at line 20
object includePermanently(string ...$includes)

Include the given properties for every transformation.

Parameters

string ...$includes

Return Value

object

at line 25
object exclude(string ...$excludes)

Exclude the given properties.

Parameters

string ...$excludes

Return Value

object

at line 30
object excludePermanently(string ...$excludes)

Exclude the given lazy properties for every transformation.

Parameters

string ...$excludes

Return Value

object

at line 35
object only(string ...$only)

Include only the given properties.

Parameters

string ...$only

Return Value

object

at line 40
object onlyPermanently(string ...$only)

Include only the given properties for every transformation.

Parameters

string ...$only

Return Value

object

at line 45
object except(string ...$except)

Include every property except the given properties.

Parameters

string ...$except

Return Value

object

at line 50
object exceptPermanently(string ...$except)

Exclude the given properties for every transformation.

Parameters

string ...$except

Return Value

object

at line 55
object includeWhen(string $include, bool|Closure $condition, bool $permanent = false)

Include a property when the condition passes.

Parameters

string $include
bool|Closure $condition
bool $permanent

Return Value

object

at line 60
object excludeWhen(string $exclude, bool|Closure $condition, bool $permanent = false)

Exclude a property when the condition passes.

Parameters

string $exclude
bool|Closure $condition
bool $permanent

Return Value

object

at line 65
object onlyWhen(string $only, bool|Closure $condition, bool $permanent = false)

Include only a property when the condition passes.

Parameters

string $only
bool|Closure $condition
bool $permanent

Return Value

object

at line 70
object exceptWhen(string $except, bool|Closure $condition, bool $permanent = false)

Exclude a property when the condition passes.

Parameters

string $except
bool|Closure $condition
bool $permanent

Return Value

object

at line 75
bool hasPartialsDefinition()

Determine whether this object has partial definitions.

Return Value

bool

at line 80
PartialsDefinition getPartialsDefinition()

Get the current partial definitions.

Return Value

PartialsDefinition