Skip to content

Latest commit

 

History

History
303 lines (202 loc) · 7.46 KB

SingleEntitySearchOperation.md

File metadata and controls

303 lines (202 loc) · 7.46 KB

BumbleDocGen / Technical description of the project / Class map / SingleEntitySearchOperation


namespace BumbleDocGen\Core\Parser\Entity\CollectionLogOperation;

final class SingleEntitySearchOperation implements \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationInterface

Initialization methods:

  1. __construct

Methods:

  1. call
  2. getArgs
  3. getArgsHash
  4. getEntityName
  5. getFunctionName
  6. getKey
  7. getRequestedEntityName
  8. incrementUsageCount

Method details:

public function __construct(string $functionName, array $args, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface|null $entity);

Parameters:

Name Type Description
$functionName string -
$args array -
$entity \BumbleDocGen\Core\Parser\Entity\RootEntityInterface | null -

public function call(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface|null;

Parameters:

Name Type Description
$rootEntityCollection \BumbleDocGen\Core\Parser\Entity\RootEntityCollection -

Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface | null


public function getArgs(): array;

Parameters: not specified

Return value: array


public function getArgsHash(): string;

Parameters: not specified

Return value: string


public function getEntityName(): string|null;

Parameters: not specified

Return value: string | null


public function getFunctionName(): string;

Parameters: not specified

Return value: string


public function getKey(): string;

Parameters: not specified

Return value: string


public function getRequestedEntityName(): string;

Parameters: not specified

Return value: string


public function incrementUsageCount(): void;

Parameters: not specified

Return value: void