BumbleDocGen / Technical description of the project / Class map
Directory layout ( only documented files shown ):
└──src/ │ ├──AI/ │ │ ├──Console/ │ │ │ ├── AddDocBlocksCommand.php — Base class for all commands. │ │ │ └── GenerateReadMeTemplateCommand.php — Base class for all commands. │ │ ├──Generators/ │ │ │ ├── DocBlocksGenerator.php │ │ │ └── ReadmeTemplateGenerator.php │ │ ├──Providers/ │ │ │ └──OpenAI/ │ │ │ │ └── Provider.php │ │ ├──Traits/ │ │ │ └── SharedCommandLogicTrait.php │ │ ├── ProviderFactory.php │ │ └── ProviderInterface.php │ ├──Console/ │ │ ├──Command/ │ │ │ ├── AdditionalCommandCollection.php │ │ │ ├── BaseCommand.php — Base class for all commands. │ │ │ ├── ConfigurationCommand.php — Base class for all commands. │ │ │ └── GenerateCommand.php — Base class for all commands. │ │ ├──ProgressBar/ │ │ │ ├── ProgressBarFactory.php │ │ │ └── StylizedProgressBar.php │ │ └── App.php — An Application is the container for a collection of commands. │ ├──Core/ │ │ ├──Cache/ │ │ │ ├──LocalCache/ │ │ │ │ ├──Exception/ │ │ │ │ │ └── ObjectNotFoundException.php — Exception is the base class for all Exceptions. │ │ │ │ └── LocalObjectCache.php │ │ │ ├── EntityCacheItemPool.php │ │ │ ├── SharedCompressedDocumentFileCache.php │ │ │ └── SourceLocatorCacheItemPool.php │ │ ├──Configuration/ │ │ │ ├──Exception/ │ │ │ │ └── InvalidConfigurationParameterException.php — Exception is the base class for all Exceptions. │ │ │ ├──ValueResolver/ │ │ │ │ ├── ArgvValueResolver.php — We supplement the values by replacing the shortcodes with real values by the arguments passed to ... │ │ │ │ ├── InternalValueResolver.php — We supplement the values by replacing the shortcodes with real values by internalValuesMap │ │ │ │ ├── RefValueResolver.php — We supplement the values by replacing the shortcodes with real values by the configuration key │ │ │ │ └── ValueResolverInterface.php — Class interface to resolve value from config file │ │ │ ├──ValueTransformer/ │ │ │ │ ├── ValueToClassTransformer.php — Standard text-to-class transformer │ │ │ │ └── ValueTransformerInterface.php — Interface defining classes that transform text configuration values into objects │ │ │ ├── Configuration.php — Configuration project documentation │ │ │ ├── ConfigurationKey.php │ │ │ └── ConfigurationParameterBag.php — Wrapper for getting raw configuration file data │ │ ├──Logger/ │ │ │ └──Handler/ │ │ │ │ └── GenerationErrorsHandler.php — Base Handler class providing the Handler structure, including processors and formatters │ │ ├──Parser/ │ │ │ ├──Entity/ │ │ │ │ ├──Cache/ │ │ │ │ │ ├──CacheKey/ │ │ │ │ │ │ ├── CacheKeyGeneratorInterface.php │ │ │ │ │ │ ├── DefaultCacheKeyGenerator.php │ │ │ │ │ │ └── RendererContextCacheKeyGenerator.php │ │ │ │ │ ├── CacheableEntityInterface.php │ │ │ │ │ ├── CacheableEntityTrait.php │ │ │ │ │ ├── CacheableEntityWrapperFactory.php │ │ │ │ │ ├── CacheableEntityWrapperTrait.php │ │ │ │ │ ├── CacheableMethod.php │ │ │ │ │ └── EntityCacheStorageHelper.php │ │ │ │ ├──CollectionLogOperation/ │ │ │ │ │ ├── CloneOperation.php │ │ │ │ │ ├── IterateEntitiesOperation.php │ │ │ │ │ ├── OperationInterface.php │ │ │ │ │ ├── OperationsCollection.php │ │ │ │ │ └── SingleEntitySearchOperation.php │ │ │ │ ├── BaseEntityCollection.php │ │ │ │ ├── EntityInterface.php │ │ │ │ ├── LoggableRootEntityCollection.php │ │ │ │ ├── RootEntityCollection.php │ │ │ │ ├── RootEntityCollectionsGroup.php │ │ │ │ └── RootEntityInterface.php — Since the documentation generator supports several programming languages, their entities need to ... │ │ │ ├──FilterCondition/ │ │ │ │ ├──CommonFilterCondition/ │ │ │ │ │ ├── FalseCondition.php — False conditions, any object is not available │ │ │ │ │ ├── FileTextContainsCondition.php — Checking if a file contains a substring │ │ │ │ │ ├── LocatedInCondition.php — Checking the existence of an entity in the specified directories │ │ │ │ │ ├── LocatedNotInCondition.php — Checking the existence of an entity not in the specified directories │ │ │ │ │ └── TrueCondition.php — True conditions, any object is available │ │ │ │ ├── ConditionGroup.php — Filter condition to group other filter conditions. A group can have an OR/AND condition test; In ... │ │ │ │ ├── ConditionGroupTypeEnum.php │ │ │ │ └── ConditionInterface.php │ │ │ ├──SourceLocator/ │ │ │ │ ├── BaseSourceLocator.php │ │ │ │ ├── DirectoriesSourceLocator.php — Loads all files from the specified directory │ │ │ │ ├── FileIteratorSourceLocator.php — Loads all files using an iterator │ │ │ │ ├── RecursiveDirectoriesSourceLocator.php — Loads all files from the specified directories, which are traversed recursively │ │ │ │ ├── SingleFileSourceLocator.php — Loads one specific file by its path │ │ │ │ ├── SourceLocatorInterface.php │ │ │ │ └── SourceLocatorsCollection.php │ │ │ └── ProjectParser.php — Entity for project parsing using source locators │ │ ├──Plugin/ │ │ │ ├──CorePlugin/ │ │ │ │ ├──LastPageCommitter/ │ │ │ │ │ └── LastPageCommitter.php — Plugin for adding a block with information about the last commit and date of page update to the g... │ │ │ │ └──PageLinker/ │ │ │ │ │ ├── BasePageLinker.php │ │ │ │ │ ├── PageHtmlLinkerPlugin.php — Adds URLs to empty links in HTML format; Links may contain: 1) Short entity name 2) Full entity n... │ │ │ │ │ ├── PageLinkerPlugin.php — Adds URLs to empty links in HTML format; Links may contain: 1) Short entity name 2) Full entity n... │ │ │ │ │ └── PageRstLinkerPlugin.php — Adds URLs to empty links in rst format; Links may contain: 1) Short entity name 2) Full entity na... │ │ │ ├──Event/ │ │ │ │ ├──Parser/ │ │ │ │ │ └── OnLoadSourceLocatorsCollection.php — Called when source locators are loaded │ │ │ │ └──Renderer/ │ │ │ │ │ ├── AfterRenderingEntities.php — Event is the base class for classes containing event data. │ │ │ │ │ ├── BeforeCreatingDocFile.php — Called before the content of the documentation document is saved to a file │ │ │ │ │ ├── BeforeRenderingDocFiles.php — The event occurs before the main documents begin rendering │ │ │ │ │ ├── BeforeRenderingEntities.php — The event occurs before the rendering of entity documents begins, after the main documents have b... │ │ │ │ │ ├── OnCreateDocumentedEntityWrapper.php — The event occurs when an entity is added to the list for documentation │ │ │ │ │ ├── OnGetProjectTemplatesDirs.php — This event occurs when all directories containing document templates are retrieved │ │ │ │ │ ├── OnGetTemplatePathByRelativeDocPath.php — The event occurs when the path to the template file is obtained relative to the path to the document │ │ │ │ │ ├── OnGettingResourceLink.php — Event occurs when a reference to an entity (resource) is received │ │ │ │ │ └── OnLoadEntityDocPluginContent.php — Called when entity documentation is generated (plugin content loading) │ │ │ ├── OnlySingleExecutionEvent.php │ │ │ ├── PluginEventDispatcher.php — The EventDispatcherInterface is the central point of Symfony's event listener system. │ │ │ ├── PluginInterface.php │ │ │ └── PluginsCollection.php │ │ └──Renderer/ │ │ │ ├──Breadcrumbs/ │ │ │ │ ├── BreadcrumbsHelper.php — Helper entity for working with breadcrumbs │ │ │ │ └── BreadcrumbsTwigEnvironment.php │ │ │ ├──Context/ │ │ │ │ ├──Dependency/ │ │ │ │ │ ├── DirectoryDependency.php │ │ │ │ │ ├── FileDependency.php │ │ │ │ │ ├── RendererDependencyFactory.php │ │ │ │ │ └── RendererDependencyInterface.php │ │ │ │ ├── DocumentTransformableEntityInterface.php — Interface for entities that can be generated into documents │ │ │ │ ├── DocumentedEntityWrapper.php — Wrapper for the entity that was requested for documentation │ │ │ │ ├── DocumentedEntityWrappersCollection.php │ │ │ │ └── RendererContext.php — Document rendering context │ │ │ ├──EntityDocRenderer/ │ │ │ │ ├── EntityDocRendererInterface.php — Entity documentation renderer interface │ │ │ │ └── EntityDocRenderersCollection.php │ │ │ ├──PageLinkProcessor/ │ │ │ │ ├── BasePageLinkProcessor.php │ │ │ │ ├── GithubPagesLinkProcessor.php │ │ │ │ └── PageLinkProcessorInterface.php │ │ │ ├──Twig/ │ │ │ │ ├──Filter/ │ │ │ │ │ ├── AddIndentFromLeft.php — Filter adds indent from left │ │ │ │ │ ├── CustomFilterInterface.php │ │ │ │ │ ├── CustomFiltersCollection.php │ │ │ │ │ ├── FixStrSize.php — The filter pads the string with the specified characters on the right to the specified size │ │ │ │ │ ├── PregMatch.php — Perform a regular expression match │ │ │ │ │ ├── PrepareSourceLink.php — The filter converts the string into an anchor that can be used in a GitHub document link │ │ │ │ │ ├── Quotemeta.php — Quote meta characters │ │ │ │ │ ├── RemoveLineBrakes.php — The filter replaces all line breaks with a space │ │ │ │ │ ├── StrTypeToUrl.php — The filter converts the string with the data type into a link to the documented entity, if possible. │ │ │ │ │ ├── TextToCodeBlock.php — Convert text to code block │ │ │ │ │ └── TextToHeading.php — Convert text to html header │ │ │ │ ├──Function/ │ │ │ │ │ ├── CustomFunctionInterface.php │ │ │ │ │ ├── CustomFunctionsCollection.php │ │ │ │ │ ├── DrawDocumentationMenu.php — Generate documentation menu in HTML format. To generate the menu, the start page is taken, and al... │ │ │ │ │ ├── DrawDocumentedEntityLink.php — Creates an entity link by object │ │ │ │ │ ├── FileGetContents.php — Displaying the content of a file or web resource │ │ │ │ │ ├── GeneratePageBreadcrumbs.php — Function to generate breadcrumbs on the page │ │ │ │ │ ├── GetDocumentationPageUrl.php — Creates an entity link by object │ │ │ │ │ ├── GetDocumentedEntityUrl.php — Get the URL of a documented entity by its name. If the entity is found, next to the file where th... │ │ │ │ │ ├── LoadPluginsContent.php — Process entity template blocks with plugins. The method returns the content processed by plugins. │ │ │ │ │ └── PrintEntityCollectionAsList.php — Outputting entity data as HTML list │ │ │ │ ├── MainExtension.php — This is an extension that is used to generate documents from templates │ │ │ │ └── MainTwigEnvironment.php │ │ │ ├── Renderer.php — Generates and processes files from directory TemplatesDir saving them to directory OutputDir │ │ │ ├── RendererHelper.php │ │ │ ├── RendererIteratorFactory.php │ │ │ └── TemplateFile.php │ ├──LanguageHandler/ │ │ ├──Php/ │ │ │ ├──Parser/ │ │ │ │ ├──Entity/ │ │ │ │ │ ├──Cache/ │ │ │ │ │ │ └── CacheablePhpEntityFactory.php │ │ │ │ │ ├──Exception/ │ │ │ │ │ │ └── ReflectionException.php — Exception is the base class for all Exceptions. │ │ │ │ │ ├──Reflection/ │ │ │ │ │ │ └── ReflectorWrapper.php │ │ │ │ │ ├── BaseEntity.php │ │ │ │ │ ├── ClassEntity.php — Class entity │ │ │ │ │ ├── ClassEntityCollection.php — Collection of PHP class entities │ │ │ │ │ ├── ConstantEntity.php — Class constant entity │ │ │ │ │ ├── ConstantEntityCollection.php │ │ │ │ │ ├── DynamicMethodEntity.php — Method obtained by parsing the "method" annotation │ │ │ │ │ ├── MethodEntity.php — Class method entity │ │ │ │ │ ├── MethodEntityCollection.php │ │ │ │ │ ├── MethodEntityInterface.php │ │ │ │ │ ├── PropertyEntity.php — Class property entity │ │ │ │ │ └── PropertyEntityCollection.php │ │ │ │ ├──FilterCondition/ │ │ │ │ │ ├──ClassConstantFilterCondition/ │ │ │ │ │ │ ├── IsPrivateCondition.php — Check is a private constant or not │ │ │ │ │ │ ├── IsProtectedCondition.php — Check is a protected constant or not │ │ │ │ │ │ ├── IsPublicCondition.php — Check is a public constant or not │ │ │ │ │ │ └── VisibilityCondition.php — Constant access modifier check │ │ │ │ │ ├──ClassFilterCondition/ │ │ │ │ │ │ └── VisibilityConditionModifier.php │ │ │ │ │ ├──MethodFilterCondition/ │ │ │ │ │ │ ├── IsPrivateCondition.php — Check is a private method or not │ │ │ │ │ │ ├── IsProtectedCondition.php — Check is a protected method or not │ │ │ │ │ │ ├── IsPublicCondition.php — Check is a public method or not │ │ │ │ │ │ ├── OnlyFromCurrentClassCondition.php — Only methods that belong to the current class (not parent) │ │ │ │ │ │ └── VisibilityCondition.php — Method access modifier check │ │ │ │ │ └──PropertyFilterCondition/ │ │ │ │ │ │ ├── IsPrivateCondition.php — Check is a private property or not │ │ │ │ │ │ ├── IsProtectedCondition.php — Check is a protected property or not │ │ │ │ │ │ ├── IsPublicCondition.php — Check is a public property or not │ │ │ │ │ │ ├── OnlyFromCurrentClassCondition.php — Only properties that belong to the current class (not parent) │ │ │ │ │ │ └── VisibilityCondition.php — Property access modifier check │ │ │ │ ├──SourceLocator/ │ │ │ │ │ ├──Internal/ │ │ │ │ │ │ ├── CachedSourceLocator.php │ │ │ │ │ │ └── SystemAsyncSourceLocator.php │ │ │ │ │ ├── AsyncSourceLocator.php — Lazy loading classes. Cannot be used for initial parsing of files, only for getting specific docu... │ │ │ │ │ └── CustomSourceLocatorInterface.php │ │ │ │ ├── ComposerParser.php │ │ │ │ └── ParserHelper.php │ │ │ ├──Plugin/ │ │ │ │ ├──CorePlugin/ │ │ │ │ │ ├──BasePhpStubber/ │ │ │ │ │ │ ├── BasePhpStubberPlugin.php — Adding links to type documentation and documentation of built-in PHP classes │ │ │ │ │ │ ├── PhpDocumentorStubberPlugin.php — Adding links to the documentation of PHP classes in the \phpDocumentor namespace │ │ │ │ │ │ └── PhpUnitStubberPlugin.php — Adding links to the documentation of PHP classes in the \PHPUnit namespace │ │ │ │ │ ├──ComposerPackagesStubber/ │ │ │ │ │ │ └── StubberPlugin.php — The plugin allows you to automatically provide links to github repositories for documented classe... │ │ │ │ │ └──EntityDocUnifiedPlace/ │ │ │ │ │ │ └── EntityDocUnifiedPlacePlugin.php — This plugin changes the algorithm for saving entity documents. The standard system stores each fi... │ │ │ │ └──Event/ │ │ │ │ │ ├──Entity/ │ │ │ │ │ │ └── OnCheckIsClassEntityCanBeLoad.php — Event is the base class for classes containing event data. │ │ │ │ │ └──Parser/ │ │ │ │ │ │ ├── AfterLoadingClassEntityCollection.php — The event is called after the initial creation of a collection of class entities │ │ │ │ │ │ └── OnAddClassEntityToCollection.php — Called when each class entity is added to the entity collection │ │ │ ├──Renderer/ │ │ │ │ ├──EntityDocRenderer/ │ │ │ │ │ ├──PhpClassToMd/ │ │ │ │ │ │ ├── PhpClassRendererTwigEnvironment.php │ │ │ │ │ │ └── PhpClassToMdDocRenderer.php — Rendering PHP classes into md format documents (for display on GitHub) │ │ │ │ │ └── EntityDocRendererHelper.php │ │ │ │ └──Twig/ │ │ │ │ │ └──Function/ │ │ │ │ │ │ ├── DrawClassMap.php — Generate class map in HTML format │ │ │ │ │ │ └── GetClassMethodsBodyCode.php — Get the code of the specified class methods as a formatted string │ │ │ ├── PhpHandler.php │ │ │ └── PhpHandlerSettings.php │ │ ├── LanguageHandlerInterface.php │ │ └── LanguageHandlersCollection.php │ ├── DocGenerator.php — Class for generating documentation. │ └── DocGeneratorFactory.php
Last page committer: fshcherbanich <[email protected]>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Tue Nov 14 2023
Made with Bumble Documentation Generator