Документация классов

classes/blocks/BlockBlogs.class.php

@@ -18,13 +18,24 @@
 /**
  * Обработка блока с рейтингом блогов
  *
+ * @package blocks
+ * @since 1.0
  */
 class BlockBlogs extends Block {
+	/**
+	 * Запуск обработки
+	 */
 	public function Exec() {
+		/**
+		 * Получаем список блогов
+		 */
 		if ($aResult=$this->Blog_GetBlogsRating(1,Config::Get('block.blogs.row'))) {
 			$aBlogs=$aResult['collection'];
 			$oViewer=$this->Viewer_GetLocalViewer();
 			$oViewer->Assign('aBlogs',$aBlogs);
+			/**
+			 * Формируем результат в виде шаблона и возвращаем
+			 */
 			$sTextResult=$oViewer->Fetch("blocks/block.blogs_top.tpl");
 			$this->Viewer_Assign('sBlogsTop',$sTextResult);
 		}

classes/blocks/BlockStream.class.php

@@ -16,14 +16,25 @@
 */
 
 /**
- * Обработка блока с комментариями
+ * Обработка блока с комментариями (прямой эфир)
  *
+ * @package blocks
+ * @since 1.0
  */
 class BlockStream extends Block {
+	/**
+	 * Запуск обработки
+	 */
 	public function Exec() {
+		/**
+		 * Получаем комментарии
+		 */
 		if ($aComments=$this->Comment_GetCommentsOnline('topic',Config::Get('block.stream.row'))) {
 			$oViewer=$this->Viewer_GetLocalViewer();
 			$oViewer->Assign('aComments',$aComments);
+			/**
+			 * Формируем результат в виде шаблона и возвращаем
+			 */
 			$sTextResult=$oViewer->Fetch("blocks/block.stream_comment.tpl");
 			$this->Viewer_Assign('sStreamComments',$sTextResult);
 		}

classes/blocks/BlockStreamConfig.class.php

@@ -18,10 +18,21 @@
 /**
  * Блок настройки ленты активности
  *
+ * @package blocks
+ * @since 1.0
  */
 class BlockStreamConfig extends Block {
+	/**
+	 * Запуск обработки
+	 */
 	public function Exec() {
+		/**
+		 * пользователь авторизован?
+		 */
 		if ($oUserCurrent = $this->User_getUserCurrent()) {
+			/**
+			 * Получаем и прогружаем необходимые переменные в шаблон
+			 */
 			$aTypesList = $this->Stream_getTypesList($oUserCurrent->getId());
 			$this->Viewer_Assign('aStreamTypesList', $aTypesList);
 			$aUserSubscribes = $this->Stream_getUserSubscribes($oUserCurrent->getId());

classes/blocks/BlockTags.class.php

@@ -18,9 +18,14 @@
 /**
  * Обрабатывает блок облака тегов
  *
+ * @package blocks
+ * @since 1.0
  */
 class BlockTags extends Block {
-	public function Exec() {			
+	/**
+	 * Запуск обработки
+	 */
+	public function Exec() {
 		/**
 		 * Получаем список тегов
 		 */
@@ -31,8 +36,8 @@ class BlockTags extends Block {
 		if ($aTags) {
 			$this->Tools_MakeCloud($aTags);
 			/**
-		 	* Устанавливаем шаблон вывода
-		 	*/
+			 * Устанавливаем шаблон вывода
+			 */
 			$this->Viewer_Assign("aTags",$aTags);
 		}
 		/**
@@ -53,5 +58,4 @@ class BlockTags extends Block {
 		}
 	}
 }
-
 ?>

classes/blocks/BlockTagsCity.class.php

@@ -18,12 +18,25 @@
 /**
  * Обрабатывает блок облака тегов городов юзеров
  *
+ * @package blocks
+ * @since 1.0
  */
 class BlockTagsCity extends Block {
+	/**
+	 * Запуск обработки
+	 */
 	public function Exec() {
+		/**
+		 * Получаем города
+		 */
 		$aCities=$this->Geo_GetGroupCitiesByTargetType('user',20);
+		/**
+		 * Формируем облако тегов
+		 */
 		$this->Tools_MakeCloud($aCities);
-
+		/**
+		 * Выводим в шаблон
+		 */
 		$this->Viewer_Assign("aCityList",$aCities);
 	}
 }

classes/blocks/BlockTagsCountry.class.php

@@ -18,12 +18,25 @@
 /**
  * Обрабатывает блок облака тегов стран юзеров
  *
+ * @package blocks
+ * @since 1.0
  */
 class BlockTagsCountry extends Block {
+	/**
+	 * Запуск обработки
+	 */
 	public function Exec() {
+		/**
+		 * Получаем страны
+		 */
 		$aCountries=$this->Geo_GetGroupCountriesByTargetType('user',20);
+		/**
+		 * Формируем облако тегов
+		 */
 		$this->Tools_MakeCloud($aCountries);
-
+		/**
+		 * Выводим в шаблон
+		 */
 		$this->Viewer_Assign("aCountryList",$aCountries);
 	}
 }

classes/blocks/BlockTagsFavouriteTopic.class.php

@@ -18,9 +18,17 @@
 /**
  * Обрабатывает блок облака тегов для избранного
  *
+ * @package blocks
+ * @since 1.0
  */
 class BlockTagsFavouriteTopic extends Block {
+	/**
+	 * Запуск обработки
+	 */
 	public function Exec() {
+		/**
+		 * Пользователь авторизован?
+		 */
 		if ($oUserCurrent = $this->User_getUserCurrent()) {
 			if (!($oUser=$this->getParam('user'))) {
 				$oUser=$oUserCurrent;

classes/blocks/BlockUserfeedBlogs.class.php

@@ -18,9 +18,17 @@
 /**
  * Блок настройки списка блогов в ленте
  *
+ * @package blocks
+ * @since 1.0
  */
 class BlockUserfeedBlogs extends Block {
+	/**
+	 * Запуск обработки
+	 */
 	public function Exec() {
+		/**
+		 * Пользователь авторизован?
+		 */
 		if ($oUserCurrent = $this->User_getUserCurrent()) {
 			$aUserSubscribes = $this->Userfeed_getUserSubscribes($oUserCurrent->getId());
 			/**
@@ -34,7 +42,9 @@ class BlockUserfeedBlogs extends Block {
 			$aBlogsId=array_merge($aBlogsId,$aBlogsOwnerId);
 
 			$aBlogs=$this->Blog_GetBlogsAdditionalData($aBlogsId,array('owner'=>array()),array('blog_title'=>'asc'));
-
+			/**
+			 * Выводим в шаблон
+			 */
 			$this->Viewer_Assign('aUserfeedSubscribedBlogs', $aUserSubscribes['blogs']);
 			$this->Viewer_Assign('aUserfeedBlogs', $aBlogs);
 		}

classes/blocks/BlockUserfeedUsers.class.php

@@ -18,10 +18,21 @@
 /**
  * Блок настройки списка пользователей в ленте
  *
+ * @package blocks
+ * @since 1.0
  */
 class BlockUserfeedUsers extends Block {
+	/**
+	 * Запуск обработки
+	 */
 	public function Exec() {
+		/**
+		 * Пользователь авторизован?
+		 */
 		if ($oUserCurrent = $this->User_getUserCurrent()) {
+			/**
+			 * Получаем необходимые переменные и прогружаем в шаблон
+			 */
 			$aUserSubscribes = $this->Userfeed_getUserSubscribes($oUserCurrent->getId());
 			$aFriends = $this->User_getUsersFriend($oUserCurrent->getId());
 			$this->Viewer_Assign('aUserfeedSubscribedUsers', $aUserSubscribes['users']);

classes/hooks/HookCopyright.class.php

@@ -18,12 +18,21 @@
 /**
  * Регистрация хука для вывода ссылки копирайта
  *
+ * @package hooks
+ * @since 1.0
  */
 class HookCopyright extends Hook {
+	/**
+	 * Регистрируем хуки
+	 */
 	public function RegisterHook() {
 		$this->AddHook('template_copyright','CopyrightLink',__CLASS__,-100);
 	}
-
+	/**
+	 * Обработка хука копирайта
+	 *
+	 * @return string
+	 */
 	public function CopyrightLink() {
 		/**
 		 * Выводим везде, кроме страницы списка блогов и списка всех комментов

classes/hooks/HookMain.class.php

@@ -16,14 +16,21 @@
 */
 
 /**
- * Регистрация хуков
+ * Регистрация основных хуков
  *
+ * @package hooks
+ * @since 1.0
  */
 class HookMain extends Hook {
+	/**
+	 * Регистрируем хуки
+	 */
 	public function RegisterHook() {
 		$this->AddHook('init_action','InitAction',__CLASS__,1000);
 	}
-
+	/**
+	 * Обработка хука инициализации экшенов
+	 */
 	public function InitAction() {
 		/**
 		 * Проверяем наличие директории install

classes/hooks/HookSponsor.class.php

@@ -18,12 +18,21 @@
 /**
  * Регистрация хука для вывода ссылки спонсора релиза
  *
+ * @package hooks
+ * @since 1.0
  */
 class HookSponsor extends Hook {
+	/**
+	 * Регистрируем хуки
+	 */
 	public function RegisterHook() {
 		$this->AddHook('template_copyright','SponsorLink',__CLASS__,-100);
 	}
-
+	/**
+	 * Обработка хука копирайта
+	 *
+	 * @return string
+	 */
 	public function SponsorLink() {
 		/**
 		 * Выводим на странице списка блогов и списка всех комментов

classes/hooks/HookStatisticsPerformance.class.php

@@ -18,24 +18,39 @@
 /**
  * Регистрация хука для вывода статистики производительности
  *
+ * @package hooks
+ * @since 1.0
  */
 class HookStatisticsPerformance extends Hook {
+	/**
+	 * Регистрируем хуки
+	 */
 	public function RegisterHook() {
 		$this->AddHook('template_body_end','Statistics',__CLASS__,-1000);
 	}
-
+	/**
+	 * Обработка хука перед закрывающим тегом body
+	 *
+	 * @return string
+	 */
 	public function Statistics() {
 		$oEngine=Engine::getInstance();
-		
+		/**
+		 * Подсчитываем время выполнения
+		 */
 		$iTimeInit=$oEngine->GetTimeInit();
 		$iTimeFull=round(microtime(true)-$iTimeInit,3);
 		$this->Viewer_Assign('iTimeFullPerformance',$iTimeFull);
-		
+		/**
+		 * Получаем статистику по кешу и БД
+		 */
 		$aStats=$oEngine->getStats();
 		$aStats['cache']['time']=round($aStats['cache']['time'],5);
 		$this->Viewer_Assign('aStatsPerformance',$aStats);
-		
 		$this->Viewer_Assign('bIsShowStatsPerformance',Router::GetIsShowStats());
+		/**
+		 * В ответ рендерим шаблон статистики
+		 */
 		return $this->Viewer_Fetch('statistics_performance.tpl');
 	}
 }