Added automatically generated api references to the project

flow-php · Feb 7, 2025 · 48fac20 · 48fac20
1 parent b23ac5e
commit 48fac20
Show file tree

Hide file tree

Showing 49 changed files with 1,075 additions and 40 deletions.
diff --git a/.github/workflows/baseline.yml b/.github/workflows/baseline.yml
@@ -238,6 +238,9 @@ jobs:
           GOOGLE_CONVERSION_TAG: '${{ vars.GOOGLE_CONVERSION_TAG }}'
         working-directory: "web/landing"
 
+      - name: "Generate Api References"
+        run: "composer build:docs:api"
+
       - name: Pushes build to website repository
         uses: cpina/github-action-push-to-another-repository@main
         env:

diff --git a/composer.json b/composer.json
@@ -396,6 +396,36 @@
         "build:docs": [
             "bin/docs.php dsl:dump web/landing/resources/dsl.json"
         ],
+        "build:docs:api": [
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/core.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/cli.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.array-dot.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.azure-sdk.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.doctrine-dbal-bulk.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.filesystem.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.parquet.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.parquet-viewer.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.rdsl.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.snappy.xml",
+
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.chartjs.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.csv.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.doctrine.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.elasticsearch.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.google-sheet.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.http.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.json.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.logger.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.meilisearch.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.parquet.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.text.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.xml.xml",
+
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/bridge.filesystem.async-aws.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/bridge.filesystem.azure.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/bridge.symfony.http-foundation.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/bridge.monolog.http.xml"
+        ],
         "build:parquet:thrift": [
             "grep -q 'namespace php Flow.Parquet.Thrift' src/lib/parquet/src/Flow/Parquet/Resources/Thrift/parquet.thrift || { echo \"Flow php namespace not found in thrift definition!\"; exit 1; }\n",
             "rm src/lib/parquet/src/Flow/Parquet/Thrift/*.php",

diff --git a/documentation/components/adapters/chartjs.md b/documentation/components/adapters/chartjs.md
@@ -1,6 +1,8 @@
 # Chart JS Adapter
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/chartjs)
+- [📁Files](/documentation/api/adapter/chartjs/indices/files.html)
 
 Flow PHP's Adapter ChartJS is a meticulously designed library intended to seamlessly integrate ChartJS within your ETL (
 Extract, Transform, Load) workflows. This adapter is pivotal for developers seeking to effortlessly render and interact

diff --git a/documentation/components/adapters/csv.md b/documentation/components/adapters/csv.md
@@ -1,6 +1,8 @@
 # CSV Adapter 
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/csv)
+- [📁Files](/documentation/api/adapter/csv/indices/files.html)
 
 Flow PHP's Adapter CSV is a proficient library crafted to enable seamless interaction with CSV data within your ETL (
 Extract, Transform, Load) workflows. This adapter is indispensable for developers aiming to effortlessly extract from or

diff --git a/documentation/components/adapters/doctrine.md b/documentation/components/adapters/doctrine.md
@@ -1,6 +1,8 @@
 # ETL Adapter: Doctrine
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/doctrine)
+- [📁Files](/documentation/api/adapter/doctrin/indices/files.html)
 
 Flow PHP's Adapter Doctrine is an adept library designed to seamlessly integrate Doctrine ORM within your ETL (Extract,
 Transform, Load) workflows. This adapter is crucial for developers seeking to effortlessly interact with databases using

diff --git a/documentation/components/adapters/elasticsearch.md b/documentation/components/adapters/elasticsearch.md
@@ -1,6 +1,8 @@
 # ETL Adapter: Elasticsearch
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/elasticsearch)
+- [📁Files](/documentation/api/adapter/elasticsearch/indices/files.html)
 
 Flow PHP's Adapter Elasticsearch is a sophisticated library devised to facilitate seamless interaction with
 Elasticsearch within your ETL (Extract, Transform, Load) workflows. This adapter is essential for developers aiming to

