README

LGT Toolkit is a Concrete CMS package designed to provide a standard set of site defaults, blocks, attributes, and admin utilities for Lime Green Tangerine builds. It is built as a concrete5-package and installs a consistent toolkit for content editors, developers, and designers working inside Concrete CMS.

Requirements

Concrete CMS 9.5+
PHP 8.4+
Composer-based project installation

Package overview

The package defines a package handle of lgt_toolkit and is installed as a standard Concrete package. On install and upgrade it:

registers package service providers
creates dashboard single pages
installs custom attribute types and attribute sets
installs a block type set and the bundled block types
copies selected application overrides into /application
applies default CMS configuration values for SEO, security, session handling, white-labelling, and social media links

Included functionality

Core CMS defaults

The package sets a wide range of default Concrete configuration values to match the LGT project baseline, including:

marketplace disabled
URL rewriting enabled
SEO title formatting and trailing slash preferences
accessibility toolbar titles enabled
white-label settings applied for the Lime Green Tangerine brand
database-backed session configuration
security session invalidation on IP mismatch
social media service definitions for common profiles

Custom attributes

The package creates a set of reusable attributes for site and page content:

Site attributes
- Company name
- Company phone
- Company email
- Company address
- Default sharing image
Page / collection attributes
- Page banner
- SEO header
- Page redirector
File attributes
- File categories

It also installs custom attribute types:

country
lgt_colour_picker
lgt_file_set
lgt_page_redirector

Custom blocks

The package auto-installs these block types under a package-specific block set:

lgt_ajax_file_list
lgt_ajax_page_list
lgt_anchor_menu
lgt_anchor_target
lgt_blockquote
lgt_button
lgt_content_side_title
lgt_content_site_attribute
lgt_fileset_gallery
lgt_manual_nav
lgt_section
lgt_social_share
lgt_spacer
lgt_video
lgt_vimeo_video

These blocks provide content patterns and UI elements commonly used across LGT sites, including page and file lists, navigation, buttons, content sections, galleries, video embeds, and social sharing.

Dashboard utilities

The package creates dashboard pages for common tasks:

/dashboard/lgt_toolkit
/dashboard/lgt_toolkit/cookie_popup
/dashboard/lgt_toolkit/duplicate_express
/dashboard/lgt_toolkit/redirections

These pages support configuration for:

cookie policy behaviour
duplicate Express object tooling
301/302 redirections to pages

Redirections

The Redirections dashboard page (/dashboard/lgt_toolkit/redirections) manages redirections from old URL paths to pages on the site, for example after a migration or a page rename.

Each rule has a source path, a destination page and a status code:

Temporary (302) is the default and is recommended.
Permanent (301) can be chosen per rule.

From the dashboard page you can add, edit, delete and bulk-delete rules, and filter the list by source path or status code. The list is paginated and sortable.

How redirections are served

Rules are stored in the LgtRedirections table. Each rule's source path is also added as a non-canonical PagePath on the destination page, and removed again when the rule is changed or deleted. Canonical page paths are never touched.

A request middleware answers matching requests before Concrete issues its own redirect for additional page paths. Core always uses a 301, so this is what allows 302 rules to work. The middleware:

only handles GET and HEAD requests
keeps the original query string on the redirect
does nothing if the destination page has been deleted, trashed or is no longer routable
fails open, so a database problem never takes the site down

Path rules

Source paths are normalised before they are stored or matched: lowercase, a leading slash, no trailing slash, and no query string or fragment. Full URLs are accepted if they are on the current site's host; URLs on other hosts are rejected.

A rule is rejected if the source:

is empty, the home page (/), or contains control characters, whitespace or . / .. segments
is a reserved system path, such as /dashboard, /login, /logout, /concrete, /ccm, /application, /packages, /updates, /index.php, /robots.txt or /sitemap.xml
is already the address of the destination page, or of any other page
already has a redirection

The destination must be an existing, published page. Trashed, system, admin and external-link pages cannot be used.

