hiqsol / core
Yii 3.0 proposal :: NOT FOR ACTUAL USE
dev-master
2018-07-20 14:36 UTC
Requires
Requires (Dev)
- hiqdev/hidev-php: <2.0 || dev-master
- hiqsol/hidev-hiqsol: <2.0 || dev-master
- yiisoft/di: *@dev
Replaces
- yiisoft/yii2: *
This package is auto-updated.
Last update: 2024-10-18 07:49:04 UTC
README
This package is Yii 3.0 architecture changes proposal.
NOT INTENDED FOR ACTUAL USE
Idea
- framework gets split into parts, not radically, but functionally
yiisoft/core
- all former framework but all the followingyiisoft/di
- as is, fixed some bugsyiisfot/yii-web
- everything fromweb
andfilter
folders, can be used without yiisoft/console, but requires coreyiisfot/yii-console
- everything fromconsole
folder, can be used without yiisoft/web, but requires coreyiisoft/log
- everything fromlog
folder, any PSR compatible cache could be used, can be done framework independentyiisoft/cache
- everything fromcaching
folder, any PSR compatible cache could be used, can be done framework independentyiisoft/db
- not all apps need it, can be done framework independentyiisoft/rbac
- not all apps need it, can be done framework independent- also should be considered:
- grid
- widgets
- split db and ActiveRecord
- also please see discussion #1
- don't mention framework version anywhere besides version constraints in
composer.json
files- rename yii extensions with
yii-
prefix - rule of thumb:
- if extension requires
yiisoft/core
directly or through dependencies - then prefix withyii-
- if extension can be used without yii (completely or partially) - name without
yii-
prefix - if extension provides more functions with yii - suggest yii
- if extension requires
- rename yii extensions with
yiisfot/core
requires only virtual psr implementations instead of concrete yii packages- actually not all psr implementations will work right now, but it's a declaration of intentions and will be implemented sooner or later
- every part provides it's own configuration in
config
folder, see examples below- summary config is assembled with composer-config-plugin, we can think about other config assembling tool, but this one is already tested and there are no others :)
- I understand it is most arguable question but it can become main framework feature
- allows to throw away things like coreComponents and other crutches like merging config parts available in the framework code
- the config becomes the config of DI container holding configs for application and all the services (previously it was config of application)
- allows to create onion applications and plugins, please see my article
- also please see discussion #2
yii2-composer
- not needed anymore- yii2-extension composer package type is not need, extensions will become
library
- also yii2-composer assembles
extensions.php
used for aliases and bootstrap composer-config-plugin does all the same but more effectively
- yii2-extension composer package type is not need, extensions will become
- think of completely remove bootstrap feature:
- it was mostly used by extensions to merge into application config - composer-config-plugin must be used for it
- event triggers should be configured for all other cases
- which improves performance by running tasks not for every request but for certain only
- DI
- completely remove
ServiceLocator
, use DI instead - completely remove components support from
Application
andModule
- according to my experiense, DI is quite enough
Application
becomes really shorter and simpler
- completely remove
- completely remove
Configurable
andYii::configure(),
andinit()
goes with them- remove everywhere
$config
(last constructor argument) Configurable
worked this way:$config
array was passed to constructor$config
gets applied withYii::configure()
- constructor runs
init()
- it doesn't work with new DI because of the following:
- new DI calls constructor and then sets props
- init cannot be called from constructor
- in theory
init()
could be called with DI, but it's necessary to ensure it to be called after settings all props
- it is necessary to fix all classes having
init()
- it is serious BC-break, but everything gets simpler:
- no need to make changes to
yiisoft/di
- initialization better be substituted with getters which makes it deferred so more productive in theory
- no need to make changes to
- remove everywhere
- redo
Yii
as clean helper, without global static properties:- no need to require Yii in entry script
- move to all other helpers
yii\helpers\Yii
- remove "global variables"
Yii::$app
,Yii::$logger
and so on - move aliases to
Application
- leave only:
Yii::t()
,Yii::createObject()
and logging and profiling functions - to make them working
Yii::setContainer($container)
must be called in entry script - but if no container is defined - make all the functions operating in default way like logging with PHP built-in capabilities
- I think
Yii::createObject()
should be deprecated, starting with removing its use in the framework and then remove it completely in next version in favour ofFactory::create()
- bunch of defines will be moved to
config/defines.php
, composer-config-plugin assembles defines too
- cleanup
- rename folder
web
topublic
- rename alias
@webroot
to@public
- I want to make less files in heavy loaded folders (base, web), making a bit more folders,
but without growing folder depth
- move all exceptions to own folder in base and web
- move web formatters to own folder
- think of: url, action
- rename folder
Entry script
<?php use hiqdev\composer\config\Builder; use yii\di\Container; use yii\helpers\Yii; (function () { require_once __DIR__ . '/../vendor/autoload.php'; require_once Builder::path('defines'); $container = new Container(require Builder::path('web')); Yii::setContainer($container); $container->get('app')->run(); })();
Config examples
Sample from yiisoft/core
, src/config/common.php:
<?php return [ yii\base\Application::class => Reference::to('app'), 'app' => [ 'aliases' => [ '@root' => dirname(__DIR__, 5), '@vendor' => dirname(__DIR__, 4), ], 'params' => $params, ], yii\base\Request::class => Reference::to('request'), yii\base\View::class => Reference::to('view'), ];
Sample from yiisoft/web
, src/config/web.php:
<?php return [ 'app' => [ '__class' => yii\web\Application::class, 'id' => 'web', 'name' => 'web', ], 'request' => [ '__class' => yii\web\Request::class, ], 'view' => [ '__class' => yii\web\View::class, ], ];
Sample from yiisoft/console
, src/config/console.php:
<?php return [ 'app' => [ '__class' => yii\console\Application::class, 'id' => 'console', 'name' => 'console', ], 'request' => [ '__class' => yii\console\Request::class, ], 'view' => [ '__class' => yii\console\View::class, ], ];
Sample from yiisoft/log
, src/config/common.php:
<?php return [ 'logger' => [ '__class' => yii\log\Logger::class, ], Psr\Log\LoggerInterface::class => yii\di\Reference::to('logger'), ];
Parts and folders
License
This project is released under the terms of the BSD-3-Clause license. Read more here.
Copyright © 2018, sol (http://hiqdev.com/)