init repo

CONTRIBUTING.md

@@ -0,0 +1,140 @@
+# Contributing to this project
+
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of
+the developers managing and developing this open source project. In return,
+they should reciprocate that respect in addressing your issue or assessing
+patches and features.
+
+## Using the issue tracker
+
+The issue tracker is the preferred channel for [bug reports](#bugs),
+[features requests](#features) and [submitting pull
+requests](#pull-requests), but please respect the following restrictions:
+
+* Please **do not** use the issue tracker for personal support requests.
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and
+  respect the opinions of others.
+
+
+<a name="bugs"></a>
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** &mdash; check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
+   latest `master` or development branch in the repository.
+
+3. **Isolate the problem** &mdash; create a [reduced test
+   case](http://css-tricks.com/reduced-test-cases/) and a live example.
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment? What steps will reproduce the issue? What browser(s) and OS
+experience the problem? What would you expect to be the outcome? All these
+details will help people to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the Yii2 and Yii2-plugins-system versions in which it occurs. If
+> suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> `<url>` - a link to the reduced test case
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+
+
+<a name="features"></a>
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the project's developers of the merits of this feature. Please
+provide as much detail and context as possible.
+
+
+<a name="pull-requests"></a>
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic
+help. They should remain focused in scope and avoid containing unrelated
+commits.
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code, porting to a different language),
+otherwise you risk spending a lot of time working on something that the
+project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+
+Follow this process if you'd like your work considered for inclusion in the
+project:
+
+1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/<repo-name>
+   # Navigate to the newly cloned directory
+   cd <repo-name>
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/<upstream-owner>/<repo-name>
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout <dev-branch>
+   git pull upstream <dev-branch>
+   ```
+
+3. Create a new topic branch (off the main project development branch) to
+   contain your feature, change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Please adhere to these [git commit
+   message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+   or your code is unlikely be merged into the main project. Use Git's
+   [interactive rebase](https://help.github.com/articles/interactive-rebase)
+   feature to tidy up your commits before making them public.
+
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream <dev-branch>
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
+license your work under the same license as that used by the project.

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 LoveOrigami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 LoveOrigami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Module.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace lo\plugins;
+
+use Yii;
+use yii\helpers\Inflector;
+
+class Module extends \yii\base\Module
+{
+    public $controllerNamespace = 'lo\plugins\controllers';
+    public $defaultRoute = 'item';
+
+    // Directory
+    public $pluginsDir;
+
+    public function init()
+    {
+        parent::init();
+        // custom initialization code goes here
+
+        if (!isset(\Yii::$app->i18n->translations['plugin'])) {
+            \Yii::$app->i18n->translations['plugin'] = [
+                'class' => 'yii\i18n\PhpMessageSource',
+                'sourceLanguage' => 'en',
+                'basePath' => '@lo/plugins/messages'
+            ];
+        }
+
+        //user did not define the Navbar?
+        if (!$this->pluginsDir) {
+            $this->pluginsDir = [
+                '@lo/plugins/plugins'
+            ];
+        }
+    }
+}

README.md

@@ -0,0 +1,98 @@
+# Getting started with Yii2-plugins-system
+
+Yii2-plugins-system is designed to work out of the box. It means that installation requires
+minimal steps. Only one configuration step should be taken and you are ready to
+have plugin system on your Yii2 website.
+
+!["Plugins"](docs/img/tab_plugins.jpg)
+
+### 1. Download
+
+Yii2-plugins-system can be installed using composer. Run following command to download and
+install Yii2-plugins-system:
+
+```bash
+composer require "loveorigami/yii2-plugins-system": "*"
+```
+
+### 2. Update database schema
+
+The last thing you need to do is updating your database schema by applying the
+migrations. Make sure that you have properly configured `db` application component
+and run the following command:
+
+```bash
+$ php yii migrate/up --migrationPath=@vendor/loveorigami/yii2-plugins-system/migrations
+```
+
+### 3. Configure application
+
+Let's start with defining module in `@backend/config/main.php`:
+
+```php
+'modules' => [
+    'plugins' => [
+        'class' => 'lo\plugins\Module',
+        'pluginsDir'=>[
+            '@lo/plugins/plugins', // default dir with core plugins
+            // '@common/plugins', // dir with our plugins
+        ]
+    ],
+],
+```
+That's all, now you have module installed and configured in advanced template.
+
+Next, open `@frontend/config/main.php` and add following:
+
+```
+'bootstrap' => ['log', 'plugins'],
+...
+'components' => [
+    'plugins' => [
+        'class' => 'lo\plugins\components\EventBootstrap',
+        'appId' => 'frontend'
+    ],
+    ...
+]
+```
+
+Also do the same thing with `@backend/config/main.php`:
+
+```
+'bootstrap' => ['log', 'plugins'],
+...
+'components' => [
+    'plugins' => [
+        'class' => 'lo\plugins\components\EventBootstrap',
+        'appId' => 'backend'
+    ],
+    ...
+]
+```
+
+## Core plugins (examples)
+
+* [Hello world!] (plugins/helloworld)
+* [Code Highlighting] (plugins/code)
+* [Http Authentication] (plugins/httpauth)
+
+## Your plugins
+
+* [Create] (docs/create_plugin.md)
+* [Install] (docs/install_plugin.md)
+
+## Contributing to this project
+
+Anyone and everyone is welcome to contribute. Please take a moment to
+review the [guidelines for contributing](CONTRIBUTING.md).
+
+## License
+
+Yii2-plugins-system is released under the MIT License. See the bundled [LICENSE.md](LICENSE.md)
+for details.
+
+## Thanks
+
+* Bariew for [event manager] (https://github.com/bariew/yii2-event-component) component
+* Troxa for [yii2-shortcodes] (https://github.com/tpoxa/yii2-shortcodes) component 
+* ElisDn for great webinar about [yii2-events] (http://www.elisdn.ru/blog/74/events-on-yii2-and-javascript) (by ru)