|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* CallableDirPlugin.php - Jaxon callable dir plugin |
|
5
|
|
|
* |
|
6
|
|
|
* This class registers directories containing user defined callable classes, |
|
7
|
|
|
* and generates client side javascript code. |
|
8
|
|
|
* |
|
9
|
|
|
* @package jaxon-core |
|
|
|
|
|
|
10
|
|
|
* @author Jared White |
|
|
|
|
|
|
11
|
|
|
* @author J. Max Wilson |
|
|
|
|
|
|
12
|
|
|
* @author Joseph Woolley |
|
|
|
|
|
|
13
|
|
|
* @author Steffen Konerow |
|
|
|
|
|
|
14
|
|
|
* @author Thierry Feuzeu <[email protected]> |
|
15
|
|
|
* @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson |
|
|
|
|
|
|
16
|
|
|
* @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White & J. Max Wilson |
|
|
|
|
|
|
17
|
|
|
* @copyright 2016 Thierry Feuzeu <[email protected]> |
|
18
|
|
|
* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
19
|
|
|
* @link https://github.com/jaxon-php/jaxon-core |
|
20
|
|
|
*/ |
|
|
|
|
|
|
21
|
|
|
|
|
22
|
|
|
namespace Jaxon\Request\Plugin\CallableClass; |
|
23
|
|
|
|
|
24
|
|
|
use Jaxon\Jaxon; |
|
25
|
|
|
use Jaxon\Plugin\Contract\CallableRegistryInterface; |
|
26
|
|
|
use Jaxon\Plugin\Contract\PluginInterface; |
|
27
|
|
|
use Jaxon\Utils\Translation\Translator; |
|
28
|
|
|
use Jaxon\Exception\SetupException; |
|
29
|
|
|
|
|
30
|
|
|
use function is_array; |
|
31
|
|
|
use function is_dir; |
|
32
|
|
|
use function is_string; |
|
33
|
|
|
use function realpath; |
|
34
|
|
|
use function rtrim; |
|
35
|
|
|
use function trim; |
|
36
|
|
|
|
|
37
|
|
|
class CallableDirPlugin implements PluginInterface, CallableRegistryInterface |
|
|
|
|
|
|
38
|
|
|
{ |
|
39
|
|
|
/** |
|
40
|
|
|
* The callable registry |
|
41
|
|
|
* |
|
42
|
|
|
* @var CallableRegistry |
|
43
|
|
|
*/ |
|
44
|
|
|
protected $xRegistry; |
|
|
|
|
|
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* @var Translator |
|
48
|
|
|
*/ |
|
49
|
|
|
protected $xTranslator; |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* The class constructor |
|
53
|
|
|
* |
|
54
|
|
|
* @param CallableRegistry $xRegistry |
|
|
|
|
|
|
55
|
|
|
* @param Translator $xTranslator |
|
|
|
|
|
|
56
|
|
|
*/ |
|
57
|
|
|
public function __construct(CallableRegistry $xRegistry, Translator $xTranslator) |
|
|
|
|
|
|
58
|
|
|
{ |
|
59
|
|
|
$this->xRegistry = $xRegistry; |
|
|
|
|
|
|
60
|
|
|
$this->xTranslator = $xTranslator; |
|
61
|
|
|
} |
|
|
|
|
|
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* @inheritDoc |
|
65
|
|
|
*/ |
|
|
|
|
|
|
66
|
|
|
public function getName(): string |
|
67
|
|
|
{ |
|
68
|
|
|
return Jaxon::CALLABLE_DIR; |
|
69
|
|
|
} |
|
|
|
|
|
|
70
|
|
|
|
|
71
|
|
|
/** |
|
72
|
|
|
* Check the directory |
|
73
|
|
|
* |
|
74
|
|
|
* @param string $sDirectory The path of teh directory being registered |
|
|
|
|
|
|
75
|
|
|
* |
|
76
|
|
|
* @return string |
|
77
|
|
|
* @throws SetupException |
|
78
|
|
|
*/ |
|
79
|
|
|
private function checkDirectory(string $sDirectory): string |
|
80
|
|
|
{ |
|
81
|
|
|
$sDirectory = rtrim(trim($sDirectory), '/\\'); |
|
82
|
|
|
if(!is_dir($sDirectory)) |
|
83
|
|
|
{ |
|
84
|
|
|
throw new SetupException($this->xTranslator->trans('errors.objects.invalid-declaration')); |
|
85
|
|
|
} |
|
86
|
|
|
return realpath($sDirectory); |
|
87
|
|
|
} |
|
|
|
|
|
|
88
|
|
|
|
|
89
|
|
|
/** |
|
|
|
|
|
|
90
|
|
|
* @inheritDoc |
|
91
|
|
|
* @throws SetupException |
|
92
|
|
|
*/ |
|
|
|
|
|
|
93
|
|
|
public function checkOptions(string $sCallable, $xOptions): array |
|
94
|
|
|
{ |
|
95
|
|
|
if(is_string($xOptions)) |
|
96
|
|
|
{ |
|
97
|
|
|
$xOptions = ['namespace' => $xOptions]; |
|
98
|
|
|
} |
|
99
|
|
|
if(!is_array($xOptions)) |
|
100
|
|
|
{ |
|
101
|
|
|
throw new SetupException($this->xTranslator->trans('errors.objects.invalid-declaration')); |
|
102
|
|
|
} |
|
103
|
|
|
// Check the directory |
|
104
|
|
|
$xOptions['directory'] = $this->checkDirectory($sCallable); |
|
105
|
|
|
// Check the namespace |
|
106
|
|
|
$sNamespace = $xOptions['namespace'] ?? ''; |
|
107
|
|
|
if(!($xOptions['namespace'] = trim($sNamespace, ' \\'))) |
|
|
|
|
|
|
108
|
|
|
{ |
|
109
|
|
|
$xOptions['namespace'] = ''; |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
|
|
// Change the keys in $xOptions to have "\" as separator |
|
113
|
|
|
$_aOptions = []; |
|
114
|
|
|
foreach($xOptions as $sName => $aOption) |
|
115
|
|
|
{ |
|
116
|
|
|
$sName = trim(str_replace('.', '\\', $sName), ' \\'); |
|
|
|
|
|
|
117
|
|
|
$_aOptions[$sName] = $aOption; |
|
118
|
|
|
} |
|
119
|
|
|
// Boolean to check if the dir is already parsed |
|
120
|
|
|
$_aOptions['parsed'] = false; |
|
121
|
|
|
return $_aOptions; |
|
122
|
|
|
} |
|
|
|
|
|
|
123
|
|
|
|
|
124
|
|
|
/** |
|
|
|
|
|
|
125
|
|
|
* @inheritDoc |
|
126
|
|
|
*/ |
|
|
|
|
|
|
127
|
|
|
public function register(string $sType, string $sCallable, array $aOptions): bool |
|
128
|
|
|
{ |
|
129
|
|
|
if(($aOptions['namespace'])) |
|
130
|
|
|
{ |
|
131
|
|
|
$this->xRegistry->addNamespace($aOptions['namespace'], $aOptions); |
|
132
|
|
|
return true; |
|
133
|
|
|
} |
|
134
|
|
|
$this->xRegistry->addDirectory($aOptions['directory'], $aOptions); |
|
135
|
|
|
return true; |
|
136
|
|
|
} |
|
|
|
|
|
|
137
|
|
|
|
|
138
|
|
|
/** |
|
|
|
|
|
|
139
|
|
|
* @inheritDoc |
|
140
|
|
|
* @throws SetupException |
|
141
|
|
|
*/ |
|
|
|
|
|
|
142
|
|
|
public function getCallable(string $sCallable) |
|
143
|
|
|
{ |
|
144
|
|
|
return $this->xRegistry->getCallableObject($sCallable); |
|
145
|
|
|
} |
|
|
|
|
|
|
146
|
|
|
} |
|
147
|
|
|
|
jaxon-php /
jaxon-core
Loading history...