diff --git a/documentation/components/adapters/google-sheet.md b/documentation/components/adapters/google-sheet.md
@@ -1,6 +1,8 @@
 # ETL Adapter: Google Sheet
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/google-sheet)
+- [📁Files](/documentation/api/adapter/google-sheet/indices/files.html)
 
 Flow PHP's Adapter Google Sheet is a comprehensive library engineered to enable smooth interactions with Google Sheets
 within your ETL (Extract, Transform, Load) workflows. This adapter is indispensable for developers looking to seamlessly

diff --git a/documentation/components/adapters/http.md b/documentation/components/adapters/http.md
@@ -1,6 +1,8 @@
 # ETL Adapter: HTTP
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/http)
+- [📁Files](/documentation/api/adapter/http/indices/files.html)
 
 Flow PHP's Adapter HTTP is a finely crafted library designed to enable seamless interaction with HTTP protocols within
 your ETL (Extract, Transform, Load) workflows. This adapter is vital for developers aiming to effortlessly send or

diff --git a/documentation/components/adapters/json.md b/documentation/components/adapters/json.md
@@ -1,6 +1,8 @@
 # ETL Adapter: JSON
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/json)
+- [📁Files](/documentation/api/adapter/json/indices/files.html)
 
 Flow PHP's Adapter JSON is a meticulously engineered library aimed at facilitating seamless interactions with JSON data
 within your ETL (Extract, Transform, Load) workflows. This adapter is paramount for developers seeking to effortlessly

diff --git a/documentation/components/adapters/logger.md b/documentation/components/adapters/logger.md
@@ -1,6 +1,8 @@
 # ETL Adapter: Logger
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/logger)
+- [📁Files](/documentation/api/adapter/logger/indices/files.html)
 
 ETL Adapter that provides PSR Logger support for ETL.
 

diff --git a/documentation/components/adapters/meilisearch.md b/documentation/components/adapters/meilisearch.md
@@ -1,6 +1,8 @@
 # ETL Adapter: MeiliSearch
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/meilisearch)
+- [📁Files](/documentation/api/adapter/meilisearch/indices/files.html)
 
 Flow PHP's Adapter MeiliSearch is a refined library designed to seamlessly integrate MeiliSearch capabilities within
 your ETL (Extract, Transform, Load) workflows. This adapter is essential for developers seeking to effortlessly interact

diff --git a/documentation/components/adapters/parquet.md b/documentation/components/adapters/parquet.md
@@ -1,6 +1,8 @@
 # ETL Adapter: Parquet
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/parquet)
+- [📁Files](/documentation/api/adapter/parquet/indices/files.html)
 
 Flow PHP's Adapter Parquet is a sophisticated library meticulously engineered to enable seamless interaction with
 Parquet data formats within your ETL (Extract, Transform, Load) workflows. This adapter is crucial for developers

diff --git a/documentation/components/adapters/text.md b/documentation/components/adapters/text.md
@@ -1,6 +1,8 @@
 # ETL Adapter: Text
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/text)
+- [📁Files](/documentation/api/adapter/text/indices/files.html)
 
 Flow PHP's Adapter Text is a meticulously crafted library dedicated to enabling seamless handling of text data within
 your ETL (Extract, Transform, Load) workflows. This adapter is pivotal for developers seeking to effortlessly extract

diff --git a/documentation/components/adapters/xml.md b/documentation/components/adapters/xml.md
@@ -1,6 +1,8 @@
 # ETL Adapter: XML
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/adapter/xml)
+- [📁Files](/documentation/api/adapter/xml/indices/files.html)
 
 Flow PHP's Adapter XML is a dedicated library engineered to facilitate seamless interactions with XML data within your
 ETL (Extract, Transform, Load) processes. This adapter empowers developers to effortlessly extract from and load data

