How catkinfox/opengraph works
This October CMS plugin generates cached, text-overlaid OpenGraph images for CMS pages. The principal workflow is page rendering → component settings and title selection → image generation or cache reuse → an image URL exposed to the page’s OpenGraph markup. Administrators configure assets and typography and can clear the cache. The README documents these capabilities; the component and generator implementations were sampled, while the markup partial’s contents were not, so its rendering link follows the documented behavior.
Main entry points: ImageGenerator.php Image generator · OpenGraphImage.php OpenGraph component · Settings.php Image settings · fields.yaml Settings form
Components 12
Page image flow
- OpenGraph component
components/OpenGraphImage.php - OpenGraph markup
components/opengraphimage/default.htm - Generated image URL
Image settings
- Image settings
models/Settings.php - Settings form
models/settings/fields.yaml - Uploaded assets
Generation and cache
- Image generator
classes/ImageGenerator.php - Imagick extension
- Media cache
Other components
- Page request
- October CMS
- Site administrator
Connections 13
- Page request → October CMS: requests page
- October CMS → OpenGraph component: renders component
- Site administrator → Settings form: configures
- Settings form → Image settings: updates
- Image settings → Uploaded assets: stores uploads
- OpenGraph component → Image settings: reads settings
- OpenGraph component → Image generator: requests image
- Image generator → Imagick extension: renders image
- Image generator → Media cache: checks cache
- Image generator → Media cache: writes image
- Image generator → OpenGraph component: returns URL
- OpenGraph component → OpenGraph markup: provides image URL
- Image settings → Media cache: clears cache