depicter / vendor / htmlburger / wpemerge / src / Middleware / HasMiddlewareDefinitionsInterface.php

HasMiddlewareDefinitionsInterface.php in Depicter — Popup & Slider Builder 1.2.0, at vendor/htmlburger/wpemerge/src/Middleware/HasMiddlewareDefinitionsInterface.php

74 lines 1.6 KB

Raw Download Zip

1	<?php
2	/**
3	* @package WPEmerge
4	* @author Atanas Angelov <hi@atanas.dev>
5	* @copyright 2017-2019 Atanas Angelov
6	* @license https://www.gnu.org/licenses/gpl-2.0.html GPL-2.0
7	* @link https://wpemerge.com/
8	*/
9
10	namespace WPEmerge\Middleware;
11
12	/**
13	* Provide middleware definitions.
14	*/
15	interface HasMiddlewareDefinitionsInterface {
16	/**
17	* Register middleware.
18	*
19	* @codeCoverageIgnore
20	* @param array<string, string> $middleware
21	* @return void
22	*/
23	public function setMiddleware( $middleware );
24
25	/**
26	* Register middleware groups.
27	*
28	* @codeCoverageIgnore
29	* @param array<string, string[]> $middleware_groups
30	* @return void
31	*/
32	public function setMiddlewareGroups( $middleware_groups );
33
34	/**
35	* Filter array of middleware into a unique set.
36	*
37	* @param array[] $middleware
38	* @return string[]
39	*/
40	public function uniqueMiddleware( $middleware );
41
42	/**
43	* Expand array of middleware into an array of fully qualified class names.
44	*
45	* @param string[] $middleware
46	* @return array[]
47	*/
48	public function expandMiddleware( $middleware );
49
50	/**
51	* Expand a middleware group into an array of fully qualified class names.
52	*
53	* @param string $group
54	* @return array[]
55	*/
56	public function expandMiddlewareGroup( $group );
57
58	/**
59	* Expand middleware into an array of fully qualified class names and any companion arguments.
60	*
61	* @param string $middleware
62	* @return array[]
63	*/
64	public function expandMiddlewareMolecule( $middleware );
65
66	/**
67	* Expand a single middleware a fully qualified class name.
68	*
69	* @param string $middleware
70	* @return string
71	*/
72	public function expandMiddlewareAtom( $middleware );
73	}
74