diff --git a/documentation/components/bridges/filesystem-async-aws-bridge.md b/documentation/components/bridges/filesystem-async-aws-bridge.md
@@ -1,6 +1,8 @@
 # Filesystem Async AWS
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/bridge/filesystem/async-aws)
+- [📁Files](/documentation/api/bridge/filesystem/async-aws/indices/files.html)
 
 The Filesystem Async AWS Bridge is a bridge that allows you to use the S3 as a filesystem in your application 
 through [Async AWS SDK](https://github.com/async-aws/s3).

diff --git a/documentation/components/bridges/filesystem-azure-bridge.md b/documentation/components/bridges/filesystem-azure-bridge.md
@@ -1,6 +1,8 @@
 # Filesystem Azure Bridge
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/bridge/filesystem/azure)
+- [📁Files](/documentation/api/bridge/filesystem/azure/indices/files.html)
 
 The Filesystem Azure Bridge is a bridge that allows you to use the Azure Blob Storage as a filesystem in your application.
 

diff --git a/documentation/components/bridges/monolog-http-bridge.md b/documentation/components/bridges/monolog-http-bridge.md
@@ -1,6 +1,8 @@
 # Monolog HTTP Bridge
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/bridge/monolog/http)
+- [📁Files](/documentation/api/bridge/monolog/http/indices/files.html)
 
 Monolog HTTP Bridge is a package that iterates through LogRecord context and normalizes all instances of `Request` and `Response` from [PSR7](https://www.php-fig.org/psr/psr-7/).
 

diff --git a/documentation/components/bridges/symfony-http-foundation-bridge.md b/documentation/components/bridges/symfony-http-foundation-bridge.md
@@ -1,6 +1,8 @@
 # Symfony Http Foundation Bridge
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/bridge/symfony/http-foundation)
+- [📁Files](/documentation/api/bridge/symfony/http-foundation/indices/files.html)
 
 Http Foundation Bridge provides seamless integration between Symfony Http Foundation and Flow PHP.
 

diff --git a/documentation/components/cli/docs.md b/documentation/components/cli/docs.md
@@ -1,5 +1,8 @@
 # Flow Command Line Interface
 
+- [⬅️️ Back](/documentation/quick-start.md)
+- [📚API Reference](/documentation/api/cli)
+- [📁Files](/documentation/api/cli/indices/files.html)
 
 ## Installation
 

diff --git a/documentation/components/core/core.md b/documentation/components/core/core.md
@@ -1,6 +1,8 @@
 # Data Frame
 
 - [⬅️️ Back](/documentation/quick-start.md)
+- [📚API Reference](/documentation/api/core)
+- [📁Files](/documentation/api/core/indices/files.html)
 
 A Data Frame is a structured collection of tabular data, similar to a spreadsheet.  
 It organizes information into rows and columns, making it easy to understand, filter, and transform.  

diff --git a/documentation/components/libs/array-dot.md b/documentation/components/libs/array-dot.md
@@ -1,6 +1,8 @@
 # Array Dot
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/lib/array-dot)
+- [📁Files](/documentation/api/lib/array-dot/indices/files.html)
 
 Flow PHP's Array Dot is a proficient library engineered to enhance array handling and manipulation in PHP. This library
 embodies a practical solution for accessing and manipulating array elements using dot notation, facilitating a more

diff --git a/documentation/components/libs/azure-sdk.md b/documentation/components/libs/azure-sdk.md
@@ -1,6 +1,8 @@
 # Azure SDK
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/lib/azure-sdk)
+- [📁Files](/documentation/api/lib/azure-sdk/indices/files.html)
 
 Simple, lightweight, dependency-free and efficient Azure SDK for PHP.
 

diff --git a/documentation/components/libs/doctrine-dbal-bulk.md b/documentation/components/libs/doctrine-dbal-bulk.md
@@ -1,6 +1,8 @@
 # Doctrine Bulk
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/lib/doctrine-dbal-bulk)
+- [📁Files](/documentation/api/lib/doctrine-dbal-bulk/indices/files.html)
 
 Flow PHP's Doctrine DBAL Bulk is a specialized library crafted for optimizing bulk operations in your data workflows.
 This library is a prime choice for handling bulk data tasks with the Doctrine Database Abstraction Layer (DBAL),

