├── css
    └── styles.css
├── composer.json
├── routing.yml
├── README.md
├── Controller
    └── HelloWorldController.php
├── Plugin.php
└── LICENSE


/css/styles.css:
--------------------------------------------------------------------------------
1 | /*
2 |  * It is an empty styles file.
3 |  */
4 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "mibew/boilerplate-plugin",
 3 |     "description": "An example plugin for Mibew 2.0.",
 4 |     "license": "Apache-2.0",
 5 |     "authors": [
 6 |         {
 7 |             "name": "Dmitriy Simushev",
 8 |             "email": "simushevds@mibew.org"
 9 |         }
10 |     ],
11 |     "autoload": {
12 |         "psr-0": {"Mibew\\Mibew\\Plugin\\Boilerplate\\": ""}
13 |     },
14 |     "target-dir": "Mibew/Mibew/Plugin/Boilerplate"
15 | }


--------------------------------------------------------------------------------
/routing.yml:
--------------------------------------------------------------------------------
 1 | # Here we can easily define custom routes. Let's create a "Hello world!" page.
 2 | mibew_boilerplate_hello:
 3 |     # Relative path from the Mibew web root is used here.
 4 |     path: /mibew-boilerplate-hello/{name}
 5 |     # Set some defaults for the request
 6 |     defaults:
 7 |         # This value is special. It tells the system what action should be
 8 |         # invoked for the response
 9 |         _controller: Mibew\Mibew\Plugin\Boilerplate\Controller\HelloWorldController::indexAction
10 |         # Set a default value for the "{name}" placeholder
11 |         name: world
12 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Boilerplate plugin
 2 | 
 3 | It does nothing but can be used as a template for a real plugin.
 4 | 
 5 | ## Installation
 6 | 
 7 | 1. Download files of the plugin.
 8 | 
 9 | 2. Create folder "`<Mibew root>`/plugins/Mibew/Mibew/Plugin/Boilerplate" (case does matter).
