tflori/orm

» API Reference » ORM\Helper

ORM\Helper

Table of Contents

• Abstract
• Methods
  • Helper::first - Get the first element of $array
  • Helper::getKey - Get the key (defined by $referenced) from $entity
  • Helper::getUniqueKeys - Get a unique list of keys (defined by $reference) from $entities
  • Helper::groupBy -
  • Helper::keyBy - Create an associative array where the key
  • Helper::only -
  • Helper::pluck -
  • Helper::shortName - Gets the short name of a class without creating a Reflection
  • Helper::traitUsesRecursive - Get all traits used by the class and it's parents.
  • Helper::uniqueArrays - Make an array of arrays unique

Abstract

Methods

ORM\Helper::first

public static function first(array $array, mixed $default = null): mixed

Get the first element of $array

Returns $default if the array is empty.

Parameters

ORM\Helper::first

↑ top

ORM\Helper::getKey

public static function getKey(
    array $reference, 
    \ORM\Entity $entity, 
    bool $allowEmpty = true, 
): array|null

Get the key (defined by $referenced) from $entity

Reference defines the mapping of attributes in $entity to attributes in the referenced object.

Example: $entity is an Article and the ‘userId’ references the ‘id’ of the user. Then $reference should be ['userId' => 'id'] and the result will be ['id' => 23]

Parameters

ORM\Helper::getKey

↑ top

ORM\Helper::getUniqueKeys

public static function getUniqueKeys(
    array $reference, 
    \ORM\Entity $entities, 
): array|false

Get a unique list of keys (defined by $reference) from $entities

Parameters

See Also:

• ORM\Helper::getKey

ORM\Helper::getUniqueKeys

↑ top

ORM\Helper::groupBy

public static function groupBy(array $array, mixed $retriever): mixed

Parameters

ORM\Helper::groupBy

↑ top

ORM\Helper::keyBy

public static function keyBy(array $array, mixed $retriever): array|false

Create an associative array where the key

Parameters

ORM\Helper::keyBy

↑ top

ORM\Helper::only

public static function only(array $array, array $keys): mixed

Parameters

ORM\Helper::only

↑ top

ORM\Helper::pluck

public static function pluck(array $array, mixed $retriever): mixed

Parameters

ORM\Helper::pluck

↑ top

ORM\Helper::shortName

public static function shortName(string $class): string

Gets the short name of a class without creating a Reflection

Parameters

ORM\Helper::shortName

↑ top

ORM\Helper::traitUsesRecursive

public static function traitUsesRecursive(
    string $class, 
    bool $withParents = true, 
): string[]

Get all traits used by the class and it’s parents.

Iterates recursively through traits to get traits used by traits.

Parameters

ORM\Helper::traitUsesRecursive

↑ top

ORM\Helper::uniqueArrays

public static function uniqueArrays(array[] $array): array

Make an array of arrays unique

Parameters

ORM\Helper::uniqueArrays

↑ top