Добавлены комментарии к коду

zombiQWERTY · May 11, 2014 · 2446a23 · 2446a23
1 parent 045621a
commit 2446a23
Show file tree

Hide file tree

Showing 15 changed files with 550 additions and 84 deletions.
diff --git a/application/classes/config.class.php b/application/classes/config.class.php
@@ -1,14 +1,77 @@
 <?
+/**
+ * SimpleMVC
+ *
+ * An open source application development framework for PHP 5.1.6 or newer
+ *
+ * @package		SimpleMVC
+ * @author		zombiQWERTY
+ * @copyright	Copyright (c) 2014, zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ * @since		Version 1.0
+ */
+
+// ------------------------------------------------------------------------
+
+/**
+ * Config file with default settings
+ *
+ * @package		SimpleMVC
+ * @category	Back-controller
+ * @author		zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ */
+
 class Config {
-
+
+	/**
+	 * Set the index controller of your app. Can not be 'index'
+	 * Устанавливает главный контроллер Вашего приложения. Не может быть 'index'
+	 */
 	public static $indexPage = 'main';
+
+	/**
+	 * Set the layout of your app
+	 * Устанавливает шаблон Вашего приложения
+	 */
 	public static $layout    = 'default';
-
+
+
+	/**
+	 * Switch on/off work with db
+	 * Включает/выключает работу с базой данных
+	 */
 	public static $db        = true;
+
+	/**
+	 * Set the db connect host
+	 * Устанавливает хост для соединения с базой данных
+	 */
 	public static $host      = 'localhost';
+
+	/**
+	 * Set the db connect username
+	 * Устанавливает логин для соединения с базой данных
+	 */
 	public static $user      = 'root';
+
+	/**
+	 * Set the db connect password
+	 * Устанавливает пароль для соединения с базой данных
+	 */
 	public static $password  = 'zvezda';
+
+	/**
+	 * Set the database for work with db
+	 * Устанавливает таблицу для работы с базой данных
+	 */
 	public static $database  = 'simpleMVC';
+
+	/**
+	 * Set the db connect charset
+	 * Устанавливает кодировку для соединения с базой данных
+	 */
 	public static $charset   = 'utf8';
+
 }
 ?>
diff --git a/application/classes/database.class.php b/application/classes/database.class.php
@@ -1,6 +1,32 @@
 <?
