Passed
Push — master ( c5e11d...bd0bd9 )
by Jean-Christophe
05:42
created

ScaffoldController::_createController()   B

Complexity

Conditions 6
Paths 9

Size

Total Lines 33
Code Lines 28

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 42

Importance

Changes 0
Metric Value
eloc 28
dl 0
loc 33
ccs 0
cts 33
cp 0
rs 8.8497
c 0
b 0
f 0
cc 6
nc 9
nop 5
crap 42
1
<?php
2
3
namespace Ubiquity\scaffolding;
4
5
use Ubiquity\controllers\Startup;
6
use Ubiquity\utils\base\UFileSystem;
7
use Ubiquity\utils\base\UString;
8
9
abstract class ScaffoldController {
10
	public static $views = [ "CRUD" => [ "index" => "@framework/crud/index.html","form" => "@framework/crud/form.html","display" => "@framework/crud/display.html" ],
11
			"auth" => [ "index" => "@framework/auth/index.html","info" => "@framework/auth/info.html","noAccess" => "@framework/auth/noAccess.html","disconnected" => "@framework/auth/disconnected.html","message" => "@framework/auth/message.html","baseTemplate" => "@framework/auth/baseTemplate.html" ] ];
12
13
	protected abstract function getTemplateDir();
14
15
	protected abstract function storeControllerNameInSession($controller);
16
17
	protected abstract function showSimpleMessage($content, $type, $title = null, $icon = "info", $timeout = NULL, $staticName = null);
18
19
	public function _createMethod($access, $name, $parameters = "", $return = "", $content = "", $comment = "") {
20
		$templateDir = $this->getTemplateDir ();
21
		$keyAndValues = [ "%access%" => $access,"%name%" => $name,"%parameters%" => $parameters,"%content%" => $content,"%comment%" => $comment,"%return%" => $return ];
22
		return UFileSystem::openReplaceInTemplateFile ( $templateDir . "method.tpl", $keyAndValues );
23
	}
24
25
	protected function _createController($controllerName, $variables = [], $ctrlTemplate = 'controller.tpl', $hasView = false, $jsCallback = "") {
26
		$message = "";
27
		$templateDir = $this->getTemplateDir ();
28
		$controllersNS = \rtrim ( Startup::getNS ( "controllers" ), "\\" );
29
		$controllersDir = \ROOT . \DS . str_replace ( "\\", \DS, $controllersNS );
30
		$controllerName = \ucfirst ( $controllerName );
31
		$filename = $controllersDir . \DS . $controllerName . ".php";
32
		if (\file_exists ( $filename ) === false) {
33
			if ($controllersNS !== "") {
34
				$namespace = "namespace " . $controllersNS . ";";
35
			}
36
			$msgView = "";
37
			$indexContent = "";
38
			if ($hasView) {
39
				$viewDir = \ROOT . \DS . "views" . \DS . $controllerName . \DS;
40
				UFileSystem::safeMkdir ( $viewDir );
41
				$viewName = $viewDir . \DS . "index.html";
42
				UFileSystem::openReplaceWriteFromTemplateFile ( $templateDir . "view.tpl", $viewName, [ "%controllerName%" => $controllerName,"%actionName%" => "index" ] );
43
				$msgView = "<br>The default view associated has been created in <b>" . UFileSystem::cleanPathname ( \ROOT . \DS . $viewDir ) . "</b>";
44
				$indexContent = "\$this->loadView(\"" . $controllerName . "/index.html\");";
45
			}
46
			$variables = \array_merge ( $variables, [ "%controllerName%" => $controllerName,"%indexContent%" => $indexContent,"%namespace%" => $namespace ] );
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $namespace does not seem to be defined for all execution paths leading up to this point.
Loading history...
47
			UFileSystem::openReplaceWriteFromTemplateFile ( $templateDir . $ctrlTemplate, $filename, $variables );
48
			$msgContent = "The <b>" . $controllerName . "</b> controller has been created in <b>" . UFileSystem::cleanFilePathname ( $filename ) . "</b>." . $msgView;
49
			if (isset ( $variables ["%path%"] ) && $variables ["%path%"] !== "") {
50
				$msgContent .= $this->_addMessageForRouteCreation ( $variables ["%path%"], $jsCallback );
0 ignored issues
show
Bug introduced by
The method _addMessageForRouteCreation() does not exist on Ubiquity\scaffolding\ScaffoldController. It seems like you code against a sub-type of Ubiquity\scaffolding\ScaffoldController such as Ubiquity\scaffolding\AdminScaffoldController. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

50
				$msgContent .= $this->/** @scrutinizer ignore-call */ _addMessageForRouteCreation ( $variables ["%path%"], $jsCallback );
Loading history...
51
			}
52
			$this->storeControllerNameInSession ( $controllersNS . "\\" . $controllerName );
53
			$message = $this->showSimpleMessage ( $msgContent, "success", null, "checkmark circle", NULL, "msgGlobal" );
54
		} else {
55
			$message = $this->showSimpleMessage ( "The file <b>" . $filename . "</b> already exists.<br>Can not create the <b>" . $controllerName . "</b> controller!", "warning", null, "warning circle", 100000, "msgGlobal" );
56
		}
57
		return $message;
58
	}
59
60
	public function addCrudController($crudControllerName, $resource, $crudDatas = null, $crudViewer = null, $crudEvents = null, $crudViews = null, $routePath = '') {
61
		$classContent = "";
62
		$routeName = "";
0 ignored issues
show
Unused Code introduced by
The assignment to $routeName is dead and can be removed.
Loading history...
63
		$uses = [ ];
64
		$controllerNS = Startup::getNS ( "controllers" );
65
		$messages = [ ];
66
		$routeName = $crudControllerName;
67
		$this->_createMethod ( "public", "__construct", "", "", "\n\t\tparent::__construct();\n\$this->model=\"{$resource}\";" );
68
69
		if (isset ( $crudDatas )) {
70
			$uses [] = "use controllers\\crud\\datas\\{$crudControllerName}Datas;";
71
			$uses [] = "use Ubiquity\\controllers\\crud\\CRUDDatas;";
72
73
			$classContent .= $this->_createMethod ( "protected", "getAdminData", "", ": CRUDDatas", "\t\treturn new {$crudControllerName}Datas(\$this);" );
74
			$messages [] = $this->createCRUDDatasClass ( $crudControllerName );
75
		}
76
77
		if (isset ( $crudViewer )) {
78
			$uses [] = "use controllers\\crud\\viewers\\{$crudControllerName}Viewer;";
79
			$uses [] = "use Ubiquity\\controllers\\admin\\viewers\\ModelViewer;";
80
81
			$classContent .= $this->_createMethod ( "protected", "getModelViewer", "", ": ModelViewer", "\t\treturn new {$crudControllerName}Viewer(\$this);" );
82
			$messages [] = $this->createModelViewerClass ( $crudControllerName );
83
		}
84
		if (isset ( $crudEvents )) {
85
			$uses [] = "use controllers\\crud\\events\\{$crudControllerName}Events;";
86
			$uses [] = "use Ubiquity\\controllers\\crud\\CRUDEvents;";
87
88
			$classContent .= $this->_createMethod ( "protected", "getEvents", "", ": CRUDEvents", "\t\treturn new {$crudControllerName}Events(\$this);" );
89
			$messages [] = $this->createEventsClass ( $crudControllerName );
90
		}
91
92
		if (isset( $crudViews )) {
93
			$crudViews=explode(",", $crudViews);
94
			$uses [] = "use controllers\\crud\\files\\{$crudControllerName}Files;";
95
			$uses [] = "use Ubiquity\\controllers\\crud\\CRUDFiles;";
96
			$classContent .= $this->_createMethod ( "protected", "getFiles", "", ": CRUDFiles", "\t\treturn new {$crudControllerName}Files();" );
97
			$classFilesContent = [ ];
98
			foreach ( $crudViews as $file ) {
99
				if (isset ( self::$views ["CRUD"] [$file] )) {
100
					$frameworkViewname = self::$views ["CRUD"] [$file];
101
					$this->createCrudView ( $frameworkViewname, $crudControllerName, $file );
102
					$classFilesContent [] = $this->_createMethod ( "public", "getView" . ucfirst ( $file ), "", "", "\t\treturn \"" . $crudControllerName . "/" . $file . ".html\";" );
103
				}
104
			}
105
			$messages [] = $this->createCRUDFilesClass ( $crudControllerName, implode ( "", $classFilesContent ) );
106
		}
107
		if ($routePath!=null) {
108
			if (UString::isNotNull ( $routePath )) {
109
				if (! UString::startswith ( $routePath, "/" )) {
110
					$routePath = "/" . $routePath;
111
				}
112
				$routeName = $routePath;
113
				$routePath = "\n * @route(\"{$routePath}\",\"inherited\"=>true,\"automated\"=>true)";
114
			}
115
		}
116
		$uses = implode ( "\n", $uses );
117
		$messages [] = $this->_createController ( $crudControllerName, [ "%routeName%" => $routeName,"%route%" => $routePath,"%resource%" => $resource,"%uses%" => $uses,"%namespace%" => $controllerNS,"%baseClass%" => "\\Ubiquity\\controllers\\crud\\CRUDController","%content%" => $classContent ], "crudController.tpl" );
118
		echo implode ( "\n", $messages );
119
	}
120
121
	public function addAuthController($authControllerName, $baseClass, $authViews = null, $routePath = "") {
122
		$classContent = "";
123
		$routeName = "";
0 ignored issues
show
Unused Code introduced by
The assignment to $routeName is dead and can be removed.
Loading history...
124
125
		if ($baseClass == "\\Ubiquity\\controllers\\auth\\AuthController") {
126
			$controllerTemplate = "authController.tpl";
127
			$uses = [ "use Ubiquity\\utils\\http\\USession;","use Ubiquity\\utils\\http\\URequest;" ];
128
		} else {
129
			$controllerTemplate = "authController_.tpl";
130
			$uses = [ ];
131
		}
132
		$controllerNS = Startup::getNS ( "controllers" );
133
134
		$messages = [ ];
135
		$routeName = $authControllerName;
136
		if (isset ( $authViews )) {
137
			$authViews=explode(",", $authViews);
138
			$uses [] = "use controllers\\auth\\files\\{$authControllerName}Files;";
139
			$uses [] = "use Ubiquity\\controllers\\auth\\AuthFiles;";
140
			$classContent .= $this->_createMethod ( "protected", "getFiles", "", ": AuthFiles", "\t\treturn new {$authControllerName}Files();" );
141
			$classFilesContent = [ ];
142
			foreach ( $authViews as $file ) {
143
				if (isset ( self::$views ["auth"] [$file] )) {
144
					$frameworkViewname = self::$views ["auth"] [$file];
145
					$this->createCrudView ( $frameworkViewname, $authControllerName, $file );
146
					$classFilesContent [] = $this->_createMethod ( "public", "getView" . ucfirst ( $file ), "", "", "\t\treturn \"" . $authControllerName . "/" . $file . ".html\";" );
147
				}
148
			}
149
			$messages [] = $this->createAuthFilesClass ( $authControllerName, implode ( "", $classFilesContent ) );
150
		}
151
		if ($routePath!=null) {
152
			if (UString::isNotNull ( $routePath )) {
153
				if (! UString::startswith ( $routePath, "/" )) {
154
					$routePath = "/" . $routePath;
155
				}
156
				$routeName = $routePath;
157
				$routePath = "\n * @route(\"{$routePath}\",\"inherited\"=>true,\"automated\"=>true)";
158
			}
159
		}
160
		$uses = implode ( "\n", $uses );
161
		$messages [] = $this->_createController ( $authControllerName, [ "%routeName%" => $routeName,"%route%" => $routePath,"%uses%" => $uses,"%namespace%" => $controllerNS,"%baseClass%" => $baseClass,"%content%" => $classContent ], $controllerTemplate );
162
		echo implode ( "\n", $messages );
163
	}
164
165
	public function _createClass($template, $classname, $namespace, $uses, $extendsOrImplements, $classContent) {
166
		$namespaceVar = "";
167
		if (UString::isNotNull ( $namespace )) {
168
			$namespaceVar = "namespace {$namespace};";
169
		}
170
		$variables = [ "%classname%" => $classname,"%namespace%" => $namespaceVar,"%uses%" => $uses,"%extendsOrImplements%" => $extendsOrImplements,"%classContent%" => $classContent ];
171
		$templateDir = $this->getTemplateDir ();
172
		$directory = UFileSystem::getDirFromNamespace ( $namespace );
173
		UFileSystem::safeMkdir ( $directory );
174
		$filename = UFileSystem::cleanFilePathname ( $directory . \DS . $classname . ".php" );
175
		if (! file_exists ( $filename )) {
176
			UFileSystem::openReplaceWriteFromTemplateFile ( $templateDir . $template, $filename, $variables );
177
			$message = $this->showSimpleMessage ( "The <b>" . $classname . "</b> class has been created in <b>" . $filename . "</b>.", "success", "Creation", "checkmark circle" );
178
		} else {
179
			$message = $this->showSimpleMessage ( "The file <b>" . $filename . "</b> already exists.<br>Can not create the <b>" . $classname . "</b> class!", "warning", "Creation", "warning circle" );
180
		}
181
		return $message;
182
	}
183
184
	protected function createCRUDDatasClass($crudControllerName) {
185
		$ns = Startup::getNS ( "controllers" ) . "crud\\datas";
186
		$uses = "\nuse Ubiquity\\controllers\\crud\\CRUDDatas;";
187
		return $this->_createClass ( "class.tpl", $crudControllerName . "Datas", $ns, $uses, "extends CRUDDatas", "\t//use override/implement Methods" );
188
	}
189
190
	protected function createModelViewerClass($crudControllerName) {
191
		$ns = Startup::getNS ( "controllers" ) . "crud\\viewers";
192
		$uses = "\nuse Ubiquity\\controllers\\admin\\viewers\\ModelViewer;";
193
		return $this->_createClass ( "class.tpl", $crudControllerName . "Viewer", $ns, $uses, "extends ModelViewer", "\t//use override/implement Methods" );
194
	}
195
196
	protected function createEventsClass($crudControllerName) {
197
		$ns = Startup::getNS ( "controllers" ) . "crud\\events";
198
		$uses = "\nuse Ubiquity\\controllers\\crud\\CRUDEvents;";
199
		return $this->_createClass ( "class.tpl", $crudControllerName . "Events", $ns, $uses, "extends CRUDEvents", "\t//use override/implement Methods" );
200
	}
201
202
	protected function createCRUDFilesClass($crudControllerName, $classContent = "") {
203
		$ns = Startup::getNS ( "controllers" ) . "crud\\files";
204
		$uses = "\nuse Ubiquity\\controllers\\crud\\CRUDFiles;";
205
		return $this->_createClass ( "class.tpl", $crudControllerName . "Files", $ns, $uses, "extends CRUDFiles", $classContent );
206
	}
207
208
	protected function createAuthFilesClass($authControllerName, $classContent = "") {
209
		$ns = Startup::getNS ( "controllers" ) . "auth\\files";
210
		$uses = "\nuse Ubiquity\\controllers\\auth\\AuthFiles;";
211
		return $this->_createClass ( "class.tpl", $authControllerName . "Files", $ns, $uses, "extends AuthFiles", $classContent );
212
	}
213
214
	protected function createCrudView($frameworkName, $controllerName, $newName) {
215
		$folder = \ROOT . \DS . "views" . \DS . $controllerName;
216
		UFileSystem::safeMkdir ( $folder );
217
		try {
218
			$blocks = $this->view->getBlockNames ( $frameworkName );
0 ignored issues
show
Bug introduced by
The property view does not exist on Ubiquity\scaffolding\ScaffoldController. Did you mean views?
Loading history...
219
			if (sizeof ( $blocks ) > 0) {
220
				$content = [ "{% extends \"" . $frameworkName . "\" %}\n" ];
221
				foreach ( $blocks as $blockname ) {
222
					$content [] = "{% block " . $blockname . " %}\n\t{{ parent() }}\n{% endblock %}\n";
223
				}
224
			} else {
225
				$content = [ $this->view->getCode ( $frameworkName ) ];
226
			}
227
		} catch ( \Exception $e ) {
228
			$content = [ $this->view->getCode ( $frameworkName ) ];
229
		}
230
		return UFileSystem::save ( $folder . \DS . $newName . ".html", implode ( "", $content ) );
231
	}
232
}
233
234