Skip to content

Commit

Permalink
Merge pull request #62 from bumble-tech/caching_system_refactoring
Browse files Browse the repository at this point in the history
Cache system refactoring
  • Loading branch information
shcherbanich authored Nov 1, 2023
2 parents 241d74b + 72836e2 commit 19055cb
Show file tree
Hide file tree
Showing 47 changed files with 399 additions and 307 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ To update this documentation, run the following command:

<div id='page_committer_info'>
<hr>
<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b> Sat Oct 28 11:03:31 2023 +0300<br><b>Page content update date:</b> Tue Oct 31 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b> Sat Oct 28 11:03:31 2023 +0300<br><b>Page content update date:</b> Wed Nov 01 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
2 changes: 1 addition & 1 deletion docs/shared_c.cache

Large diffs are not rendered by default.

58 changes: 41 additions & 17 deletions docs/tech/1.configuration/classes/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ final class Configuration
<li>
<a href="#mgetcachedir">getCacheDir</a>
</li>
<li>
<a href="#mgetconfigurationversion">getConfigurationVersion</a>
</li>
<li>
<a href="#mgetdocgenlibdir">getDocGenLibDir</a>
</li>
Expand Down Expand Up @@ -153,7 +156,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParame
<ul>
<li><a name="mgetadditionalconsolecommands" href="#mgetadditionalconsolecommands">#</a>
<b>getAdditionalConsoleCommands</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L344">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L349">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -187,7 +190,7 @@ public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\Ad
<ul>
<li><a name="mgetcachedir" href="#mgetcachedir">#</a>
<b>getCacheDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L191">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L196">source code</a></li>
</ul>

```php
Expand All @@ -208,14 +211,35 @@ public function getCacheDir(): string|null;

</ul>

</div>
<hr>
<div class='method_description-block'>

<ul>
<li><a name="mgetconfigurationversion" href="#mgetconfigurationversion">#</a>
<b>getConfigurationVersion</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L42">source code</a></li>
</ul>

```php
public function getConfigurationVersion(): string;
```



<b>Parameters:</b> not specified

<b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.string.php'>string</a>


</div>
<hr>
<div class='method_description-block'>

<ul>
<li><a name="mgetdocgenlibdir" href="#mgetdocgenlibdir">#</a>
<b>getDocGenLibDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L334">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L339">source code</a></li>
</ul>

```php
Expand All @@ -236,7 +260,7 @@ public function getDocGenLibDir(): string;
<ul>
<li><a name="mgetgitclientpath" href="#mgetgitclientpath">#</a>
<b>getGitClientPath</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L237">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L242">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -264,7 +288,7 @@ public function getGitClientPath(): string;
<ul>
<li><a name="mgetlanguagehandlerscollection" href="#mgetlanguagehandlerscollection">#</a>
<b>getLanguageHandlersCollection</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L152">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L157">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -298,7 +322,7 @@ public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\L
<ul>
<li><a name="mgetoutputdir" href="#mgetoutputdir">#</a>
<b>getOutputDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L104">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L109">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -326,7 +350,7 @@ public function getOutputDir(): string;
<ul>
<li><a name="mgetoutputdirbaseurl" href="#mgetoutputdirbaseurl">#</a>
<b>getOutputDirBaseUrl</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L136">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L141">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -354,7 +378,7 @@ public function getOutputDirBaseUrl(): string;
<ul>
<li><a name="mgetpagelinkprocessor" href="#mgetpagelinkprocessor">#</a>
<b>getPageLinkProcessor</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L219">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L224">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -388,7 +412,7 @@ public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProc
<ul>
<li><a name="mgetplugins" href="#mgetplugins">#</a>
<b>getPlugins</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L173">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L178">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -422,7 +446,7 @@ public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
<ul>
<li><a name="mgetprojectroot" href="#mgetprojectroot">#</a>
<b>getProjectRoot</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L45">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L50">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -450,7 +474,7 @@ public function getProjectRoot(): string;
<ul>
<li><a name="mgetsourcelocators" href="#mgetsourcelocators">#</a>
<b>getSourceLocators</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L61">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L66">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -484,7 +508,7 @@ public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\Sou
<ul>
<li><a name="mgettemplatesdir" href="#mgettemplatesdir">#</a>
<b>getTemplatesDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L79">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L84">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -512,7 +536,7 @@ public function getTemplatesDir(): string;
<ul>
<li><a name="mgettwigfilters" href="#mgettwigfilters">#</a>
<b>getTwigFilters</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L276">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L281">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -546,7 +570,7 @@ public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\Custom
<ul>
<li><a name="mgettwigfunctions" href="#mgettwigfunctions">#</a>
<b>getTwigFunctions</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L253">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L258">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -580,7 +604,7 @@ public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\Cu
<ul>
<li><a name="mgetworkingdir" href="#mgetworkingdir">#</a>
<b>getWorkingDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L325">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L330">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -608,7 +632,7 @@ public function getWorkingDir(): string;
<ul>
<li><a name="mischeckfileingitbeforecreatingdocenabled" href="#mischeckfileingitbeforecreatingdocenabled">#</a>
<b>isCheckFileInGitBeforeCreatingDocEnabled</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L311">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L316">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -636,7 +660,7 @@ public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
<ul>
<li><a name="musesharedcache" href="#musesharedcache">#</a>
<b>useSharedCache</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L297">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L302">source code</a></li>
</ul>

```php
Expand Down
2 changes: 1 addition & 1 deletion docs/tech/1.configuration/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,4 +222,4 @@ The inheritance algorithm is as follows: scalar types can be overwritten by each

<div id='page_committer_info'>
<hr>
<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b> Sat Oct 28 11:03:31 2023 +0300<br><b>Page content update date:</b> Tue Oct 31 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b> Sat Oct 28 11:03:31 2023 +0300<br><b>Page content update date:</b> Wed Nov 01 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
Loading

0 comments on commit 19055cb

Please sign in to comment.