# vinugawade/com.osseed.eventcalendar architecture

> Architecture diagram of the GitHub repository vinugawade/com.osseed.eventcalendar, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vinugawade/com.osseed.eventcalendar
- Repository: https://github.com/vinugawade/com.osseed.eventcalendar

## Overview

##### Project Type and Purpose
- This is a PHP–JavaScript “plugin” (extension) for CiviCRM that provides an Event Calendar.
- It hooks into CiviCRM’s framework (Admin UI, API v3, ORM, templating), supplies its own forms/pages for configuration and display, and integrates with Joomla and WordPress front-ends.

##### High-Level Components
a. CiviCRM Core
- Provides DB schema management, API framework, ORM (DAO/BAO), menu hooks, templating (Smarty), event system.
b. EventCalendar Extension
- PHP Back-end
– DAO/BAO classes (CRM/EventCalendar/DAO & BAO)
– Form classes (CRM/EventCalendar/Form) for settings
– Page controllers (CRM/EventCalendar/Page) for ManageEventCalendars & ShowEvents
– Upgrader (Upgrader.php) & SQL scripts (sql/auto_install.sql, auto_uninstall.sql) for schema changes
– XML schema definitions (xml/schema/CRM/EventCalendar/*.xml)
– API v3 endpoints (api/v3/EventCalendar.php, EventCalendarEventType.php)
- Front-end Assets
– Templates (templates/CRM/EventCalendar/… .tpl) rendered by Smarty
– CSS (css/fullcalendar.css, civicrm_events.css)
– JS libraries (js/fullcalendar.js, moment.js, jscolor.js, locale-all.js, eventcalendar.js)
- Localization files (l10n/*/*.mo)
c. Integration Adapters
- Joomla menu type (joomla/EventCalendar/…)
- WordPress plugin wrapper (wordpress/osseed-wordpress-event-calendar/*.php)
d. Data Store
- MySQL (tables civicrm_event_calendar, civicrm_event_calendar_type, plus CiviCRM’s core tables)

##### Relationships & Data Flows
- Admin user → CiviCRM menu → Extension Form/Page → BAO/DAO → MySQL
- Public user → /civicrm/showevents → Page controller → DAO → JSON or HTML → Front-end JS (FullCalendar) → Renders calendar
- API clients → /civicrm/api/v3/EventCalendar → API wrapper → DAO → DB → JSON
- Upgrader/SQL → DB schema changes on install/upgrade
- CMS (Joomla/WordPress) → loads plugin files → registers menu/shortcode → delegates to CiviCRM pages

##### Architectural Patterns & Principles
- MVC-like within CiviCRM: Page controllers (C), Smarty templates (V), BAO/DAO (M)
- Extension modularity: clear separation of configuration (Form), presentation (Page + templates), data (DAO/BAO)
- API-first: provides a v3 API wrapper for event calendar entities
- Plugin-adapter layers for multiple CMSs

## Diagram (Mermaid)

```mermaid
graph TB
  %% CMS Adapters
  subgraph "CMS Adapters"
    A1[Joomla Adapter]:::adapter
    A2[WordPress Adapter]:::adapter
  end
  A1 -->|loads extension| Core
  A2 -->|loads extension| Core

  %% CiviCRM Core
  subgraph "CiviCRM Core"
    Core[/"CiviCRM Core"/]:::core
  end
  Core --> Extension

  %% EventCalendar Extension
  subgraph "EventCalendar Extension"
    %% Configuration UI
    subgraph "Configuration UI"
      F1["CRM/EventCalendar/Form/EventCalendarSettings.php"]:::backend
      P1["CRM/EventCalendar/Page/ManageEventCalendars.php"]:::backend
    end

    %% Public UI
    subgraph "Public UI"
      P2["CRM/EventCalendar/Page/ShowEvents.php"]:::backend
      FE["FullCalendar JS & Templates"]:::frontend
    end

    %% Data Layer
    subgraph "Data Layer"
      M1["CRM/EventCalendar/DAO/EventCalendar.php"]:::backend
      M2["CRM/EventCalendar/DAO/EventCalendarEventType.php"]:::backend
      B1["CRM/EventCalendar/BAO/EventCalendar.php"]:::backend
    end

    %% API v3 Endpoints
    subgraph "API v3 Endpoints"
      API1["api/v3/EventCalendar.php"]:::backend
      API2["api/v3/EventCalendarEventType.php"]:::backend
    end

    %% Schema & Upgrades
    subgraph "Schema & Upgrades"
      U1["CRM/EventCalendar/Upgrader.php"]:::backend
      S1["/sql/auto_install.sql/"]:::backend
      S2["/sql/auto_uninstall.sql/"]:::backend
      X1["/xml/schema/CRM/EventCalendar/EventCalendar.xml/"]:::backend
      X2["/xml/schema/CRM/EventCalendar/EventCalendar.entityType.php/"]:::backend
      X3["/xml/schema/CRM/EventCalendar/EventCalendarType.xml/"]:::backend
      X4["/xml/schema/CRM/EventCalendar/EventCalendarType.entityType.php/"]:::backend
    end

    %% Front-end Assets
    subgraph "Front-end Assets"
      CSS1["css/fullcalendar.css"]:::frontend
      CSS2["css/civicrm_events.css"]:::frontend
      JS1["js/fullcalendar.js"]:::frontend
      JS2["js/moment.js"]:::frontend
      JS3["js/jscolor.js"]:::frontend
      JS4["js/locale-all.js"]:::frontend
      JS5["js/eventcalendar.js"]:::frontend
      T1["templates/CRM/EventCalendar/Form/EventCalendarSettings.tpl"]:::frontend
      T2["templates/CRM/EventCalendar/Page/ManageEventCalendars.tpl"]:::frontend
      T3["templates/CRM/EventCalendar/Page/ShowEvents.tpl"]:::frontend
    end

    %% Localization
    subgraph "Localization"
      L1["l10n/fr_CA/LC_MESSAGES/eventcalendar.mo"]:::backend
      L2["l10n/fr_FR/LC_MESSAGES/eventcalendar.mo"]:::backend
    end
  end

  %% Database
  DB[(MySQL)]:::db

  %% Data Flows
  F1 -->|"submit settings"| B1
  P1 -->|"display settings"| F1
  P1 -->|"load settings"| B1
  B1 -->|"write"| DB
  M1 -->|"fetch/save"| DB
  M2 -->|"fetch/save"| DB
  P2 -->|"fetch events"| M1
  M1 -->|"return events"| P2
  P2 -->|"render"| FE
  API1 -->|"api call"| M1
  API2 -->|"api call"| M2
  M1 -->|"return JSON"| API1
  U1 -->|"run install"| S1
  U1 -->|"run uninstall"| S2
  U1 -->|"load xml schema"| X1
  U1 -->|"load xml schema"| X2
  U1 -->|"load xml schema"| X3
  U1 -->|"load xml schema"| X4
  S1 -->|"execute"| DB
  S2 -->|"execute"| DB

  %% Click Events
  click M1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/CRM/EventCalendar/DAO/EventCalendar.php"
  click M2 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/CRM/EventCalendar/DAO/EventCalendarEventType.php"
  click B1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/CRM/EventCalendar/BAO/EventCalendar.php"
  click F1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/CRM/EventCalendar/Form/EventCalendarSettings.php"
  click P1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/CRM/EventCalendar/Page/ManageEventCalendars.php"
  click P2 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/CRM/EventCalendar/Page/ShowEvents.php"
  click U1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/CRM/EventCalendar/Upgrader.php"
  click S1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/sql/auto_install.sql"
  click S2 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/sql/auto_uninstall.sql"
  click X1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/xml/schema/CRM/EventCalendar/EventCalendar.xml"
  click X2 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/xml/schema/CRM/EventCalendar/EventCalendar.entityType.php"
  click X3 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/xml/schema/CRM/EventCalendar/EventCalendarType.xml"
  click X4 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/xml/schema/CRM/EventCalendar/EventCalendarType.entityType.php"
  click API1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/api/v3/EventCalendar.php"
  click API2 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/api/v3/EventCalendarEventType.php"
  click T1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/templates/CRM/EventCalendar/Form/EventCalendarSettings.tpl"
  click T2 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/templates/CRM/EventCalendar/Page/ManageEventCalendars.tpl"
  click T3 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/templates/CRM/EventCalendar/Page/ShowEvents.tpl"
  click CSS1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/css/fullcalendar.css"
  click CSS2 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/css/civicrm_events.css"
  click JS1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/js/fullcalendar.js"
  click JS2 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/js/moment.js"
  click JS3 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/js/jscolor.js"
  click JS4 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/js/locale-all.js"
  click JS5 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/js/eventcalendar.js"
  click A1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/joomla/EventCalendar/metadata.xml"
  click A1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/joomla/EventCalendar/view.html.php"
  click A1 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/joomla/EventCalendar/tmpl/default.xml"
  click A2 "https://github.com/vinugawade/com.osseed.eventcalendar/blob/master/wordpress/osseed-wordpress-event-calendar/osseed-wordpress-event-calendar.php"

  %% Styles
  classDef backend fill:#D0E1FF,stroke:#0366d6,stroke-width:1px
  classDef frontend fill:#DFF2D8,stroke:#22863a,stroke-width:1px
  classDef db fill:#FFEFD5,stroke:#d73a49,stroke-width:1px
  classDef adapter fill:#F3E5F5,stroke:#6f42c1,stroke-width:1px
  classDef core fill:#FFF5B1,stroke:#735c0f,stroke-width:1px
```
