guanguans / yii-goaop
Bringing the goaop to Yii. - 将 goaop 集成到 Yii。
Fund package maintenance!
Patreon
www.guanguans.cn/images/wechat.jpeg
Installs: 43
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Type:yii
Requires
- goaop/framework: ^2.0
- yiisoft/yii2: ~2.0
Requires (Dev)
- brainmaestro/composer-git-hooks: ^2.7
- friendsofphp/php-cs-fixer: ^2.16
- mockery/mockery: ^1.2
- phpunit/phpunit: ~7||~8
README
Bringing the goaop/framework to Yii. - 将 goaop/framework 集成到 Yii,在 Yii 中优雅的面向切面编程。
Requirement
- Yii >= 2.0
Installation
$ composer require guanguans/yii-goaop --prefer-dist -vvv
composer.json
add:
"autoload": { "psr-4": { "backend\\": "backend/", "frontend\\": "frontend/", "common\\": "common/", "console\\": "console/", "app\\": "" } }
$ composer dumpautoload
Configuration
yii2-app-advanced
Config config/main.php
file add:
<?php return [ 'bootstrap' => [ 'aop', ], 'components' => [ 'aop' => [ 'class' => 'Guanguans\YiiGoAop\GoAopComponent', 'initOptions' => [ // AOP Debug Mode 'debug' => false, // Application Root Directory 'appDir' => dirname(dirname(__DIR__)), // AOP Cache Directory 'cacheDir' => dirname(__DIR__).'/runtime/aspect', // Cache File Mode 'cacheFileMode' => 511, // Miscellaneous AOP Engine Features 'features' => 0, // Directories White List 'includePaths' => [ dirname(__DIR__), ], // Directories Black List 'excludePaths' => [ dirname(__DIR__).'/runtime', dirname(__DIR__).'/tests', dirname(__DIR__).'/views', ], // AOP Container 'containerClass' => \Go\Core\GoAspectContainer::class, ], // Yours aspects 'aspects' => [ frontend\aspects\LoggingAspect::class, ], ], ] ];
yii2-app-basic
Config config/web.php
file add:
return [ 'bootstrap' => [ 'aop', ], 'components' => [ 'aop' => [ 'class' => 'Guanguans\YiiGoAop\GoAopComponent', 'initOptions' => [ // AOP Debug Mode 'debug' => false, // Application Root Directory 'appDir' => dirname(dirname(__DIR__)), // AOP Cache Directory 'cacheDir' => dirname(__DIR__).'/runtime/aspect', // Cache File Mode 'cacheFileMode' => 511, // Miscellaneous AOP Engine Features 'features' => 0, // Directories White List 'includePaths' => [ dirname(__DIR__).'/assets', dirname(__DIR__).'/aspects', dirname(__DIR__).'/commands', dirname(__DIR__).'/controllers', dirname(__DIR__).'/models', dirname(__DIR__).'/widgets', ], // Directories Black List 'excludePaths' => [ dirname(__DIR__).'/config', dirname(__DIR__).'/mail', dirname(__DIR__).'/runtime', dirname(__DIR__).'/tests', dirname(__DIR__).'/vagrant', dirname(__DIR__).'/vendor', dirname(__DIR__).'/views', dirname(__DIR__).'/web', ], // AOP Container 'containerClass' => \Go\Core\GoAspectContainer::class, ], // Yours aspects 'aspects' => [ app\aspects\LoggingAspect::class, ], ], ] ];
Usage
Create a aspect for public frontend\controllers\SiteController->*Index(*)
<?php namespace frontend\aspects; use Go\Aop\Aspect; use Go\Aop\Intercept\MethodInvocation; use Go\Lang\Annotation\Before; use Go\Lang\Annotation\After; use Yii; class LoggingAspect implements Aspect { /** * Method that will be called before real method * @param MethodInvocation $invocation Invocation * @Before("execution(public frontend\controllers\SiteController->*Index(*))") */ public function beforeMethodExecution(MethodInvocation $invocation) { file_put_contents(Yii::$app->getRuntimePath().'/logs/logging.log', 'this is a before method testing.'.PHP_EOL, FILE_APPEND); } /** * Method that will be called after real method * @param MethodInvocation $invocation Invocation * @After("execution(public frontend\controllers\SiteController->*Index(*))") */ public function afterMethodExecution(MethodInvocation $invocation) { file_put_contents(Yii::$app->getRuntimePath().'/logs/logging.log', 'this is a after method testing.'.PHP_EOL, FILE_APPEND); } }
Run frontend\controllers\SiteController\actionIndex
action
cat frontend/runtime/logs/logging.log
───────┬─────────────────────────────────────────────────────────────────── │ File: frontend/runtime/logs/logging.log ───────┼─────────────────────────────────────────────────────────────────── 1 │ this is a before method testing. 2 │ this is a after method testing. ───────┴───────────────────────────────────────────────────────────────────
Testing
$ composer test