CCDNComponent DashboardBundle README.

Notes:

This bundle is for the symfony framework and requires Symfony ~2.4 and PHP 5.4

This file is part of the CCDNComponent bundles(s)

© CCDN © CodeConsortium

Available on:

• Github
• Packagist

Theme and Sprite graphics courtesy of twitter bootstrap and GLYPHICONS.

Other graphics are works of CodeConsortium.

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

Description.

This is a Symfony2 bundle for creating a Dashboard for site navigation. It features a plug and play service architecture.

Bundles can register services via tags to list their links within the dashboard bundle. Because it uses service tags, bundles are not coupled with the Dashboard and if Dashboard bundle is removed, then nothing will break.

Each link can be specified in any given bundles DashboardIntegrator class which you can place in the bundles Component/Dashboard folder.

The class can contain numerous links, each with a specified route or a statically typed url. An icon and translated text.

Features.

DashboardBundle Provides the following features:

1. Bundles Integrate via service tags.
2. Decoupled interaction with 3rd party bundles.
3. Bundles can add multiple links from a single class.
4. Links can be grouped into categories which are shared by more than one bundle.
5. Each link can specify either a route or a url.
6. Each link can specify a graphical icon to use.
7. Each link has access to the SF2 translator to translate prior to rendering.
8. Utilises Twitter-Bootstrap interface by default.

Before installation of this bundle, you can download the Sandbox for testing/development and feature review, or alternatively see the product in use at CodeConsortium.

Documentation.

Documentation can be found in the Resources/doc/index.md file in this bundle:

Read the Documentation.

Installation.

All the installation instructions are located in documentation.

License.

This software is licensed under the MIT license. See the complete license file in the bundle:

Resources/meta/LICENSE

Read the License.

About.

CCDNComponent DashboardBundle is free software from Code Consortium. See also the list of contributors.

Reporting an issue or feature request.

Issues and feature requests are tracked in the Github issue tracker.

Discussions and debates on the project can be further discussed at Code Consortium.