diff --git a/.gitignore b/.gitignore index 5cbbce09..3f72cc73 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,5 @@ composer.phar /.phpunit.result.cache /demo/demo2-templates-generation/templates/ /.bumbleDocGenCache/ +/demo/demo5-config-array/docs/ +/demo/demo5-config-array/.cache/ diff --git a/composer.json b/composer.json index 99a4de6d..865e2794 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "bumble-tech/bumble-doc-gen", "description": "Documentation generator next to the code for large and small php projects", - "type": "project", + "type": "library", "license": "Apache-2.0", "keywords": ["documentation-generator", "phpdoc", "cli-tool", "documentation", "docs", "llms", "chatgpt", "php"], "homepage": "https://github.com/bumble-tech/bumble-doc-gen", @@ -31,7 +31,6 @@ "symfony/cache": "^6.0", "symfony/event-dispatcher": "^6.0", "php-di/php-di": "^7.0", - "ocramius/proxy-manager": "~2.0", "symfony/yaml": "^6.0", "hassankhan/config": "^3.1", "tectalic/openai": "^1.5", diff --git a/composer.lock b/composer.lock index d60a87bd..dd65f70b 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "7f5651e61bc501ef3ce91aa575e6ec4b", + "content-hash": "edc0d594bf655060ddb4128634082d53", "packages": [ { "name": "bramus/ansi-php", @@ -240,16 +240,16 @@ }, { "name": "doctrine/deprecations", - "version": "v1.1.1", + "version": "1.1.2", "source": { "type": "git", "url": "https://github.com/doctrine/deprecations.git", - "reference": "612a3ee5ab0d5dd97b7cf3874a6efe24325efac3" + "reference": "4f2d4f2836e7ec4e7a8625e75c6aa916004db931" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/doctrine/deprecations/zipball/612a3ee5ab0d5dd97b7cf3874a6efe24325efac3", - "reference": "612a3ee5ab0d5dd97b7cf3874a6efe24325efac3", + "url": "https://api.github.com/repos/doctrine/deprecations/zipball/4f2d4f2836e7ec4e7a8625e75c6aa916004db931", + "reference": "4f2d4f2836e7ec4e7a8625e75c6aa916004db931", "shasum": "" }, "require": { @@ -281,9 +281,9 @@ "homepage": "https://www.doctrine-project.org/", "support": { "issues": "https://github.com/doctrine/deprecations/issues", - "source": "https://github.com/doctrine/deprecations/tree/v1.1.1" + "source": "https://github.com/doctrine/deprecations/tree/1.1.2" }, - "time": "2023-06-03T09:27:29+00:00" + "time": "2023-09-27T20:04:15+00:00" }, { "name": "doctrine/lexer", @@ -798,72 +798,6 @@ }, "time": "2022-07-25T13:18:36+00:00" }, - { - "name": "laminas/laminas-code", - "version": "4.7.1", - "source": { - "type": "git", - "url": "https://github.com/laminas/laminas-code.git", - "reference": "91aabc066d5620428120800c0eafc0411e441a62" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/laminas/laminas-code/zipball/91aabc066d5620428120800c0eafc0411e441a62", - "reference": "91aabc066d5620428120800c0eafc0411e441a62", - "shasum": "" - }, - "require": { - "php": ">=7.4, <8.2" - }, - "require-dev": { - "doctrine/annotations": "^1.13.2", - "ext-phar": "*", - "laminas/laminas-coding-standard": "^2.3.0", - "laminas/laminas-stdlib": "^3.6.1", - "phpunit/phpunit": "^9.5.10", - "psalm/plugin-phpunit": "^0.17.0", - "vimeo/psalm": "^4.13.1" - }, - "suggest": { - "doctrine/annotations": "Doctrine\\Common\\Annotations >=1.0 for annotation features", - "laminas/laminas-stdlib": "Laminas\\Stdlib component" - }, - "type": "library", - "autoload": { - "files": [ - "polyfill/ReflectionEnumPolyfill.php" - ], - "psr-4": { - "Laminas\\Code\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "description": "Extensions to the PHP Reflection API, static code scanning, and code generation", - "homepage": "https://laminas.dev", - "keywords": [ - "code", - "laminas", - "laminasframework" - ], - "support": { - "chat": "https://laminas.dev/chat", - "docs": "https://docs.laminas.dev/laminas-code/", - "forum": "https://discourse.laminas.dev", - "issues": "https://github.com/laminas/laminas-code/issues", - "rss": "https://github.com/laminas/laminas-code/releases.atom", - "source": "https://github.com/laminas/laminas-code" - }, - "funding": [ - { - "url": "https://funding.communitybridge.org/projects/laminas-project", - "type": "community_bridge" - } - ], - "time": "2022-11-21T01:32:31+00:00" - }, { "name": "laravel/serializable-closure", "version": "v1.3.1", @@ -1028,16 +962,16 @@ }, { "name": "nette/php-generator", - "version": "v4.0.9", + "version": "v4.1.0", "source": { "type": "git", "url": "https://github.com/nette/php-generator.git", - "reference": "72cf9e20686904678d9c1de664c6f7a8c9d676ed" + "reference": "8b728c622c49b196513c0f95508f2f66342d1e8f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/nette/php-generator/zipball/72cf9e20686904678d9c1de664c6f7a8c9d676ed", - "reference": "72cf9e20686904678d9c1de664c6f7a8c9d676ed", + "url": "https://api.github.com/repos/nette/php-generator/zipball/8b728c622c49b196513c0f95508f2f66342d1e8f", + "reference": "8b728c622c49b196513c0f95508f2f66342d1e8f", "shasum": "" }, "require": { @@ -1057,7 +991,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "4.0-dev" + "dev-master": "4.1-dev" } }, "autoload": { @@ -1091,22 +1025,22 @@ ], "support": { "issues": "https://github.com/nette/php-generator/issues", - "source": "https://github.com/nette/php-generator/tree/v4.0.9" + "source": "https://github.com/nette/php-generator/tree/v4.1.0" }, - "time": "2023-08-29T19:09:26+00:00" + "time": "2023-09-26T12:28:52+00:00" }, { "name": "nette/utils", - "version": "v4.0.1", + "version": "v4.0.2", "source": { "type": "git", "url": "https://github.com/nette/utils.git", - "reference": "9124157137da01b1f5a5a22d6486cb975f26db7e" + "reference": "cead6637226456b35e1175cc53797dd585d85545" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/nette/utils/zipball/9124157137da01b1f5a5a22d6486cb975f26db7e", - "reference": "9124157137da01b1f5a5a22d6486cb975f26db7e", + "url": "https://api.github.com/repos/nette/utils/zipball/cead6637226456b35e1175cc53797dd585d85545", + "reference": "cead6637226456b35e1175cc53797dd585d85545", "shasum": "" }, "require": { @@ -1128,8 +1062,7 @@ "ext-intl": "to use Strings::webalize(), toAscii(), normalize() and compare()", "ext-json": "to use Nette\\Utils\\Json", "ext-mbstring": "to use Strings::lower() etc...", - "ext-tokenizer": "to use Nette\\Utils\\Reflection::getUseStatements()", - "ext-xml": "to use Strings::length() etc. when mbstring is not available" + "ext-tokenizer": "to use Nette\\Utils\\Reflection::getUseStatements()" }, "type": "library", "extra": { @@ -1178,9 +1111,9 @@ ], "support": { "issues": "https://github.com/nette/utils/issues", - "source": "https://github.com/nette/utils/tree/v4.0.1" + "source": "https://github.com/nette/utils/tree/v4.0.2" }, - "time": "2023-07-30T15:42:21+00:00" + "time": "2023-09-19T11:58:07+00:00" }, { "name": "nikic/php-parser", @@ -1316,99 +1249,18 @@ ], "time": "2023-05-02T11:26:24+00:00" }, - { - "name": "ocramius/proxy-manager", - "version": "2.14.1", - "source": { - "type": "git", - "url": "https://github.com/Ocramius/ProxyManager.git", - "reference": "3990d60ef79001badbab4927a6a811682274a0d1" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/Ocramius/ProxyManager/zipball/3990d60ef79001badbab4927a6a811682274a0d1", - "reference": "3990d60ef79001badbab4927a6a811682274a0d1", - "shasum": "" - }, - "require": { - "composer-runtime-api": "^2.1.0", - "laminas/laminas-code": "^4.4.2", - "php": "~8.0.0", - "webimpress/safe-writer": "^2.2.0" - }, - "conflict": { - "thecodingmachine/safe": "<1.3.3" - }, - "require-dev": { - "codelicia/xulieta": "^0.1.6", - "doctrine/coding-standard": "^9.0.0", - "ext-phar": "*", - "phpbench/phpbench": "^1.0.3", - "phpunit/phpunit": "^9.5.6", - "roave/infection-static-analysis-plugin": "^1.8", - "squizlabs/php_codesniffer": "^3.6.0", - "vimeo/psalm": "^4.8.1" - }, - "suggest": { - "laminas/laminas-json": "To have the JsonRpc adapter (Remote Object feature)", - "laminas/laminas-soap": "To have the Soap adapter (Remote Object feature)", - "laminas/laminas-xmlrpc": "To have the XmlRpc adapter (Remote Object feature)", - "ocramius/generated-hydrator": "To have very fast object to array to object conversion for ghost objects" - }, - "type": "library", - "autoload": { - "psr-4": { - "ProxyManager\\": "src/ProxyManager" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Marco Pivetta", - "email": "ocramius@gmail.com", - "homepage": "https://ocramius.github.io/" - } - ], - "description": "A library providing utilities to generate, instantiate and generally operate with Object Proxies", - "homepage": "https://github.com/Ocramius/ProxyManager", - "keywords": [ - "aop", - "lazy loading", - "proxy", - "proxy pattern", - "service proxies" - ], - "support": { - "issues": "https://github.com/Ocramius/ProxyManager/issues", - "source": "https://github.com/Ocramius/ProxyManager/tree/2.14.1" - }, - "funding": [ - { - "url": "https://github.com/Ocramius", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/ocramius/proxy-manager", - "type": "tidelift" - } - ], - "time": "2022-03-05T18:43:14+00:00" - }, { "name": "php-di/invoker", - "version": "2.3.3", + "version": "2.3.4", "source": { "type": "git", "url": "https://github.com/PHP-DI/Invoker.git", - "reference": "cd6d9f267d1a3474bdddf1be1da079f01b942786" + "reference": "33234b32dafa8eb69202f950a1fc92055ed76a86" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/PHP-DI/Invoker/zipball/cd6d9f267d1a3474bdddf1be1da079f01b942786", - "reference": "cd6d9f267d1a3474bdddf1be1da079f01b942786", + "url": "https://api.github.com/repos/PHP-DI/Invoker/zipball/33234b32dafa8eb69202f950a1fc92055ed76a86", + "reference": "33234b32dafa8eb69202f950a1fc92055ed76a86", "shasum": "" }, "require": { @@ -1442,7 +1294,7 @@ ], "support": { "issues": "https://github.com/PHP-DI/Invoker/issues", - "source": "https://github.com/PHP-DI/Invoker/tree/2.3.3" + "source": "https://github.com/PHP-DI/Invoker/tree/2.3.4" }, "funding": [ { @@ -1450,7 +1302,7 @@ "type": "github" } ], - "time": "2021-12-13T09:22:56+00:00" + "time": "2023-09-08T09:24:21+00:00" }, { "name": "php-di/php-di", @@ -1898,16 +1750,16 @@ }, { "name": "phpstan/phpdoc-parser", - "version": "1.23.1", + "version": "1.24.2", "source": { "type": "git", "url": "https://github.com/phpstan/phpdoc-parser.git", - "reference": "846ae76eef31c6d7790fac9bc399ecee45160b26" + "reference": "bcad8d995980440892759db0c32acae7c8e79442" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpstan/phpdoc-parser/zipball/846ae76eef31c6d7790fac9bc399ecee45160b26", - "reference": "846ae76eef31c6d7790fac9bc399ecee45160b26", + "url": "https://api.github.com/repos/phpstan/phpdoc-parser/zipball/bcad8d995980440892759db0c32acae7c8e79442", + "reference": "bcad8d995980440892759db0c32acae7c8e79442", "shasum": "" }, "require": { @@ -1939,9 +1791,9 @@ "description": "PHPDoc parser with support for nullable, intersection and generic types", "support": { "issues": "https://github.com/phpstan/phpdoc-parser/issues", - "source": "https://github.com/phpstan/phpdoc-parser/tree/1.23.1" + "source": "https://github.com/phpstan/phpdoc-parser/tree/1.24.2" }, - "time": "2023-08-03T16:32:59+00:00" + "time": "2023-09-26T12:28:12+00:00" }, { "name": "psr/cache", @@ -2097,16 +1949,16 @@ }, { "name": "psr/http-client", - "version": "1.0.2", + "version": "1.0.3", "source": { "type": "git", "url": "https://github.com/php-fig/http-client.git", - "reference": "0955afe48220520692d2d09f7ab7e0f93ffd6a31" + "reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-fig/http-client/zipball/0955afe48220520692d2d09f7ab7e0f93ffd6a31", - "reference": "0955afe48220520692d2d09f7ab7e0f93ffd6a31", + "url": "https://api.github.com/repos/php-fig/http-client/zipball/bb5906edc1c324c9a05aa0873d40117941e5fa90", + "reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90", "shasum": "" }, "require": { @@ -2143,9 +1995,9 @@ "psr-18" ], "support": { - "source": "https://github.com/php-fig/http-client/tree/1.0.2" + "source": "https://github.com/php-fig/http-client" }, - "time": "2023-04-10T20:12:12+00:00" + "time": "2023-09-23T14:17:50+00:00" }, { "name": "psr/http-factory", @@ -3790,16 +3642,16 @@ }, { "name": "tectalic/openai", - "version": "v1.5.0", + "version": "v1.6.0", "source": { "type": "git", "url": "https://github.com/tectalichq/public-openai-client-php.git", - "reference": "434f48f816818f4a56eb8801f24b3d85ddc35a01" + "reference": "aa321d55bdd01511515e7b3436c092325fa651f4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/tectalichq/public-openai-client-php/zipball/434f48f816818f4a56eb8801f24b3d85ddc35a01", - "reference": "434f48f816818f4a56eb8801f24b3d85ddc35a01", + "url": "https://api.github.com/repos/tectalichq/public-openai-client-php/zipball/aa321d55bdd01511515e7b3436c092325fa651f4", + "reference": "aa321d55bdd01511515e7b3436c092325fa651f4", "shasum": "" }, "require": { @@ -3838,7 +3690,7 @@ "license": [ "MIT" ], - "description": "An OpenAI REST API Client with support for ChatGPT, GPT-4, GPT-3.5, GPT-3, Codex, DALL·E, Whisper, Embeddings and Moderation models. Includes fully typed Data Transfer Objects (DTOs) for all requests and responses and IDE autocomplete support.", + "description": "An OpenAI REST API Client with support for ChatGPT, GPT-4, GPT-3.5, GPT-3, Codex, DALL·E, Whisper, Embeddings, Fine-Tuning and Moderation models. Includes fully typed Data Transfer Objects (DTOs) for all requests and responses and IDE autocomplete support.", "homepage": "https://tectalic.com/apis/openai", "keywords": [ "ChatGpt", @@ -3847,6 +3699,7 @@ "api", "dall-e", "dalle", + "fine-tuning", "gpt-3.5", "gpt-4", "gpt3", @@ -3858,9 +3711,9 @@ "whisper" ], "support": { - "source": "https://github.com/tectalichq/public-openai-client-php/tree/v1.5.0" + "source": "https://github.com/tectalichq/public-openai-client-php/tree/v1.6.0" }, - "time": "2023-06-19T03:13:28+00:00" + "time": "2023-09-06T02:15:29+00:00" }, { "name": "twig/twig", @@ -3933,65 +3786,6 @@ ], "time": "2023-08-28T11:09:02+00:00" }, - { - "name": "webimpress/safe-writer", - "version": "2.2.0", - "source": { - "type": "git", - "url": "https://github.com/webimpress/safe-writer.git", - "reference": "9d37cc8bee20f7cb2f58f6e23e05097eab5072e6" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/webimpress/safe-writer/zipball/9d37cc8bee20f7cb2f58f6e23e05097eab5072e6", - "reference": "9d37cc8bee20f7cb2f58f6e23e05097eab5072e6", - "shasum": "" - }, - "require": { - "php": "^7.3 || ^8.0" - }, - "require-dev": { - "phpunit/phpunit": "^9.5.4", - "vimeo/psalm": "^4.7", - "webimpress/coding-standard": "^1.2.2" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.2.x-dev", - "dev-develop": "2.3.x-dev", - "dev-release-1.0": "1.0.x-dev" - } - }, - "autoload": { - "psr-4": { - "Webimpress\\SafeWriter\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-2-Clause" - ], - "description": "Tool to write files safely, to avoid race conditions", - "keywords": [ - "concurrent write", - "file writer", - "race condition", - "safe writer", - "webimpress" - ], - "support": { - "issues": "https://github.com/webimpress/safe-writer/issues", - "source": "https://github.com/webimpress/safe-writer/tree/2.2.0" - }, - "funding": [ - { - "url": "https://github.com/michalbundyra", - "type": "github" - } - ], - "time": "2021-04-19T16:34:45+00:00" - }, { "name": "webmozart/assert", "version": "1.11.0", @@ -4054,16 +3848,16 @@ "packages-dev": [ { "name": "captainhook/captainhook", - "version": "5.16.4", + "version": "5.17.3", "source": { "type": "git", "url": "https://github.com/captainhookphp/captainhook.git", - "reference": "524c8660551bafe9c7211440a71a35984e8dfc4b" + "reference": "cac493cfacf14f3a2d16b4ebff9a3bc9adb4c68d" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/captainhookphp/captainhook/zipball/524c8660551bafe9c7211440a71a35984e8dfc4b", - "reference": "524c8660551bafe9c7211440a71a35984e8dfc4b", + "url": "https://api.github.com/repos/captainhookphp/captainhook/zipball/cac493cfacf14f3a2d16b4ebff9a3bc9adb4c68d", + "reference": "cac493cfacf14f3a2d16b4ebff9a3bc9adb4c68d", "shasum": "" }, "require": { @@ -4073,7 +3867,7 @@ "php": ">=7.4", "sebastianfeldmann/camino": "^0.9.2", "sebastianfeldmann/cli": "^3.3", - "sebastianfeldmann/git": "^3.8.9", + "sebastianfeldmann/git": "^3.9", "symfony/console": "^2.7 || ^3.0 || ^4.0 || ^5.0 || ^6.0", "symfony/filesystem": "^2.7 || ^3.0 || ^4.0 || ^5.0 || ^6.0", "symfony/process": "^2.7 || ^3.0 || ^4.0 || ^5.0 || ^6.0" @@ -4125,7 +3919,7 @@ ], "support": { "issues": "https://github.com/captainhookphp/captainhook/issues", - "source": "https://github.com/captainhookphp/captainhook/tree/5.16.4" + "source": "https://github.com/captainhookphp/captainhook/tree/5.17.3" }, "funding": [ { @@ -4133,7 +3927,7 @@ "type": "github" } ], - "time": "2023-04-17T19:48:47+00:00" + "time": "2023-10-04T11:51:41+00:00" }, { "name": "captainhook/plugin-composer", @@ -4192,16 +3986,16 @@ }, { "name": "dg/bypass-finals", - "version": "v1.5.0", + "version": "v1.5.1", "source": { "type": "git", "url": "https://github.com/dg/bypass-finals.git", - "reference": "7df37b7342d7d25ab906e53eb4e92d83542f46c1" + "reference": "12ef25e1f8d4144e4ec80d13a28895e8942f4104" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/dg/bypass-finals/zipball/7df37b7342d7d25ab906e53eb4e92d83542f46c1", - "reference": "7df37b7342d7d25ab906e53eb4e92d83542f46c1", + "url": "https://api.github.com/repos/dg/bypass-finals/zipball/12ef25e1f8d4144e4ec80d13a28895e8942f4104", + "reference": "12ef25e1f8d4144e4ec80d13a28895e8942f4104", "shasum": "" }, "require": { @@ -4239,9 +4033,9 @@ ], "support": { "issues": "https://github.com/dg/bypass-finals/issues", - "source": "https://github.com/dg/bypass-finals/tree/v1.5.0" + "source": "https://github.com/dg/bypass-finals/tree/v1.5.1" }, - "time": "2023-08-23T11:20:33+00:00" + "time": "2023-09-16T09:13:54+00:00" }, { "name": "doctrine/instantiator", @@ -4485,16 +4279,16 @@ }, { "name": "phpunit/php-code-coverage", - "version": "9.2.27", + "version": "9.2.29", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "b0a88255cb70d52653d80c890bd7f38740ea50d1" + "reference": "6a3a87ac2bbe33b25042753df8195ba4aa534c76" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/b0a88255cb70d52653d80c890bd7f38740ea50d1", - "reference": "b0a88255cb70d52653d80c890bd7f38740ea50d1", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/6a3a87ac2bbe33b25042753df8195ba4aa534c76", + "reference": "6a3a87ac2bbe33b25042753df8195ba4aa534c76", "shasum": "" }, "require": { @@ -4551,7 +4345,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy", - "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/9.2.27" + "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/9.2.29" }, "funding": [ { @@ -4559,7 +4353,7 @@ "type": "github" } ], - "time": "2023-07-26T13:44:30+00:00" + "time": "2023-09-19T04:57:46+00:00" }, { "name": "phpunit/php-file-iterator", @@ -4804,16 +4598,16 @@ }, { "name": "phpunit/phpunit", - "version": "9.6.11", + "version": "9.6.13", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "810500e92855eba8a7a5319ae913be2da6f957b0" + "reference": "f3d767f7f9e191eab4189abe41ab37797e30b1be" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/810500e92855eba8a7a5319ae913be2da6f957b0", - "reference": "810500e92855eba8a7a5319ae913be2da6f957b0", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/f3d767f7f9e191eab4189abe41ab37797e30b1be", + "reference": "f3d767f7f9e191eab4189abe41ab37797e30b1be", "shasum": "" }, "require": { @@ -4828,7 +4622,7 @@ "phar-io/manifest": "^2.0.3", "phar-io/version": "^3.0.2", "php": ">=7.3", - "phpunit/php-code-coverage": "^9.2.13", + "phpunit/php-code-coverage": "^9.2.28", "phpunit/php-file-iterator": "^3.0.5", "phpunit/php-invoker": "^3.1.1", "phpunit/php-text-template": "^2.0.3", @@ -4887,7 +4681,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/phpunit/issues", "security": "https://github.com/sebastianbergmann/phpunit/security/policy", - "source": "https://github.com/sebastianbergmann/phpunit/tree/9.6.11" + "source": "https://github.com/sebastianbergmann/phpunit/tree/9.6.13" }, "funding": [ { @@ -4903,7 +4697,7 @@ "type": "tidelift" } ], - "time": "2023-08-19T07:10:56+00:00" + "time": "2023-09-19T05:39:22+00:00" }, { "name": "sebastian/cli-parser", @@ -5985,16 +5779,16 @@ }, { "name": "sebastianfeldmann/git", - "version": "3.8.9", + "version": "3.9.2", "source": { "type": "git", "url": "https://github.com/sebastianfeldmann/git.git", - "reference": "38586be69b0932b630337afcc8db12e5b7981254" + "reference": "11c85123216b32985f8f0b8547a52390d87d544e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianfeldmann/git/zipball/38586be69b0932b630337afcc8db12e5b7981254", - "reference": "38586be69b0932b630337afcc8db12e5b7981254", + "url": "https://api.github.com/repos/sebastianfeldmann/git/zipball/11c85123216b32985f8f0b8547a52390d87d544e", + "reference": "11c85123216b32985f8f0b8547a52390d87d544e", "shasum": "" }, "require": { @@ -6034,7 +5828,7 @@ ], "support": { "issues": "https://github.com/sebastianfeldmann/git/issues", - "source": "https://github.com/sebastianfeldmann/git/tree/3.8.9" + "source": "https://github.com/sebastianfeldmann/git/tree/3.9.2" }, "funding": [ { @@ -6042,7 +5836,7 @@ "type": "github" } ], - "time": "2023-03-30T16:37:34+00:00" + "time": "2023-10-04T10:59:08+00:00" }, { "name": "squizlabs/php_codesniffer", @@ -6224,5 +6018,5 @@ "ext-mbstring": "*" }, "platform-dev": [], - "plugin-api-version": "2.3.0" + "plugin-api-version": "2.6.0" } diff --git a/demo/demo1/demoScript.php b/demo/demo1/demoScript.php index 4c852da9..0681075a 100644 --- a/demo/demo1/demoScript.php +++ b/demo/demo1/demoScript.php @@ -8,6 +8,6 @@ try { $docGen = (new \BumbleDocGen\DocGeneratorFactory())->create(__DIR__ . '/demo-config.yaml'); $docGen->generate(); -} catch (\Exception|\Psr\Cache\InvalidArgumentException $e) { +} catch (\Exception | \Psr\Cache\InvalidArgumentException $e) { die($e->getMessage()); -} \ No newline at end of file +} diff --git a/demo/demo2-templates-generation/demoScript.php b/demo/demo2-templates-generation/demoScript.php index e13bef1d..27f1080b 100644 --- a/demo/demo2-templates-generation/demoScript.php +++ b/demo/demo2-templates-generation/demoScript.php @@ -8,6 +8,6 @@ try { $docGen = (new \BumbleDocGen\DocGeneratorFactory())->create(__DIR__ . '/demo-config.yaml'); $docGen->generateProjectTemplatesStructure(); -} catch (\Exception|\Psr\Cache\InvalidArgumentException $e) { +} catch (\Exception | \Psr\Cache\InvalidArgumentException $e) { die($e->getMessage()); -} \ No newline at end of file +} diff --git a/demo/demo3-add-missing-doc-blocks/demoScript.php b/demo/demo3-add-missing-doc-blocks/demoScript.php index 1e84ba95..93702bce 100644 --- a/demo/demo3-add-missing-doc-blocks/demoScript.php +++ b/demo/demo3-add-missing-doc-blocks/demoScript.php @@ -8,6 +8,6 @@ try { $docGen = (new \BumbleDocGen\DocGeneratorFactory())->create(__DIR__ . '/demo-config.yaml'); $docGen->addMissingDocBlocks(); -} catch (\Exception|\Psr\Cache\InvalidArgumentException $e) { +} catch (\Exception | \Psr\Cache\InvalidArgumentException $e) { die($e->getMessage()); -} \ No newline at end of file +} diff --git a/demo/demo4-generating-readme-file/demoScript.php b/demo/demo4-generating-readme-file/demoScript.php index cddf0ec1..d287e7d0 100644 --- a/demo/demo4-generating-readme-file/demoScript.php +++ b/demo/demo4-generating-readme-file/demoScript.php @@ -8,6 +8,6 @@ try { $docGen = (new \BumbleDocGen\DocGeneratorFactory())->create(__DIR__ . '/demo-config.yaml'); $docGen->fillInReadmeMdTemplate(); -} catch (\Exception|\Psr\Cache\InvalidArgumentException $e) { +} catch (\Exception | \Psr\Cache\InvalidArgumentException $e) { die($e->getMessage()); -} \ No newline at end of file +} diff --git a/demo/demo5-config-array/demoScript.php b/demo/demo5-config-array/demoScript.php new file mode 100644 index 00000000..7c733bd3 --- /dev/null +++ b/demo/demo5-config-array/demoScript.php @@ -0,0 +1,40 @@ +#!/usr/bin/env php +createByConfigArray([ + 'project_root' => '%WORKING_DIR%/vendor/doctrine', + 'demo_dir' => '%WORKING_DIR%/demo/demo5-config-array', // <= custom parameter + 'cache_dir' => '%demo_dir%/.cache', + 'templates_dir' => '%demo_dir%/templates', + 'output_dir' => "%demo_dir%/docs", + 'output_dir_base_url' => "%demo_dir%/docs", + 'check_file_in_git_before_creating_doc' => false, + 'language_handlers' => [ + 'php' => [ + 'class' => \BumbleDocGen\LanguageHandler\Php\PhpHandler::class, + 'settings' => [ + 'async_source_loading_enabled' => true, + ], + ] + ], + 'source_locators' => [ + [ + 'class' => \BumbleDocGen\Core\Parser\SourceLocator\RecursiveDirectoriesSourceLocator::class, + 'arguments' => [ + 'directories' => [ + '%project_root%' + ] + ] + ] + ], + ]); + $docGen->generate(); +} catch (\Exception | \Psr\Cache\InvalidArgumentException $e) { + die($e->getMessage()); +} diff --git a/demo/demo5-config-array/templates/README.md.twig b/demo/demo5-config-array/templates/README.md.twig new file mode 100644 index 00000000..c9231639 --- /dev/null +++ b/demo/demo5-config-array/templates/README.md.twig @@ -0,0 +1,9 @@ +{% set title = 'Demo 5' %} + +{{ "Demo 5" | textToHeading('H1') }} + +{{ printEntityCollectionAsList( phpClassEntityCollection.filterByPaths(['/annotations']) ) }} + +To update this documentation, run the following command: + +{{ 'php demo/demo5-config-array/demoScript.php' | textToCodeBlock('console') }} \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 017c6a21..4cd120ae 100644 --- a/docs/README.md +++ b/docs/README.md @@ -62,6 +62,8 @@ $factory = new DocGeneratorFactory(); // Create a DocGenerator instance $docgen = $factory->create('/path/to/configuration/files'); +// or $docgen = $factory->createByConfigArray([...]); + // Now call the desired operation $docgen->generate(); ``` @@ -93,4 +95,4 @@ To update this documentation, run the following command:

-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sun Sep 10 17:47:00 2023 +0300
Page content update date: Thu Sep 28 2023
Made with Bumble Documentation Generator
\ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Oct 5 17:42:06 2023 +0300
Page content update date: Fri Oct 06 2023
Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index c272965c..00000000 --- a/docs/_config.yml +++ /dev/null @@ -1,15 +0,0 @@ -markdown: GFM -name: "" -title: null - -remote_theme: tuur29/pages-themes-cayman -color: - header: "#000" - gradient_left: "#e53935" - gradient_right: "#f57c00" -syntax_theme: https://stylishthemes.github.io/Syntax-Themes/pygments/css-github/pygments-monokai.css - -darkmode: true -github: - is_project_page: false -title-heading: false \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html deleted file mode 100644 index 41554095..00000000 --- a/docs/_layouts/default.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - - {% if site.syntax_theme %} - - {% endif %} - - - -
- {{ content }} - -
- - - \ No newline at end of file diff --git a/docs/classes/DocGenerator.md b/docs/classes/DocGenerator.md index 10a750be..75183c78 100644 --- a/docs/classes/DocGenerator.md +++ b/docs/classes/DocGenerator.md @@ -2,7 +2,7 @@ BumbleDocGen / DocGenerator

- DocGenerator class: + DocGenerator class:

@@ -55,11 +55,11 @@ final class DocGenerator @@ -74,11 +74,11 @@ final class DocGenerator ```php -public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfony\Component\Console\Style\OutputStyle $io, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Parser\ProjectParser $parser, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Renderer\Renderer $renderer, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \Monolog\Logger $logger); +public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfony\Component\Console\Style\OutputStyle $io, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\Core\Parser\ProjectParser $parser, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Renderer\Renderer $renderer, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \Monolog\Logger $logger); ``` @@ -108,6 +108,11 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo $configuration \BumbleDocGen\Core\Configuration\Configuration - + + + $pluginEventDispatcher + \BumbleDocGen\Core\Plugin\PluginEventDispatcher + - $parser @@ -146,7 +151,7 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo ```php @@ -186,7 +191,7 @@ public function addMissingDocBlocks(): void; ```php @@ -226,7 +231,7 @@ public function fillInReadmeMdTemplate(): void; ```php @@ -254,7 +259,7 @@ public function generate(): void; ```php @@ -294,7 +299,7 @@ public function generateProjectTemplatesStructure(): void; ```php diff --git a/docs/classes/DocGeneratorFactory.md b/docs/classes/DocGeneratorFactory.md index 0799a14d..f7b319d3 100644 --- a/docs/classes/DocGeneratorFactory.md +++ b/docs/classes/DocGeneratorFactory.md @@ -36,6 +36,9 @@ final class DocGeneratorFactory
  • create
  • +
  • + createByConfigArray +
  • createConfiguration
  • @@ -128,6 +131,57 @@ public function create(string|null ...$configurationFiles): \BumbleDocGen\DocGen Return value: \BumbleDocGen\DocGenerator +Throws: + + + +
    +
    + + + +```php +public function createByConfigArray(array $config): \BumbleDocGen\DocGenerator; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $configarray-
    + +Return value: \BumbleDocGen\DocGenerator + + Throws:
    \ No newline at end of file diff --git a/docs/tech/2.parser/classes/ClassEntity.md b/docs/tech/2.parser/classes/ClassEntity.md index be23c7d7..ab6c5060 100644 --- a/docs/tech/2.parser/classes/ClassEntity.md +++ b/docs/tech/2.parser/classes/ClassEntity.md @@ -416,7 +416,7 @@ public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocu \DI\NotFoundException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -447,7 +447,7 @@ public function documentCreationAllowed(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -477,7 +477,7 @@ public function entityCacheIsOutdated(): bool; Throws: @@ -541,7 +541,7 @@ public function getAbsoluteFileName(): string|null; Throws: @@ -625,7 +625,7 @@ public function getCasesNames(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -673,7 +673,7 @@ public function getConstant(string $name): string|array|int|bool|null|float; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -732,7 +732,7 @@ public function getConstantEntity(string $constantName, bool $unsafe = true): \B \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -769,7 +769,7 @@ public function getConstantEntityCollection(): \BumbleDocGen\LanguageHandler\Php \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -800,7 +800,7 @@ public function getConstants(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -831,7 +831,7 @@ public function getConstantsData(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -868,7 +868,7 @@ public function getDescription(): string; \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -898,7 +898,7 @@ public function getDescriptionLinks(): array; Throws: @@ -971,7 +971,7 @@ public function getDocComment(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1008,7 +1008,7 @@ public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\ \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1059,7 +1059,7 @@ public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\En Throws: @@ -1168,7 +1168,7 @@ public function getExtends(): string|null; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1196,7 +1196,7 @@ public function getFileContent(): string; Throws: @@ -1264,7 +1264,7 @@ public function getFileSourceLink(bool $withLine = true): string|null; Throws: @@ -1318,7 +1318,7 @@ public function getFullFileName(): string|null; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1349,7 +1349,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1380,7 +1380,7 @@ public function getInterfaceNames(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1411,7 +1411,7 @@ public function getInterfacesEntities(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1442,7 +1442,7 @@ public function getInterfacesString(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1498,7 +1498,7 @@ public function getMethodEntity(string $methodName, bool $unsafe = true): \Bumbl \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • @@ -1532,7 +1532,7 @@ public function getMethodEntityCollection(): \BumbleDocGen\LanguageHandler\Php\P \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \DI\NotFoundException
  • @@ -1569,7 +1569,7 @@ public function getMethodsData(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1600,7 +1600,7 @@ public function getModifiersString(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1652,7 +1652,7 @@ public function getNamespaceName(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1704,7 +1704,7 @@ public function getParentClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entit \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1735,7 +1735,7 @@ public function getParentClassName(): string|null; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1766,7 +1766,7 @@ public function getParentClassNames(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1856,7 +1856,7 @@ public function getPropertiesData(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1912,7 +1912,7 @@ public function getPropertyEntity(string $propertyName, bool $unsafe = true): \B \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • @@ -1946,7 +1946,7 @@ public function getPropertyEntityCollection(): \BumbleDocGen\LanguageHandler\Php \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \DI\NotFoundException
  • @@ -2021,7 +2021,7 @@ public function getRelativeFileName(bool $loadIfEmpty = true): string|null; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2094,7 +2094,7 @@ public function getStartLine(): int; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2127,7 +2127,7 @@ public function getThrows(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2158,7 +2158,7 @@ public function getTraitsNames(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2244,7 +2244,7 @@ public function hasConstant(string $constant): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2345,7 +2345,7 @@ public function hasMethod(string $method): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2393,7 +2393,7 @@ public function hasParentClass(string $parentClassName): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2441,7 +2441,7 @@ public function hasProperty(string $property): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2495,7 +2495,7 @@ public function hasTraits(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2543,7 +2543,7 @@ public function implementsInterface(string $interfaceName): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2650,7 +2650,7 @@ public function isEntityFileCanBeLoad(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2719,7 +2719,7 @@ public function isEnum(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2747,7 +2747,7 @@ public function isInGit(): bool; Throws: @@ -2812,7 +2812,7 @@ public function isInterface(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2883,7 +2883,7 @@ public function isSubclassOf(string $className): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -2914,7 +2914,7 @@ public function isTrait(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException diff --git a/docs/tech/2.parser/classes/ClassEntityCollection.md b/docs/tech/2.parser/classes/ClassEntityCollection.md index 6872f984..b40d7c69 100644 --- a/docs/tech/2.parser/classes/ClassEntityCollection.md +++ b/docs/tech/2.parser/classes/ClassEntityCollection.md @@ -248,7 +248,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity Throws: @@ -370,7 +370,7 @@ public function filterByNameRegularExpression(string $regexPattern): \BumbleDocG \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -418,7 +418,7 @@ public function filterByParentClassNames(array $parentClassNames): \BumbleDocGen \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -466,7 +466,7 @@ public function filterByPaths(array $paths): \BumbleDocGen\LanguageHandler\Php\P \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -782,7 +782,7 @@ public function getOnlyInstantiable(): \BumbleDocGen\LanguageHandler\Php\Parser\ \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -813,7 +813,7 @@ public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\En \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1070,7 +1070,7 @@ public function loadClassEntities(): void; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException diff --git a/docs/tech/2.parser/classes/ConstantEntity.md b/docs/tech/2.parser/classes/ConstantEntity.md index 4a7005d9..ade7f56e 100644 --- a/docs/tech/2.parser/classes/ConstantEntity.md +++ b/docs/tech/2.parser/classes/ConstantEntity.md @@ -256,7 +256,7 @@ public function entityCacheIsOutdated(): bool; Throws: @@ -403,7 +403,7 @@ public function getDescriptionLinks(): array; Throws: @@ -470,7 +470,7 @@ public function getDocComment(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -545,7 +545,7 @@ public function getEndLine(): int; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -599,7 +599,7 @@ public function getFileName(): string|null; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -646,7 +646,7 @@ public function getFileSourceLink(bool $withLine = true): string|null; Throws: @@ -742,7 +742,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -794,7 +794,7 @@ public function getNamespaceName(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -932,7 +932,7 @@ public function getStartLine(): int; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -965,7 +965,7 @@ public function getThrows(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1127,7 +1127,7 @@ public function isEntityFileCanBeLoad(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1181,7 +1181,7 @@ public function isPrivate(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1212,7 +1212,7 @@ public function isProtected(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1243,7 +1243,7 @@ public function isPublic(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException diff --git a/docs/tech/2.parser/classes/MethodEntity.md b/docs/tech/2.parser/classes/MethodEntity.md index 81c91b00..6b38a916 100644 --- a/docs/tech/2.parser/classes/MethodEntity.md +++ b/docs/tech/2.parser/classes/MethodEntity.md @@ -310,7 +310,7 @@ public function entityCacheIsOutdated(): bool; Throws: @@ -464,7 +464,7 @@ public function getDescription(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -494,7 +494,7 @@ public function getDescriptionLinks(): array; Throws: @@ -582,7 +582,7 @@ public function getDocComment(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -619,7 +619,7 @@ public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\ \DI\NotFoundException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -650,7 +650,7 @@ public function getDocCommentLine(): int|null; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -687,7 +687,7 @@ public function getDocCommentLineRecursive(): int|null; \DI\NotFoundException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -724,7 +724,7 @@ public function getDocCommentRecursive(): string; \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -778,7 +778,7 @@ public function getEndLine(): int; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -832,7 +832,7 @@ public function getFileName(): string|null; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -879,7 +879,7 @@ public function getFileSourceLink(bool $withLine = true): string|null; Throws: @@ -933,7 +933,7 @@ public function getFirstReturnValue(): mixed; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1006,7 +1006,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1037,7 +1037,7 @@ public function getModifiersString(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1089,7 +1089,7 @@ public function getNamespaceName(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1149,7 +1149,7 @@ public function getParameters(): array; \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \Exception
  • @@ -1189,7 +1189,7 @@ public function getParametersString(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1247,7 +1247,7 @@ public function getPrototype(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ \DI\NotFoundException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1284,7 +1284,7 @@ public function getReturnType(): string; \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1384,7 +1384,7 @@ public function getSignature(): string; \DI\NotFoundException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1415,7 +1415,7 @@ public function getStartColumn(): int; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1446,7 +1446,7 @@ public function getStartLine(): int; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1479,7 +1479,7 @@ public function getThrows(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1683,7 +1683,7 @@ public function isEntityFileCanBeLoad(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1741,7 +1741,7 @@ public function isInitialization(): bool; \DI\NotFoundException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1795,7 +1795,7 @@ public function isPrivate(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1826,7 +1826,7 @@ public function isProtected(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1857,7 +1857,7 @@ public function isPublic(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1888,7 +1888,7 @@ public function isStatic(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException diff --git a/docs/tech/2.parser/classes/PropertyEntity.md b/docs/tech/2.parser/classes/PropertyEntity.md index 4d40a6c7..5366d46b 100644 --- a/docs/tech/2.parser/classes/PropertyEntity.md +++ b/docs/tech/2.parser/classes/PropertyEntity.md @@ -268,7 +268,7 @@ public function entityCacheIsOutdated(): bool; Throws: @@ -422,7 +422,7 @@ public function getDescription(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -452,7 +452,7 @@ public function getDescriptionLinks(): array; Throws: @@ -525,7 +525,7 @@ public function getDocComment(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -562,7 +562,7 @@ public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\ \DI\NotFoundException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -616,7 +616,7 @@ public function getEndLine(): int; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -670,7 +670,7 @@ public function getFileName(): string|null; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -717,7 +717,7 @@ public function getFileSourceLink(bool $withLine = true): string|null; Throws: @@ -813,7 +813,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -850,7 +850,7 @@ public function getModifiersString(): string; \DI\NotFoundException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -902,7 +902,7 @@ public function getNamespaceName(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1040,7 +1040,7 @@ public function getStartLine(): int; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1073,7 +1073,7 @@ public function getThrows(): array; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1110,7 +1110,7 @@ public function getType(): string; \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1272,7 +1272,7 @@ public function isEntityFileCanBeLoad(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1347,7 +1347,7 @@ public function isPrivate(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1378,7 +1378,7 @@ public function isProtected(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -1409,7 +1409,7 @@ public function isPublic(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException diff --git a/docs/tech/2.parser/entity.md b/docs/tech/2.parser/entity.md index 33de5e99..75efade4 100644 --- a/docs/tech/2.parser/entity.md +++ b/docs/tech/2.parser/entity.md @@ -123,4 +123,4 @@ These classes are a convenient wrapper for accessing data in templates:

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Thu Sep 28 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/2.parser/entityFilterCondition.md b/docs/tech/2.parser/entityFilterCondition.md index 1ddd49cc..2273be88 100644 --- a/docs/tech/2.parser/entityFilterCondition.md +++ b/docs/tech/2.parser/entityFilterCondition.md @@ -78,4 +78,4 @@ Filter condition for working with entities PHP language handler:

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/2.parser/readme.md b/docs/tech/2.parser/readme.md index d2513543..a8eb5dd3 100644 --- a/docs/tech/2.parser/readme.md +++ b/docs/tech/2.parser/readme.md @@ -41,4 +41,4 @@ In this section, we show how the parser works and what components it consists of

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/2.parser/sourceLocator.md b/docs/tech/2.parser/sourceLocator.md index ea011ffb..5c874b72 100644 --- a/docs/tech/2.parser/sourceLocator.md +++ b/docs/tech/2.parser/sourceLocator.md @@ -30,4 +30,4 @@ You can create your own source locators or use any existing ones. All source loc

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:09:56 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:09:56 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/breadcrumbs.md b/docs/tech/3.renderer/breadcrumbs.md index 0ff92453..d7aacecf 100644 --- a/docs/tech/3.renderer/breadcrumbs.md +++ b/docs/tech/3.renderer/breadcrumbs.md @@ -51,4 +51,4 @@ Here is an example of the result of the `generatePageBreadcrumbs` function:

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/classes/BreadcrumbsHelper.md b/docs/tech/3.renderer/classes/BreadcrumbsHelper.md index d4b3b7be..ee9de81d 100644 --- a/docs/tech/3.renderer/classes/BreadcrumbsHelper.md +++ b/docs/tech/3.renderer/classes/BreadcrumbsHelper.md @@ -157,7 +157,7 @@ public function getAllPageLinks(): array; \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -213,7 +213,7 @@ public function getBreadcrumbs(string $filePatch, bool $fromCurrent = true): arr \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -269,7 +269,7 @@ public function getBreadcrumbsForTemplates(string $templateFilePatch, bool $from \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException @@ -317,7 +317,7 @@ public function getPageDataByKey(string $key): array|null; \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \DI\NotFoundException
  • @@ -368,7 +368,7 @@ public function getPageDocFileByKey(string $key): string|null; \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \DI\NotFoundException
  • @@ -419,7 +419,7 @@ public function getPageLinkByKey(string $key): string|null; \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \DI\NotFoundException
  • @@ -467,7 +467,7 @@ public function getTemplateLinkKey(string $templateName): string|null; Throws: @@ -512,7 +512,7 @@ public function getTemplateTitle(string $templateName): string; Throws: @@ -593,7 +593,7 @@ public function renderBreadcrumbs(string $currentPageTitle, string $filePatch, b \Twig\Error\LoaderError
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException diff --git a/docs/tech/3.renderer/classes/ClassEntityCollection_2.md b/docs/tech/3.renderer/classes/ClassEntityCollection_2.md index 372c2b7a..83388311 100644 --- a/docs/tech/3.renderer/classes/ClassEntityCollection_2.md +++ b/docs/tech/3.renderer/classes/ClassEntityCollection_2.md @@ -248,10 +248,10 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity Throws: @@ -319,10 +319,10 @@ public function filterByInterfaces(array $interfaces): \BumbleDocGen\LanguageHan Throws: @@ -367,10 +367,10 @@ public function filterByNameRegularExpression(string $regexPattern): \BumbleDocG Throws: @@ -415,10 +415,10 @@ public function filterByParentClassNames(array $parentClassNames): \BumbleDocGen Throws: @@ -463,10 +463,10 @@ public function filterByPaths(array $paths): \BumbleDocGen\LanguageHandler\Php\P Throws: @@ -779,10 +779,10 @@ public function getOnlyInstantiable(): \BumbleDocGen\LanguageHandler\Php\Parser\ Throws: @@ -810,10 +810,10 @@ public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\En Throws: @@ -1067,10 +1067,10 @@ public function loadClassEntities(): void; \DI\DependencyException
  • - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException diff --git a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md index bdcec51d..0755e794 100644 --- a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md +++ b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md @@ -211,13 +211,13 @@ public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $ \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \DI\NotFoundException
  • - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException diff --git a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md index 781ce3b7..b4ed9a18 100644 --- a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md +++ b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md @@ -211,13 +211,13 @@ public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $ \DI\DependencyException
  • - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
  • \DI\NotFoundException
  • - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException diff --git a/docs/tech/3.renderer/readme.md b/docs/tech/3.renderer/readme.md index daea1feb..275c4b7b 100644 --- a/docs/tech/3.renderer/readme.md +++ b/docs/tech/3.renderer/readme.md @@ -60,4 +60,4 @@ This process is presented in the form of a diagram below.

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/templates.md b/docs/tech/3.renderer/templates.md index 5ffaa888..18adcb46 100644 --- a/docs/tech/3.renderer/templates.md +++ b/docs/tech/3.renderer/templates.md @@ -101,4 +101,4 @@ Result after starting the documentation generation process:

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/templatesDynamicBlocks.md b/docs/tech/3.renderer/templatesDynamicBlocks.md index 8a4f475b..b3f8bf98 100644 --- a/docs/tech/3.renderer/templatesDynamicBlocks.md +++ b/docs/tech/3.renderer/templatesDynamicBlocks.md @@ -26,4 +26,4 @@ You can use the built-in functions and filters or add your own, so you can imple

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/templatesLinking.md b/docs/tech/3.renderer/templatesLinking.md index 360b9e7c..a7b16b7b 100644 --- a/docs/tech/3.renderer/templatesLinking.md +++ b/docs/tech/3.renderer/templatesLinking.md @@ -27,4 +27,4 @@ You can also implement your own functions for relinking if necessary.

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/templatesVariables.md b/docs/tech/3.renderer/templatesVariables.md index 31c9ec2f..8aa1ecb1 100644 --- a/docs/tech/3.renderer/templatesVariables.md +++ b/docs/tech/3.renderer/templatesVariables.md @@ -11,4 +11,4 @@ There are several variables available in each processed template.

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Thu Sep 28 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/twigCustomFilters.md b/docs/tech/3.renderer/twigCustomFilters.md index e573dd50..7543e0ea 100644 --- a/docs/tech/3.renderer/twigCustomFilters.md +++ b/docs/tech/3.renderer/twigCustomFilters.md @@ -263,4 +263,4 @@ Here is a list of filters available by default:

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/twigCustomFunctions.md b/docs/tech/3.renderer/twigCustomFunctions.md index 29b1c0d3..e2e992f1 100644 --- a/docs/tech/3.renderer/twigCustomFunctions.md +++ b/docs/tech/3.renderer/twigCustomFunctions.md @@ -385,4 +385,4 @@ Here is a list of functions available by default:

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Thu Sep 28 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/4.pluginSystem/readme.md b/docs/tech/4.pluginSystem/readme.md index 94e263dc..594b5440 100644 --- a/docs/tech/4.pluginSystem/readme.md +++ b/docs/tech/4.pluginSystem/readme.md @@ -192,4 +192,4 @@ plugins:

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/classes/App.md b/docs/tech/classes/App.md index a1700ae4..7995cb2b 100644 --- a/docs/tech/classes/App.md +++ b/docs/tech/classes/App.md @@ -107,7 +107,7 @@ class App extends \Symfony\Component\Console\Application implements \Symfony\Con
  • reset - - This method is used to reset an object to its initial state.
  • +
  • run - Runs the current application.
  • @@ -999,7 +999,7 @@ public function renderThrowable(\Throwable $e, \Symfony\Component\Console\Output public function reset(): mixed; ``` -
    This method is used to reset an object to its initial state.
    + Parameters: not specified diff --git a/docs/tech/classes/BaseCommand.md b/docs/tech/classes/BaseCommand.md index 144803b8..15fd66a2 100644 --- a/docs/tech/classes/BaseCommand.md +++ b/docs/tech/classes/BaseCommand.md @@ -162,7 +162,7 @@ abstract class BaseCommand extends \Symfony\Component\Console\Command\Command ```php diff --git a/docs/tech/classes/DocGenerator.md b/docs/tech/classes/DocGenerator.md index c29b4948..fabe7f77 100644 --- a/docs/tech/classes/DocGenerator.md +++ b/docs/tech/classes/DocGenerator.md @@ -2,7 +2,7 @@ BumbleDocGen / Technical description of the project / Class map / DocGenerator

    - DocGenerator class: + DocGenerator class:

    @@ -55,11 +55,11 @@ final class DocGenerator @@ -74,11 +74,11 @@ final class DocGenerator ```php -public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfony\Component\Console\Style\OutputStyle $io, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Parser\ProjectParser $parser, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Renderer\Renderer $renderer, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \Monolog\Logger $logger); +public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfony\Component\Console\Style\OutputStyle $io, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\Core\Parser\ProjectParser $parser, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Renderer\Renderer $renderer, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \Monolog\Logger $logger); ``` @@ -108,6 +108,11 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo $configuration \BumbleDocGen\Core\Configuration\Configuration - + + + $pluginEventDispatcher + \BumbleDocGen\Core\Plugin\PluginEventDispatcher + - $parser @@ -146,7 +151,7 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo ```php @@ -186,7 +191,7 @@ public function addMissingDocBlocks(): void; ```php @@ -226,7 +231,7 @@ public function fillInReadmeMdTemplate(): void; ```php @@ -254,7 +259,7 @@ public function generate(): void; ```php @@ -294,7 +299,7 @@ public function generateProjectTemplatesStructure(): void; ```php diff --git a/docs/tech/classes/DocGeneratorFactory.md b/docs/tech/classes/DocGeneratorFactory.md index bb0a0c29..cce00f98 100644 --- a/docs/tech/classes/DocGeneratorFactory.md +++ b/docs/tech/classes/DocGeneratorFactory.md @@ -36,6 +36,9 @@ final class DocGeneratorFactory
  • create
  • +
  • + createByConfigArray +
  • createConfiguration
  • @@ -128,6 +131,57 @@ public function create(string|null ...$configurationFiles): \BumbleDocGen\DocGen Return value: \BumbleDocGen\DocGenerator +Throws: + + + +
    +
    + + + +```php +public function createByConfigArray(array $config): \BumbleDocGen\DocGenerator; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $configarray-
    + +Return value: \BumbleDocGen\DocGenerator + + Throws:

    @@ -213,7 +185,7 @@ public function addSubscriber(\Symfony\Component\EventDispatcher\EventSubscriber ```php diff --git a/docs/tech/map.md b/docs/tech/map.md index 9e5a267d..b1fef760 100644 --- a/docs/tech/map.md +++ b/docs/tech/map.md @@ -238,4 +238,4 @@ Directory layout ( only documented files shown ):

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Thu Sep 28 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/readme.md b/docs/tech/readme.md index 72e8c1d4..28e36af4 100644 --- a/docs/tech/readme.md +++ b/docs/tech/readme.md @@ -32,9 +32,16 @@ To start the documentation generation process, you need to call the following co ``` +or + +```php + (new DocGeneratorFactory())->createByConfigArray($configArray)->generate() +``` + + After that, the process of parsing the project code according to the configuration will start, and then filling the templates with data and saving the finished result as final documents.

    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Sep 2 21:01:47 2023 +0300
    Page content update date: Wed Sep 27 2023
    Made with Bumble Documentation Generator
    \ No newline at end of file +Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Thu Oct 5 17:42:06 2023 +0300
    Page content update date: Fri Oct 06 2023
    Made with Bumble Documentation Generator \ No newline at end of file diff --git a/selfdoc/templates/README.md.twig b/selfdoc/templates/README.md.twig index 16616b4b..b4d78c5d 100644 --- a/selfdoc/templates/README.md.twig +++ b/selfdoc/templates/README.md.twig @@ -60,6 +60,8 @@ $factory = new DocGeneratorFactory(); // Create a DocGenerator instance $docgen = $factory->create('/path/to/configuration/files'); +// or $docgen = $factory->createByConfigArray([...]); + // Now call the desired operation $docgen->generate(); ``` diff --git a/selfdoc/templates/_config.yml b/selfdoc/templates/_config.yml deleted file mode 100644 index c272965c..00000000 --- a/selfdoc/templates/_config.yml +++ /dev/null @@ -1,15 +0,0 @@ -markdown: GFM -name: "" -title: null - -remote_theme: tuur29/pages-themes-cayman -color: - header: "#000" - gradient_left: "#e53935" - gradient_right: "#f57c00" -syntax_theme: https://stylishthemes.github.io/Syntax-Themes/pygments/css-github/pygments-monokai.css - -darkmode: true -github: - is_project_page: false -title-heading: false \ No newline at end of file diff --git a/selfdoc/templates/_layouts/default.html b/selfdoc/templates/_layouts/default.html deleted file mode 100644 index 41554095..00000000 --- a/selfdoc/templates/_layouts/default.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - - {% if site.syntax_theme %} - - {% endif %} - - - -
    - {{ content }} - -
    - - - \ No newline at end of file diff --git a/selfdoc/templates/tech/1.configuration/readme.md.twig b/selfdoc/templates/tech/1.configuration/readme.md.twig index dd18ddcf..ff35fe91 100644 --- a/selfdoc/templates/tech/1.configuration/readme.md.twig +++ b/selfdoc/templates/tech/1.configuration/readme.md.twig @@ -3,10 +3,12 @@ {{ "Configuration" | textToHeading('H1') }} -Documentation generator configuration is stored in special files. +Documentation generator configuration can be stored in special files. They can be in different formats: yaml, json, php arrays, ini, xml -During the generation process, the data from these files is loaded into the Configuration class, and the code works directly with it. +But it is not necessary to use files to store the configuration; you can also initialize the documentation generator instance by passing there an array of configuration parameters (see demo-5) + +During the instance creation process, configuration data is loaded into Configuration class, and the code works directly with it. {{ "Configuration file example" | textToHeading('H2') }} diff --git a/selfdoc/templates/tech/readme.md.twig b/selfdoc/templates/tech/readme.md.twig index 3f98e194..858ce1c2 100644 --- a/selfdoc/templates/tech/readme.md.twig +++ b/selfdoc/templates/tech/readme.md.twig @@ -30,4 +30,8 @@ To start the documentation generation process, you need to call the following co {{ "(new DocGeneratorFactory())->create($configFile)->generate()" | textToCodeBlock('php') }} +or + +{{ "(new DocGeneratorFactory())->createByConfigArray($configArray)->generate()" | textToCodeBlock('php') }} + After that, the process of parsing the project code according to the configuration will start, and then filling the templates with data and saving the finished result as final documents. diff --git a/src/Console/Command/BaseCommand.php b/src/Console/Command/BaseCommand.php index c2056137..19979257 100644 --- a/src/Console/Command/BaseCommand.php +++ b/src/Console/Command/BaseCommand.php @@ -57,13 +57,21 @@ protected function createDocGenInstance( return $docGeneratorFactory->create(); } + private function prepareCustomConfigurationParameterValue(string $optionName, string $rawValue): string|bool|int|float + { + return match ($optionName) { + 'use_shared_cache' => (fn($rawValue): bool => !($rawValue === 'false') && $rawValue)($rawValue), + default => $rawValue, + }; + } + final protected function getCustomConfigurationParameters(InputInterface $input): array { $customConfigurationParameters = []; foreach ($this->getCustomConfigOptionsMap() as $optionName => $description) { $optionValue = $input->getOption($optionName); if (!is_null($optionValue)) { - $customConfigurationParameters[$optionName] = $optionValue; + $customConfigurationParameters[$optionName] = $this->prepareCustomConfigurationParameterValue($optionName, $optionValue); } } return $customConfigurationParameters; diff --git a/src/Console/Command/GenerateCommand.php b/src/Console/Command/GenerateCommand.php index af45b382..35046669 100644 --- a/src/Console/Command/GenerateCommand.php +++ b/src/Console/Command/GenerateCommand.php @@ -7,7 +7,6 @@ use DI\DependencyException; use DI\NotFoundException; use Psr\Cache\InvalidArgumentException; -use Symfony\Component\Filesystem\Path; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; @@ -20,6 +19,7 @@ protected function getCustomConfigOptionsMap(): array 'templates_dir' => 'Path to directory with documentation templates', 'output_dir' => 'Path to the directory where the finished documentation will be generated', 'cache_dir' => 'Configuration parameter: Path to the directory where the documentation generator cache will be saved', + 'use_shared_cache' => 'Enable/disable shared cache when generating documentation (true/false)', ]; } diff --git a/src/Core/Plugin/PluginEventDispatcher.php b/src/Core/Plugin/PluginEventDispatcher.php index e9e94640..c9198bf7 100644 --- a/src/Core/Plugin/PluginEventDispatcher.php +++ b/src/Core/Plugin/PluginEventDispatcher.php @@ -4,29 +4,12 @@ namespace BumbleDocGen\Core\Plugin; -use BumbleDocGen\Core\Configuration\Configuration; -use BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException; -use DI\DependencyException; -use DI\NotFoundException; use Symfony\Component\EventDispatcher\EventDispatcher; class PluginEventDispatcher extends EventDispatcher { private array $handledSingleExecutionEvents = []; - /** - * @throws DependencyException - * @throws NotFoundException - * @throws InvalidConfigurationParameterException - */ - public function __construct(Configuration $configuration) - { - parent::__construct(); - foreach ($configuration->getPlugins() as $plugin) { - $this->addSubscriber($plugin); - } - } - public function dispatch(object $event, string $eventName = null): object { if ($event instanceof OnlySingleExecutionEvent) { diff --git a/src/DocGenerator.php b/src/DocGenerator.php index 829982ef..61a56b59 100644 --- a/src/DocGenerator.php +++ b/src/DocGenerator.php @@ -8,6 +8,7 @@ use BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException; use BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup; use BumbleDocGen\Core\Parser\ProjectParser; +use BumbleDocGen\Core\Plugin\PluginEventDispatcher; use BumbleDocGen\Core\Renderer\Renderer; use BumbleDocGen\Core\Renderer\Twig\Filter\AddIndentFromLeft; use BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity; @@ -32,13 +33,14 @@ */ final class DocGenerator { - public const VERSION = '1.1.0'; + public const VERSION = '1.2.0'; public const LOG_FILE_NAME = 'last_run.log'; public function __construct( private Filesystem $fs, private OutputStyle $io, private Configuration $configuration, + PluginEventDispatcher $pluginEventDispatcher, private ProjectParser $parser, private ParserHelper $parserHelper, private Renderer $renderer, @@ -48,6 +50,10 @@ public function __construct( if (file_exists(self::LOG_FILE_NAME)) { unlink(self::LOG_FILE_NAME); } + + foreach ($configuration->getPlugins() as $plugin) { + $pluginEventDispatcher->addSubscriber($plugin); + } } /** diff --git a/src/DocGeneratorFactory.php b/src/DocGeneratorFactory.php index 722f06ca..e32a2201 100644 --- a/src/DocGeneratorFactory.php +++ b/src/DocGeneratorFactory.php @@ -58,6 +58,27 @@ public function create(?string ...$configurationFiles): DocGenerator } } + /** + * @throws DependencyException + * @throws NotFoundException + * @throws \Exception + */ + public function createByConfigArray(array $config): DocGenerator + { + $diContainer = $this->buildDiContainer(); + $logger = $diContainer->get(LoggerInterface::class); + try { + /** @var ConfigurationParameterBag $configurationParameterBag */ + $configurationParameterBag = $diContainer->get(ConfigurationParameterBag::class); + $configurationParameterBag->loadFromArray($config); + $configurationParameterBag->loadFromArray($this->customConfigurationParameters); + return $diContainer->get(DocGenerator::class); + } catch (\Exception $e) { + $logger->error("{$e->getMessage()} ( {$e->getFile()}:{$e->getLine()} )"); + throw new \RuntimeException($e->getMessage()); + } + } + /** * @throws DependencyException * @throws NotFoundException diff --git a/src/di-config.php b/src/di-config.php index 8af72172..4c8833e3 100644 --- a/src/di-config.php +++ b/src/di-config.php @@ -10,7 +10,6 @@ use Monolog\Handler\StreamHandler; use Monolog\Logger; use Psr\Log\LoggerInterface; -use BumbleDocGen\Core\Plugin\PluginEventDispatcher; use Symfony\Component\Console\Completion\CompletionInput; use Symfony\Component\Console\Output\ConsoleOutput; use Symfony\Component\Console\Style\OutputStyle; @@ -69,7 +68,6 @@ \DI\autowire(RefValueResolver::class), ] ), - PluginEventDispatcher::class => \DI\autowire(PluginEventDispatcher::class)->lazy(), OutputStyle::class => \DI\autowire(SymfonyStyle::class) ->constructor( input: \DI\autowire(CompletionInput::class),