# limegreentangerine/classkit architecture

> Architecture diagram of the GitHub repository limegreentangerine/classkit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/limegreentangerine/classkit
- Repository: https://github.com/limegreentangerine/classkit

## Overview

ClassKit is a reusable Concrete CMS helper library, not a standalone application. Its main workflow is package authors extending the package controller and composing setup traits; other independent helpers support page/AJAX listing, localization, API calls, file imports, search, and entities. The README documents these capabilities; source excerpts and the index substantiate only some internal calls, so undocumented connections are omitted.

Main entry points: [`src/Page/AjaxPage/AjaxPage.php`](https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/AjaxPage.php) (AJAX pagination), [`src/Api/ConnectionController.php`](https://github.com/limegreentangerine/classkit/blob/main/src/Api/ConnectionController.php) (API connection), [`src/Package/PackageController.php`](https://github.com/limegreentangerine/classkit/blob/main/src/Package/PackageController.php) (Package controller), [`src/Package/Traits`](https://github.com/limegreentangerine/classkit/tree/main/src/Package/Traits) (Setup traits)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_package["Package lifecycle"]
  node_package_controller["Package controller"]
  node_install_event["Install event"]
  node_package_traits["Setup traits"]
end

subgraph group_pages["Pages and localization"]
  node_page_helpers["Page helpers<br/>[Page.php]"]
  node_page_list["Page list<br/>[PageList.php]"]
  node_ajax_page["AJAX pagination<br/>[AjaxPage.php]"]
  node_ajax_config["AJAX configuration<br/>[AjaxPageConfig.php]"]
  node_ajax_request["AJAX request"]
  node_ajax_response["AJAX response"]
  node_sort_order["Sort order<br/>[SortOrder.php]"]
  node_translation["Translation adaptor"]
  node_global_area["Localized global area<br/>[GlobalArea.php]"]
  node_theme["Theme helper<br/>[Theme.php]"]
end

subgraph group_integrations["API and files"]
  node_api_connection["API connection"]
  node_api_response["API responses<br/>[Response.php]"]
  node_response_types["Response types<br/>[ResponseType.php]"]
  node_request_methods["Request methods<br/>[RequestMethod.php]"]
  node_error_response["Error responses<br/>[ErrorResponse.php]"]
  node_file_import["Remote file import"]
end

subgraph group_utilities["Search and foundations"]
  node_cached_search["Cached search<br/>[CachedSearch.php]"]
  node_search_results["Search results<br/>[Result.php]"]
  node_search_list["Search list helpers<br/>[ListTrait.php]"]
  node_search_item["Result item helpers<br/>[ItemTrait.php]"]
  node_entities["Entity bases<br/>[BaseEntity.php]"]
  node_environment["Environment checks<br/>[Environment.php]"]
  node_logger["Logger<br/>[Logger.php]"]
end

node_package_author(("Package author"))
node_cms(("Concrete CMS"))
node_remote_api(("Remote API"))
node_file_manager[("Concrete file manager")]

node_package_author -.->|"extends"| node_package_controller
node_package_author -.->|"composes"| node_package_traits
node_package_controller -->|"dispatches"| node_install_event
node_package_controller -.->|"registers setup"| node_cms
node_package_traits -->|"uses page"| node_page_helpers
node_package_traits -->|"reuses import"| node_file_import
node_ajax_page -->|"reads options"| node_ajax_config
node_ajax_page -->|"parses request"| node_ajax_request
node_ajax_page -->|"queries pages"| node_page_list
node_ajax_page -->|"selects ordering"| node_sort_order
node_ajax_page -->|"uses adaptor"| node_translation
node_ajax_page -->|"builds payload"| node_ajax_response
node_global_area -->|"reads locale"| node_cms
node_theme -->|"installs theme"| node_cms
node_api_connection -->|"validates method"| node_request_methods
node_api_connection -->|"selects format"| node_response_types
node_api_connection -->|"creates response"| node_api_response
node_api_connection -->|"creates errors"| node_error_response
node_api_connection -->|"sends request"| node_remote_api
node_file_import -->|"imports files"| node_file_manager
node_cached_search -.->|"returns results"| node_search_results
node_search_item -->|"uses result"| node_search_results
node_entities -.->|"supports models"| node_cms
node_environment -.->|"checks runtime"| node_cms

click node_package_controller "https://github.com/limegreentangerine/classkit/blob/main/src/Package/PackageController.php"
click node_install_event "https://github.com/limegreentangerine/classkit/blob/main/src/Package/Events/PackageInstallEvent.php"
click node_package_traits "https://github.com/limegreentangerine/classkit/tree/main/src/Package/Traits"
click node_page_helpers "https://github.com/limegreentangerine/classkit/blob/main/src/Page/Page.php"
click node_page_list "https://github.com/limegreentangerine/classkit/blob/main/src/Page/PageList.php"
click node_ajax_page "https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/AjaxPage.php"
click node_ajax_config "https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/AjaxPageConfig.php"
click node_ajax_request "https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/AjaxPageRequest.php"
click node_ajax_response "https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/AjaxPageResponse.php"
click node_sort_order "https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/Enums/SortOrder.php"
click node_translation "https://github.com/limegreentangerine/classkit/blob/main/src/Page/TranslationAdaptorTrait.php"
click node_global_area "https://github.com/limegreentangerine/classkit/blob/main/src/Area/GlobalArea.php"
click node_theme "https://github.com/limegreentangerine/classkit/blob/main/src/Page/Theme/Theme.php"
click node_api_connection "https://github.com/limegreentangerine/classkit/blob/main/src/Api/ConnectionController.php"
click node_api_response "https://github.com/limegreentangerine/classkit/blob/main/src/Api/Response/Response.php"
click node_response_types "https://github.com/limegreentangerine/classkit/blob/main/src/Api/Enum/ResponseType.php"
click node_request_methods "https://github.com/limegreentangerine/classkit/blob/main/src/Api/Enum/RequestMethod.php"
click node_error_response "https://github.com/limegreentangerine/classkit/blob/main/src/Api/Response/ErrorResponse.php"
click node_file_import "https://github.com/limegreentangerine/classkit/blob/main/src/File/ImportFileTrait.php"
click node_cached_search "https://github.com/limegreentangerine/classkit/blob/main/src/Search/CachedSearch.php"
click node_search_results "https://github.com/limegreentangerine/classkit/blob/main/src/Search/Result.php"
click node_search_list "https://github.com/limegreentangerine/classkit/blob/main/src/Search/ItemList/ListTrait.php"
click node_search_item "https://github.com/limegreentangerine/classkit/blob/main/src/Search/Result/Item/ItemTrait.php"
click node_entities "https://github.com/limegreentangerine/classkit/blob/main/src/Entity/Core/BaseEntity.php"
click node_environment "https://github.com/limegreentangerine/classkit/blob/main/src/Environment/Environment.php"
click node_logger "https://github.com/limegreentangerine/classkit/blob/main/src/Log/Logger.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_package_controller,node_install_event,node_package_traits toneBlue
class node_page_helpers,node_page_list,node_ajax_page,node_ajax_config,node_ajax_request,node_ajax_response,node_sort_order,node_translation,node_global_area,node_theme,node_file_manager toneAmber
class node_api_connection,node_api_response,node_response_types,node_request_methods,node_error_response,node_file_import,node_remote_api toneMint
class node_cached_search,node_search_results,node_search_list,node_search_item,node_entities,node_environment,node_logger toneRose
class node_package_author,node_cms toneIndigo
```

## Components

### Package lifecycle

- [Package controller](https://github.com/limegreentangerine/classkit/blob/main/src/Package/PackageController.php): `src/Package/PackageController.php`
- [Install event](https://github.com/limegreentangerine/classkit/blob/main/src/Package/Events/PackageInstallEvent.php): `src/Package/Events/PackageInstallEvent.php`
- [Setup traits](https://github.com/limegreentangerine/classkit/tree/main/src/Package/Traits): `src/Package/Traits`

### Pages and localization

- [Page helpers](https://github.com/limegreentangerine/classkit/blob/main/src/Page/Page.php): `src/Page/Page.php`
- [Page list](https://github.com/limegreentangerine/classkit/blob/main/src/Page/PageList.php): `src/Page/PageList.php`
- [AJAX pagination](https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/AjaxPage.php): `src/Page/AjaxPage/AjaxPage.php`
- [AJAX configuration](https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/AjaxPageConfig.php): `src/Page/AjaxPage/AjaxPageConfig.php`
- [AJAX request](https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/AjaxPageRequest.php): `src/Page/AjaxPage/AjaxPageRequest.php`
- [AJAX response](https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/AjaxPageResponse.php): `src/Page/AjaxPage/AjaxPageResponse.php`
- [Sort order](https://github.com/limegreentangerine/classkit/blob/main/src/Page/AjaxPage/Enums/SortOrder.php): `src/Page/AjaxPage/Enums/SortOrder.php`
- [Translation adaptor](https://github.com/limegreentangerine/classkit/blob/main/src/Page/TranslationAdaptorTrait.php): `src/Page/TranslationAdaptorTrait.php`
- [Localized global area](https://github.com/limegreentangerine/classkit/blob/main/src/Area/GlobalArea.php): `src/Area/GlobalArea.php`
- [Theme helper](https://github.com/limegreentangerine/classkit/blob/main/src/Page/Theme/Theme.php): `src/Page/Theme/Theme.php`

### API and files

- [API connection](https://github.com/limegreentangerine/classkit/blob/main/src/Api/ConnectionController.php): `src/Api/ConnectionController.php`
- [API responses](https://github.com/limegreentangerine/classkit/blob/main/src/Api/Response/Response.php): `src/Api/Response/Response.php`
- [Response types](https://github.com/limegreentangerine/classkit/blob/main/src/Api/Enum/ResponseType.php): `src/Api/Enum/ResponseType.php`
- [Request methods](https://github.com/limegreentangerine/classkit/blob/main/src/Api/Enum/RequestMethod.php): `src/Api/Enum/RequestMethod.php`
- [Error responses](https://github.com/limegreentangerine/classkit/blob/main/src/Api/Response/ErrorResponse.php): `src/Api/Response/ErrorResponse.php`
- [Remote file import](https://github.com/limegreentangerine/classkit/blob/main/src/File/ImportFileTrait.php): `src/File/ImportFileTrait.php`

### Search and foundations

- [Cached search](https://github.com/limegreentangerine/classkit/blob/main/src/Search/CachedSearch.php): `src/Search/CachedSearch.php`
- [Search results](https://github.com/limegreentangerine/classkit/blob/main/src/Search/Result.php): `src/Search/Result.php`
- [Search list helpers](https://github.com/limegreentangerine/classkit/blob/main/src/Search/ItemList/ListTrait.php): `src/Search/ItemList/ListTrait.php`
- [Result item helpers](https://github.com/limegreentangerine/classkit/blob/main/src/Search/Result/Item/ItemTrait.php): `src/Search/Result/Item/ItemTrait.php`
- [Entity bases](https://github.com/limegreentangerine/classkit/blob/main/src/Entity/Core/BaseEntity.php): `src/Entity/Core/BaseEntity.php`
- [Environment checks](https://github.com/limegreentangerine/classkit/blob/main/src/Environment/Environment.php): `src/Environment/Environment.php`
- [Logger](https://github.com/limegreentangerine/classkit/blob/main/src/Log/Logger.php): `src/Log/Logger.php`

### Other components

- **Package author**
- **Concrete CMS**
- **Remote API**
- **Concrete file manager**

## Connections

- Package author → Package controller: extends (evidence: `README.md`)
- Package author → Setup traits: composes (evidence: `README.md`)
- Package controller → Install event: dispatches (evidence: `src/Package/PackageController.php`)
- Package controller → Concrete CMS: registers setup (evidence: `README.md`)
- Setup traits → Page helpers: uses page (evidence: `src/Package/Traits/PageTrait.php`)
- Setup traits → Remote file import: reuses import (evidence: `src/Package/Traits/FileTrait.php`)
- AJAX pagination → AJAX configuration: reads options (evidence: `src/Page/AjaxPage/AjaxPage.php`)
- AJAX pagination → AJAX request: parses request (evidence: `src/Page/AjaxPage/AjaxPage.php`)
- AJAX pagination → Page list: queries pages (evidence: `src/Page/AjaxPage/AjaxPage.php`)
- AJAX pagination → Sort order: selects ordering (evidence: `src/Page/AjaxPage/AjaxPage.php`)
- AJAX pagination → Translation adaptor: uses adaptor (evidence: `src/Page/AjaxPage/AjaxPage.php`)
- AJAX pagination → AJAX response: builds payload (evidence: `src/Page/AjaxPage/AjaxPage.php`)
- Localized global area → Concrete CMS: reads locale (evidence: `src/Area/GlobalArea.php`)
- Theme helper → Concrete CMS: installs theme (evidence: `src/Page/Theme/Theme.php`)
- API connection → Request methods: validates method (evidence: `src/Api/ConnectionController.php`)
- API connection → Response types: selects format (evidence: `src/Api/ConnectionController.php`)
- API connection → API responses: creates response (evidence: `src/Api/ConnectionController.php`)
- API connection → Error responses: creates errors (evidence: `src/Api/ConnectionController.php`)
- API connection → Remote API: sends request (evidence: `src/Api/ConnectionController.php`)
- Remote file import → Concrete file manager: imports files (evidence: `src/File/ImportFileTrait.php`)
- Cached search → Search results: returns results
- Result item helpers → Search results: uses result (evidence: `src/Search/Result/Item/ItemTrait.php`)
- Entity bases → Concrete CMS: supports models (evidence: `README.md`)
- Environment checks → Concrete CMS: checks runtime (evidence: `README.md`)
