Skip to content

install.md

Latest commit

 

History

History
147 lines (107 loc) · 4.23 KB

install.md

File metadata and controls

147 lines (107 loc) · 4.23 KB
Raw

Installing CCDNMessage MessageBundle

Dependencies:

Note you will need a User Bundle so that you can map the UserInterface to your own User entity. You can use whatecer User Bundle you prefer. FOSUserBundle is highly rated.

Installation:

Installation takes only 4 steps:

  1. Download and install dependencies via Composer.
  2. Register bundles with AppKernel.php.
  3. Update your app/config/routing.yml.
  4. Update your app/config/config.yml.
  5. Update your database schema.

Step 1: Download and install dependencies via Composer.

Append the following to end of your applications composer.json file (found in the root of your Symfony2 installation):

// composer.json
{
    // ...
    "require": {
        // ...
        "codeconsortium/ccdn-message-bundle": "dev-master"
    }
}

NOTE: Please replace dev-master in the snippet above with the latest stable branch, for example 2.0.*.

Then, you can install the new dependencies by running Composer's update command from the directory where your composer.json file is located:

$ php composer.phar update

Step 2: Register bundles with AppKernel.php.

Now, Composer will automatically download all required files, and install them for you. All that is left to do is to update your AppKernel.php file, and register the new bundle:

// app/AppKernel.php
public function registerBundles()
{
    $bundles = array(
        new Knp\Bundle\PaginatorBundle\KnpPaginatorBundle(),
        new CCDNMessage\MessageBundle\CCDNMessageMessageBundle(),
        // ...
    );
}

Notice this include KNP Paginator, which is an important dependency.

Step 3: Update your app/config/routing.yml.

In your app/config/routing.yml add:

# app/config/routing.yml
CCDNMessageMessageBundle:
    resource: "@CCDNMessageMessageBundle/Resources/config/routing.yml"
    prefix: /

You can change the route of the standalone route to any route you like, it is included for convenience.

Step 4: Update your app/config/config.yml.

In your app/config/config.yml add:

# app/config/config.yml
ccdn_message_message: # Required
    entity:           # Required
        user:         # Required
            class:    Acme\YourUserBundle\Entity\User # Required

Replace Acme\YourUserBundle\Entity\User with the user class of your chosen user bundle.

Step 5: Update your database schema.

Make sure to add the MessageBundle to doctrines mapping configuration:

# app/config/config.yml
# Doctrine Configuration
doctrine:
    orm:
        default_entity_manager: default
        auto_generate_proxy_classes: "%kernel.debug%"
        resolve_target_entities:
            Symfony\Component\Security\Core\User\UserInterface: Acme\YourUserBundle\Entity\User
        entity_managers:
            default:
                mappings:
                    CCDNMessageMessageBundle:
                        mapping:              true
                        type:                 yml
                        dir:                  "Resources/config/doctrine"
                        alias:                ~
                        prefix:               CCDNMessage\MessageBundle\Entity
                        is_bundle:            true

Replace Acme\YourUserBundle\Entity\User with the user class of your chosen user bundle.

From your projects root Symfony directory on the command line run:

$ php app/console doctrine:schema:update --dump-sql

Take the SQL that is output and update your database manually.

Warning:

Please take care when updating your database, check the output SQL before applying it.

Translations

If you wish to use default texts provided in this bundle, you have to make sure you have translator enabled in your config.

# app/config/config.yml
framework:
    translator: ~

Next Steps.

Change the layout template you wish to use for each page by changing the configs under the labelled section 'layout_templates'.

Installation should now be complete!

If you need further help/support, have suggestions or want to contribute please join the community at Code Consortium