setono/sylius-log-entry-plugin

Sylius plugin that makes it easy to work with log entries

dev-master / 1.0.x-dev 2020-02-25 07:10 UTC

Requires

• php: ^7.2
• sylius/sylius: ^1.3
• symfony/config: ^4.4 || ^5.0
• thecodingmachine/safe: ^1.0

Requires (Dev)

• behat/behat: ^3.4
• behat/mink: ^1.7@dev
• behat/mink-browserkit-driver: ^1.3
• behat/mink-extension: ^2.2
• behat/mink-selenium2-driver: ^1.3
• ergebnis/composer-normalize: ^2.0
• friends-of-behat/page-object-extension: ^0.3
• friends-of-behat/suite-settings-extension: ^1.0
• friends-of-behat/symfony-extension: ^2.0
• friends-of-behat/variadic-extension: ^1.1
• korbeil/phpstan-generic-rules: ^0.2.1
• lakion/mink-debug-extension: ^1.2.3
• matthiasnoback/symfony-config-test: ^4.0
• matthiasnoback/symfony-dependency-injection-test: ^4.0
• phpspec/phpspec: ^5.0 || ^6.0
• phpstan/phpstan: ^0.12
• phpstan/phpstan-doctrine: ^0.12
• phpstan/phpstan-strict-rules: ^0.12
• phpstan/phpstan-webmozart-assert: ^0.12
• phpunit/phpunit: ^8.0
• roave/security-advisories: dev-master
• sensiolabs/security-checker: ^6.0
• sylius-labs/coding-standard: ^3.1
• symfony/browser-kit: ^3.4 || ^4.3 || ^5.0
• symfony/debug-bundle: ^3.4 || ^4.3 || ^5.0
• symfony/dotenv: ^4.3 || ^5.0
• symfony/intl: ^3.4 || ^4.3 || ^5.0
• symfony/web-profiler-bundle: ^3.4 || ^4.3 || ^5.0
• symfony/web-server-bundle: ^3.4 || ^4.3 || ^5.0
• thecodingmachine/phpstan-safe-rule: ^1.0@beta

MIT

• log
• sylius
• sylius-plugin
• setono

README

Adds a LogEntry entity you can use to log messages and associate them with your other entities. The test application has an example where we have added log entries to orders.

Installation

• Install plugin using composer:

  $ composer require setono/sylius-log-entry-plugin

• Add bundle to config/bundles.php:

  <?php
  // config/bundles.php
  
  return [
      // ...
      Setono\SyliusLogEntryPlugin\SetonoSyliusLogEntryPlugin::class => ['all' => true],
  ];

• Configure entities & repositories like here:

  • Entities
  • Overriding

• Import routes:

  # config/routes/setono_sylius_log_entry.yaml
  setono_sylius_log_entry:
      resource: "@SetonoSyliusLogEntryPlugin/Resources/config/routes.yaml"

• Update your schema:

  # Generate and edit migration
  bin/console doctrine:migrations:diff
  
  # Then apply migration
  bin/console doctrine:migrations:migrate

Contribution

Installation

To automatically execute installation steps, load fixtures and run server with just one command, run:

# Optional step, if 5 mins enough for webserver to try
# @see https://getcomposer.org/doc/06-config.md#process-timeout
composer config --global process-timeout 0

composer try

Running plugin tests

• PHPSpec

  $ composer phpspec

• Behat

  $ composer behat

• All tests (phpspec & behat)

  $ composer test

Pushing changes & making PRs

Please run composer all to run all checks and tests before making PR or pushing changes to repo.