[Fusionforge-commits] r18395 - in trunk/src/www: search/include/renderers survey/include themes/funky themes/gforge trove

Marc-Etienne VARGENAU vargenau at fusionforge.org
Tue Nov 5 21:44:51 CET 2013


Author: vargenau
Date: 2013-11-05 21:44:51 +0100 (Tue, 05 Nov 2013)
New Revision: 18395

Modified:
   trunk/src/www/search/include/renderers/AdvancedSearchHtmlSearchRenderer.class.php
   trunk/src/www/search/include/renderers/DocsAllHtmlSearchRenderer.class.php
   trunk/src/www/search/include/renderers/DocsHtmlSearchRenderer.class.php
   trunk/src/www/search/include/renderers/FrsHtmlSearchRenderer.class.php
   trunk/src/www/search/include/renderers/FullProjectHtmlSearchRenderer.class.php
   trunk/src/www/search/include/renderers/NewsHtmlSearchRenderer.class.php
   trunk/src/www/search/include/renderers/RssSearchRenderer.class.php
   trunk/src/www/search/include/renderers/TasksHtmlSearchRenderer.class.php
   trunk/src/www/search/include/renderers/TrackersHtmlSearchRenderer.class.php
   trunk/src/www/survey/include/SurveyHTML.class.php
   trunk/src/www/themes/funky/Theme.class.php
   trunk/src/www/themes/gforge/Theme.class.php
   trunk/src/www/trove/TroveCategory.class.php
Log:
Update PHP Doc

