Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guanguans/yii-goaop
Bringing the goaop/framework to Yii. - 将 goaop/framework 集成到 Yii。在 Yii 中优雅的面向切面编程。
https://github.com/guanguans/yii-goaop
aop aop-aspects aspects goaop yii yii2 yii2-extension
Last synced: 2 months ago
JSON representation
Bringing the goaop/framework to Yii. - 将 goaop/framework 集成到 Yii。在 Yii 中优雅的面向切面编程。
- Host: GitHub
- URL: https://github.com/guanguans/yii-goaop
- Owner: guanguans
- License: mit
- Created: 2020-10-12T01:41:33.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-09T09:12:30.000Z (over 3 years ago)
- Last Synced: 2024-09-30T22:11:25.166Z (3 months ago)
- Topics: aop, aop-aspects, aspects, goaop, yii, yii2, yii2-extension
- Language: PHP
- Homepage:
- Size: 28.3 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# yii-goaop
[](https://codecov.io/gh/guanguans/yii-goaop)
[](https://github.styleci.io/repos/303249572?branch=main)
[](//packagist.org/packages/guanguans/yii-goaop)
[](//packagist.org/packages/guanguans/yii-goaop)
[](//packagist.org/packages/guanguans/yii-goaop)
> Bringing the goaop/framework to Yii. - 将 goaop/framework 集成到 Yii，在 Yii 中优雅的面向切面编程。
## Requirement
* Yii >= 2.0
## Installation
``` bash
$ composer require guanguans/yii-goaop --prefer-dist -vvv
```
`composer.json` add:
``` json
"autoload": {
"psr-4": {
"backend\\": "backend/",
"frontend\\": "frontend/",
"common\\": "common/",
"console\\": "console/",
"app\\": ""
}
}
```
``` bash
$ composer dumpautoload
```
## Configuration
### yii2-app-advanced
Config `config/main.php` file add:
``` php
[
'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:
``` 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__).'/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
*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`
``` bash
───────┬───────────────────────────────────────────────────────────────────
│ File: frontend/runtime/logs/logging.log
───────┼───────────────────────────────────────────────────────────────────
1 │ this is a before method testing.
2 │ this is a after method testing.
───────┴───────────────────────────────────────────────────────────────────
```
## Testing
``` bash
$ composer test
```
## Related Links
* [https://github.com/goaop/framework](https://github.com/goaop/framework)
## License
[MIT](LICENSE)