oveleon/contao-company-bundle

Company integration for Contao Open Source CMS

1.5.1 2024-10-09 06:49 UTC

Requires

• php: ^8.1
• contao/core-bundle: ^4.13 || ^5.3
• jeroendesloovere/vcard: ^1.7
• symfony/config: ^5.4 || ^6.4 || ^7.0
• symfony/dependency-injection: ^5.4 || ^6.4 || ^7.0
• symfony/event-dispatcher: ^5.4 || ^6.4 || ^7.0
• symfony/filesystem: ^5.4 || ^6.4 || ^7.0
• symfony/framework-bundle: ^5.4 || ^6.4 || ^7.0
• symfony/http-foundation: ^5.4 || ^6.4 || ^7.0
• symfony/http-kernel: ^5.4 || ^6.4 || ^7.0
• symfony/routing: ^5.4 || ^6.4 || ^7.0

Requires (Dev)

• contao/contao-rector: @dev
• contao/easy-coding-standard: ^6.12
• contao/manager-plugin: ^2.3.1
• contao/test-case: ^5.1
• phpstan/phpstan: ^1.0
• phpstan/phpstan-doctrine: ^1.3
• phpstan/phpstan-phpunit: ^1.0
• phpstan/phpstan-symfony: ^1.0
• phpunit/phpunit: ^9.5
• shipmonk/composer-dependency-analyser: ^1.5
• slam/phpstan-extensions: ^6.0
• symfony/phpunit-bridge: ^5.4 || ^6.0
• thecodingmachine/phpstan-strict-rules: ^1.0

Conflicts

• contao/core: *
• contao/manager-plugin: <2.0 || >=3.0

MIT

• Oveleon
• Sebastian Zoglowek
• Fabian Ekert

• contao
• insert-tags
• company-bundle

README

The Company Bundle adds company information via Insert-Tags, social media information and a logo module for websites and different website roots.

Support

If you like this extension, we'd love your support in keeping the open-source spirit alive.

If you think this plugin is useful, please consider sponsoring us to help contribute to our time invested and to further development of this and other open source projects.

Your contributions, whether through coding, testing, providing feedback, or even a donation, help ensure that we can continue offering free open source software. Join us in making a difference, and thank you for your support! - Oveleon.

Working with Contao 4.13 and Contao ^5.3 (PHP ^8.1)

Description

The company bundle allows you to manage company details for one or more companies provided in the contao settings and website roots. Company details stored in the settings are used as a fallback if specific company details are missing in the involved website roots. Company details can be displayed dynamically by using the provided company modules (social-media-list & logo) or alternatively by using the provided company insert tags. You can display company details dynamically simply by using the provided company modules or alternatively by using a company insert tag.

• Features
• Installation
  • Composer
  • Contao Manager
• Setup
  • Company-Details
  • Logo
  • Social-media-list
• Insert tags
  • Company-details
  • Additional
• Front end Modules

Features

• Compatible with Contao 4.13 and higher versions (PHP 8 Support)
• Easy setup for company details
• All company details can be overwritten within website roots
• Fallback company details
• Insert tags
• Logo module
  • Href works with prepend locale and different website roots
• Social media lists

Installation

Via composer

composer require oveleon/contao-company-bundle

Via contao-manager

Search for contao company bundle and add it to your extensions.

After installing the contao-company-bundle, you need to run a contao install.

Setup

Setup company details

1. Go to System > Settings and navigate to the palette: Company-details

   

2. Type in your company details to be used with insert-tags and save the changes

3. Additionally you can select a logo and create multiple social media entries

4. If you want to overwrite your company-details for different website roots, go to Layout > Site structure > Edit page (Root page) and navigate to the palette: Company-details. Keep in mind that saving these will overwrite the modules and insert-tags for this root page.

Logo module

1. Create the front-end module Logo
2. Set up an image size
3. Decide wether the logo should redirect to the website root
4. Embed the module within your layout (e.g. header-section) or in your articles

Social media list

1. Create the front-end module Social media list
2. Choose a template (Default or nolabel)
3. Embed the module within your articles
4. (Additionally you can choose the template nolabel and style them with an icon font)

Insert tags

Your company information can be displayed using following insert-tags.

For more information on Insert tags, please visit the official Contao documentation.

Example

{{company::name}}
{{company::tel}}

Company details

Additional

Front end modules

Logo (Company)

Displays the saved company logo with an optional redirect to the website root.

The image for the logo-module is set up within the system or root page settings.

Social media list (Company)

Displays the company social media.

The social media list is set up within the system or root page settings.

Adding custom social media

The social media platforms within the select box are generated from the file:

tl_company_socials.xlf

You are able to add new social-media by creating a translation file and uploading them on your server as shown below:

Contao root files

Company Settings