CSV import

Rules can be imported in bulk from the dashboard page, which also offers a sample file to download. Files must be .csv or .txt and up to 2MB. Up to 5,000 rows are read.

source,destination,code
/old-about-us,/about-us,302
/old-contact,/contact,301
/old-news,/news,

Columns are source, destination and an optional status code (301 or 302; blank uses 302).
The delimiter (comma, semicolon or tab) is detected from the first line.
A header row is skipped if the first cell starts with source, from or old.
The destination is a path or full URL of a page on this site.
Invalid rows are skipped rather than failing the whole import. The import report lists each skipped row with its line number and reason, including duplicates within the file.

Page Redirector attribute

Separately, the lgt_page_redirector attribute type and its page_redirector page attribute (in the Navigation and Indexing set) redirect an individual page, when it is viewed, to another page or an external URL using a chosen HTTP status. This is independent of the Redirections dashboard page.

Package services and integrations

The package registers supporting services for common application needs:

autocache for automatic cache management
focal_point for image focal point handling
lgt_mail for custom mail handling
express_debugger for Express debugging support

It also registers routes for:

duplicate Express object conversion
LGT AJAX file/page listing endpoints
focal point dialog handling
cookie policy AJAX endpoints

Installation

Add the package to your Concrete project with Composer:

composer require limegreentangerine/lgt_toolkit
Install the package in the Concrete CMS dashboard or via the package manager workflow.
Once enabled, the package will automatically create the dashboard pages, blocks, attributes, and configuration.

Development notes

This package is intentionally opinionated and is meant to provide a shared baseline for multiple Concrete CMS sites. It centralises commonly reused configuration, block patterns, and attribute definitions so projects can start from a predictable, production-friendly standard.

Slideshow helper

The package includes a reusable slideshow utility in src/Slideshow for building slide configurations and exposing the generated option payload for front-end rendering. It supports either a list of string slides or an array of slide objects, and provides the default viewport sizing, snap behaviour, autoplay, and button controls used across site builds.

Example

use LgtToolkit\Slideshow\Slideshow;

$slides = [
    ['title' => 'One', 'image' => '/images/one.jpg'],
    ['title' => 'Two', 'image' => '/images/two.jpg'],
];

$slideshow = new Slideshow($slides, [
    'mobile' => 1,
    'desktop' => 2,
    'hd' => 3,
    'draggable' => true,
    'snap' => 'center',
    'autoplay' => [
        'enabled' => true,
        'speed' => 6,
        'useTimer' => true,
    ],
]);

$options = $slideshow->getOptions();
$styleVars = $slideshow->generateStyleVariables();

Supported settings

The slideshow settings array supports the following options:

mobile, desktop, hd: visible slides per breakpoint
draggable: whether drag/swipe interaction is enabled
snap: snap alignment (none, start, center, end)
gap, peek: per-breakpoint spacing values
showButtons, showPagination: per-breakpoint visibility toggles
useTheme: whether the theme stylesheet should be used
prevIcon, nextIcon: icon classes for navigation buttons
autoplay: nested settings for enabled state, speed, and timer usage
template: optional package template metadata

The utility exposes helper methods for the generated stylesheet, theme stylesheet, JavaScript asset, options payload, and CSS variable string, which makes it easy to render custom slide components in a Concrete CMS view layer.

Testing

The package uses PHPUnit for regression coverage. Tests live under tests/ and use a lightweight bootstrap for package code that does not require a running Concrete CMS site.

Coverage includes slideshow settings and rendering, AJAX cookie and placeholder responses, mail template rendering, social-share links, focal-point and redirect values, attribute and block behavior, dashboard output, and the responsive picture override.

Run the suite with:

composer test
composer test-coverage

Run composer test after making changes to verify the suite. Use composer test-coverage to print a coverage report when the required coverage driver is available.

License

MIT

limegreentangerine / lgt_toolkit

Package info

Security

Statistics