10 | 
11 | 3. Put files of the plugins to the just created folder.
12 | 
13 | 4. Add plugins configs to "plugins" structure in "`<Mibew root>`/configs/config.yml". If the "plugins" stucture looks like `plugins: []` it will become:
14 | 
15 |     ```yaml
16 |     plugins:
17 |         "Mibew:Boilerplate":
18 |             very_important_value: "$3.50"
19 |     ```
20 | 
21 | 5. Navigate to "`<Mibew Base URL>`/operator/plugin" page and enable the plugin.
22 | 
23 | 
24 | ## License
25 | 
26 | [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
27 | 


--------------------------------------------------------------------------------
/Controller/HelloWorldController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * Copyright 2014 the original author or authors.
 4 |  *
 5 |  * Licensed under the Apache License, Version 2.0 (the "License");
 6 |  * you may not use this file except in compliance with the License.
 7 |  * You may obtain a copy of the License at
 8 |  *
 9 |  *     http://www.apache.org/licenses/LICENSE-2.0
10 |  *
11 |  * Unless required by applicable law or agreed to in writing, software
12 |  * distributed under the License is distributed on an "AS IS" BASIS,
13 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 |  * See the License for the specific language governing permissions and
15 |  * limitations under the License.
16 |  */
17 | 
18 | namespace Mibew\Mibew\Plugin\Boilerplate\Controller;
19 | 
20 | use Mibew\Controller\AbstractController;
21 | use Symfony\Component\HttpFoundation\Request;
22 | use Symfony\Component\HttpFoundation\Response;
23 | 
24 | /**
25 |  * Controller example.
26 |  */
27 | class HelloWorldController extends AbstractController
28 | {
29 |     /**
30 |      * Displays a simple "Hello world" message.
31 |      *
32 |      * @param Request $request Incoming request.
33 |      * @return Response Rendered page content.
34 |      */
35 |     public function indexAction(Request $request)
36 |     {
37 |         return new Response('Hello ' . $request->attributes->get('name') . '!');
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/Plugin.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * Copyright 2014 the original author or authors.
  4 |  *
  5 |  * Licensed under the Apache License, Version 2.0 (the "License");
  6 |  * you may not use this file except in compliance with the License.
  7 |  * You may obtain a copy of the License at
  8 |  *
  9 |  *     http://www.apache.org/licenses/LICENSE-2.0
 10 |  *
 11 |  * Unless required by applicable law or agreed to in writing, software
 12 |  * distributed under the License is distributed on an "AS IS" BASIS,
 13 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14 |  * See the License for the specific language governing permissions and
 15 |  * limitations under the License.
 16 |  */
 17 | 
 18 | /**
 19 |  * @file The main file of Mibew:Boilerplate plugin.
 20 |  *
 21 |  * Plugin's class name, its namespace and file path must follow special naming
 22 |  * conventions. The name of the main plugin class should match pattern:
 23 |  * "\<Vendor Name>\Mibew\Plugin\<Plugin name>\Plugin". It should be placed in
 24 |  * "<mibew root>/plugins/<Vendor Name>/Mibew/Plugin/<Plugin name>/Plugin.php"
 25 |  * file. Names of vendor, plugin and directories/files are case sensitive!
 26 |  *
 27 |  * Notice that vendor and plugin names can contains only numbers and latin
 28 |  * letters and must start with a capitalized letter.
 29 |  *
 30 |  * Here are examples of good plugins names:
 31 |  *  - Abc:Xyz
 32 |  *  - Foo12:Bar
 33 |  *  - Acme:TheBestPlugin
 34 |  *
 35 |  * To configure the plugin add its configs to the "plugins" structure in
 36 |  * "<mibew root>/configs/config.yml" file. If the "plugins" structure looks
 37 |  * like:
 38 |  * <code>
 39 |  * plugins: []
 40 |  * </code>
 41 |  * it will become:
 42 |  * <code>
 43 |  * plugins:
 44 |  *     "Mibew:Boilerplate":
 45 |  *         very_important_value: "$3.50"
 46 |  * </code>
 47 |  *
 48 |  * To turn the plugin on navigate to "<Mibew Base URL>/operator/plugin" page and
 49 |  * enable the plugin.
 50 |  */
 51 | 
 52 | namespace Mibew\Mibew\Plugin\Boilerplate;
 53 | 
 54 | use Mibew\EventDispatcher\EventDispatcher;
 55 | use Mibew\EventDispatcher\Events;
 56 | 
 57 | /**
 58 |  * Defenition of the main plugin class.
 59 |  *
 60 |  * Plugin class must implements \Mibew\Plugin\PluginInterface and can extends
 61 |  * \Mibew\Plugin\AbstractPlugin class. The latter contains basic functions that
 62 |  * can be helpfull.
 63 |  *
 64 |  * If the plugin extends \Mibew\Plugin\AbstractPlugin class it must implement
 65 |  * only "run" and "getVersion" methods.
 66 |  */
 67 | class Plugin extends \Mibew\Plugin\AbstractPlugin implements \Mibew\Plugin\PluginInterface
 68 | {
 69 |     /**
 70 |      * Determine if the plugin was initialized correctly or not.
 71 |      *
 72 |      * By setting this propery to true by default we can make the plugin
 73 |      * initialized by default, so there is no need to add custom contructor
 74 |      * or initializer.
 75 |      *
 76 |      * This propery is overridden here only for example. We do not need to do
 77 |      * so in each plugin. In general case it should be set to true in the plugin
 78 |      * constructor when all necessary checks will be passed.
 79 |      *
 80 |      * Another way to control initialization state of the plugin is by means of
 81 |      * {@link \Mibew\Plugin\PluginInterface::initialized()} method.
 82 |      */
 83 |     protected $initialized = true;
 84 | 
 85 |     /**
 86 |      * Plugin's constructor.
 87 |      *
 88 |      * The code is situated here can initialize the plugin but cannot depend
 89 |      * on other plugins. All dependent code should be placed in "run" method.
 90 |      *
 91 |      * The current implementation just checks plugin's configurations.
 92 |      *
 93 |      * @param array $config Associative array of configuration params from the
 94 |      * main config file.
 95 |      */
 96 |     public function __construct($config)
 97 |     {
 98 |         // Check if a fake config param is set or it does not. In the sake of
 99 |         // simplicity we do not check the value.
100 |         if (!isset($config['very_important_value'])) {
101 |             // "very_important_value" param was not set. In this case we cannot
102 |             // initialize the plugin correctly, so we need to tell the system
103 |             // about it.
104 |             $this->initialized = false;
105 |         }
106 |     }
107 | 
108 |     /**
109 |      * The main entry point of a plugin
110 |      *
111 |      * Here we can attach event listeners and do other job.
112 |      */
113 |     public function run()
114 |     {
115 |         // We need an instatance of EventDispatcher class to attach handlers to
116 |         // events. So get it.
117 |         $dispatcher = EventDispatcher::getInstance();
118 |         // There are a lot of events. Use a few of them to show how they work.
119 |         $dispatcher->attachListener(Events::PAGE_ADD_CSS, $this, 'addCustomCss');
120 |     }
121 | 
122 |     /**
123 |      * Just attaches custom CSS file to every page that support it (chat windows
124 |      * and users waiting screen).
125 |      *
126 |      * @param array $args Associative array of arguments passed in to event
127 |      * handler. The list of arguments can vary for different events. See an
128 |      * event description to know which arguments are available and how they
129 |      * should be used.
130 |      */
131 |     public function addCustomCss(&$args)
132 |     {
133 |         $args['css'][] = str_replace(DIRECTORY_SEPARATOR, '/', $this->getFilesPath()) . '/css/styles.css';
134 |     }
135 | 
136 |     /**
137 |      * Returns verision of the plugin.
138 |      *
139 |      * The version can be any string compatible with semantic version
140 |      * convention (see {@link http://semver.org/}). For example one can use the
141 |      * following versions:
142 |      *  - "1.2.3"
143 |      *  - "0.1.7-alpha.2"
144 |      *  - "4.0.0-beta.4"
145 |      *
146 |      * @return string Plugin's version.
147 |      */
148 |     public static function getVersion()
149 |     {
150 |         return '0.1.1';
151 |     }
152 | 
153 |     /**
154 |      * Also we can add dependencies. But make sure that they were loaded BEFORE
155 |      * current plugin in config.php
156 |      *
157 |      * If the plugin depends, for example, on "Abc:BestFeature" and "Xyz:Logger"
158 |      * we need to return the following array:
159 |      * <code>
160 |      * return array(
161 |      *     'Abc:BestFeature' => '0.2.1',
162 |      *     'Xyz:Logger' => '3.1.4',
163 |      * );
164 |      * </code>
165 |      */
166 |     public static function getDependencies()
167 |     {
168 |         // This plugin does not depend on others so return an empty array.
169 |         return array();
170 |     }
171 | }
172 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | 
  2 |                                  Apache License
  3 |                            Version 2.0, January 2004
  4 |                         http://www.apache.org/licenses/
  5 | 
  6 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  7 | 
  8 |    1. Definitions.
  9 | 
 10 |       "License" shall mean the terms and conditions for use, reproduction,
 11 |       and distribution as defined by Sections 1 through 9 of this document.
 12 | 
 13 |       "Licensor" shall mean the copyright owner or entity authorized by
 14 |       the copyright owner that is granting the License.
 15 | 
 16 |       "Legal Entity" shall mean the union of the acting entity and all
 17 |       other entities that control, are controlled by, or are under common
 18 |       control with that entity. For the purposes of this definition,
 19 |       "control" means (i) the power, direct or indirect, to cause the
 20 |       direction or management of such entity, whether by contract or
 21 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 22 |       outstanding shares, or (iii) beneficial ownership of such entity.
 23 | 
 24 |       "You" (or "Your") shall mean an individual or Legal Entity
 25 |       exercising permissions granted by this License.
 26 | 
 27 |       "Source" form shall mean the preferred form for making modifications,
 28 |       including but not limited to software source code, documentation
 29 |       source, and configuration files.
 30 | 
 31 |       "Object" form shall mean any form resulting from mechanical
 32 |       transformation or translation of a Source form, including but
 33 |       not limited to compiled object code, generated documentation,
 34 |       and conversions to other media types.
 35 | 
 36 |       "Work" shall mean the work of authorship, whether in Source or
 37 |       Object form, made available under the License, as indicated by a
 38 |       copyright notice that is included in or attached to the work
 39 |       (an example is provided in the Appendix below).
 40 | 
 41 |       "Derivative Works" shall mean any work, whether in Source or Object
 42 |       form, that is based on (or derived from) the Work and for which the
 43 |       editorial revisions, annotations, elaborations, or other modifications
 44 |       represent, as a whole, an original work of authorship. For the purposes
 45 |       of this License, Derivative Works shall not include works that remain
 46 |       separable from, or merely link (or bind by name) to the interfaces of,
 47 |       the Work and Derivative Works thereof.
 48 | 
 49 |       "Contribution" shall mean any work of authorship, including
 50 |       the original version of the Work and any modifications or additions
 51 |       to that Work or Derivative Works thereof, that is intentionally
 52 |       submitted to Licensor for inclusion in the Work by the copyright owner
 53 |       or by an individual or Legal Entity authorized to submit on behalf of
 54 |       the copyright owner. For the purposes of this definition, "submitted"
 55 |       means any form of electronic, verbal, or written communication sent
 56 |       to the Licensor or its representatives, including but not limited to
 57 |       communication on electronic mailing lists, source code control systems,
 58 |       and issue tracking systems that are managed by, or on behalf of, the
 59 |       Licensor for the purpose of discussing and improving the Work, but
 60 |       excluding communication that is conspicuously marked or otherwise
 61 |       designated in writing by the copyright owner as "Not a Contribution."
 62 | 
 63 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 64 |       on behalf of whom a Contribution has been received by Licensor and
 65 |       subsequently incorporated within the Work.
 66 | 
 67 |    2. Grant of Copyright License. Subject to the terms and conditions of
 68 |       this License, each Contributor hereby grants to You a perpetual,
 69 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 70 |       copyright license to reproduce, prepare Derivative Works of,
 71 |       publicly display, publicly perform, sublicense, and distribute the
 72 |       Work and such Derivative Works in Source or Object form.
 73 | 
 74 |    3. Grant of Patent License. Subject to the terms and conditions of
 75 |       this License, each Contributor hereby grants to You a perpetual,
 76 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 77 |       (except as stated in this section) patent license to make, have made,
 78 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 79 |       where such license applies only to those patent claims licensable
 80 |       by such Contributor that are necessarily infringed by their
 81 |       Contribution(s) alone or by combination of their Contribution(s)
 82 |       with the Work to which such Contribution(s) was submitted. If You
 83 |       institute patent litigation against any entity (including a
 84 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 85 |       or a Contribution incorporated within the Work constitutes direct
 86 |       or contributory patent infringement, then any patent licenses
 87 |       granted to You under this License for that Work shall terminate
 88 |       as of the date such litigation is filed.
 89 | 
 90 |    4. Redistribution. You may reproduce and distribute copies of the
 91 |       Work or Derivative Works thereof in any medium, with or without
 92 |       modifications, and in Source or Object form, provided that You
 93 |       meet the following conditions:
 94 | 
 95 |       (a) You must give any other recipients of the Work or
 96 |           Derivative Works a copy of this License; and
 97 | 
 98 |       (b) You must cause any modified files to carry prominent notices
 99 |           stating that You changed the files; and
100 | 
101 |       (c) You must retain, in the Source form of any Derivative Works
102 |           that You distribute, all copyright, patent, trademark, and
103 |           attribution notices from the Source form of the Work,
104 |           excluding those notices that do not pertain to any part of
105 |           the Derivative Works; and
106 | 
107 |       (d) If the Work includes a "NOTICE" text file as part of its
108 |           distribution, then any Derivative Works that You distribute must
109 |           include a readable copy of the attribution notices contained
110 |           within such NOTICE file, excluding those notices that do not
111 |           pertain to any part of the Derivative Works, in at least one
112 |           of the following places: within a NOTICE text file distributed
113 |           as part of the Derivative Works; within the Source form or
114 |           documentation, if provided along with the Derivative Works; or,
115 |           within a display generated by the Derivative Works, if and
116 |           wherever such third-party notices normally appear. The contents
117 |           of the NOTICE file are for informational purposes only and
118 |           do not modify the License. You may add Your own attribution
119 |           notices within Derivative Works that You distribute, alongside
120 |           or as an addendum to the NOTICE text from the Work, provided
121 |           that such additional attribution notices cannot be construed
122 |           as modifying the License.
123 | 
124 |       You may add Your own copyright statement to Your modifications and
125 |       may provide additional or different license terms and conditions
126 |       for use, reproduction, or distribution of Your modifications, or
127 |       for any such Derivative Works as a whole, provided Your use,
128 |       reproduction, and distribution of the Work otherwise complies with
129 |       the conditions stated in this License.
130 | 
131 |    5. Submission of Contributions. Unless You explicitly state otherwise,
132 |       any Contribution intentionally submitted for inclusion in the Work
133 |       by You to the Licensor shall be under the terms and conditions of
134 |       this License, without any additional terms or conditions.
135 |       Notwithstanding the above, nothing herein shall supersede or modify
136 |       the terms of any separate license agreement you may have executed
137 |       with Licensor regarding such Contributions.
138 | 
139 |    6. Trademarks. This License does not grant permission to use the trade
140 |       names, trademarks, service marks, or product names of the Licensor,
141 |       except as required for reasonable and customary use in describing the
142 |       origin of the Work and reproducing the content of the NOTICE file.
143 | 
144 |    7. Disclaimer of Warranty. Unless required by applicable law or
145 |       agreed to in writing, Licensor provides the Work (and each
146 |       Contributor provides its Contributions) on an "AS IS" BASIS,
147 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 |       implied, including, without limitation, any warranties or conditions
149 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 |       PARTICULAR PURPOSE. You are solely responsible for determining the
151 |       appropriateness of using or redistributing the Work and assume any
152 |       risks associated with Your exercise of permissions under this License.
153 | 
154 |    8. Limitation of Liability. In no event and under no legal theory,
155 |       whether in tort (including negligence), contract, or otherwise,
156 |       unless required by applicable law (such as deliberate and grossly
157 |       negligent acts) or agreed to in writing, shall any Contributor be
158 |       liable to You for damages, including any direct, indirect, special,
159 |       incidental, or consequential damages of any character arising as a
160 |       result of this License or out of the use or inability to use the
161 |       Work (including but not limited to damages for loss of goodwill,
162 |       work stoppage, computer failure or malfunction, or any and all
163 |       other commercial damages or losses), even if such Contributor
164 |       has been advised of the possibility of such damages.
165 | 
166 |    9. Accepting Warranty or Additional Liability. While redistributing
167 |       the Work or Derivative Works thereof, You may choose to offer,
168 |       and charge a fee for, acceptance of support, warranty, indemnity,
169 |       or other liability obligations and/or rights consistent with this
170 |       License. However, in accepting such obligations, You may act only
171 |       on Your own behalf and on Your sole responsibility, not on behalf
172 |       of any other Contributor, and only if You agree to indemnify,
173 |       defend, and hold each Contributor harmless for any liability
174 |       incurred by, or claims asserted against, such Contributor by reason
175 |       of your accepting any such warranty or additional liability.
176 | 
177 |    END OF TERMS AND CONDITIONS
178 | 
179 |    APPENDIX: How to apply the Apache License to your work.
180 | 
181 |       To apply the Apache License to your work, attach the following
182 |       boilerplate notice, with the fields enclosed by brackets "[]"
183 |       replaced with your own identifying information. (Don't include
184 |       the brackets!)  The text should be enclosed in the appropriate
185 |       comment syntax for the file format. We also recommend that a
186 |       file or class name and description of purpose be included on the
187 |       same "printed page" as the copyright notice for easier
188 |       identification within third-party archives.
189 | 
190 |    Copyright [yyyy] [name of copyright owner]
191 | 
192 |    Licensed under the Apache License, Version 2.0 (the "License");
193 |    you may not use this file except in compliance with the License.
194 |    You may obtain a copy of the License at
195 | 
196 |        http://www.apache.org/licenses/LICENSE-2.0
197 | 
198 |    Unless required by applicable law or agreed to in writing, software
199 |    distributed under the License is distributed on an "AS IS" BASIS,
200 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 |    See the License for the specific language governing permissions and
202 |    limitations under the License.
203 | 


--------------------------------------------------------------------------------