Skip to content

Latest commit

 

History

History
170 lines (113 loc) · 4.85 KB

LanguageHandlerInterface.md

File metadata and controls

170 lines (113 loc) · 4.85 KB

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

LanguageHandlerInterface class: 

namespace BumbleDocGen\LanguageHandler;

interface LanguageHandlerInterface

Methods:

  1. getCustomTwigFilters - Additional twig filters that are added to the built-in ones when a language handler is included
  2. getCustomTwigFunctions - Additional twig functions that are added to the built-in ones when a language handler is included
  3. getEntityCollection
  4. getLanguageKey - Unique language handler key

Method details:

public function getCustomTwigFilters(\BumbleDocGen\Core\Renderer\Context\RendererContext $context): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
Additional twig filters that are added to the built-in ones when a language handler is included

Parameters:

Name Type Description
$context \BumbleDocGen\Core\Renderer\Context\RendererContext -

Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection

public function getCustomTwigFunctions(\BumbleDocGen\Core\Renderer\Context\RendererContext $context): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
Additional twig functions that are added to the built-in ones when a language handler is included

Parameters:

Name Type Description
$context \BumbleDocGen\Core\Renderer\Context\RendererContext -

Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection

public function getEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;

Parameters: not specified

Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection

public static function getLanguageKey(): string;
Unique language handler key

Parameters: not specified

Return value: string