Skip to content

Latest commit

 

History

History
220 lines (149 loc) · 5.42 KB

PrintEntityCollectionAsList.md

File metadata and controls

220 lines (149 loc) · 5.42 KB

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

PrintEntityCollectionAsList class: 

namespace BumbleDocGen\Core\Renderer\Twig\Function;

final class PrintEntityCollectionAsList implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
Outputting entity data as HTML list

Examples of using:

{{ printEntityCollectionAsList(phpClassEntityCollection.filterByInterfaces(['ScriptFramework\\ScriptInterface', 'ScriptFramework\\TestScriptInterface'])) }}
The function will output a list of PHP classes that match the ScriptFramework\ScriptInterface and ScriptFramework\TestScriptInterface interfaces
{{ printEntityCollectionAsList(phpClassEntityCollection) }}
The function will list all documented PHP classes

Settings:

Function name: printEntityCollectionAsList

Initialization methods:

  1. __construct

Methods:

  1. __invoke
  2. getName
  3. getOptions

Method details:

public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction);

Parameters:

Name Type Description
$getDocumentedEntityUrlFunction \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl - 
public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $type = 'ul', bool $skipDescription = false, bool $useFullName = false): string;

Parameters:

Name Type Description
$rootEntityCollection \BumbleDocGen\Core\Parser\Entity\RootEntityCollection Processed entity collection
$type string List tag type (
    /
      )
$skipDescription bool Don't print description of this entities
$useFullName bool Use the full name of the entity in the list

Return value: string

Throws:

public static function getName(): string;

Parameters: not specified

Return value: string

public static function getOptions(): array;

Parameters: not specified

Return value: array