@@ -11,39 +11,39 @@ |
||
11 | 11 | * @subpackage Utility |
12 | 12 | */ |
13 | 13 | class Str { |
14 | - /** |
|
15 | - * Determine if a given string starts with a given substring. |
|
16 | - * |
|
17 | - * @param string $haystack |
|
18 | - * @param string|array $needles |
|
19 | - * |
|
20 | - * @return bool |
|
21 | - */ |
|
22 | - public static function starts_with( $haystack, $needles ) { |
|
23 | - foreach ( (array) $needles as $needle ) { |
|
24 | - if ( '' !== $needle && 0 === strpos( $haystack, $needle ) ) { |
|
25 | - return true; |
|
26 | - } |
|
27 | - } |
|
14 | + /** |
|
15 | + * Determine if a given string starts with a given substring. |
|
16 | + * |
|
17 | + * @param string $haystack |
|
18 | + * @param string|array $needles |
|
19 | + * |
|
20 | + * @return bool |
|
21 | + */ |
|
22 | + public static function starts_with( $haystack, $needles ) { |
|
23 | + foreach ( (array) $needles as $needle ) { |
|
24 | + if ( '' !== $needle && 0 === strpos( $haystack, $needle ) ) { |
|
25 | + return true; |
|
26 | + } |
|
27 | + } |
|
28 | 28 | |
29 | - return false; |
|
30 | - } |
|
29 | + return false; |
|
30 | + } |
|
31 | 31 | |
32 | - /** |
|
33 | - * Determine if a given string ends with a given substring. |
|
34 | - * |
|
35 | - * @param string $haystack |
|
36 | - * @param string|array $needles |
|
37 | - * |
|
38 | - * @return bool |
|
39 | - */ |
|
40 | - public static function ends_with( $haystack, $needles ) { |
|
41 | - foreach ( (array) $needles as $needle ) { |
|
42 | - if ( substr( $haystack, - strlen( $needle ) ) === (string) $needle ) { |
|
43 | - return true; |
|
44 | - } |
|
45 | - } |
|
32 | + /** |
|
33 | + * Determine if a given string ends with a given substring. |
|
34 | + * |
|
35 | + * @param string $haystack |
|
36 | + * @param string|array $needles |
|
37 | + * |
|
38 | + * @return bool |
|
39 | + */ |
|
40 | + public static function ends_with( $haystack, $needles ) { |
|
41 | + foreach ( (array) $needles as $needle ) { |
|
42 | + if ( substr( $haystack, - strlen( $needle ) ) === (string) $needle ) { |
|
43 | + return true; |
|
44 | + } |
|
45 | + } |
|
46 | 46 | |
47 | - return false; |
|
48 | - } |
|
47 | + return false; |
|
48 | + } |
|
49 | 49 | } |
@@ -2,10 +2,10 @@ |
||
2 | 2 | namespace Intraxia\Jaxion\Contract\Core; |
3 | 3 | |
4 | 4 | interface I18n { |
5 | - /** |
|
6 | - * Loads the plugin's textdomain. |
|
7 | - * |
|
8 | - * @return void |
|
9 | - */ |
|
10 | - public function load_plugin_textdomain(); |
|
5 | + /** |
|
6 | + * Loads the plugin's textdomain. |
|
7 | + * |
|
8 | + * @return void |
|
9 | + */ |
|
10 | + public function load_plugin_textdomain(); |
|
11 | 11 | } |
@@ -11,53 +11,53 @@ |
||
11 | 11 | * @subpackage Core |
12 | 12 | */ |
13 | 13 | class I18n implements I18nContract, HasActions { |
14 | - /** |
|
15 | - * Plugin basename |
|
16 | - * |
|
17 | - * @var string |
|
18 | - */ |
|
19 | - private $basename; |
|
14 | + /** |
|
15 | + * Plugin basename |
|
16 | + * |
|
17 | + * @var string |
|
18 | + */ |
|
19 | + private $basename; |
|
20 | 20 | |
21 | - /** |
|
22 | - * Plugin path. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - private $path; |
|
21 | + /** |
|
22 | + * Plugin path. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + private $path; |
|
27 | 27 | |
28 | - /** |
|
29 | - * I18n constructor. |
|
30 | - * |
|
31 | - * @param string $basename Plugin basename. |
|
32 | - * @param string $path Plugin path. |
|
33 | - */ |
|
34 | - public function __construct( $basename, $path ) { |
|
35 | - $this->basename = $basename; |
|
36 | - $this->path = $path; |
|
37 | - } |
|
28 | + /** |
|
29 | + * I18n constructor. |
|
30 | + * |
|
31 | + * @param string $basename Plugin basename. |
|
32 | + * @param string $path Plugin path. |
|
33 | + */ |
|
34 | + public function __construct( $basename, $path ) { |
|
35 | + $this->basename = $basename; |
|
36 | + $this->path = $path; |
|
37 | + } |
|
38 | 38 | |
39 | - /** |
|
40 | - * {@inheritdoc} |
|
41 | - */ |
|
42 | - public function load_plugin_textdomain() { |
|
43 | - load_plugin_textdomain( |
|
44 | - $this->basename, |
|
45 | - false, |
|
46 | - basename( $this->path ) . '/languages/' |
|
47 | - ); |
|
48 | - } |
|
39 | + /** |
|
40 | + * {@inheritdoc} |
|
41 | + */ |
|
42 | + public function load_plugin_textdomain() { |
|
43 | + load_plugin_textdomain( |
|
44 | + $this->basename, |
|
45 | + false, |
|
46 | + basename( $this->path ) . '/languages/' |
|
47 | + ); |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * {@inheritDoc} |
|
52 | - * |
|
53 | - * @return array |
|
54 | - */ |
|
55 | - public function action_hooks() { |
|
56 | - return array( |
|
57 | - array( |
|
58 | - 'hook' => 'init', |
|
59 | - 'method' => 'load_plugin_textdomain', |
|
60 | - ), |
|
61 | - ); |
|
62 | - } |
|
50 | + /** |
|
51 | + * {@inheritDoc} |
|
52 | + * |
|
53 | + * @return array |
|
54 | + */ |
|
55 | + public function action_hooks() { |
|
56 | + return array( |
|
57 | + array( |
|
58 | + 'hook' => 'init', |
|
59 | + 'method' => 'load_plugin_textdomain', |
|
60 | + ), |
|
61 | + ); |
|
62 | + } |
|
63 | 63 | } |
@@ -13,137 +13,137 @@ |
||
13 | 13 | * @package Intraxia\Jaxion |
14 | 14 | */ |
15 | 15 | class Application extends Container implements ApplicationContract { |
16 | - /** |
|
17 | - * Define plugin version on Application. |
|
18 | - */ |
|
19 | - const VERSION = ''; |
|
20 | - |
|
21 | - /** |
|
22 | - * Singleton instance of the Application object |
|
23 | - * |
|
24 | - * @var Application[] |
|
25 | - */ |
|
26 | - protected static $instances = array(); |
|
27 | - |
|
28 | - /** |
|
29 | - * Instantiates a new Application container. |
|
30 | - * |
|
31 | - * The Application constructor enforces the presence of of a single instance |
|
32 | - * of the Application. If an instance already exists, an Exception will be thrown. |
|
33 | - * |
|
34 | - * @param string $file |
|
35 | - * @param array $providers |
|
36 | - * |
|
37 | - * @throws ApplicationAlreadyBootedException |
|
38 | - */ |
|
39 | - public function __construct( $file, array $providers = array() ) { |
|
40 | - if ( isset( static::$instances[ get_called_class() ] ) ) { |
|
41 | - throw new ApplicationAlreadyBootedException; |
|
42 | - } |
|
43 | - |
|
44 | - static::$instances[ get_called_class() ] = $this; |
|
45 | - |
|
46 | - $this->register_constants( $file ); |
|
47 | - $this->register_core_services(); |
|
48 | - |
|
49 | - register_activation_hook( $file, array( $this, 'activate' ) ); |
|
50 | - register_deactivation_hook( $file, array( $this, 'deactivate' ) ); |
|
51 | - |
|
52 | - parent::__construct( $providers ); |
|
53 | - } |
|
54 | - |
|
55 | - /** |
|
56 | - * {@inheritDoc} |
|
57 | - * |
|
58 | - * @throws UnexpectedValueException |
|
59 | - */ |
|
60 | - public function boot() { |
|
61 | - $loader = $this->fetch( 'loader' ); |
|
62 | - |
|
63 | - if ( ! $loader instanceof LoaderContract ) { |
|
64 | - throw new UnexpectedValueException; |
|
65 | - } |
|
66 | - |
|
67 | - foreach ( $this as $alias => $value ) { |
|
68 | - if ( $value instanceof HasActions ) { |
|
69 | - $loader->register_actions( $value ); |
|
70 | - } |
|
71 | - |
|
72 | - if ( $value instanceof HasFilters ) { |
|
73 | - $loader->register_filters( $value ); |
|
74 | - } |
|
75 | - |
|
76 | - if ( $value instanceof HasShortcode ) { |
|
77 | - $loader->register_shortcode( $value ); |
|
78 | - } |
|
79 | - } |
|
80 | - |
|
81 | - add_action( 'plugins_loaded', array( $loader, 'run' ) ); |
|
82 | - } |
|
83 | - |
|
84 | - /** |
|
85 | - * {@inheritdoc} |
|
86 | - * |
|
87 | - * @codeCoverageIgnore |
|
88 | - */ |
|
89 | - public function activate() { |
|
90 | - // no-op |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * {@inheritdoc} |
|
95 | - * |
|
96 | - * @codeCoverageIgnore |
|
97 | - */ |
|
98 | - public function deactivate() { |
|
99 | - // no-op |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * {@inheritDoc} |
|
104 | - * |
|
105 | - * @return Application |
|
106 | - * @throws ApplicationNotBootedException |
|
107 | - */ |
|
108 | - public static function instance() { |
|
109 | - if ( ! isset( static::$instances[ get_called_class() ] ) ) { |
|
110 | - throw new ApplicationNotBootedException; |
|
111 | - } |
|
112 | - |
|
113 | - return static::$instances[ get_called_class() ]; |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * {@inheritDoc} |
|
118 | - */ |
|
119 | - public static function shutdown() { |
|
120 | - if ( isset( static::$instances[ get_called_class() ] ) ) { |
|
121 | - unset( static::$instances[ get_called_class() ] ); |
|
122 | - } |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * Sets the plugin's url, path, and basename. |
|
127 | - * |
|
128 | - * @param string $file |
|
129 | - */ |
|
130 | - private function register_constants( $file ) { |
|
131 | - $this->share( 'url', plugin_dir_url( $file ) ); |
|
132 | - $this->share( 'path', plugin_dir_path( $file ) ); |
|
133 | - $this->share( 'basename', $basename = plugin_basename( $file ) ); |
|
134 | - $this->share( 'slug', dirname( $basename ) ); |
|
135 | - $this->share( 'version', static::VERSION ); |
|
136 | - } |
|
137 | - |
|
138 | - /** |
|
139 | - * Registers the built-in services with the Application container. |
|
140 | - */ |
|
141 | - private function register_core_services() { |
|
142 | - $this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function ( $app ) { |
|
143 | - return new Loader( $app ); |
|
144 | - } ); |
|
145 | - $this->share( array( 'i18n' => 'Intaxia\Jaxion\Contract\Core\I18n' ), function ( $app ) { |
|
146 | - return new I18n( $app->fetch( 'basename' ), $app->fetch( 'path' ) ); |
|
147 | - } ); |
|
148 | - } |
|
16 | + /** |
|
17 | + * Define plugin version on Application. |
|
18 | + */ |
|
19 | + const VERSION = ''; |
|
20 | + |
|
21 | + /** |
|
22 | + * Singleton instance of the Application object |
|
23 | + * |
|
24 | + * @var Application[] |
|
25 | + */ |
|
26 | + protected static $instances = array(); |
|
27 | + |
|
28 | + /** |
|
29 | + * Instantiates a new Application container. |
|
30 | + * |
|
31 | + * The Application constructor enforces the presence of of a single instance |
|
32 | + * of the Application. If an instance already exists, an Exception will be thrown. |
|
33 | + * |
|
34 | + * @param string $file |
|
35 | + * @param array $providers |
|
36 | + * |
|
37 | + * @throws ApplicationAlreadyBootedException |
|
38 | + */ |
|
39 | + public function __construct( $file, array $providers = array() ) { |
|
40 | + if ( isset( static::$instances[ get_called_class() ] ) ) { |
|
41 | + throw new ApplicationAlreadyBootedException; |
|
42 | + } |
|
43 | + |
|
44 | + static::$instances[ get_called_class() ] = $this; |
|
45 | + |
|
46 | + $this->register_constants( $file ); |
|
47 | + $this->register_core_services(); |
|
48 | + |
|
49 | + register_activation_hook( $file, array( $this, 'activate' ) ); |
|
50 | + register_deactivation_hook( $file, array( $this, 'deactivate' ) ); |
|
51 | + |
|
52 | + parent::__construct( $providers ); |
|
53 | + } |
|
54 | + |
|
55 | + /** |
|
56 | + * {@inheritDoc} |
|
57 | + * |
|
58 | + * @throws UnexpectedValueException |
|
59 | + */ |
|
60 | + public function boot() { |
|
61 | + $loader = $this->fetch( 'loader' ); |
|
62 | + |
|
63 | + if ( ! $loader instanceof LoaderContract ) { |
|
64 | + throw new UnexpectedValueException; |
|
65 | + } |
|
66 | + |
|
67 | + foreach ( $this as $alias => $value ) { |
|
68 | + if ( $value instanceof HasActions ) { |
|
69 | + $loader->register_actions( $value ); |
|
70 | + } |
|
71 | + |
|
72 | + if ( $value instanceof HasFilters ) { |
|
73 | + $loader->register_filters( $value ); |
|
74 | + } |
|
75 | + |
|
76 | + if ( $value instanceof HasShortcode ) { |
|
77 | + $loader->register_shortcode( $value ); |
|
78 | + } |
|
79 | + } |
|
80 | + |
|
81 | + add_action( 'plugins_loaded', array( $loader, 'run' ) ); |
|
82 | + } |
|
83 | + |
|
84 | + /** |
|
85 | + * {@inheritdoc} |
|
86 | + * |
|
87 | + * @codeCoverageIgnore |
|
88 | + */ |
|
89 | + public function activate() { |
|
90 | + // no-op |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * {@inheritdoc} |
|
95 | + * |
|
96 | + * @codeCoverageIgnore |
|
97 | + */ |
|
98 | + public function deactivate() { |
|
99 | + // no-op |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * {@inheritDoc} |
|
104 | + * |
|
105 | + * @return Application |
|
106 | + * @throws ApplicationNotBootedException |
|
107 | + */ |
|
108 | + public static function instance() { |
|
109 | + if ( ! isset( static::$instances[ get_called_class() ] ) ) { |
|
110 | + throw new ApplicationNotBootedException; |
|
111 | + } |
|
112 | + |
|
113 | + return static::$instances[ get_called_class() ]; |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * {@inheritDoc} |
|
118 | + */ |
|
119 | + public static function shutdown() { |
|
120 | + if ( isset( static::$instances[ get_called_class() ] ) ) { |
|
121 | + unset( static::$instances[ get_called_class() ] ); |
|
122 | + } |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * Sets the plugin's url, path, and basename. |
|
127 | + * |
|
128 | + * @param string $file |
|
129 | + */ |
|
130 | + private function register_constants( $file ) { |
|
131 | + $this->share( 'url', plugin_dir_url( $file ) ); |
|
132 | + $this->share( 'path', plugin_dir_path( $file ) ); |
|
133 | + $this->share( 'basename', $basename = plugin_basename( $file ) ); |
|
134 | + $this->share( 'slug', dirname( $basename ) ); |
|
135 | + $this->share( 'version', static::VERSION ); |
|
136 | + } |
|
137 | + |
|
138 | + /** |
|
139 | + * Registers the built-in services with the Application container. |
|
140 | + */ |
|
141 | + private function register_core_services() { |
|
142 | + $this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function ( $app ) { |
|
143 | + return new Loader( $app ); |
|
144 | + } ); |
|
145 | + $this->share( array( 'i18n' => 'Intaxia\Jaxion\Contract\Core\I18n' ), function ( $app ) { |
|
146 | + return new I18n( $app->fetch( 'basename' ), $app->fetch( 'path' ) ); |
|
147 | + } ); |
|
148 | + } |
|
149 | 149 | } |
@@ -12,208 +12,208 @@ |
||
12 | 12 | * @subpackage Register |
13 | 13 | */ |
14 | 14 | class Register implements RegisterContract { |
15 | - /** |
|
16 | - * Minification string for enqueued assets. |
|
17 | - * |
|
18 | - * @var string |
|
19 | - */ |
|
20 | - private $min = ''; |
|
21 | - |
|
22 | - /** |
|
23 | - * Url to the plugin directory. |
|
24 | - * |
|
25 | - * @var string |
|
26 | - */ |
|
27 | - protected $url; |
|
28 | - |
|
29 | - /** |
|
30 | - * Script/plugin version. |
|
31 | - * |
|
32 | - * @var string |
|
33 | - */ |
|
34 | - protected $version; |
|
35 | - |
|
36 | - /** |
|
37 | - * Array of script definition arrays. |
|
38 | - * |
|
39 | - * @var array |
|
40 | - */ |
|
41 | - private $scripts = array(); |
|
42 | - |
|
43 | - /** |
|
44 | - * Array of style definition arrays. |
|
45 | - * |
|
46 | - * @var array |
|
47 | - */ |
|
48 | - private $styles = array(); |
|
49 | - |
|
50 | - /** |
|
51 | - * Instantiates a new instance of the Register class. |
|
52 | - * |
|
53 | - * The URL param should be relative to the plugin directory. The URL |
|
54 | - * form should always end with a '/'. All asset location definitions |
|
55 | - * should not begin with a slash and should be relative to the plugin's |
|
56 | - * root directory. The URL provided by default from the Application |
|
57 | - * class is compatible. |
|
58 | - * |
|
59 | - * @param string $url |
|
60 | - * @param string $version |
|
61 | - */ |
|
62 | - public function __construct( $url, $version = null ) { |
|
63 | - $this->url = $url; |
|
64 | - $this->version = $version ?: null; // Empty string should remain null. |
|
65 | - } |
|
66 | - |
|
67 | - /** |
|
68 | - * {@inheritdoc} |
|
69 | - * |
|
70 | - * @param bool $debug |
|
71 | - */ |
|
72 | - public function set_debug( $debug ) { |
|
73 | - if ( $debug ) { |
|
74 | - $this->min = '.min'; |
|
75 | - } else { |
|
76 | - $this->min = ''; |
|
77 | - } |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * {@inheritdoc} |
|
82 | - * |
|
83 | - * @param array $script |
|
84 | - */ |
|
85 | - public function register_script( $script ) { |
|
86 | - $this->scripts[] = $script; |
|
87 | - } |
|
88 | - |
|
89 | - /** |
|
90 | - * {@inheritdoc} |
|
91 | - * |
|
92 | - * @param array $style |
|
93 | - */ |
|
94 | - public function register_style( $style ) { |
|
95 | - $this->styles[] = $style; |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * {@inheritDoc} |
|
100 | - */ |
|
101 | - public function enqueue_web_scripts() { |
|
102 | - foreach ( $this->scripts as $script ) { |
|
103 | - if ( in_array( $script['type'], array( 'web', 'shared' ) ) ) { |
|
104 | - $this->enqueue_script( $script ); |
|
105 | - } |
|
106 | - } |
|
107 | - } |
|
108 | - |
|
109 | - /** |
|
110 | - * {@inheritDoc} |
|
111 | - */ |
|
112 | - public function enqueue_web_styles() { |
|
113 | - foreach ( $this->styles as $style ) { |
|
114 | - if ( in_array( $style['type'], array( 'web', 'shared' ) ) ) { |
|
115 | - $this->enqueue_style( $style ); |
|
116 | - } |
|
117 | - } |
|
118 | - } |
|
119 | - |
|
120 | - /** |
|
121 | - * {@inheritDoc} |
|
122 | - * |
|
123 | - * @param string $hook Passes a string representing the current page. |
|
124 | - */ |
|
125 | - public function enqueue_admin_scripts( $hook ) { |
|
126 | - foreach ( $this->scripts as $script ) { |
|
127 | - if ( in_array( $script['type'], array( 'admin', 'shared' ) ) ) { |
|
128 | - $this->enqueue_script( $script, $hook ); |
|
129 | - } |
|
130 | - } |
|
131 | - } |
|
132 | - |
|
133 | - /** |
|
134 | - * {@inheritDoc} |
|
135 | - * |
|
136 | - * @param string $hook Passes a string representing the current page. |
|
137 | - */ |
|
138 | - public function enqueue_admin_styles( $hook ) { |
|
139 | - foreach ( $this->styles as $style ) { |
|
140 | - if ( in_array( $style['type'], array( 'admin', 'shared' ) ) ) { |
|
141 | - $this->enqueue_style( $style, $hook ); |
|
142 | - } |
|
143 | - } |
|
144 | - } |
|
145 | - |
|
146 | - /** |
|
147 | - * {@inheritDoc} |
|
148 | - * |
|
149 | - * @return array[] |
|
150 | - */ |
|
151 | - public function action_hooks() { |
|
152 | - return array( |
|
153 | - array( |
|
154 | - 'hook' => 'wp_enqueue_scripts', |
|
155 | - 'method' => 'enqueue_web_scripts', |
|
156 | - ), |
|
157 | - array( |
|
158 | - 'hook' => 'wp_enqueue_scripts', |
|
159 | - 'method' => 'enqueue_web_styles', |
|
160 | - ), |
|
161 | - array( |
|
162 | - 'hook' => 'admin_enqueue_scripts', |
|
163 | - 'method' => 'enqueue_admin_scripts', |
|
164 | - ), |
|
165 | - array( |
|
166 | - 'hook' => 'admin_enqueue_scripts', |
|
167 | - 'method' => 'enqueue_admin_styles', |
|
168 | - ), |
|
169 | - ); |
|
170 | - } |
|
171 | - |
|
172 | - /** |
|
173 | - * Enqueues an individual script if the style's condition is met. |
|
174 | - * |
|
175 | - * @param array $script The script attachment callback. |
|
176 | - * @param string $hook The location hook. Only passed on admin side. |
|
177 | - */ |
|
178 | - protected function enqueue_script( $script, $hook = null ) { |
|
179 | - if ( $script['condition']( $hook ) ) { |
|
180 | - wp_enqueue_script( |
|
181 | - $script['handle'], |
|
182 | - $this->url . $script['src'] . '.js', |
|
183 | - isset( $script['deps'] ) ? $script['deps'] : array(), |
|
184 | - $this->version, |
|
185 | - isset( $script['footer'] ) ? $script['footer'] : false |
|
186 | - ); |
|
187 | - |
|
188 | - if ( isset( $script['localize'] ) ) { |
|
189 | - if ( is_callable( $script['localize'] ) ) { // @todo make all properties callables |
|
190 | - $script['localize'] = call_user_func( $script['localize'] ); |
|
191 | - } |
|
192 | - |
|
193 | - wp_localize_script( |
|
194 | - $script['handle'], |
|
195 | - $script['localize']['name'], |
|
196 | - $script['localize']['data'] |
|
197 | - ); |
|
198 | - } |
|
199 | - } |
|
200 | - } |
|
201 | - |
|
202 | - /** |
|
203 | - * Enqueues an individual stylesheet if the style's condition is met. |
|
204 | - * |
|
205 | - * @param array $style The style attachment callback. |
|
206 | - * @param string $hook The location hook. |
|
207 | - */ |
|
208 | - protected function enqueue_style( $style, $hook = null ) { |
|
209 | - if ( $style['condition']( $hook ) ) { |
|
210 | - wp_enqueue_style( |
|
211 | - $style['handle'], |
|
212 | - $this->url . $style['src'] . '.css', |
|
213 | - isset( $style['deps'] ) ? $style['deps'] : array(), |
|
214 | - $this->version, |
|
215 | - isset( $style['media'] ) ? $style['media'] : 'all' |
|
216 | - ); |
|
217 | - } |
|
218 | - } |
|
15 | + /** |
|
16 | + * Minification string for enqueued assets. |
|
17 | + * |
|
18 | + * @var string |
|
19 | + */ |
|
20 | + private $min = ''; |
|
21 | + |
|
22 | + /** |
|
23 | + * Url to the plugin directory. |
|
24 | + * |
|
25 | + * @var string |
|
26 | + */ |
|
27 | + protected $url; |
|
28 | + |
|
29 | + /** |
|
30 | + * Script/plugin version. |
|
31 | + * |
|
32 | + * @var string |
|
33 | + */ |
|
34 | + protected $version; |
|
35 | + |
|
36 | + /** |
|
37 | + * Array of script definition arrays. |
|
38 | + * |
|
39 | + * @var array |
|
40 | + */ |
|
41 | + private $scripts = array(); |
|
42 | + |
|
43 | + /** |
|
44 | + * Array of style definition arrays. |
|
45 | + * |
|
46 | + * @var array |
|
47 | + */ |
|
48 | + private $styles = array(); |
|
49 | + |
|
50 | + /** |
|
51 | + * Instantiates a new instance of the Register class. |
|
52 | + * |
|
53 | + * The URL param should be relative to the plugin directory. The URL |
|
54 | + * form should always end with a '/'. All asset location definitions |
|
55 | + * should not begin with a slash and should be relative to the plugin's |
|
56 | + * root directory. The URL provided by default from the Application |
|
57 | + * class is compatible. |
|
58 | + * |
|
59 | + * @param string $url |
|
60 | + * @param string $version |
|
61 | + */ |
|
62 | + public function __construct( $url, $version = null ) { |
|
63 | + $this->url = $url; |
|
64 | + $this->version = $version ?: null; // Empty string should remain null. |
|
65 | + } |
|
66 | + |
|
67 | + /** |
|
68 | + * {@inheritdoc} |
|
69 | + * |
|
70 | + * @param bool $debug |
|
71 | + */ |
|
72 | + public function set_debug( $debug ) { |
|
73 | + if ( $debug ) { |
|
74 | + $this->min = '.min'; |
|
75 | + } else { |
|
76 | + $this->min = ''; |
|
77 | + } |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * {@inheritdoc} |
|
82 | + * |
|
83 | + * @param array $script |
|
84 | + */ |
|
85 | + public function register_script( $script ) { |
|
86 | + $this->scripts[] = $script; |
|
87 | + } |
|
88 | + |
|
89 | + /** |
|
90 | + * {@inheritdoc} |
|
91 | + * |
|
92 | + * @param array $style |
|
93 | + */ |
|
94 | + public function register_style( $style ) { |
|
95 | + $this->styles[] = $style; |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * {@inheritDoc} |
|
100 | + */ |
|
101 | + public function enqueue_web_scripts() { |
|
102 | + foreach ( $this->scripts as $script ) { |
|
103 | + if ( in_array( $script['type'], array( 'web', 'shared' ) ) ) { |
|
104 | + $this->enqueue_script( $script ); |
|
105 | + } |
|
106 | + } |
|
107 | + } |
|
108 | + |
|
109 | + /** |
|
110 | + * {@inheritDoc} |
|
111 | + */ |
|
112 | + public function enqueue_web_styles() { |
|
113 | + foreach ( $this->styles as $style ) { |
|
114 | + if ( in_array( $style['type'], array( 'web', 'shared' ) ) ) { |
|
115 | + $this->enqueue_style( $style ); |
|
116 | + } |
|
117 | + } |
|
118 | + } |
|
119 | + |
|
120 | + /** |
|
121 | + * {@inheritDoc} |
|
122 | + * |
|
123 | + * @param string $hook Passes a string representing the current page. |
|
124 | + */ |
|
125 | + public function enqueue_admin_scripts( $hook ) { |
|
126 | + foreach ( $this->scripts as $script ) { |
|
127 | + if ( in_array( $script['type'], array( 'admin', 'shared' ) ) ) { |
|
128 | + $this->enqueue_script( $script, $hook ); |
|
129 | + } |
|
130 | + } |
|
131 | + } |
|
132 | + |
|
133 | + /** |
|
134 | + * {@inheritDoc} |
|
135 | + * |
|
136 | + * @param string $hook Passes a string representing the current page. |
|
137 | + */ |
|
138 | + public function enqueue_admin_styles( $hook ) { |
|
139 | + foreach ( $this->styles as $style ) { |
|
140 | + if ( in_array( $style['type'], array( 'admin', 'shared' ) ) ) { |
|
141 | + $this->enqueue_style( $style, $hook ); |
|
142 | + } |
|
143 | + } |
|
144 | + } |
|
145 | + |
|
146 | + /** |
|
147 | + * {@inheritDoc} |
|
148 | + * |
|
149 | + * @return array[] |
|
150 | + */ |
|
151 | + public function action_hooks() { |
|
152 | + return array( |
|
153 | + array( |
|
154 | + 'hook' => 'wp_enqueue_scripts', |
|
155 | + 'method' => 'enqueue_web_scripts', |
|
156 | + ), |
|
157 | + array( |
|
158 | + 'hook' => 'wp_enqueue_scripts', |
|
159 | + 'method' => 'enqueue_web_styles', |
|
160 | + ), |
|
161 | + array( |
|
162 | + 'hook' => 'admin_enqueue_scripts', |
|
163 | + 'method' => 'enqueue_admin_scripts', |
|
164 | + ), |
|
165 | + array( |
|
166 | + 'hook' => 'admin_enqueue_scripts', |
|
167 | + 'method' => 'enqueue_admin_styles', |
|
168 | + ), |
|
169 | + ); |
|
170 | + } |
|
171 | + |
|
172 | + /** |
|
173 | + * Enqueues an individual script if the style's condition is met. |
|
174 | + * |
|
175 | + * @param array $script The script attachment callback. |
|
176 | + * @param string $hook The location hook. Only passed on admin side. |
|
177 | + */ |
|
178 | + protected function enqueue_script( $script, $hook = null ) { |
|
179 | + if ( $script['condition']( $hook ) ) { |
|
180 | + wp_enqueue_script( |
|
181 | + $script['handle'], |
|
182 | + $this->url . $script['src'] . '.js', |
|
183 | + isset( $script['deps'] ) ? $script['deps'] : array(), |
|
184 | + $this->version, |
|
185 | + isset( $script['footer'] ) ? $script['footer'] : false |
|
186 | + ); |
|
187 | + |
|
188 | + if ( isset( $script['localize'] ) ) { |
|
189 | + if ( is_callable( $script['localize'] ) ) { // @todo make all properties callables |
|
190 | + $script['localize'] = call_user_func( $script['localize'] ); |
|
191 | + } |
|
192 | + |
|
193 | + wp_localize_script( |
|
194 | + $script['handle'], |
|
195 | + $script['localize']['name'], |
|
196 | + $script['localize']['data'] |
|
197 | + ); |
|
198 | + } |
|
199 | + } |
|
200 | + } |
|
201 | + |
|
202 | + /** |
|
203 | + * Enqueues an individual stylesheet if the style's condition is met. |
|
204 | + * |
|
205 | + * @param array $style The style attachment callback. |
|
206 | + * @param string $hook The location hook. |
|
207 | + */ |
|
208 | + protected function enqueue_style( $style, $hook = null ) { |
|
209 | + if ( $style['condition']( $hook ) ) { |
|
210 | + wp_enqueue_style( |
|
211 | + $style['handle'], |
|
212 | + $this->url . $style['src'] . '.css', |
|
213 | + isset( $style['deps'] ) ? $style['deps'] : array(), |
|
214 | + $this->version, |
|
215 | + isset( $style['media'] ) ? $style['media'] : 'all' |
|
216 | + ); |
|
217 | + } |
|
218 | + } |
|
219 | 219 | } |
@@ -4,52 +4,52 @@ |
||
4 | 4 | use Intraxia\Jaxion\Contract\Core\HasActions; |
5 | 5 | |
6 | 6 | interface Register extends HasActions { |
7 | - /** |
|
8 | - * Enable debug mode for the enqueued assets. |
|
9 | - * |
|
10 | - * Debug mode will enqueue unminified versions of the registered assets. |
|
11 | - * Primarily, this is intended to be used along with WordPress's `SCRIPT_DEBUG` |
|
12 | - * constant, which enables unminified core assets to be enqueued. |
|
13 | - * |
|
14 | - * @param bool $debug |
|
15 | - */ |
|
16 | - public function set_debug( $debug ); |
|
17 | - |
|
18 | - /** |
|
19 | - * Provides a method to register new scripts outside of the constructor. |
|
20 | - * |
|
21 | - * @param array $script |
|
22 | - */ |
|
23 | - public function register_script( $script ); |
|
24 | - |
|
25 | - /** |
|
26 | - * Provides a method to register new styles outside of the constructor. |
|
27 | - * |
|
28 | - * @param array $style |
|
29 | - */ |
|
30 | - public function register_style( $style ); |
|
31 | - |
|
32 | - /** |
|
33 | - * Enqueues the web & shared scripts on the Register. |
|
34 | - */ |
|
35 | - public function enqueue_web_scripts(); |
|
36 | - |
|
37 | - /** |
|
38 | - * Enqueues the web & shared styles on the Register. |
|
39 | - */ |
|
40 | - public function enqueue_web_styles(); |
|
41 | - |
|
42 | - /** |
|
43 | - * Enqueues the admin & shared scripts on the Register. |
|
44 | - * |
|
45 | - * @param string $hook Passes a string representing the current page. |
|
46 | - */ |
|
47 | - public function enqueue_admin_scripts( $hook ); |
|
48 | - |
|
49 | - /** |
|
50 | - * Enqueues the admin & shared styles on the Register. |
|
51 | - * |
|
52 | - * @param string $hook Passes a string representing the current page. |
|
53 | - */ |
|
54 | - public function enqueue_admin_styles( $hook ); |
|
7 | + /** |
|
8 | + * Enable debug mode for the enqueued assets. |
|
9 | + * |
|
10 | + * Debug mode will enqueue unminified versions of the registered assets. |
|
11 | + * Primarily, this is intended to be used along with WordPress's `SCRIPT_DEBUG` |
|
12 | + * constant, which enables unminified core assets to be enqueued. |
|
13 | + * |
|
14 | + * @param bool $debug |
|
15 | + */ |
|
16 | + public function set_debug( $debug ); |
|
17 | + |
|
18 | + /** |
|
19 | + * Provides a method to register new scripts outside of the constructor. |
|
20 | + * |
|
21 | + * @param array $script |
|
22 | + */ |
|
23 | + public function register_script( $script ); |
|
24 | + |
|
25 | + /** |
|
26 | + * Provides a method to register new styles outside of the constructor. |
|
27 | + * |
|
28 | + * @param array $style |
|
29 | + */ |
|
30 | + public function register_style( $style ); |
|
31 | + |
|
32 | + /** |
|
33 | + * Enqueues the web & shared scripts on the Register. |
|
34 | + */ |
|
35 | + public function enqueue_web_scripts(); |
|
36 | + |
|
37 | + /** |
|
38 | + * Enqueues the web & shared styles on the Register. |
|
39 | + */ |
|
40 | + public function enqueue_web_styles(); |
|
41 | + |
|
42 | + /** |
|
43 | + * Enqueues the admin & shared scripts on the Register. |
|
44 | + * |
|
45 | + * @param string $hook Passes a string representing the current page. |
|
46 | + */ |
|
47 | + public function enqueue_admin_scripts( $hook ); |
|
48 | + |
|
49 | + /** |
|
50 | + * Enqueues the admin & shared styles on the Register. |
|
51 | + * |
|
52 | + * @param string $hook Passes a string representing the current page. |
|
53 | + */ |
|
54 | + public function enqueue_admin_styles( $hook ); |
|
55 | 55 | } |
@@ -9,318 +9,318 @@ |
||
9 | 9 | |
10 | 10 | interface Collection extends Iterator, Countable, Serializes { |
11 | 11 | |
12 | - /** |
|
13 | - * Returns the type of the collection. |
|
14 | - * |
|
15 | - * @return string |
|
16 | - */ |
|
17 | - public function get_type(); |
|
18 | - |
|
19 | - /** |
|
20 | - * Returns a collection with $element added. |
|
21 | - * |
|
22 | - * @param mixed $element |
|
23 | - * @return Collection |
|
24 | - * @throws InvalidArgumentException |
|
25 | - */ |
|
26 | - public function add( $element ); |
|
27 | - |
|
28 | - /** |
|
29 | - * Removes every element from the collection. |
|
30 | - * |
|
31 | - * @return Collection |
|
32 | - */ |
|
33 | - public function clear(); |
|
34 | - |
|
35 | - /** |
|
36 | - * Returns true if the collection contains any elements that satisfy |
|
37 | - * $condition, returns false if it contains none. |
|
38 | - * |
|
39 | - * @param callable $condition |
|
40 | - * @return bool |
|
41 | - */ |
|
42 | - public function contains( $condition ); |
|
43 | - |
|
44 | - /** |
|
45 | - * Returns the first element in the collection that satisfies |
|
46 | - * $condition, returns false if no such element exists. |
|
47 | - * |
|
48 | - * @param callable $condition |
|
49 | - * @return mixed |
|
50 | - */ |
|
51 | - public function find( $condition ); |
|
52 | - |
|
53 | - /** |
|
54 | - * Returns the index of the first element in the collection that satisfies |
|
55 | - * $condition, returns -1 if no such element exists. |
|
56 | - * |
|
57 | - * @param callable $condition |
|
58 | - * @return int |
|
59 | - */ |
|
60 | - public function find_index( $condition ); |
|
61 | - |
|
62 | - /** |
|
63 | - * Returns the element in the collection at $index. |
|
64 | - * |
|
65 | - * @param int $index Index to get element from. |
|
66 | - * @return mixed |
|
67 | - * @throws OutOfRangeException |
|
68 | - */ |
|
69 | - public function at( $index ); |
|
70 | - |
|
71 | - /** |
|
72 | - * Returns true if $index is within the collection's range and returns false |
|
73 | - * if it is not. |
|
74 | - * |
|
75 | - * @param int $index Index to check for existence. |
|
76 | - * @return bool |
|
77 | - * @throws InvalidArgumentException |
|
78 | - */ |
|
79 | - public function index_exists( $index ); |
|
80 | - |
|
81 | - /** |
|
82 | - * Returns the number of elements in the collection. |
|
83 | - * |
|
84 | - * @return int |
|
85 | - */ |
|
86 | - public function count(); |
|
87 | - |
|
88 | - /** |
|
89 | - * Returns a collection that only contains the elements which satisfy |
|
90 | - * $condition. |
|
91 | - * |
|
92 | - * @param callable $condition |
|
93 | - * @return Collection |
|
94 | - */ |
|
95 | - public function filter( $condition ); |
|
96 | - |
|
97 | - /** |
|
98 | - * Returns the last element in the collection that satisfies $condition, |
|
99 | - * returns false if no such element exists. |
|
100 | - * |
|
101 | - * @param callable $condition |
|
102 | - * @return mixed |
|
103 | - */ |
|
104 | - public function find_last( $condition ); |
|
105 | - |
|
106 | - /** |
|
107 | - * Returns the index of the last element in the collection that satisfies |
|
108 | - * $condition, returns -1 if no such element exists. |
|
109 | - * |
|
110 | - * @param callable $condition |
|
111 | - * @return int |
|
112 | - */ |
|
113 | - public function find_last_index( $condition ); |
|
114 | - |
|
115 | - /** |
|
116 | - * Returns a collection that contains the subset of elements ranging from the |
|
117 | - * index $start to $end. |
|
118 | - * |
|
119 | - * @param int $start Begining index to slice from. |
|
120 | - * @param int $end End index to slice to. |
|
121 | - * @return Collection |
|
122 | - * @throws InvalidArgumentException |
|
123 | - */ |
|
124 | - public function slice( $start, $end ); |
|
125 | - |
|
126 | - /** |
|
127 | - * Inserts $element at $index. |
|
128 | - * |
|
129 | - * @param int $index Index to start at. |
|
130 | - * @param mixed $element Element to insert. |
|
131 | - * @return Collection |
|
132 | - * @throws InvalidArgumentException |
|
133 | - * @throws OutOfRangeException |
|
134 | - */ |
|
135 | - public function insert( $index, $element ); |
|
136 | - |
|
137 | - /** |
|
138 | - * Inserts the range $elements at $index. |
|
139 | - * |
|
140 | - * @param int $index |
|
141 | - * @param array $elements |
|
142 | - * @return Collection |
|
143 | - * @throws OutOfRangeException |
|
144 | - */ |
|
145 | - public function insert_range( $index, array $elements ); |
|
146 | - |
|
147 | - /** |
|
148 | - * Removes all of the elements that satisfy $condition. |
|
149 | - * |
|
150 | - * @param callable $condition |
|
151 | - * @return Collection |
|
152 | - */ |
|
153 | - public function reject( $condition ); |
|
154 | - |
|
155 | - /** |
|
156 | - * Removes the element at $index. |
|
157 | - * |
|
158 | - * @param int $index Index to remove. |
|
159 | - * @return Collection |
|
160 | - * @throws OutOfRangeException |
|
161 | - */ |
|
162 | - public function remove_at( $index ); |
|
163 | - |
|
164 | - /** |
|
165 | - * Reverses the order of the elements in the collection. |
|
166 | - * |
|
167 | - * @return Collection |
|
168 | - */ |
|
169 | - public function reverse(); |
|
170 | - |
|
171 | - /** |
|
172 | - * Sorts the elements in the collection using the user supplied comparison |
|
173 | - * function $callback. |
|
174 | - * |
|
175 | - * @param callable $callback |
|
176 | - * @return Collection |
|
177 | - */ |
|
178 | - public function sort( $callback ); |
|
179 | - |
|
180 | - /** |
|
181 | - * Returns an array containing the elements in the collection. |
|
182 | - * |
|
183 | - * @return array |
|
184 | - */ |
|
185 | - public function to_array(); |
|
186 | - |
|
187 | - /** |
|
188 | - * Iteratively reduces the collection to a single value using the callback |
|
189 | - * function $callable. |
|
190 | - * |
|
191 | - * @param callable $callable |
|
192 | - * @param null $initial |
|
193 | - * @return mixed |
|
194 | - */ |
|
195 | - public function reduce( $callable, $initial = null ); |
|
196 | - |
|
197 | - /** |
|
198 | - * Returns true if every element in the collection satisfies $condition, |
|
199 | - * returns false if not. |
|
200 | - * |
|
201 | - * @param callable $condition |
|
202 | - * @return bool |
|
203 | - */ |
|
204 | - public function every( $condition ); |
|
205 | - |
|
206 | - /** |
|
207 | - * Removes all of the elements in the collection starting at index $num. |
|
208 | - * |
|
209 | - * @param int $num Number of elements to drop. |
|
210 | - * @return Collection |
|
211 | - * @throws InvalidArgumentException |
|
212 | - */ |
|
213 | - public function drop( $num ); |
|
214 | - |
|
215 | - /** |
|
216 | - * Removes all of the elements in the collectioin between index 0 and $num. |
|
217 | - * |
|
218 | - * @param int $num Number of elements to drop. |
|
219 | - * @return Collection |
|
220 | - * @throws InvalidArgumentException |
|
221 | - */ |
|
222 | - public function drop_right( $num ); |
|
223 | - |
|
224 | - /** |
|
225 | - * Iteratively drops elements in the collection that satisfy $condition until |
|
226 | - * an element is encountered that does not satisfy $condition. |
|
227 | - * |
|
228 | - * @param callable $condition |
|
229 | - * @return Collection |
|
230 | - */ |
|
231 | - public function drop_while( $condition ); |
|
232 | - |
|
233 | - /** |
|
234 | - * Removes the first element in the collection. |
|
235 | - * |
|
236 | - * @return Collection |
|
237 | - * @throws InvalidArgumentException |
|
238 | - */ |
|
239 | - public function tail(); |
|
240 | - |
|
241 | - /** |
|
242 | - * Removes all of the elements in the collection starting at index $num. |
|
243 | - * |
|
244 | - * @param int $num Number of elements to take. |
|
245 | - * @return Collection |
|
246 | - * @throws InvalidArgumentException |
|
247 | - */ |
|
248 | - public function take( $num ); |
|
249 | - |
|
250 | - /** |
|
251 | - * Removes all of the elements in the collection before index $num. |
|
252 | - * |
|
253 | - * @param int $num Number of elements to take. |
|
254 | - * @return Collection |
|
255 | - * @throws InvalidArgumentException |
|
256 | - */ |
|
257 | - public function take_right( $num ); |
|
258 | - |
|
259 | - /** |
|
260 | - * Iterates through the collection until an element is encountered that does |
|
261 | - * not satisfy $condition, then drops all of the elements starting at that |
|
262 | - * index. |
|
263 | - * |
|
264 | - * @param callable $condition |
|
265 | - * @return Collection |
|
266 | - */ |
|
267 | - public function take_while( $condition ); |
|
268 | - |
|
269 | - /** |
|
270 | - * Applies the callback function $callable to each element in the collection. |
|
271 | - * |
|
272 | - * @param callable $callable |
|
273 | - */ |
|
274 | - public function each( $callable ); |
|
275 | - |
|
276 | - /** |
|
277 | - * Returns a new instance of the collection with the callback function |
|
278 | - * $callable applied to each element. |
|
279 | - * |
|
280 | - * @param callable $callable |
|
281 | - * @return Collection |
|
282 | - */ |
|
283 | - public function map( $callable ); |
|
284 | - |
|
285 | - /** |
|
286 | - * Iteratively reduces the collection to a single value using the callback |
|
287 | - * function $callable starting at the rightmost index. |
|
288 | - * |
|
289 | - * @param callable $callable |
|
290 | - * @param null $initial |
|
291 | - * @return mixed |
|
292 | - */ |
|
293 | - public function reduce_right( $callable, $initial = null ); |
|
294 | - |
|
295 | - /** |
|
296 | - * Randomly reorders the elements in the collection. |
|
297 | - * |
|
298 | - * @return Collection |
|
299 | - */ |
|
300 | - public function shuffle(); |
|
301 | - |
|
302 | - /** |
|
303 | - * Adds every member of $elements to the collection. |
|
304 | - * |
|
305 | - * @param array|Collection $elements Array of elements to merge. |
|
306 | - * @return Collection |
|
307 | - * @throws InvalidArgumentException |
|
308 | - */ |
|
309 | - public function merge( $elements ); |
|
310 | - |
|
311 | - /** |
|
312 | - * Get first element of the collection |
|
313 | - * |
|
314 | - * @return mixed |
|
315 | - * @throws OutOfBoundsException |
|
316 | - */ |
|
317 | - public function first(); |
|
318 | - |
|
319 | - /** |
|
320 | - * Get last element of the collection |
|
321 | - * |
|
322 | - * @return mixed |
|
323 | - * @throws OutOfBoundsException |
|
324 | - */ |
|
325 | - public function last(); |
|
12 | + /** |
|
13 | + * Returns the type of the collection. |
|
14 | + * |
|
15 | + * @return string |
|
16 | + */ |
|
17 | + public function get_type(); |
|
18 | + |
|
19 | + /** |
|
20 | + * Returns a collection with $element added. |
|
21 | + * |
|
22 | + * @param mixed $element |
|
23 | + * @return Collection |
|
24 | + * @throws InvalidArgumentException |
|
25 | + */ |
|
26 | + public function add( $element ); |
|
27 | + |
|
28 | + /** |
|
29 | + * Removes every element from the collection. |
|
30 | + * |
|
31 | + * @return Collection |
|
32 | + */ |
|
33 | + public function clear(); |
|
34 | + |
|
35 | + /** |
|
36 | + * Returns true if the collection contains any elements that satisfy |
|
37 | + * $condition, returns false if it contains none. |
|
38 | + * |
|
39 | + * @param callable $condition |
|
40 | + * @return bool |
|
41 | + */ |
|
42 | + public function contains( $condition ); |
|
43 | + |
|
44 | + /** |
|
45 | + * Returns the first element in the collection that satisfies |
|
46 | + * $condition, returns false if no such element exists. |
|
47 | + * |
|
48 | + * @param callable $condition |
|
49 | + * @return mixed |
|
50 | + */ |
|
51 | + public function find( $condition ); |
|
52 | + |
|
53 | + /** |
|
54 | + * Returns the index of the first element in the collection that satisfies |
|
55 | + * $condition, returns -1 if no such element exists. |
|
56 | + * |
|
57 | + * @param callable $condition |
|
58 | + * @return int |
|
59 | + */ |
|
60 | + public function find_index( $condition ); |
|
61 | + |
|
62 | + /** |
|
63 | + * Returns the element in the collection at $index. |
|
64 | + * |
|
65 | + * @param int $index Index to get element from. |
|
66 | + * @return mixed |
|
67 | + * @throws OutOfRangeException |
|
68 | + */ |
|
69 | + public function at( $index ); |
|
70 | + |
|
71 | + /** |
|
72 | + * Returns true if $index is within the collection's range and returns false |
|
73 | + * if it is not. |
|
74 | + * |
|
75 | + * @param int $index Index to check for existence. |
|
76 | + * @return bool |
|
77 | + * @throws InvalidArgumentException |
|
78 | + */ |
|
79 | + public function index_exists( $index ); |
|
80 | + |
|
81 | + /** |
|
82 | + * Returns the number of elements in the collection. |
|
83 | + * |
|
84 | + * @return int |
|
85 | + */ |
|
86 | + public function count(); |
|
87 | + |
|
88 | + /** |
|
89 | + * Returns a collection that only contains the elements which satisfy |
|
90 | + * $condition. |
|
91 | + * |
|
92 | + * @param callable $condition |
|
93 | + * @return Collection |
|
94 | + */ |
|
95 | + public function filter( $condition ); |
|
96 | + |
|
97 | + /** |
|
98 | + * Returns the last element in the collection that satisfies $condition, |
|
99 | + * returns false if no such element exists. |
|
100 | + * |
|
101 | + * @param callable $condition |
|
102 | + * @return mixed |
|
103 | + */ |
|
104 | + public function find_last( $condition ); |
|
105 | + |
|
106 | + /** |
|
107 | + * Returns the index of the last element in the collection that satisfies |
|
108 | + * $condition, returns -1 if no such element exists. |
|
109 | + * |
|
110 | + * @param callable $condition |
|
111 | + * @return int |
|
112 | + */ |
|
113 | + public function find_last_index( $condition ); |
|
114 | + |
|
115 | + /** |
|
116 | + * Returns a collection that contains the subset of elements ranging from the |
|
117 | + * index $start to $end. |
|
118 | + * |
|
119 | + * @param int $start Begining index to slice from. |
|
120 | + * @param int $end End index to slice to. |
|
121 | + * @return Collection |
|
122 | + * @throws InvalidArgumentException |
|
123 | + */ |
|
124 | + public function slice( $start, $end ); |
|
125 | + |
|
126 | + /** |
|
127 | + * Inserts $element at $index. |
|
128 | + * |
|
129 | + * @param int $index Index to start at. |
|
130 | + * @param mixed $element Element to insert. |
|
131 | + * @return Collection |
|
132 | + * @throws InvalidArgumentException |
|
133 | + * @throws OutOfRangeException |
|
134 | + */ |
|
135 | + public function insert( $index, $element ); |
|
136 | + |
|
137 | + /** |
|
138 | + * Inserts the range $elements at $index. |
|
139 | + * |
|
140 | + * @param int $index |
|
141 | + * @param array $elements |
|
142 | + * @return Collection |
|
143 | + * @throws OutOfRangeException |
|
144 | + */ |
|
145 | + public function insert_range( $index, array $elements ); |
|
146 | + |
|
147 | + /** |
|
148 | + * Removes all of the elements that satisfy $condition. |
|
149 | + * |
|
150 | + * @param callable $condition |
|
151 | + * @return Collection |
|
152 | + */ |
|
153 | + public function reject( $condition ); |
|
154 | + |
|
155 | + /** |
|
156 | + * Removes the element at $index. |
|
157 | + * |
|
158 | + * @param int $index Index to remove. |
|
159 | + * @return Collection |
|
160 | + * @throws OutOfRangeException |
|
161 | + */ |
|
162 | + public function remove_at( $index ); |
|
163 | + |
|
164 | + /** |
|
165 | + * Reverses the order of the elements in the collection. |
|
166 | + * |
|
167 | + * @return Collection |
|
168 | + */ |
|
169 | + public function reverse(); |
|
170 | + |
|
171 | + /** |
|
172 | + * Sorts the elements in the collection using the user supplied comparison |
|
173 | + * function $callback. |
|
174 | + * |
|
175 | + * @param callable $callback |
|
176 | + * @return Collection |
|
177 | + */ |
|
178 | + public function sort( $callback ); |
|
179 | + |
|
180 | + /** |
|
181 | + * Returns an array containing the elements in the collection. |
|
182 | + * |
|
183 | + * @return array |
|
184 | + */ |
|
185 | + public function to_array(); |
|
186 | + |
|
187 | + /** |
|
188 | + * Iteratively reduces the collection to a single value using the callback |
|
189 | + * function $callable. |
|
190 | + * |
|
191 | + * @param callable $callable |
|
192 | + * @param null $initial |
|
193 | + * @return mixed |
|
194 | + */ |
|
195 | + public function reduce( $callable, $initial = null ); |
|
196 | + |
|
197 | + /** |
|
198 | + * Returns true if every element in the collection satisfies $condition, |
|
199 | + * returns false if not. |
|
200 | + * |
|
201 | + * @param callable $condition |
|
202 | + * @return bool |
|
203 | + */ |
|
204 | + public function every( $condition ); |
|
205 | + |
|
206 | + /** |
|
207 | + * Removes all of the elements in the collection starting at index $num. |
|
208 | + * |
|
209 | + * @param int $num Number of elements to drop. |
|
210 | + * @return Collection |
|
211 | + * @throws InvalidArgumentException |
|
212 | + */ |
|
213 | + public function drop( $num ); |
|
214 | + |
|
215 | + /** |
|
216 | + * Removes all of the elements in the collectioin between index 0 and $num. |
|
217 | + * |
|
218 | + * @param int $num Number of elements to drop. |
|
219 | + * @return Collection |
|
220 | + * @throws InvalidArgumentException |
|
221 | + */ |
|
222 | + public function drop_right( $num ); |
|
223 | + |
|
224 | + /** |
|
225 | + * Iteratively drops elements in the collection that satisfy $condition until |
|
226 | + * an element is encountered that does not satisfy $condition. |
|
227 | + * |
|
228 | + * @param callable $condition |
|
229 | + * @return Collection |
|
230 | + */ |
|
231 | + public function drop_while( $condition ); |
|
232 | + |
|
233 | + /** |
|
234 | + * Removes the first element in the collection. |
|
235 | + * |
|
236 | + * @return Collection |
|
237 | + * @throws InvalidArgumentException |
|
238 | + */ |
|
239 | + public function tail(); |
|
240 | + |
|
241 | + /** |
|
242 | + * Removes all of the elements in the collection starting at index $num. |
|
243 | + * |
|
244 | + * @param int $num Number of elements to take. |
|
245 | + * @return Collection |
|
246 | + * @throws InvalidArgumentException |
|
247 | + */ |
|
248 | + public function take( $num ); |
|
249 | + |
|
250 | + /** |
|
251 | + * Removes all of the elements in the collection before index $num. |
|
252 | + * |
|
253 | + * @param int $num Number of elements to take. |
|
254 | + * @return Collection |
|
255 | + * @throws InvalidArgumentException |
|
256 | + */ |
|
257 | + public function take_right( $num ); |
|
258 | + |
|
259 | + /** |
|
260 | + * Iterates through the collection until an element is encountered that does |
|
261 | + * not satisfy $condition, then drops all of the elements starting at that |
|
262 | + * index. |
|
263 | + * |
|
264 | + * @param callable $condition |
|
265 | + * @return Collection |
|
266 | + */ |
|
267 | + public function take_while( $condition ); |
|
268 | + |
|
269 | + /** |
|
270 | + * Applies the callback function $callable to each element in the collection. |
|
271 | + * |
|
272 | + * @param callable $callable |
|
273 | + */ |
|
274 | + public function each( $callable ); |
|
275 | + |
|
276 | + /** |
|
277 | + * Returns a new instance of the collection with the callback function |
|
278 | + * $callable applied to each element. |
|
279 | + * |
|
280 | + * @param callable $callable |
|
281 | + * @return Collection |
|
282 | + */ |
|
283 | + public function map( $callable ); |
|
284 | + |
|
285 | + /** |
|
286 | + * Iteratively reduces the collection to a single value using the callback |
|
287 | + * function $callable starting at the rightmost index. |
|
288 | + * |
|
289 | + * @param callable $callable |
|
290 | + * @param null $initial |
|
291 | + * @return mixed |
|
292 | + */ |
|
293 | + public function reduce_right( $callable, $initial = null ); |
|
294 | + |
|
295 | + /** |
|
296 | + * Randomly reorders the elements in the collection. |
|
297 | + * |
|
298 | + * @return Collection |
|
299 | + */ |
|
300 | + public function shuffle(); |
|
301 | + |
|
302 | + /** |
|
303 | + * Adds every member of $elements to the collection. |
|
304 | + * |
|
305 | + * @param array|Collection $elements Array of elements to merge. |
|
306 | + * @return Collection |
|
307 | + * @throws InvalidArgumentException |
|
308 | + */ |
|
309 | + public function merge( $elements ); |
|
310 | + |
|
311 | + /** |
|
312 | + * Get first element of the collection |
|
313 | + * |
|
314 | + * @return mixed |
|
315 | + * @throws OutOfBoundsException |
|
316 | + */ |
|
317 | + public function first(); |
|
318 | + |
|
319 | + /** |
|
320 | + * Get last element of the collection |
|
321 | + * |
|
322 | + * @return mixed |
|
323 | + * @throws OutOfBoundsException |
|
324 | + */ |
|
325 | + public function last(); |
|
326 | 326 | } |
@@ -5,178 +5,178 @@ |
||
5 | 5 | use Iterator; |
6 | 6 | |
7 | 7 | interface Dictionary extends Iterator, Countable, Serializes { |
8 | - /** |
|
9 | - * Returns the type of the dictionary's keys. |
|
10 | - * |
|
11 | - * @return string |
|
12 | - */ |
|
13 | - public function get_key_type(); |
|
14 | - |
|
15 | - /** |
|
16 | - * Returns the type of the dictionary's values. |
|
17 | - * |
|
18 | - * @return string |
|
19 | - */ |
|
20 | - public function get_value_type(); |
|
21 | - |
|
22 | - /** |
|
23 | - * Returns true if $key is in the dictionary, returns false if it is not. |
|
24 | - * |
|
25 | - * @param mixed $key Key to check for. |
|
26 | - * |
|
27 | - * @return bool |
|
28 | - */ |
|
29 | - public function exists( $key ); |
|
30 | - |
|
31 | - /** |
|
32 | - * Returns true if the callable returns true. The callable should accept a |
|
33 | - * key and value as arguments and return a boolean. |
|
34 | - * |
|
35 | - * @param callable $callable |
|
36 | - * @return bool |
|
37 | - */ |
|
38 | - public function contains( $callable ); |
|
39 | - |
|
40 | - /** |
|
41 | - * Returns the value associated with $key. |
|
42 | - * |
|
43 | - * @param mixed $key Key to get. |
|
44 | - * |
|
45 | - * @return mixed |
|
46 | - */ |
|
47 | - public function get( $key ); |
|
48 | - |
|
49 | - /** |
|
50 | - * Removes the key-value pair represented by $key from the dictionary. |
|
51 | - * |
|
52 | - * @param mixed $key Key to remove. |
|
53 | - * |
|
54 | - * @return static |
|
55 | - */ |
|
56 | - public function delete( $key ); |
|
57 | - |
|
58 | - /** |
|
59 | - * Returns true if $value is in the dictionary, returns false if not. |
|
60 | - * |
|
61 | - * @param mixed $value Value to check for existence. |
|
62 | - * |
|
63 | - * @return bool |
|
64 | - */ |
|
65 | - public function value_exists( $value ); |
|
66 | - |
|
67 | - /** |
|
68 | - * Returns the number of key-value pairs in the dictionary. |
|
69 | - * |
|
70 | - * @return int |
|
71 | - */ |
|
72 | - public function count(); |
|
73 | - |
|
74 | - /** |
|
75 | - * Removes every key-value pair from the dictionary. |
|
76 | - * |
|
77 | - * @return static |
|
78 | - */ |
|
79 | - public function clear(); |
|
80 | - |
|
81 | - /** |
|
82 | - * Returns the key-value pairs in the dictionary as an associative array. |
|
83 | - * |
|
84 | - * @return array |
|
85 | - */ |
|
86 | - public function to_array(); |
|
87 | - |
|
88 | - /** |
|
89 | - * Returns a dictionary that only contains the key-value pairs which satisfy |
|
90 | - * $condition. |
|
91 | - * |
|
92 | - * @param callable $condition |
|
93 | - * |
|
94 | - * @return static |
|
95 | - */ |
|
96 | - public function filter( $condition ); |
|
97 | - |
|
98 | - /** |
|
99 | - * Removes all key-value pairs from the Dictionary that do not satisfy |
|
100 | - * $condition. |
|
101 | - * |
|
102 | - * @param callable $condition |
|
103 | - * |
|
104 | - * @return Dictionary |
|
105 | - */ |
|
106 | - public function reject( $condition ); |
|
107 | - |
|
108 | - /** |
|
109 | - * Adds the key-value pair containing $key and $value to the dictionary. |
|
110 | - * |
|
111 | - * @param mixed $key Key to add. |
|
112 | - * @param mixed $value Value to add. |
|
113 | - * |
|
114 | - * @return Dictionary |
|
115 | - * @throws \InvalidArgumentException |
|
116 | - */ |
|
117 | - public function add( $key, $value ); |
|
118 | - |
|
119 | - /** |
|
120 | - * Applies the callback function $callable to each key-value pair in the |
|
121 | - * dictionary. |
|
122 | - * |
|
123 | - * @param callable $callable |
|
124 | - */ |
|
125 | - public function each( $callable ); |
|
126 | - |
|
127 | - /** |
|
128 | - * Returns the value associated with $key in the dictionary, returns |
|
129 | - * $default if it does not. |
|
130 | - * |
|
131 | - * @param mixed $key Key to fetch. |
|
132 | - * @param mixed $default Default value if key is not found. |
|
133 | - * |
|
134 | - * @return mixed |
|
135 | - */ |
|
136 | - public function get_or_else( $key, $default ); |
|
137 | - |
|
138 | - /** |
|
139 | - * Returns an array of all keys in the dictionary. |
|
140 | - * |
|
141 | - * @return array |
|
142 | - */ |
|
143 | - public function keys(); |
|
144 | - |
|
145 | - /** |
|
146 | - * Returns an array of all values in the dictionary. |
|
147 | - * |
|
148 | - * @return array |
|
149 | - */ |
|
150 | - public function values(); |
|
151 | - |
|
152 | - /** |
|
153 | - * Returns a new dictionary with the callback function $callable applied to |
|
154 | - * every key-value pair in the dictionary. |
|
155 | - * |
|
156 | - * @param callable $callable |
|
157 | - * |
|
158 | - * @return static |
|
159 | - */ |
|
160 | - public function map( $callable ); |
|
161 | - |
|
162 | - /** |
|
163 | - * Adds every key-value pair in $storage to the dictionary. |
|
164 | - * |
|
165 | - * @param array|Dictionary $source Storage object to merge. |
|
166 | - * |
|
167 | - * @return static |
|
168 | - */ |
|
169 | - public function merge( $source ); |
|
170 | - |
|
171 | - |
|
172 | - /** |
|
173 | - * Reduce the dictionary to a single value. The callable should contain |
|
174 | - * args: carry, key, value |
|
175 | - * |
|
176 | - * @param callable $callable |
|
177 | - * @param mixed $initial |
|
178 | - * |
|
179 | - * @return mixed |
|
180 | - */ |
|
181 | - public function reduce( $callable, $initial ); |
|
8 | + /** |
|
9 | + * Returns the type of the dictionary's keys. |
|
10 | + * |
|
11 | + * @return string |
|
12 | + */ |
|
13 | + public function get_key_type(); |
|
14 | + |
|
15 | + /** |
|
16 | + * Returns the type of the dictionary's values. |
|
17 | + * |
|
18 | + * @return string |
|
19 | + */ |
|
20 | + public function get_value_type(); |
|
21 | + |
|
22 | + /** |
|
23 | + * Returns true if $key is in the dictionary, returns false if it is not. |
|
24 | + * |
|
25 | + * @param mixed $key Key to check for. |
|
26 | + * |
|
27 | + * @return bool |
|
28 | + */ |
|
29 | + public function exists( $key ); |
|
30 | + |
|
31 | + /** |
|
32 | + * Returns true if the callable returns true. The callable should accept a |
|
33 | + * key and value as arguments and return a boolean. |
|
34 | + * |
|
35 | + * @param callable $callable |
|
36 | + * @return bool |
|
37 | + */ |
|
38 | + public function contains( $callable ); |
|
39 | + |
|
40 | + /** |
|
41 | + * Returns the value associated with $key. |
|
42 | + * |
|
43 | + * @param mixed $key Key to get. |
|
44 | + * |
|
45 | + * @return mixed |
|
46 | + */ |
|
47 | + public function get( $key ); |
|
48 | + |
|
49 | + /** |
|
50 | + * Removes the key-value pair represented by $key from the dictionary. |
|
51 | + * |
|
52 | + * @param mixed $key Key to remove. |
|
53 | + * |
|
54 | + * @return static |
|
55 | + */ |
|
56 | + public function delete( $key ); |
|
57 | + |
|
58 | + /** |
|
59 | + * Returns true if $value is in the dictionary, returns false if not. |
|
60 | + * |
|
61 | + * @param mixed $value Value to check for existence. |
|
62 | + * |
|
63 | + * @return bool |
|
64 | + */ |
|
65 | + public function value_exists( $value ); |
|
66 | + |
|
67 | + /** |
|
68 | + * Returns the number of key-value pairs in the dictionary. |
|
69 | + * |
|
70 | + * @return int |
|
71 | + */ |
|
72 | + public function count(); |
|
73 | + |
|
74 | + /** |
|
75 | + * Removes every key-value pair from the dictionary. |
|
76 | + * |
|
77 | + * @return static |
|
78 | + */ |
|
79 | + public function clear(); |
|
80 | + |
|
81 | + /** |
|
82 | + * Returns the key-value pairs in the dictionary as an associative array. |
|
83 | + * |
|
84 | + * @return array |
|
85 | + */ |
|
86 | + public function to_array(); |
|
87 | + |
|
88 | + /** |
|
89 | + * Returns a dictionary that only contains the key-value pairs which satisfy |
|
90 | + * $condition. |
|
91 | + * |
|
92 | + * @param callable $condition |
|
93 | + * |
|
94 | + * @return static |
|
95 | + */ |
|
96 | + public function filter( $condition ); |
|
97 | + |
|
98 | + /** |
|
99 | + * Removes all key-value pairs from the Dictionary that do not satisfy |
|
100 | + * $condition. |
|
101 | + * |
|
102 | + * @param callable $condition |
|
103 | + * |
|
104 | + * @return Dictionary |
|
105 | + */ |
|
106 | + public function reject( $condition ); |
|
107 | + |
|
108 | + /** |
|
109 | + * Adds the key-value pair containing $key and $value to the dictionary. |
|
110 | + * |
|
111 | + * @param mixed $key Key to add. |
|
112 | + * @param mixed $value Value to add. |
|
113 | + * |
|
114 | + * @return Dictionary |
|
115 | + * @throws \InvalidArgumentException |
|
116 | + */ |
|
117 | + public function add( $key, $value ); |
|
118 | + |
|
119 | + /** |
|
120 | + * Applies the callback function $callable to each key-value pair in the |
|
121 | + * dictionary. |
|
122 | + * |
|
123 | + * @param callable $callable |
|
124 | + */ |
|
125 | + public function each( $callable ); |
|
126 | + |
|
127 | + /** |
|
128 | + * Returns the value associated with $key in the dictionary, returns |
|
129 | + * $default if it does not. |
|
130 | + * |
|
131 | + * @param mixed $key Key to fetch. |
|
132 | + * @param mixed $default Default value if key is not found. |
|
133 | + * |
|
134 | + * @return mixed |
|
135 | + */ |
|
136 | + public function get_or_else( $key, $default ); |
|
137 | + |
|
138 | + /** |
|
139 | + * Returns an array of all keys in the dictionary. |
|
140 | + * |
|
141 | + * @return array |
|
142 | + */ |
|
143 | + public function keys(); |
|
144 | + |
|
145 | + /** |
|
146 | + * Returns an array of all values in the dictionary. |
|
147 | + * |
|
148 | + * @return array |
|
149 | + */ |
|
150 | + public function values(); |
|
151 | + |
|
152 | + /** |
|
153 | + * Returns a new dictionary with the callback function $callable applied to |
|
154 | + * every key-value pair in the dictionary. |
|
155 | + * |
|
156 | + * @param callable $callable |
|
157 | + * |
|
158 | + * @return static |
|
159 | + */ |
|
160 | + public function map( $callable ); |
|
161 | + |
|
162 | + /** |
|
163 | + * Adds every key-value pair in $storage to the dictionary. |
|
164 | + * |
|
165 | + * @param array|Dictionary $source Storage object to merge. |
|
166 | + * |
|
167 | + * @return static |
|
168 | + */ |
|
169 | + public function merge( $source ); |
|
170 | + |
|
171 | + |
|
172 | + /** |
|
173 | + * Reduce the dictionary to a single value. The callable should contain |
|
174 | + * args: carry, key, value |
|
175 | + * |
|
176 | + * @param callable $callable |
|
177 | + * @param mixed $initial |
|
178 | + * |
|
179 | + * @return mixed |
|
180 | + */ |
|
181 | + public function reduce( $callable, $initial ); |
|
182 | 182 | } |
@@ -15,158 +15,158 @@ |
||
15 | 15 | */ |
16 | 16 | class Type { |
17 | 17 | |
18 | - /** |
|
19 | - * Type to validate against. |
|
20 | - * |
|
21 | - * @var string |
|
22 | - */ |
|
23 | - private $type; |
|
24 | - |
|
25 | - /** |
|
26 | - * Type constructor. |
|
27 | - * |
|
28 | - * @param string $type |
|
29 | - * @param bool $key_type |
|
30 | - */ |
|
31 | - public function __construct( $type, $key_type = false ) { |
|
32 | - $this->type = $this->determine( $type, $key_type ); |
|
33 | - } |
|
34 | - |
|
35 | - /** |
|
36 | - * Get validation type. |
|
37 | - * |
|
38 | - * @return string |
|
39 | - */ |
|
40 | - public function get_type() { |
|
41 | - return $this->type; |
|
42 | - } |
|
43 | - |
|
44 | - /** |
|
45 | - * Returns whether the type is an Axolotl model. |
|
46 | - * |
|
47 | - * @return bool |
|
48 | - */ |
|
49 | - public function is_model() { |
|
50 | - if ( ! class_exists( $this->type ) ) { |
|
51 | - return false; |
|
52 | - } |
|
53 | - |
|
54 | - $reflection = new ReflectionClass( $this->type ); |
|
55 | - return $reflection->isSubclassOf( 'Intraxia\Jaxion\Axolotl\Model' ); |
|
56 | - } |
|
57 | - |
|
58 | - /** |
|
59 | - * Create a new model from the given data. |
|
60 | - * |
|
61 | - * @param array $data Data for the model. |
|
62 | - * |
|
63 | - * @return Model |
|
64 | - */ |
|
65 | - public function create_model( array $data ) { |
|
66 | - return new $this->type( $data ); |
|
67 | - } |
|
68 | - |
|
69 | - /** |
|
70 | - * Validates an array of element. |
|
71 | - * |
|
72 | - * @param array $elements Elements to be validated. |
|
73 | - * |
|
74 | - * @throws InvalidArgumentException |
|
75 | - */ |
|
76 | - public function validate_elements( array $elements ) { |
|
77 | - foreach ( $elements as $element ) { |
|
78 | - $this->validate_element( $element ); |
|
79 | - } |
|
80 | - } |
|
81 | - |
|
82 | - /** |
|
83 | - * Validate whether the |
|
84 | - * |
|
85 | - * @param mixed $element Element to validate. |
|
86 | - * |
|
87 | - * @throws InvalidArgumentException |
|
88 | - */ |
|
89 | - public function validate_element( $element ) { |
|
90 | - $type = gettype( $element ); |
|
91 | - $callable = $this->type === 'callable'; |
|
92 | - $is_object = 'object' === $type; |
|
93 | - $loose_check = $this->type === 'object'; |
|
94 | - |
|
95 | - // callable must be callable |
|
96 | - if ( $callable && ! is_callable( $element ) ) { |
|
97 | - throw new InvalidArgumentException( 'Item must be callable' ); |
|
98 | - } |
|
99 | - |
|
100 | - // target isn't callable, object must be an instance of target |
|
101 | - if ( ! $loose_check && ! $callable && $is_object && ! is_a( $element, $this->type ) ) { |
|
102 | - throw new InvalidArgumentException( "Item is not type or subtype of $this->type" ); |
|
103 | - } |
|
104 | - |
|
105 | - // a non callable, non object type should match the target string |
|
106 | - if ( ! $callable && ! $is_object && $type !== $this->type ) { |
|
107 | - throw new InvalidArgumentException( "Item is not of type: $this->type" ); |
|
108 | - } |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * Determine the type to validate against. |
|
113 | - * |
|
114 | - * @param string $type Type to determine. |
|
115 | - * @param bool $key_type Whether the type is for keys. |
|
116 | - * |
|
117 | - * @return string |
|
118 | - * |
|
119 | - * @throws InvalidArgumentException |
|
120 | - */ |
|
121 | - private function determine( $type, $key_type = false ) { |
|
122 | - if ( ! $key_type && $this->non_scalar_type_exists( $type ) ) { |
|
123 | - return $type; |
|
124 | - } |
|
125 | - |
|
126 | - if ( $scalar_type = $this->determine_scalar( $type ) ) { |
|
127 | - if ( $key_type && (in_array( $scalar_type, array( 'double', 'boolean' ) )) ) { |
|
128 | - throw new InvalidArgumentException( 'This type is not supported as a key.' ); |
|
129 | - } |
|
130 | - |
|
131 | - return $scalar_type; |
|
132 | - } |
|
133 | - |
|
134 | - throw new InvalidArgumentException( 'This type does not exist.' ); |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Determines whether the given type exists. |
|
139 | - * |
|
140 | - * @param string $type Type to check. |
|
141 | - * |
|
142 | - * @return bool |
|
143 | - */ |
|
144 | - private function non_scalar_type_exists( $type ) { |
|
145 | - return class_exists( $type ) |
|
146 | - || interface_exists( $type ) |
|
147 | - || in_array( $type, array( 'array', 'object', 'callable' ) ); |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * Returns the type if it's scalar, otherwise, returns null. |
|
152 | - * |
|
153 | - * @param string $type Type to check. |
|
154 | - * |
|
155 | - * @return string|null |
|
156 | - */ |
|
157 | - private function determine_scalar( $type ) { |
|
158 | - $synonyms = array( |
|
159 | - 'int' => 'integer', |
|
160 | - 'float' => 'double', |
|
161 | - 'bool' => 'boolean', |
|
162 | - ); |
|
163 | - |
|
164 | - if ( array_key_exists( $type, $synonyms ) ) { |
|
165 | - $type = $synonyms[ $type ]; |
|
166 | - } |
|
167 | - |
|
168 | - return in_array( $type, array( 'string', 'integer', 'double', 'boolean' ) ) ? |
|
169 | - $type : |
|
170 | - null; |
|
171 | - } |
|
18 | + /** |
|
19 | + * Type to validate against. |
|
20 | + * |
|
21 | + * @var string |
|
22 | + */ |
|
23 | + private $type; |
|
24 | + |
|
25 | + /** |
|
26 | + * Type constructor. |
|
27 | + * |
|
28 | + * @param string $type |
|
29 | + * @param bool $key_type |
|
30 | + */ |
|
31 | + public function __construct( $type, $key_type = false ) { |
|
32 | + $this->type = $this->determine( $type, $key_type ); |
|
33 | + } |
|
34 | + |
|
35 | + /** |
|
36 | + * Get validation type. |
|
37 | + * |
|
38 | + * @return string |
|
39 | + */ |
|
40 | + public function get_type() { |
|
41 | + return $this->type; |
|
42 | + } |
|
43 | + |
|
44 | + /** |
|
45 | + * Returns whether the type is an Axolotl model. |
|
46 | + * |
|
47 | + * @return bool |
|
48 | + */ |
|
49 | + public function is_model() { |
|
50 | + if ( ! class_exists( $this->type ) ) { |
|
51 | + return false; |
|
52 | + } |
|
53 | + |
|
54 | + $reflection = new ReflectionClass( $this->type ); |
|
55 | + return $reflection->isSubclassOf( 'Intraxia\Jaxion\Axolotl\Model' ); |
|
56 | + } |
|
57 | + |
|
58 | + /** |
|
59 | + * Create a new model from the given data. |
|
60 | + * |
|
61 | + * @param array $data Data for the model. |
|
62 | + * |
|
63 | + * @return Model |
|
64 | + */ |
|
65 | + public function create_model( array $data ) { |
|
66 | + return new $this->type( $data ); |
|
67 | + } |
|
68 | + |
|
69 | + /** |
|
70 | + * Validates an array of element. |
|
71 | + * |
|
72 | + * @param array $elements Elements to be validated. |
|
73 | + * |
|
74 | + * @throws InvalidArgumentException |
|
75 | + */ |
|
76 | + public function validate_elements( array $elements ) { |
|
77 | + foreach ( $elements as $element ) { |
|
78 | + $this->validate_element( $element ); |
|
79 | + } |
|
80 | + } |
|
81 | + |
|
82 | + /** |
|
83 | + * Validate whether the |
|
84 | + * |
|
85 | + * @param mixed $element Element to validate. |
|
86 | + * |
|
87 | + * @throws InvalidArgumentException |
|
88 | + */ |
|
89 | + public function validate_element( $element ) { |
|
90 | + $type = gettype( $element ); |
|
91 | + $callable = $this->type === 'callable'; |
|
92 | + $is_object = 'object' === $type; |
|
93 | + $loose_check = $this->type === 'object'; |
|
94 | + |
|
95 | + // callable must be callable |
|
96 | + if ( $callable && ! is_callable( $element ) ) { |
|
97 | + throw new InvalidArgumentException( 'Item must be callable' ); |
|
98 | + } |
|
99 | + |
|
100 | + // target isn't callable, object must be an instance of target |
|
101 | + if ( ! $loose_check && ! $callable && $is_object && ! is_a( $element, $this->type ) ) { |
|
102 | + throw new InvalidArgumentException( "Item is not type or subtype of $this->type" ); |
|
103 | + } |
|
104 | + |
|
105 | + // a non callable, non object type should match the target string |
|
106 | + if ( ! $callable && ! $is_object && $type !== $this->type ) { |
|
107 | + throw new InvalidArgumentException( "Item is not of type: $this->type" ); |
|
108 | + } |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * Determine the type to validate against. |
|
113 | + * |
|
114 | + * @param string $type Type to determine. |
|
115 | + * @param bool $key_type Whether the type is for keys. |
|
116 | + * |
|
117 | + * @return string |
|
118 | + * |
|
119 | + * @throws InvalidArgumentException |
|
120 | + */ |
|
121 | + private function determine( $type, $key_type = false ) { |
|
122 | + if ( ! $key_type && $this->non_scalar_type_exists( $type ) ) { |
|
123 | + return $type; |
|
124 | + } |
|
125 | + |
|
126 | + if ( $scalar_type = $this->determine_scalar( $type ) ) { |
|
127 | + if ( $key_type && (in_array( $scalar_type, array( 'double', 'boolean' ) )) ) { |
|
128 | + throw new InvalidArgumentException( 'This type is not supported as a key.' ); |
|
129 | + } |
|
130 | + |
|
131 | + return $scalar_type; |
|
132 | + } |
|
133 | + |
|
134 | + throw new InvalidArgumentException( 'This type does not exist.' ); |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Determines whether the given type exists. |
|
139 | + * |
|
140 | + * @param string $type Type to check. |
|
141 | + * |
|
142 | + * @return bool |
|
143 | + */ |
|
144 | + private function non_scalar_type_exists( $type ) { |
|
145 | + return class_exists( $type ) |
|
146 | + || interface_exists( $type ) |
|
147 | + || in_array( $type, array( 'array', 'object', 'callable' ) ); |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * Returns the type if it's scalar, otherwise, returns null. |
|
152 | + * |
|
153 | + * @param string $type Type to check. |
|
154 | + * |
|
155 | + * @return string|null |
|
156 | + */ |
|
157 | + private function determine_scalar( $type ) { |
|
158 | + $synonyms = array( |
|
159 | + 'int' => 'integer', |
|
160 | + 'float' => 'double', |
|
161 | + 'bool' => 'boolean', |
|
162 | + ); |
|
163 | + |
|
164 | + if ( array_key_exists( $type, $synonyms ) ) { |
|
165 | + $type = $synonyms[ $type ]; |
|
166 | + } |
|
167 | + |
|
168 | + return in_array( $type, array( 'string', 'integer', 'double', 'boolean' ) ) ? |
|
169 | + $type : |
|
170 | + null; |
|
171 | + } |
|
172 | 172 | } |