abstract-types.php — Advanced Ads – Ad Manager & AdSense 2.0.25

advanced-ads / includes / abstracts / abstract-types.php

advanced-ads / includes / abstracts Last commit date

abstract-ad.php 1 day ago abstract-admin-list-table.php 1 week ago abstract-data.php 1 week ago abstract-factory.php 1 day ago abstract-group.php 1 day ago abstract-placement-type.php 1 week ago abstract-placement.php 1 day ago abstract-screen.php 3 months ago abstract-types.php 1 day ago index.php 2 years ago

abstract-types.php

229 lines

1	<?php
2	/**
3	* Abstracts Types.
4	*
5	* @package AdvancedAds
6	* @author Advanced Ads <info@wpadvancedads.com>
7	* @since 1.47.0
8	*/
9
10	namespace AdvancedAds\Abstracts;
11
12	use AdvancedAds\Framework\Utilities\Str;
13	use AdvancedAds\Framework\Interfaces\Integration_Interface;
14
15	defined( 'ABSPATH' ) \|\| exit;
16
17	/**
18	* Abstracts Types.
19	*/
20	abstract class Types implements Integration_Interface {
21
22	/**
23	* Hold types.
24	*
25	* @var array<string, object>
26	*/
27	protected $types = [];
28
29	/**
30	* Hook to filter types.
31	*
32	* @var string
33	*/
34	protected $hook = 'advanced-ads-none-types';
35
36	/**
37	* Class for unknown type.
38	*
39	* @var string
40	*/
41	protected $type_unknown = '';
42
43	/**
44	* Type interface to check.
45	*
46	* @var string
47	*/
48	protected $type_interface = '';
49
50	/**
51	* Check if has premium types.
52	*
53	* @var bool\|null
54	*/
55	private $has_premium = null;
56
57	/**
58	* Hook into WordPress.
59	*
60	* @return void
61	*/
62	public function hooks(): void {
63	add_action( 'init', [ $this, 'register_types' ], 25 );
64	}
65
66	/**
67	* Built-in type classes for this manager.
68	*
69	* @return string[]
70	*/
71	abstract protected function default_type_classes(): array;
72
73	/**
74	* Create missing type
75	*
76	* @param string $type Missing type.
77	*
78	* @return mixed
79	*/
80	public function create_missing( $type ) {
81	$this->types[ $type ] = new $this->type_unknown(
82	[
83	'id' => $type,
84	'title' => Str::capitalize( $type ),
85	]
86	);
87
88	return $this->types[ $type ];
89	}
90
91	/**
92	* Register custom type.
93	*
94	* @param string $classname Type class name.
95	*
96	* @return void
97	*/
98	public function register_type( $classname ): void {
99	$type = new $classname();
100	$this->types[ $type->get_id() ] = $type;
101	}
102
103	/**
104	* Register custom types.
105	*
106	* @return void
107	*/
108	public function register_types(): void {
109	$this->register_default_types();
110	/**
111	* Developers can add new types using this action.
112	*/
113	do_action( $this->hook . '-manager', $this );
114	/**
115	* Developers can add or replace types using this filter.
116	*/
117	$this->types = apply_filters( $this->hook, $this->types );
118
119	$this->validate_types();
120	}
121
122	/**
123	* Has type.
124	*
125	* @param string $type Type to check.
126	*
127	* @return bool
128	*/
129	public function has_type( $type ): bool {
130	return array_key_exists( $type, $this->types );
131	}
132
133	/**
134	* Get the registered type.
135	*
136	* @param string $type Type to get.
137	*
138	* @return mixed\|bool
139	*/
140	public function get_type( $type ) {
141	return $this->types[ $type ] ?? false;
142	}
143
144	/**
145	* Resolve the entity class for a type id, with lazy registration and default fallback.
146	*
147	* @param string $entity_type Entity type id.
148	* @param string $default_type Fallback type id when $entity_type is unknown.
149	*
150	* @return string Entity class name.
151	*/
152	public function get_classname_for_type( $entity_type, $default_type = 'default' ): string {
153	if ( empty( $this->types ) \|\| ! $this->has_type( $default_type ) ) {
154	$this->register_types();
155	}
156
157	$type = $this->has_type( $entity_type )
158	? $this->get_type( $entity_type )
159	: $this->get_type( $default_type );
160
161	return $type->get_classname();
162	}
163
164	/**
165	* Get the registered types.
166	*
167	* @param bool $with_unknown Include unknown type placements.
168	*
169	* @return array
170	*/
171	public function get_types( $with_unknown = true ): array {
172	return $with_unknown ? $this->types : array_filter( $this->types, fn( $type ) => ! is_a( $type, $this->type_unknown ) );
173	}
174
175	/**
176	* Check if has premium types.
177	*
178	* @return bool
179	*/
180	public function has_premium(): bool {
181	if ( null !== $this->has_premium ) {
182	return $this->has_premium;
183	}
184
185	$this->has_premium = false;
186
187	foreach ( $this->get_types() as $type ) {
188	if ( $type->is_premium() ) {
189	$this->has_premium = true;
190	break;
191	}
192	}
193
194	return $this->has_premium;
195	}
196
197	/**
198	* Register default types.
199	*
200	* @return void
201	*/
202	protected function register_default_types(): void {
203	foreach ( $this->default_type_classes() as $classname ) {
204	$this->register_type( $classname );
205	}
206	}
207
208	/**
209	* Validate types by type interface
210	*
211	* @return void
212	*/
213	private function validate_types(): void {
214	// Early bail!!
215	if ( empty( $this->type_unknown ) \|\| empty( $this->type_interface ) ) {
216	return;
217	}
218
219	foreach ( $this->types as $slug => $type ) {
220	if ( ! is_array( $type ) \|\| is_a( $type, $this->type_interface ) ) {
221	continue;
222	}
223
224	$type['id'] = $slug;
225	$this->types[ $slug ] = new $this->type_unknown( $type );
226	}
227	}
228	}
229