Modified: trunk/src/www/search/include/renderers/AdvancedSearchHtmlSearchRenderer.class.php
===================================================================
--- trunk/src/www/search/include/renderers/AdvancedSearchHtmlSearchRenderer.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/search/include/renderers/AdvancedSearchHtmlSearchRenderer.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -173,6 +173,9 @@
 	/**
 	* getPartResult - returns the result of the given renderer
 	*
+	* @param object $renderer
+	* @param string $section
+	* @param string $title
   	* @return string result of the renderer
 	*/
 	function getPartResult($renderer, $section, $title='') {

Modified: trunk/src/www/search/include/renderers/DocsAllHtmlSearchRenderer.class.php
===================================================================
--- trunk/src/www/search/include/renderers/DocsAllHtmlSearchRenderer.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/search/include/renderers/DocsAllHtmlSearchRenderer.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -36,7 +36,7 @@
 	 * @param	string	$words words we are searching for
 	 * @param	int	$offset offset
 	 * @param	boolean	$isExact if we want to search for all the words or if only one matching the query is sufficient
-	 * @param	array	$sections array of all sections to search in (array of strings)
+	 * @param	array|string	$sections array of all sections to search in (array of strings)
 	 *
 	 */
 	function DocsAllHtmlSearchRenderer($words, $offset, $isExact, $sections = SEARCH__ALL_SECTIONS) {

Modified: trunk/src/www/search/include/renderers/DocsHtmlSearchRenderer.class.php
===================================================================
--- trunk/src/www/search/include/renderers/DocsHtmlSearchRenderer.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/search/include/renderers/DocsHtmlSearchRenderer.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -37,7 +37,7 @@
 	 * @param int $offset offset
 	 * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
 	 * @param int $groupId group id
-	 * @param array $sections array of all sections to search in (array of strings)
+	 * @param array|string $sections array of all sections to search in (array of strings)
 	 *
 	 */
 	function DocsHtmlSearchRenderer($words, $offset, $isExact, $groupId, $sections=SEARCH__ALL_SECTIONS) {
@@ -99,6 +99,7 @@
 	/**
 	 * getSections - get the array of possible sections to search in
 	 *
+	 * @param int $groupId
   	 * @return array sections
 	 */
 	static function getSections($groupId) {

Modified: trunk/src/www/search/include/renderers/FrsHtmlSearchRenderer.class.php
===================================================================
--- trunk/src/www/search/include/renderers/FrsHtmlSearchRenderer.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/search/include/renderers/FrsHtmlSearchRenderer.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -33,7 +33,7 @@
 	 * @param int $offset offset
 	 * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
 	 * @param int $groupId group id
-	 * @param array $sections array of all sections to search in (array of strings)
+	 * @param array|string $sections array of all sections to search in (array of strings)
 	 *
 	 */
 	function FrsHtmlSearchRenderer($words, $offset, $isExact, $groupId, $sections=SEARCH__ALL_SECTIONS) {
@@ -85,6 +85,7 @@
 	/**
 	 * getSections - get the array of possible sections to search in
 	 *
+	 * @param int $groupId
   	 * @return array sections
 	 */
 	static function getSections($groupId) {

Modified: trunk/src/www/search/include/renderers/FullProjectHtmlSearchRenderer.class.php
===================================================================
--- trunk/src/www/search/include/renderers/FullProjectHtmlSearchRenderer.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/search/include/renderers/FullProjectHtmlSearchRenderer.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -202,6 +202,9 @@
 	/**
 	* getPartResult - returns the result of the given renderer
 	*
+	* @param object $renderer
+	* @param int $section
+	* @param string $title
   	* @return string result of the renderer
 	*/
 	function getPartResult($renderer, $section, $title='') {

Modified: trunk/src/www/search/include/renderers/NewsHtmlSearchRenderer.class.php
===================================================================
--- trunk/src/www/search/include/renderers/NewsHtmlSearchRenderer.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/search/include/renderers/NewsHtmlSearchRenderer.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -34,7 +34,6 @@
 	 * @param int $offset offset
 	 * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
 	 * @param int $groupId group id
-	 * @param array $sections array of all sections to search in (array of strings)
 	 *
 	 */
 	function NewsHtmlSearchRenderer($words, $offset, $isExact, $groupId) {
@@ -76,6 +75,7 @@
 	/**
 	 * getSections - get the array of possible sections to search in
 	 *
+	 * @param int $groupId
 	 * @return array sections
 	 */
 	static function getSections($groupId) {

Modified: trunk/src/www/search/include/renderers/RssSearchRenderer.class.php
===================================================================
--- trunk/src/www/search/include/renderers/RssSearchRenderer.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/search/include/renderers/RssSearchRenderer.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -38,7 +38,6 @@
 	 *
 	 * @param string $typeOfSearch type of the search (Software, Forum, People and so on)
 	 * @param string $words words we are searching for
-	 * @param int $offset offset
 	 * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
 	 * @param object $searchQuery SearchQuery instance
 	 */

Modified: trunk/src/www/search/include/renderers/TasksHtmlSearchRenderer.class.php
===================================================================
--- trunk/src/www/search/include/renderers/TasksHtmlSearchRenderer.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/search/include/renderers/TasksHtmlSearchRenderer.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -33,7 +33,7 @@
 	 * @param int $offset offset
 	 * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
 	 * @param int $groupId group id
-	 * @param array $sections array of all sections to search in (array of strings)
+	 * @param array|string $sections array of all sections to search in (array of strings)
 	 *
 	 */
 	function TasksHtmlSearchRenderer($words, $offset, $isExact, $groupId, $sections=SEARCH__ALL_SECTIONS) {
@@ -121,6 +121,7 @@
 	/**
 	 * getSections - get the array of possible sections to search in
 	 *
+	 * @param int $groupId group id
   	 * @return array sections
 	 */
 	static function getSections($groupId) {

Modified: trunk/src/www/search/include/renderers/TrackersHtmlSearchRenderer.class.php
===================================================================
--- trunk/src/www/search/include/renderers/TrackersHtmlSearchRenderer.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/search/include/renderers/TrackersHtmlSearchRenderer.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -33,7 +33,7 @@
 	 * @param int $offset offset
 	 * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
 	 * @param int $groupId group id
-	 * @param array $sections array of all sections to search in (array of strings)
+	 * @param array|string $sections array of all sections to search in (array of strings)
 	 *
 	 */
 	function TrackersHtmlSearchRenderer($words, $offset, $isExact, $groupId, $sections=SEARCH__ALL_SECTIONS) {
@@ -115,6 +115,7 @@
 	/**
 	 * getSections - get the array of possible sections to search in
 	 *
+	 * @param int $groupId group id
   	 * @return array sections
 	 */
 	static function getSections($groupId) {

Modified: trunk/src/www/survey/include/SurveyHTML.class.php
===================================================================
--- trunk/src/www/survey/include/SurveyHTML.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/survey/include/SurveyHTML.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -562,9 +562,13 @@
 	/**
 	 * Show survey Result
 	 *
-	 *    @param Object a Survey Response Factory
+	 *	@param object $sr a Survey Response Factory
+	 *	@param int $show_comment
+	 *	@param string $q_num
+	 *	@param int $show_graph
+	 *	@return string
 	 */
-	function showResult( &$sr, $show_comment=0, $q_num="", $show_graph=0) {
+	function showResult(&$sr, $show_comment=0, $q_num="", $show_graph=0) {
 		global $group_id;
 
 		$Survey = $sr->getSurvey();
@@ -710,8 +714,11 @@
 	/**
 	 * _makeBar - make Precentage bar as a cell in a table. Starts with <tr> and ends with </tr>
 	 *
-	 * @param String name Name
-	 * @param int percentage of the name
+	 * @param $name
+	 * @param $percent
+	 * @param $color
+	 * @internal param \name $String Name
+	 * @internal param \percentage $int of the name
 	 * @return string
 	 */
 	function _makeBar($name, $percent, $color) {

Modified: trunk/src/www/themes/funky/Theme.class.php
===================================================================
--- trunk/src/www/themes/funky/Theme.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/themes/funky/Theme.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -147,6 +147,7 @@
 	 *
 	 * @param	string	$title	Box title
 	 * @param	string	$id
+	 * @return	string
 	 */
 	function boxTop($title, $id = '') {
 		if ($id) {
@@ -174,6 +175,7 @@
 	 *
 	 * @param	string	$title	Box title
 	 * @param	string	$id
+	 * @return	string
 	 */
 	function boxMiddle($title, $id = '') {
 		if ($id) {
@@ -193,6 +195,7 @@
 	 *
 	 * @param	string	$content	Box content
 	 * @param	string	$id
+	 * @return	string
 	 */
 	function boxContent($content, $id = '') {
 		if ($id) {
@@ -209,6 +212,7 @@
 	/**
 	 * boxBottom() - Bottom HTML box
 	 *
+	 * @return	string
 	 */
 	function boxBottom() {
 		$t_result='</div><!-- class="box-surround" -->';
@@ -220,6 +224,7 @@
 	 * boxGetAltRowStyle() - Get an alternating row style for tables
 	 *
 	 * @param	int	$i	Row number
+	 * @return	string
 	 */
 	function boxGetAltRowStyle($i) 	{
 		if ($i % 2 == 0)
@@ -351,7 +356,7 @@
 	 * @param	array	$attr_arr	The array of attributes by link
 	 * @return	string	Html to build a submenu.
 	 */
-	function subMenu($title_arr, $links_arr, $attr_arr = false) {
+	function subMenu($title_arr, $links_arr, $attr_arr = array()) {
 		$return  = $this->beginSubMenu();
 		$return .= $this->printSubMenu($title_arr, $links_arr, $attr_arr);
 		$return .= $this->endSubMenu();

Modified: trunk/src/www/themes/gforge/Theme.class.php
===================================================================
--- trunk/src/www/themes/gforge/Theme.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/themes/gforge/Theme.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -221,6 +221,7 @@
 	 * boxGetAltRowStyle() - Get an alternating row style for tables
 	 *
 	 * @param	int	$i	Row number
+	 * @return	string
 	 */
 	function boxGetAltRowStyle($i) {
 		if ($i % 2 == 0) {
@@ -399,7 +400,7 @@
 	 * @param	array	$attr_arr	The array of the html attributes.
 	 * @return	string	Html to build a submenu.
 	 */
-	function subMenu($title_arr, $links_arr, $attr_arr = false) {
+	function subMenu($title_arr, $links_arr, $attr_arr = array()) {
 		$return  = $this->beginSubMenu();
 		$return .= $this->printSubMenu($title_arr, $links_arr, $attr_arr);
 		$return .= $this->endSubMenu();
@@ -416,6 +417,7 @@
 	 *					the bgcolor for the title here, that will be
 	 *					handled by $istitle
 	 * @param	bool	$istitle	is this row part of the title ?
+	 * @return	string	Html
 	 *
 	 */
 	function multiTableRow($row_attr, $cell_data, $istitle) {

Modified: trunk/src/www/trove/TroveCategory.class.php
===================================================================
--- trunk/src/www/trove/TroveCategory.class.php	2013-11-05 19:37:29 UTC (rev 18394)
+++ trunk/src/www/trove/TroveCategory.class.php	2013-11-05 20:44:51 UTC (rev 18395)
@@ -51,9 +51,9 @@
 	/**
 	 *  Constructor.
 	 *
-	 * @param	int		$categoryId		The trove_cat_id.
-	 * @param	array	$dataArray		The associative array of data.
-	 * @return	boolean	success.
+	 * @param	bool|int			$categoryId		The trove_cat_id.
+	 * @param	bool|array	$dataArray		The associative array of data.
+	 * @return	bool	success.
 	 */
 	function TroveCategory($categoryId = false, $dataArray = false) {
 		if ($categoryId) {




More information about the Fusionforge-commits mailing list