sbc/auto-reporting-bundle

Send daily PDF reports about the application's activity

dev-master / 1.x-dev 2018-05-14 14:16 UTC

Requires

• php: >=5.5.9
• dompdf/dompdf: ^0.8.2
• symfony/framework-bundle: ^2.8 || ^3.0

MIT

• Haouass Abderraouf
• Slimen Arnaout

• reporting bundle
• symfony reporting
• mail reporting

README

Send daily PDF reports about the application's activity.

Installation

1. composer require sbc/auto-reporting-bundle
   
2. Enable the bundle in AppKernel.php new SBC\AutomaticReportingBundle\AutomaticReportingBundle(),
   

Usage

Step 1:

Set the configuration:

# AutomaticReportingBundle configuration
automatic_reporting:
    app_name:   'Your applciation name' # will be displayed in the email
    recipients: ['[e-mail]', '[e-mail]'] # multiple recipients

Step 2:

Call @Report Annotation in the entities you want to follow:

/**
 * Post
 *
 * @ORM\Table(name="post")
 * @ORM\Entity(repositoryClass="AppBundle\Repository\PostRepository")
 *
 * @Report(
 *  dateColumn="creationDate",
 *  reportingName="Poste"
 * )
 */
class Post
{
...
}

Step 2 (differentiation solution):

You can also separate result for the same entity using the DifferentiationColumn Annotation:

/**
 * Post
 *
 * @ORM\Table(name="post")
 * @ORM\Entity(repositoryClass="AppBundle\Repository\PostRepository")
 *
 * @Report(
 *  dateColumn="creationDate",
 *  differentiationColumn="type",
 *  differentiations={
 *     @DifferentiationColumn(value="A", reportingName="Post of type A"),
 *     @DifferentiationColumn(value="B", reportingName="Post of type B")
 *  }
 * )
 */
class Post
{
...
    /**
     * Type of the Post entity
     * @var string
     *
     * @ORM\Column(name="type", type="string", length=255)
     */
    private $type;
}

Step3

• Call php bin/console reporting:generate to build and send the report
• Or create a cron job that trigger this command every day

What will actually happen ?

After calling the command the bundle will parse and get all the entities with the @Report annotation and count all the rows that being created in the current day using the dateColumn attribute, after that the bundle will generate and send a PDF attachment to the recipients containing the summary using the reportingName attribute for each entity.