Documentation

Table of contents

Introduction

This package adds the block Content Box to your concreteCMS-Site including two custom block-templates.

This block can be used to add image, text and a button at once to your website.

This block can simply be used as a button block.

You can configure some default values (used in the block-form) in the cms-backend (dashboard).

The UI of this package is (currently) available in following languages:

  • English
  • German

Contact me if you need some other langauges!

@developers and @designers: it is very simple to create your own block-templates.

Package-Requirements

  • PHP 8.*
  • ConcreteCMS 9.*
  • Composer/Installers (^1.3)

Installation

Make sure that the system requirements are met before installing this package to avoid errors.

The recommended way to install this package is via composer.


    {
      "require": {
        "tochtergesellschaft/tgs_content_box": "1.0.0"
      }
    }

To install this package wthout using composer, perform the following steps:

  1. Download and unzip the package-directory.
  2. Move the inner tga_content_box folder into your website's packages folder. The directory-structure should now look like: /public/packages/tga_content_box.
  3. Log in to your website as admin (https://example.domain/login).
  4. Navigate to the Extend Concrete dashboard-page (https://example.domain/dashboard/extend/install). At the bottom of this page in the Awaiting Installation section the package ConcreteCMS - Content Box should be listed now.
  5. Press (single-klick NOT double-click) Install next to the ConcreteCMS - Content Box package.
  6. Wait until the page is loaded again completely. The ConcreteCMS - Content Box package should now be listet now in the Currently Installed section.
  7. The Content-Box-Block was added to the block-set basic. You can use the new block now.
  8. If you don't have any color-collection configured in your theme you may want to change the default button-type (button-color). You can go to the Content Box Settings  dashboard-page (https://example.domain/dashboard/tgs_backend/content_box_settings) and adjust the default values.

Configuration

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

Simple handling of the block-data

It is very simple to work with the block-data. Down below an example.


    // creating a ContentBox-Model using the current block-data.
    /** @var \Concrete\Package\TgsContentBox\Block\TgsContentBox\Controller $blockController */
    $relevantBlockData = $blockController->getBlockData();
    
    /** @var \Concrete\Package\TgsContentBox\Model\ContentBox $cb */
    $contentBox = app('tgs/contentbox/factory/contentbox')->createFrom($relevantBlockData);
    
    echo $contentBox->getBlockId(); // int|null
    echo $contentBox->getButtonType(); // string
    echo $contentBox->getImageAlt(); // string
    echo $contentBox->hasImage(); // bool
    echo $contentBox->getLink(); // string