1	<?php
2	declare(strict_types=1);
3
4	namespace Korobochkin\WPKit\Plugins;
5
6	use Symfony\Component\DependencyInjection\ContainerAwareInterface;
7	use Symfony\Component\DependencyInjection\ContainerInterface;
8
9	interface PluginInterface extends ContainerAwareInterface
10	{
11	/**
12	* Define const NAME here with plugin name as 'my-plugin-name-'.
13	*
14	* Define const VERSION here with plugin version as '1.2.3-beta-1'.
15	*/
16
17	/**
18	* PluginInterface constructor.
19	*
20	* Do not set any actions or hooks here.
21	*
22	* @param $file string Path to plugin bootstrap file.
23	*/
24	public function __construct($file);
25
26	/**
27	* Place here any action and filters which initialize plugin.
28	*
29	* @return $this For chain calls.
30	*/
31	public function run();
32
33	/**
34	* Place here any actions and filters for WordPress admin area only.
35	*
36	* @return $this For chain calls.
37	*/
38	public function runAdmin();
39
40	/**
41	* @return string A path to plugin bootstrap file.
42	*/
43	public function getFile();
44
45	/**
46	* @param $file string A path to plugin bootstrap file.
47	*
48	* @return $this For chain calls.
49	*/
50	public function setFile($file);
51
52	/**
53	* Returns the ContainerBuilder instance used to store services.
54	*
55	* @return ContainerInterface Dependency Injection container with services.
56	*/
57	public function getContainer();
58
59	/**
60	* Sets the ContainerBuilder instance used to store services.
61	*
62	* @param ContainerInterface $container Dependency Injection container with services.
63	*
64	* @return $this For chain calls.
65	*/
66	public function setContainer(ContainerInterface $container = null);
67
68	/**
69	* Returns the plugin folder name.
70	*
71	* @return string A path to plugin root folder (where your bootstrap file located).
72	*/
73	public function getDir();
74
75	/**
76	* Returns the plugin folder url.
77	*
78	* @return string An URL to plugin root folder (where you can place your assets folder for example).
79	*/
80	public function getUrl();
81
82	/**
83	* Returns the plugin basename.
84	*
85	* @return string Plugin basename (the plugin name in plugins directory).
86	*/
87	public function getBasename();
88
89	/**
90	* Returns plugin version as a string which you can parse.
91	*
92	* @return string Version of plugin in sem ver manner.
93	*/
94	public function getVersion();
95
96	/**
97	* Returns plugin name as a string.
98	*
99	* Perfect for your plugin text domain.
100	*
101	* @return string Plugin name in 'your-plugin-name' manner.
102	*/
103	public function getName();
104	}