Charcoal Content Management System (CMS) Module

Overview

Charcoal CMS

The CMS Charcoal Module (Content Management System). Provides basic objects to build a website. Notably, Section (or page), News, Event and Faq as well as to ather user data, notably ContactInquiry.

This module is heavily dependant on charcoal-object (and therefore charcoal-core) which provides the base Content class the CMS objects are dependant on, as well as many trait / interface behaviors.

How to install

The preferred (and only supported) way of installing charcoal-cms is with composer:

★ composer require locomotivemtl/charcoal-cms

For a complete, ready-to-use project, start from the charcoal project boilerplate:

★ composer create-project locomotivemtl/charcoal-project-boilerplate:@dev --prefer-source

Dependencies

Recommended dependencies

Objects

Core objects

Section object

A section, in Charcoal, is a reachable page on the website, as part of the full hierarchical site map. They can be displayed in menus or breadcrumbs and be reached with a unique URL (routable).

Types of sections:

  • blocks
    • Blocks sections define their content as a structured map of blocks.
  • content
    • Content sections define their content in a single, simple HTML property.
  • empty
    • Empty sections are linked to a template but do not require any custom content.
  • external
    • External sections are simply a redirect to an external (or internal) URL.

All section types, except external, make use of a Template object to be rendered. Typically, a charcoal view make sure of linking the template (by default, mustache

Sections are standard Charcoal Model, meaning they are describable with a Metadata object (which define a map of properties) and storable with a Source object.

Base section properties:

Interface Name L10n Type Description
Section section_type choice
Section title string
Section subtitle html
Section summary html
Section image image
Section template_ident string
Section template_options structure
Section content html
Section attachments multi-object
Section external_url url For external URLs. Note that all content-related properties are ignored if this property is set.
Content id id The model's key.
Content active bool Inactive events should not appear in public API / frontend.
Content position int Default order property.
Authorable created_by string Admin user.
Authorable last_modified_by string Admin user.
Authorable required_acl_permissions array To do...
Timestampable created date-time
Timestampable last_modified date-time
Hierarchical master object SectionInterface.
Routable slug string Permalink. Auto-generated from title.

Interfaces

From model:

  • Describable: The objects can be defined by Metadata.
  • Storable: Objects have unique IDs and can be stored in storage / database.

From content:

  • Content: A "managed" charcoal model (describable with metadata / storable).
  • Authorable: Creation and modification user (admin) are kept in the storage.
  • Revisionable: Copy of changes will be kept upon each object update in the storage.
  • Timestampable: Creation and modification time are kept into the storage.

From charcoal-object

  • Hierarchicale: The objects can be stacked hierarchically.
  • Publishable: Objects have publish status, date and expiry. Allows moderation.
  • Routable: Objects are reachable through a URL.

From charcoal-cms:

  • Metatag: The objects have meta-information for SEO purpose.
  • Searchable: Extra keywords can be used to help search engine.
  • Templateable: The objects can be rendered with a template / controller / config combo.

Extending the section object

The \Charcoal\Cms\Section\* objects are final. To extend, use the \Charcoal\Cms\AbstractSection base object instead, to make sure no metadata conflicts arise.

Tag object

Tag objects link any objects together by providing an extra taxonomy layer. Tags may also be used to enhance internal search engines.

CMS objects

Event object

Charcoal Event is a specialized content object to describe an event, which typically happens at a given date in a certain location.

Base events properties:

Interface Name L10n Type Description
Event title string
Event subtitle html
Event summary html
Event content html
Event image image
Event start_date date-time
Event end_date date-time
Event info_url image
Content id id The model's key.
Content active bool Inactive events should not appear in public API / frontend.
Content position int Default order property.
Authorable created_by string Admin user.
Authorable last_modified_by string Admin user.
Authorable required_acl_permissions array To do...
Timestampable created date-time
Timestampable last_modified date-time
Categorizable category object EventCategory, or custom.
Publishable publishDate date-time
Publishable expiryDate date-time
Publishable publishStatus string draft, pending, or published.
Routable slug string Permalink. Auto-generated from title.
Metatag meta_title string
Metatag meta_description string
Metatag meta_image image
Metatag meta_author string
Templateable controller_ident string
Templateable template_ident string
Templateable template_options structure

Interfaces

From model:

  • Describable: The objects can be defined by Metadata.
  • Storable: Objects have unique IDs and can be stored in storage / database.

From content:

  • Content: A "managed" charcoal model (describable with metadata / storable).
  • Authorable: Creation and modification user (admin) are kept in the storage.
  • Revisionable: Copy of changes will be kept upon each object update in the storage.
  • Timestampable: Creation and modification time are kept into the storage.

From charcoal-object:

  • Categorizable: The objects can be put into a category.
  • Publishable: Objects have publish status, date and expiry. Allows moderation.
  • Routable: Objects are reachable through a URL.

From charcoal-cms:

  • Metatag: The objects have meta-information for SEO purpose.
  • Searchable: Extra keywords can be used to help search engine.
  • Templateable: The objects can be rendered with a template / controller / config combo.

Extending the event object

The \Charcoal\Cms\Event object is final. To extend, use the \Charcoal\Cms\AbstractEvent base object instead, to make sure no metadata conflicts arise.

Event categories

Event category objects are simple charcoal/object/category used to group / categorize events. The default type is Charcoal\Cms\EventCategory.

Events implement the Categorizable interface, from charcoal-object.

FAQ object

FAQ objects are a special content type that is split in a "question" / "answer" format.

FAQ categories

FAQ category objects are simple charcoal/object/category used to group / categorize FAQ objects. The default type is Charcoal\Cms\FaqCategory.

FAQs implement the Categorizable interface, from charcoal-object.

News object

News object are a special content type that with a specific news date.

Base news properties:

Interface Name L10n Type Description
News title string
News subtitle html
News summary html
News content html
News image image
News news_date date-time
News info_url image
Content id id The model's key.
Content active bool Inactive news should not appear in public API / frontend.
Content position int Default order property.
Authorable created_by string Admin user.
Authorable last_modified_by string Admin user.
Authorable required_acl_permissions array To do...
Timestampable created date-time
Timestampable last_modified date-time
Categorizable category object NewsCategory, or custom.
Publishable publishDate date-time
Publishable expiryDate date-time
Publishable publishStatus string draft, pending, or published.
Routable slug string Permalink. Auto-generated from title.
Metatag meta_title string
Metatag meta_description string
Metatag meta_image image
Metatag meta_author string
Templateable controller_ident string
Templateable template_ident string
Templateable template_options structure

Interfaces

From model:

  • Describable: The objects can be defined by Metadata.
  • Storable: Objects have unique IDs and can be stored in storage / database.

From content:

  • Content: A "managed" charcoal model (describable with metadata / storable).
  • Authorable: Creation and modification user (admin) are kept in the storage.
  • Revisionable: Copy of changes will be kept upon each object update in the storage.
  • Timestampable: Creation and modification time are kept into the storage.

From charcoal-object:

  • Categorizable: The objects can be put into a category.
  • Publishable: Objects have publish status, date and expiry. Allows moderation.
  • Routable: Objects are reachable through a URL.

From charcoal-cms:

  • Metatag: The objects have meta-information for SEO purpose.
  • Searchable: Extra keywords can be used to help search engine.
  • Templateable: The objects can be rendered with a template / controller / config combo.

Extending the news object

The \Charcoal\Cms\News object is final. To extend, use the \Charcoal\Cms\AbstractNews base object instead, to make sure no metadata conflicts arise.

News categories

News category objects are simple charcoal/object/category used to group / categorize events. The default type is Charcoal\Cms\NewsCategory.

News implement the Categorizable interface, from charcoal-object.

Development

To install the development environment:

$ composer install --prefer-source

API documentation

Development dependencies

  • phpunit/phpunit
  • squizlabs/php_codesniffer
  • satooshi/php-coveralls

Continuous Integration

Service Badge Description
Travis Build Status Runs code sniff check and unit tests. Auto-generates API documentation.
Scrutinizer Scrutinizer Code Quality Code quality checker. Also validates API documentation quality.
Coveralls Coverage Status Unit Tests code coverage.
Sensiolabs SensioLabsInsight Another code quality checker, focused on PHP.

Coding Style

The charcoal-cms module follows the Charcoal coding-style:

Coding style validation / enforcement can be performed with composer phpcs. An auto-fixer is also available with composer phpcbf.

Authors

License

Charcoal is licensed under the MIT license. See LICENSE for details.

Comments
  • Chrcoal CMS  not working

    Chrcoal CMS not working

    Hello , firstly I cloned this repo , then run "composer require locomotivemtl/charcoal-cms" , i am unable to open website or CMS system i.e Front end the go to Backend | admin page . Please help me out , as i m building website CMS with Charcoal CMS . Thanks

    opened by bidyashish 1
  • Mustache.php v2.14.1 security release

    Mustache.php v2.14.1 security release

    Mustache.php v2.14.1 was released today. It contains a security improvement, and should be a straightforward update.

    https://github.com/bobthecow/mustache.php/releases/tag/v2.14.1

    (You're receiving this issue because Packagist says you depend on Mustache.php)

    opened by bobthecow 0
  • Update tests: use array access to access instead of methods

    Update tests: use array access to access instead of methods

    Update tests: use array access to access the slug in News, Event and Section instead of slug() and use array access to get the structureInterface instead of structureInterfaces() in TemplateOptionsProperty

    opened by losted 0
  • [!] Update to latest Charcoal architecture

    [!] Update to latest Charcoal architecture

    Requires:

    • locomotivemtl/charcoal-core v0.6.x
    • locomotivemtl/charcoal-property v0.10.x

    Changed:

    • Bump branch-alias to 0.9

    Todo:

    • [ ] Convert property identifiers to camelCase
    • [ ] Prefix property getter methods
    • [ ] Normalize "get" prefix in traits (e.g., DocumentTrait, LocaleAwareTrait)
    • [ ] Clean-up AbstractWebTemplate
    • [ ] Delete new features from PR #9 from original mcaskill/charcoal-support
    • [ ] Replace individual metatag methods on AbstractWebTemplate with a single Transformer-style method (or one per specification)
    opened by mcaskill 0
  • Charcoal\Relation

    Charcoal\Relation

    Adds support for creating and working with relationships between models, using an intermediate object. A source model has one or many relationships with a target model. These relationships are stored in an intermediate pivot model.

    opened by dominiclord 1
Releases(0.10.0)
Flextype is an open-source Hybrid Content Management System with the freedom of a headless CMS and with the full functionality of a traditional CMS

Flextype is an open-source Hybrid Content Management System with the freedom of a headless CMS and with the full functionality of a traditional CMS. Building this Content Management System, we focused on simplicity. To achieve this, we implemented a simple but powerful API's.

Flextype 524 Dec 30, 2022
Baicloud CMS is a lightweight content management system (CMS) based on PHP and MySQL and running on Linux, windows and other platforms

BaiCloud-cms About BaiCloud-cms is a powerful open source CMS that allows you to create professional websites and scalable web applications. Visit the

null 5 Aug 15, 2022
The repository for Coaster CMS (coastercms.org), a full featured, Laravel based Content Management System

The repository for Coaster CMS (coastercms.org) a Laravel based Content Management System with advanced features and Physical Web integration. Table o

Coaster CMS 392 Dec 23, 2022
Fully CMS - Multi Language Content Management System - Laravel

Fully CMS Laravel 5.1 Content Managment System not stable! Features Laravel 5.1 Bootstrap Authentication Sentinel Ckeditor Bootstrap Code Prettify Fil

Sefa Karagöz 479 Dec 22, 2022
Soosyze CMS is a minimalist content management system in PHP, without database to create and manage your website easily

Soosyze CMS is a content management system without a database. It's easy to create and manage you

Soosyze 41 Jan 6, 2023
A small CMS for SaaS - A tiny content management system

Fervoare CMS A tiny content management system Project created in 2012 and ported to GitHub in 2021. Getting started Assuming you have installed a LAMP

Mark Jivko 3 Oct 1, 2022
Simple Content Management System (CMS) Blog Using Codeigniter with Hierarchical Model View Controller (HMVC) Architectural

Simple Content Management System (CMS) Blog Using Codeigniter with Hierarchical Model View Controller (HMVC) Architectural This is my source code trai

Simon Montaño 1 Oct 28, 2021
Coaster CMS a full featured, Laravel based Content Management System

The repository for Coaster CMS (coastercms.org) a Laravel based Content Management System with advanced features and Physical Web integration. Table o

Coaster CMS 392 Dec 23, 2022
e107 Bootstrap CMS (Content Management System) v2 with PHP, MySQL, HTML5, jQuery and Twitter Bootstrap

e107 is a free and open-source content management system (CMS) which allows you to manage and publish your content online with ease. Developers can save time in building websites and powerful online applications. Users can avoid programming completely! Blogs, websites, intranets – e107 does it all.

e107 Content Management System 298 Dec 17, 2022
A Concrete CMS package to add interfaces to translate multilingual content. You can translate content manually, or use cloud API.

Concrete CMS add-on: Macareux Content Translator Concrete CMS has powerful features to manage multilingual content by its default. You can add languag

株式会社マカルーデジタル 3 Nov 28, 2022
Core framework that implements the functionality of the Sulu content management system

Sulu is a highly extensible open-source PHP content management system based on the Symfony framework. Sulu is developed to deliver robust multi-lingua

Sulu CMS 921 Dec 28, 2022
Simple, modular content management system adapted for launch pages and one-page websites

Segmint Segmint is an easy-to-use flat-file landing page framework, allowing quick and efficient prototyping and deployment - perfect for freelancers

null 2 Jul 19, 2022
Monstra is a modern and lightweight Content Management System.

Monstra is a modern and lightweight Content Management System.

Monstra Content Management 398 Dec 11, 2022
ExpressionEngine is a mature, flexible, secure, free open-source content management system.

ExpressionEngine is a flexible, feature-rich, free open-source content management platform that empowers hundreds of thousands of individuals and organizations around the world to easily manage their web site.

ExpressionEngine 366 Mar 29, 2022
An advanced yet user-friendly content management system, based on the full stack Symfony framework combined with a whole host of community bundles

An advanced yet user-friendly content management system, based on the full stack Symfony framework combined with a whole host of community bundles. It provides a full featured, multi-language CMS system with an innovative page and form assembling process, versioning, workflow, translation and media managers and much more.

Kunstmaan | Accenture Interactive 374 Dec 23, 2022
Mecha is a flat-file content management system for minimalists.

Mecha CMS Mecha is a flat-file content management system for minimalists. Front-End The default layout uses only Serif and Mono fonts. Different opera

Mecha 133 Jan 1, 2023
Feindura - Flat File Content Management System

feindura - Flat File Content Management System Copyright (C) Fabian Vogelsteller [frozeman.de] published under the GNU General Public License version

Fabian Vogelsteller 39 Dec 30, 2022
Edit richt text content in Craft CMS using Article by Imperavi.

Article Editor About the plugin This plugin brings the powerful Article Editor from Imperavi to Craft CMS, allowing you to make create beautiful rich

Creativeorange 6 Mar 30, 2022
Contenta is a content API and CMS based on Drupal 8

Contenta is a content API and CMS based on Drupal 8. It provides a standard, jsonapi-based platform for building decoupled applications and websites.

Contenta CMS 326 Jul 10, 2022