1 | <?php |
||
14 | abstract class Extension |
||
15 | { |
||
16 | /** |
||
17 | * @var string |
||
18 | */ |
||
19 | protected $name; |
||
20 | |||
21 | /** |
||
22 | * @var array |
||
23 | */ |
||
24 | public $css = []; |
||
25 | |||
26 | /** |
||
27 | * @var array |
||
28 | */ |
||
29 | public $js = []; |
||
30 | |||
31 | /** |
||
32 | * @var string |
||
33 | */ |
||
34 | public $assets = ''; |
||
35 | |||
36 | /** |
||
37 | * @var string |
||
38 | */ |
||
39 | public $views = ''; |
||
40 | |||
41 | /** |
||
42 | * @var string |
||
43 | */ |
||
44 | public $migrations = ''; |
||
45 | |||
46 | /** |
||
47 | * @var array |
||
48 | */ |
||
49 | public $menu = []; |
||
50 | |||
51 | /** |
||
52 | * @var array |
||
53 | */ |
||
54 | public $permission = []; |
||
55 | |||
56 | /** |
||
57 | * Extension instance. |
||
58 | * |
||
59 | * @var Extension |
||
60 | */ |
||
61 | protected static $instance; |
||
62 | |||
63 | /** |
||
64 | * The menu validation rules. |
||
65 | * |
||
66 | * @var array |
||
67 | */ |
||
68 | protected $menuValidationRules = [ |
||
69 | 'title' => 'required', |
||
70 | 'path' => 'required', |
||
71 | 'icon' => 'required', |
||
72 | 'children' => 'nullable|array', |
||
73 | ]; |
||
74 | |||
75 | /** |
||
76 | * The permission validation rules. |
||
77 | * |
||
78 | * @var array |
||
79 | */ |
||
80 | protected $permissionValidationRules = [ |
||
81 | 'name' => 'required', |
||
82 | 'slug' => 'required', |
||
83 | 'path' => 'required', |
||
84 | ]; |
||
85 | |||
86 | /** |
||
87 | * Returns the singleton instance. |
||
88 | * |
||
89 | * @return self |
||
90 | */ |
||
91 | protected static function getInstance() |
||
101 | |||
102 | /** |
||
103 | * Bootstrap this extension. |
||
104 | */ |
||
105 | public static function boot() |
||
125 | |||
126 | /** |
||
127 | * Get the path of assets files. |
||
128 | * |
||
129 | * @return string |
||
130 | */ |
||
131 | public function assets() |
||
135 | |||
136 | /** |
||
137 | * Get the paths of css files. |
||
138 | * |
||
139 | * @return array |
||
140 | */ |
||
141 | public function css() |
||
145 | |||
146 | /** |
||
147 | * Get the paths of js files. |
||
148 | * |
||
149 | * @return array |
||
150 | */ |
||
151 | public function js() |
||
155 | |||
156 | /** |
||
157 | * Get the path of view files. |
||
158 | * |
||
159 | * @return string |
||
160 | */ |
||
161 | public function views() |
||
165 | |||
166 | /** |
||
167 | * Get the path of migration files. |
||
168 | * |
||
169 | * @return string |
||
170 | */ |
||
171 | public function migrations() |
||
175 | |||
176 | /** |
||
177 | * @return array |
||
178 | */ |
||
179 | public function menu() |
||
183 | |||
184 | /** |
||
185 | * @return array |
||
186 | */ |
||
187 | public function permission() |
||
191 | |||
192 | /** |
||
193 | * Whether the extension is enabled. |
||
194 | * |
||
195 | * @return bool |
||
196 | */ |
||
197 | public function enabled() |
||
201 | |||
202 | /** |
||
203 | * Whether the extension is disabled. |
||
204 | * |
||
205 | * @return bool |
||
206 | */ |
||
207 | public function disabled() |
||
211 | |||
212 | /** |
||
213 | * Get config set in config/admin.php. |
||
214 | * |
||
215 | * @param string $key |
||
216 | * @param null $default |
||
217 | * |
||
218 | * @return \Illuminate\Config\Repository|mixed |
||
219 | */ |
||
220 | public static function config($key = null, $default = null) |
||
232 | |||
233 | /** |
||
234 | * Import menu item and permission to laravel-admin. |
||
235 | */ |
||
236 | public static function import() |
||
262 | |||
263 | /** |
||
264 | * Validate menu fields. |
||
265 | * |
||
266 | * @param array $menu |
||
267 | * |
||
268 | * @throws \Exception |
||
269 | * |
||
270 | * @return bool |
||
271 | */ |
||
272 | public function validateMenu(array $menu) |
||
285 | |||
286 | /** |
||
287 | * Get menu validation rules. |
||
288 | * |
||
289 | * @return array |
||
290 | */ |
||
291 | protected function getMenuValidationRules() |
||
300 | |||
301 | /** |
||
302 | * Validate permission fields. |
||
303 | * |
||
304 | * @param array $permission |
||
305 | * |
||
306 | * @throws \Exception |
||
307 | * |
||
308 | * @return bool |
||
309 | */ |
||
310 | public function validatePermission(array $permission) |
||
327 | |||
328 | /** |
||
329 | * Get permission validation rules. |
||
330 | * |
||
331 | * @return array |
||
332 | */ |
||
333 | protected function getPermissionValidationRules() |
||
344 | |||
345 | /** |
||
346 | * Create a item in laravel-admin left side menu. |
||
347 | * |
||
348 | * @param string $title |
||
349 | * @param string $uri |
||
350 | * @param string $icon |
||
351 | * @param int $parentId |
||
352 | * @param array $children |
||
353 | * |
||
354 | * @throws \Exception |
||
355 | * |
||
356 | * @return Model |
||
357 | */ |
||
358 | protected static function createMenu($title, $uri, $icon = 'fa-bars', $parentId = 0, array $children = []) |
||
388 | |||
389 | /** |
||
390 | * Create a permission for this extension. |
||
391 | * |
||
392 | * @param $name |
||
393 | * @param $slug |
||
394 | * @param $path |
||
395 | * @param array $methods |
||
396 | */ |
||
397 | protected static function createPermission($name, $slug, $path, $methods = []) |
||
408 | |||
409 | /** |
||
410 | * Set routes for this extension. |
||
411 | * |
||
412 | * @param $callback |
||
413 | */ |
||
414 | public static function routes($callback) |
||
426 | } |
||
427 |