diff --git a/documentation/components/libs/filesystem.md b/documentation/components/libs/filesystem.md
@@ -1,6 +1,8 @@
 # Filesystem
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/lib/filesystem)
+- [📁Files](/documentation/api/lib/filesystem/indices/files.html)
 
 ## Installation
 

diff --git a/documentation/components/libs/parquet-viewer.md b/documentation/components/libs/parquet-viewer.md
@@ -1,6 +1,8 @@
 # Parquet Viewer
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/lib/parquet-viewer)
+- [📁Files](/documentation/api/lib/parquet-viewer/indices/files.html)
 
 ## Installation
 

diff --git a/documentation/components/libs/parquet.md b/documentation/components/libs/parquet.md
@@ -1,6 +1,8 @@
 # Parquet
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/lib/parquet)
+- [📁Files](/documentation/api/lib/parquet/indices/files.html)
 
 ## Installation
 

diff --git a/documentation/components/libs/rdsl.md b/documentation/components/libs/rdsl.md
@@ -1,6 +1,8 @@
 # DSL
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/lib/rdsl)
+- [📁Files](/documentation/api/lib/rdsl/indices/files.html)
 
 RDSL - Remote Domain Specific Language 
 

diff --git a/documentation/components/libs/snappy.md b/documentation/components/libs/snappy.md
@@ -1,6 +1,8 @@
 # Snappy
 
 - [⬅️️ Back](../../introduction.md)
+- [📚API Reference](/documentation/api/lib/snappy)
+- [📁Files](/documentation/api/lib/snappy/indices/files.html)
 
 Pure PHP implementation of Google [Snappy](https://github.com/google/snappy) compression algorithm.
 

diff --git a/phpdoc/.phpdoc/template/base.html.twig b/phpdoc/.phpdoc/template/base.html.twig
@@ -0,0 +1,18 @@
+{% extends 'layout.html.twig' %}
+
+{%
+    set topMenu = {
+    "menu": [
+        { "name": "Back", "url": "/documentation"},
+    ]
+}
+%}
+
+{% set usesPackages = false %}
+
+{% block stylesheets %}
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Cabin:ital,wght@0,400..700;1,400..700&display=swap" rel="stylesheet">
+    {{ parent() }}
+{% endblock %}
diff --git a/phpdoc/.phpdoc/template/components/header.html.twig b/phpdoc/.phpdoc/template/components/header.html.twig
@@ -0,0 +1,11 @@
+<div class="flow-header-wrapper">
+    <header class="phpdocumentor-header phpdocumentor-section">
+        {% include 'components/header-title.html.twig' %}
+        <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
+        <label class="phpdocumentor-header__menu-icon" for="menu-button">
+            <i class="fas fa-bars"></i>
+        </label>
+        {{ include('components/search.html.twig') }}
+        {% include 'components/topnav.html.twig' %}
+    </header>
+</div>
diff --git a/phpdoc/.phpdoc/template/components/sidebar.html.twig b/phpdoc/.phpdoc/template/components/sidebar.html.twig
@@ -0,0 +1,33 @@
+<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
+<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
+    Menu
+</label>
+<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
+    {% for version in project.versions %}
+        {% for toc in version.tableOfContents %}
+        {% if toc.name != 'Packages' %}
+            <section class="phpdocumentor-sidebar__category -{{ toc.name|lower }}">
+                <h2 class="phpdocumentor-sidebar__category-header">{{ toc.name|title }}</h2>
+                    {% for root in toc.roots %}
+                        {{ toc(root, 'components/menu.html.twig', 1) }}
+                    {% endfor %}
+            </section>
+        {% endif %}
+        {% endfor %}
+    {% endfor %}
+
+    <section class="phpdocumentor-sidebar__category -reports">
+        <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
+        {% if project.settings.custom['graphs.enabled'] %}
+        <h3 class="phpdocumentor-sidebar__root-package"><a href="graphs/classes.html">Class Diagram</a></h3>
+        {% endif %}
+        <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
+        <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
+        <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
+    </section>
+
+    <section class="phpdocumentor-sidebar__category -indices">
+        <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
+        <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
+    </section>
+</aside>