1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Amarkal\UI; |
4
|
|
|
|
5
|
|
|
/** |
6
|
|
|
* Implements a factory for UI component objects. Can be used to register and |
7
|
|
|
* create components. |
8
|
|
|
*/ |
9
|
|
|
class ComponentFactory |
10
|
|
|
{ |
|
|
|
|
11
|
|
|
/** |
12
|
|
|
* @var array A list of user-registered custom components |
13
|
|
|
*/ |
14
|
|
|
private static $registered_components = array(); |
15
|
|
|
|
16
|
|
|
/** |
17
|
|
|
* Create a UI component instance. |
18
|
|
|
* |
19
|
|
|
* @param string $type |
20
|
|
|
* @param array $props |
21
|
|
|
* @return AbstractComponent |
22
|
|
|
*/ |
23
|
|
|
public static function create( $type, array $props ) |
24
|
|
|
{ |
25
|
|
|
try { |
26
|
|
|
$component = self::create_registered_component($type, $props); |
|
|
|
|
27
|
|
|
} catch (\RuntimeException $ex) { |
28
|
|
|
$component = self::create_core_component($type, $props); |
|
|
|
|
29
|
|
|
} |
30
|
|
|
|
31
|
|
|
return $component; |
32
|
|
|
} |
33
|
|
|
|
34
|
|
|
/** |
35
|
|
|
* Register a custom component class. If the given component name is similar |
36
|
|
|
* to the name of one of the core components, it will override it. If a |
37
|
|
|
* custom component with a similar name has already been registered, an |
38
|
|
|
* exception will be thrown. |
39
|
|
|
* |
40
|
|
|
* @param string $type |
41
|
|
|
* @param string $class_name |
42
|
|
|
* @throws \RuntimeException |
43
|
|
|
*/ |
44
|
|
View Code Duplication |
public static function register( $type, $class_name ) |
|
|
|
|
45
|
|
|
{ |
46
|
|
|
if( !in_array($type, self::$registered_components) ) |
47
|
|
|
{ |
48
|
|
|
self::$registered_components[$type] = $class_name; |
49
|
|
|
} |
50
|
|
|
else throw new \RuntimeException("A component of type '$type' has already been registered."); |
51
|
|
|
} |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* |
55
|
|
|
* @param type $type |
56
|
|
|
* @param type $props |
57
|
|
|
* @throws \RuntimeException |
58
|
|
|
*/ |
59
|
|
|
private static function create_core_component( $type, $props ) |
60
|
|
|
{ |
61
|
|
|
$file_name = __DIR__."/components/$type/controller.php"; |
62
|
|
|
$class_name = 'Amarkal\\UI\\Component_'.$type; |
63
|
|
|
|
64
|
|
|
// Load one of the core components |
65
|
|
|
if(!class_exists($class_name)) |
66
|
|
|
{ |
67
|
|
|
if( file_exists( $file_name ) ) |
68
|
|
|
{ |
69
|
|
|
require_once $file_name; |
70
|
|
|
} |
71
|
|
|
else |
72
|
|
|
{ |
73
|
|
|
throw new \RuntimeException("A component of type '$type' does not exist."); |
74
|
|
|
} |
75
|
|
|
} |
76
|
|
|
|
77
|
|
|
return new $class_name($props); |
78
|
|
|
} |
79
|
|
|
|
80
|
|
|
/** |
81
|
|
|
* |
82
|
|
|
* @param type $type |
83
|
|
|
* @param type $props |
84
|
|
|
* @throws \RuntimeException |
85
|
|
|
*/ |
86
|
|
View Code Duplication |
private static function create_registered_component( $type, $props ) |
|
|
|
|
87
|
|
|
{ |
88
|
|
|
if(in_array($type, self::$registered_components)) |
89
|
|
|
{ |
90
|
|
|
$class_name = self::$registered_components[$type]; |
91
|
|
|
return new $class_name($props); |
92
|
|
|
} |
93
|
|
|
|
94
|
|
|
throw new \RuntimeException("A component of type '$type' has not been registered."); |
95
|
|
|
} |
96
|
|
|
|
97
|
|
|
/** |
98
|
|
|
* Private constructor to prevent instantiation |
99
|
|
|
*/ |
100
|
|
|
private function __construct() {} |
101
|
|
|
} |