gyselroth/php-helper-log

PHP logger wrapper

0.2.20 2020-09-28 12:50 UTC

Requires

• php: >=7.4
• monolog/monolog: ^1.17

Requires (Dev)

• ext-dom: *
• phpstan/phpstan: ^0.12.4
• phpunit/phpunit: 7.5.16

Apache-2.0

• gyselroth

• log
• helper

README

Table of contents

• Installation
• Log-Wrapper
  • Usage Example 1: Within Slim PHP application
  • Usage Example 2: Within Zend Framework 1 application
• Running Tests
• Running phpstan
• Contributing
• Author and License

Installation

composer require gyselroth/php-helper-zip

Log-Wrapper

To allow classes of this helper library to log, using the standard logger of the framework used in the rest of your application, the library includes Gyselroth\Helper\LogWrapper. After bootstrapping your application or its service container (if using a framework able of dependency-injection), the host application's logger can be registered with the Logger-Wrapper (skip this step if you do not use the helper library to write any log-entries):

Usage Example 1: Within Slim PHP application

<?php 
 use Gyselroth\Helper;
 //...
 
 $app = new \Slim\App($settings);

 $container = $app->getContainer();
 
 //...

 $container['logger'] = function (/*...*/) {
     // Callback to PSR-7 logger, e.g. Monolog
     //...
 };
 
 // Register host application's logger component within gyselroth Helper's logger wrapper
 new \Gyselroth\HelperLog\LoggerWrapper($app->getContainer()['logger']);

Usage Example 2: Within Zend Framework 1 application

As there's no service container for dependency injection within Zend Framework 1 yet, the helper classes will by convention draw your logger (probably Zend_Log) from the Zend_Registry

<?php 
 use Gyselroth\Helper\;
 //...
 
 $app = new Zend_Application($env, $config);
 $app->bootstrap();
  
 // Register ZF1 logger class within the helper library's logger-wrapper
 new LoggerWrapper('App_Log');
 
 $app->run();

Running Tests

composer test

Running phpstan

 vendor/bin/phpstan analyse /srv/www/trunk/src -c /srv/www/trunk/var/ci/phpstan/phpstan.neon

Contributing

See CONTRIBUTING.md

History

See CHANGELOG.md

Author and License

Copyright 2017-2020 gyselroth™ (http://www.gyselroth.com)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0":http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Used Open Source Software

Open source packages used by the gyselroth Helper Library are copyright of their vendors, see related licenses within the vendor packages.