idci/document-management-bundle

Symfony bundle to handle document management features like storage, pdf generation

v1.1.7 2019-04-30 18:18 UTC

Requires

• php: >=5.5.9
• behat/transliterator: ~1.1
• doctrine/doctrine-bundle: ^1.8
• doctrine/orm: ^2.5
• friendsofsymfony/rest-bundle: ~1.5
• jms/serializer-bundle: ^1.1
• knplabs/knp-gaufrette-bundle: ~0.5
• knplabs/knp-snappy-bundle: ~1.5
• ramsey/uuid-doctrine: ~1.4
• symfony/form: ^3.4
• symfony/options-resolver: ^3.4
• twig/twig: ~1.0

Requires (Dev)

• doctrine/doctrine-fixtures-bundle: ^2.2
• phpunit/phpunit: ^5.7
• sensio/framework-extra-bundle: ^5.0.0
• symfony/browser-kit: ^3.4
• symfony/symfony: 3.4.*
• symfony/templating: ^3.4
• symfony/twig-bundle: ~3.4

Suggests

• h4cc/wkhtmltopdf-amd64: To get wkhtmltopdf binary for 64bit architecture
• h4cc/wkhtmltopdf-i386: To get wkhtmltopdf binary for 32bit architecture
• idci/wkhtmltopdf-amd64: To get wkhtmltopdf binary up to 0.12.5 for 64bit architecture

MIT

• Brahim Boukoufallah
• Gabriel Bondaz

• dms
• document
• document management
• GED
• document generation

README

DocumentManagementBundle is a Symfony bundle to manage documents like pdf generation, storage, DMS.

Installation

Add dependencies in your composer.json file:

"require": {
    ...
    "idci/document-management-bundle": "~1.0"
},

Install these new dependencies in your application using composer:

$ make composer-update

Register needed bundles in your application kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Knp\Bundle\SnappyBundle\KnpSnappyBundle(),
        new IDCI\Bundle\DocumentManagementBundle\IDCIDocumentManagementBundle(),
    );
}

Import the bundle configuration:

# app/config/config.yml

imports:
    - { resource: @IDCIDocumentManagementBundle/Resources/config/config.yml }

Import the bundle routing:

# app/config/routing.yml

idci_document_api:
    resource: "@IDCIDocumentManagementBundle/Resources/config/routing.yml"
    prefix: /api

Define the binary path for wkhtmltopdf:

# app/config/parameters.yml
parameters:
    document_management_snappy_pdf_binary_path: '%kernel.root_dir%/../bin/wkhtmltopdf'

That's it, you are ready to use it.

Tests

Install bundle dependencies:

$ make composer-update

To execute unit tests:

$ make phpunit

To execute functional tests:

$ make phpunit-functional