+/**
+ * SimpleMVC
+ *
+ * An open source application development framework for PHP 5.1.6 or newer
+ *
+ * @package		SimpleMVC
+ * @author		zombiQWERTY
+ * @copyright	Copyright (c) 2014, zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ * @since		Version 1.0
+ */
+
+// ------------------------------------------------------------------------
+
+/**
+ * Config db file with default settings
+ *
+ * @package		SimpleMVC
+ * @category	Back-controller
+ * @author		zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ */
+
 class Database {
 
+	/**
+	 * Constructor
+	 */
 	function __construct() {
 		$connections = array(
 			'development' => 'mysql://'.Config::$user.':'.Config::$password.'@'.Config::$host.'/'.Config::$database.'?charset='.Config::$charset,

diff --git a/application/mvc/views/errors/error404.php b/application/mvc/views/errors/error404.php
@@ -55,8 +55,8 @@
 </head>
 <body>
 	<div id="container">
-		<h1><?php echo $heading; ?></h1>
-		<?php echo $message; ?>
+		<h1><?=$heading?></h1>
+		<?=$message?>
 	</div>
 </body>
 </html>
diff --git a/application/mvc/views/errors/errorDB.php b/application/mvc/views/errors/errorDB.php
diff --git a/application/mvc/views/errors/errorGeneral.php b/application/mvc/views/errors/errorGeneral.php
@@ -55,8 +55,8 @@
 </head>
 <body>
 	<div id="container">
-		<h1><?php echo $heading; ?></h1>
-		<?php echo $message; ?>
+		<h1><?=$heading?></h1>
+		<?=$message?>
 	</div>
 </body>
 </html>
diff --git a/application/mvc/views/errors/errorPhp.php b/application/mvc/views/errors/errorPhp.php
@@ -2,9 +2,9 @@
 
 <h4>A PHP Error was encountered</h4>
 
-<p>Severity: <?php echo $severity; ?></p>
-<p>Message:  <?php echo $message; ?></p>
-<p>Filename: <?php echo $filepath; ?></p>
-<p>Line Number: <?php echo $line; ?></p>
+<p>Severity: <?=$severity?></p>
+<p>Message:  <?=$message?></p>
+<p>Filename: <?=$filepath?></p>
+<p>Line Number: <?=$line?></p>
 
 </div>
diff --git a/index.php b/index.php
@@ -1,19 +1,71 @@
 <?
+/**
+ * SimpleMVC
+ *
+ * An open source application development framework for PHP 5.1.6 or newer
+ *
+ * @package		SimpleMVC
+ * @author		zombiQWERTY
+ * @copyright	Copyright (c) 2014, zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ * @since		Version 1.0
+ */
+
+// ------------------------------------------------------------------------
+
+/**
+ * Framework Initialization File
+ *
+ * @package		SimpleMVC
+ * @category	Back-controller
+ * @author		zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ */
+
+// ------------------------------------------------------------------------
+
+/**
+ * Set header charset and Moscow locale
+ */
 header('Content-Type: text/html; charset=utf-8');
 setlocale(LC_ALL, 'Russian_Russia.65001');
 
+// ------------------------------------------------------------------------
+
+/**
+ * Define useful consts for work
+ */
 define('BASE_URL', 'http://'.$_SERVER['HTTP_HOST']);
 define('ROOT'    , $_SERVER['DOCUMENT_ROOT']);
 define('APPPATH' , ROOT.'/application/');
 define('SYSPATH' , ROOT.'/system/');
 
-require_once SYSPATH.'autoload.php';
+// ------------------------------------------------------------------------
 
+/**
+ * require needful files
+ */
+require_once SYSPATH.'autoload.php';
 require_once SYSPATH.'exceptionHandler.php';
 
+// ------------------------------------------------------------------------
+
+/**
+ * Set handler for native php errors
+ */
 set_error_handler('exceptionHandler');
 
+// ------------------------------------------------------------------------
+
+/**
+ * Disable magic quotes
+ */
 if (!Common::isPhp('5.3')) @set_magic_quotes_runtime(0);
 
+// ------------------------------------------------------------------------
+
+/**
+ * Initialization the application
+ */
 new Application();
 ?>
diff --git a/system/autoload.php b/system/autoload.php
@@ -1,4 +1,35 @@
 <?
+/**
+ * SimpleMVC
+ *
+ * An open source application development framework for PHP 5.1.6 or newer
+ *
+ * @package		SimpleMVC
+ * @author		zombiQWERTY
+ * @copyright	Copyright (c) 2014, zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ * @since		Version 1.0
+ */
+
+// ------------------------------------------------------------------------
+
+/**
+ * Autoload classes
+ *
+ * @package		SimpleMVC
+ * @category	Back-controller
+ * @author		zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ */
+
+// ------------------------------------------------------------------------
+
+/**
+ * Get classes on the go
+ *
+ * @param	string
+ * @return	class
+ */
 spl_autoload_register(function($class) {
 	$paths = array(APPPATH.'classes/', SYSPATH.'classes/', APPPATH.'libraries/');
 

diff --git a/system/classes/application.class.php b/system/classes/application.class.php
@@ -1,6 +1,41 @@
 <?
+/**
+ * SimpleMVC
+ *
+ * An open source application development framework for PHP 5.1.6 or newer
+ *
+ * @package		SimpleMVC
+ * @author		zombiQWERTY
+ * @copyright	Copyright (c) 2014, zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ * @since		Version 1.0
+ */
+
+// ------------------------------------------------------------------------
+
+/**
+ * System Initialization File
+ *
+ * Loads the base classes and executes the request.
+ *
+ * @package		SimpleMVC
+ * @category	Front-controller
+ * @author		zombiQWERTY
+ * @link		http://zombiqwerty.ru/simplemvc/
+ */
+
+/**
+ * SimpleMVC Version
+ *
+ * @var string
+ */
+define('SM_VERSION', '2.0.1');
+
 class Application {
 
+	/**
+	 * Constructor
+	 */
 	public function __construct() {
 		if (Config::$db) {
 			require_once SYSPATH.'ActiveRecord/ActiveRecord.php';