AbstractPlugin.php — Weight Based Shipping Table Rate for WooCommerce – Flexible Shipping 6.11.0

flexible-shipping / vendor_prefixed / wpdesk / wp-builder / src / Plugin / AbstractPlugin.php

flexible-shipping / vendor_prefixed / wpdesk / wp-builder / src / Plugin Last commit date

WithoutNamespace 2 weeks ago AbstractPlugin.php 2 weeks ago Activateable.php 2 weeks ago ActivationAware.php 2 weeks ago ActivationTracker.php 2 weeks ago Conditional.php 2 weeks ago Deactivateable.php 2 weeks ago Hookable.php 2 weeks ago HookableCollection.php 2 weeks ago HookableParent.php 2 weeks ago HookablePluginDependant.php 2 weeks ago PluginAccess.php 2 weeks ago SlimPlugin.php 2 weeks ago TemplateLoad.php 2 weeks ago

AbstractPlugin.php

194 lines

1	<?php
2
3	namespace FSVendor\WPDesk\PluginBuilder\Plugin;
4
5	/**
6	* Base plugin with most basic functionalities used by every WPDesk plugin.
7	*
8	*
9	* Known issues:
10	*
11	* The class name is too generic but can't be changed as it would introduce a major incompatibility for most of the plugins.
12	* The $plugin_url, $docs_url and most other fields should be removed as they only litter the place but for compatibility reasons we can't do it right now.
13	* Hook methods should be moved to external classes but for compatibility reasons we can't do it right now.
14	*/
15	abstract class AbstractPlugin extends SlimPlugin
16	{
17	/**
18	* Most info about plugin internals.
19	*
20	* @var \WPDesk_Plugin_Info
21	*/
22	protected $plugin_info;
23	/**
24	* Unique string for this plugin in [a-z_]+ format.
25	*
26	* @var string
27	*/
28	protected $plugin_namespace;
29	/**
30	* Absolute URL to the plugin dir.
31	*
32	* @var string
33	*/
34	protected $plugin_url;
35	/**
36	* Absolute URL to the plugin docs.
37	*
38	* @var string
39	*/
40	protected $docs_url;
41	/**
42	* Absolute URL to the plugin settings url.
43	*
44	* @var string
45	*/
46	protected $settings_url;
47	/**
48	* Support URL.
49	*
50	* @var string
51	*/
52	protected $support_url;
53	/**
54	* AbstractPlugin constructor.
55	*
56	* @param \WPDesk_Plugin_Info $plugin_info
57	*/
58	public function __construct($plugin_info)
59	{
60	$this->plugin_info = $plugin_info;
61	$this->plugin_namespace = strtolower($plugin_info->get_plugin_dir());
62	$this->plugin_url = $this->plugin_info->get_plugin_url();
63	$this->init_base_variables();
64	}
65	/**
66	* Initialize internal state of the plugin.
67	*
68	* @return void
69	* @deprecated Just use __construct to initialize plugin internal state.
70	*
71	*/
72	public function init_base_variables()
73	{
74	}
75	/**
76	* Initializes plugin external state.
77	*
78	* The plugin internal state is initialized in the constructor and the plugin should be internally consistent after creation.
79	* The external state includes hooks execution, communication with other plugins, integration with WC etc.
80	*
81	* @return void
82	*/
83	public function init()
84	{
85	$this->hooks();
86	}
87	/**
88	* Returns absolute path to the plugin dir.
89	*
90	* @return string
91	*/
92	public function get_plugin_file_path()
93	{
94	return $this->plugin_info->get_plugin_file_name();
95	}
96	/**
97	* Returns plugin text domain.
98	*
99	* @return string
100	*/
101	public function get_text_domain()
102	{
103	return $this->plugin_info->get_text_domain();
104	}
105	/**
106	* Returns unique string for plugin in [a-z_]+ format. Can be used as plugin id in various places like plugin slug etc.
107	*
108	* @return string
109	*/
110	public function get_namespace()
111	{
112	return $this->plugin_namespace;
113	}
114	/**
115	* Returns plugin absolute URL.
116	*
117	* @return string
118	*/
119	public function get_plugin_url()
120	{
121	return esc_url(trailingslashit($this->plugin_url));
122	}
123	/**
124	* Returns plugin absolute URL to dir with front end assets.
125	*
126	* @return string
127	*/
128	public function get_plugin_assets_url()
129	{
130	return esc_url(trailingslashit($this->get_plugin_url() . 'assets'));
131	}
132	/**
133	* @return $this
134	* @deprecated For backward compatibility.
135	*
136	*/
137	public function get_plugin()
138	{
139	return $this;
140	}
141	/**
142	* Integrate with WordPress and with other plugins using action/filter system.
143	*
144	* @return void
145	*/
146	protected function hooks()
147	{
148	add_action('admin_enqueue_scripts', [$this, 'admin_enqueue_scripts']);
149	add_action('wp_enqueue_scripts', [$this, 'wp_enqueue_scripts']);
150	add_filter('plugin_action_links_' . plugin_basename($this->get_plugin_file_path()), [$this, 'links_filter']);
151	}
152	/**
153	* Append JS scripts in the WordPress admin panel. This is a hook function. Do not execute directly.
154	*
155	* @return void
156	*/
157	public function admin_enqueue_scripts()
158	{
159	}
160	/**
161	* Append JS scripts in WordPress. This is a hook function. Do not execute directly.
162	*
163	* @return void
164	*/
165	public function wp_enqueue_scripts()
166	{
167	}
168	/**
169	* Initialize plugin admin links. This is a hook function. Do not execute directly.
170	*
171	* @param string[] $links
172	*
173	* @return string[]
174	*/
175	public function links_filter($links)
176	{
177	$support_link = get_locale() === 'pl_PL' ? 'https://www.wpdesk.pl/support/' : 'https://www.wpdesk.net/support';
178	if ($this->support_url) {
179	$support_link = $this->support_url;
180	}
181	$plugin_links = ['<a target="_blank" href="' . $support_link . '">' . esc_html__('Support', 'flexible-shipping') . '</a>'];
182	$links = array_merge($plugin_links, $links);
183	if ($this->docs_url) {
184	$plugin_links = ['<a target="_blank" href="' . $this->docs_url . '">' . esc_html__('Docs', 'flexible-shipping') . '</a>'];
185	$links = array_merge($plugin_links, $links);
186	}
187	if ($this->settings_url) {
188	$plugin_links = ['<a href="' . $this->settings_url . '">' . esc_html__('Settings', 'flexible-shipping') . '</a>'];
189	$links = array_merge($plugin_links, $links);
190	}
191	return $links;
192	}
193	}
194