[Fusionforge-commits] FusionForge branch master updated. v6.0.5-1736-gf6f0ee5

Marc-Etienne VARGENAU vargenau at libremir.placard.fr.eu.org
Tue May 2 18:15:38 CEST 2017


This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "FusionForge".

The branch, master has been updated
       via  f6f0ee57d6c7a2f19d75e19cbb54443c81bebd9a (commit)
      from  53e24be23dcee0b38ba6050742fb45a7603a26e8 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
https://scm.fusionforge.org/anonscm/gitweb/?p=fusionforge/fusionforge.git;a=commitdiff;h=f6f0ee57d6c7a2f19d75e19cbb54443c81bebd9a

commit f6f0ee57d6c7a2f19d75e19cbb54443c81bebd9a
Author: Marc-Etienne Vargenau <marc-etienne.vargenau at nokia.com>
Date:   Tue May 2 18:15:10 2017 +0200

    PHP Doc

diff --git a/src/common/docman/Document.class.php b/src/common/docman/Document.class.php
index 61c184b..4d747ae 100644
--- a/src/common/docman/Document.class.php
+++ b/src/common/docman/Document.class.php
@@ -90,9 +90,6 @@ class Document extends FFObject {
 	 * @param	$Group
 	 * @param	bool	$docid
 	 * @param	bool	$arr
-	 * @internal	param	\The $object Group object to which this document is associated.
-	 * @internal	param	\The $int docid.
-	 * @internal	param	\The $array associative array of data.
 	 */
 	function __construct(&$Group, $docid = false, $arr = false) {
 		parent::__construct($docid, get_class());
@@ -621,8 +618,7 @@ class Document extends FFObject {
 	 * isMonitoredBy - get the monitored status of this document for a specific user id.
 	 *
 	 * @param	string	$userid
-	 * @internal	param	\User $int ID
-	 * @return	boolean	true if monitored by this user
+	 * @return	bool	true if monitored by this user
 	 */
 	function isMonitoredBy($userid = 'ALL') {
 		$MonitorElementObject = new MonitorElement('docdata');
@@ -704,9 +700,7 @@ class Document extends FFObject {
 	 * @param	int	$stateLock	the status to be set
 	 * @param	string	$userid		the lock owner
 	 * @param	int	$thistime	the epoch time
-	 * @internal	param	\The $int status of the lock.
-	 * @internal	param	\The $int userid who set the lock.
-	 * @return	boolean	success or not.
+	 * @return	bool	success or not.
 	 */
 	function setLock($stateLock, $userid = NULL, $thistime = 0) {
 		$colArr = array('locked', 'locked_by', 'lockdate');
diff --git a/src/common/docman/DocumentFactory.class.php b/src/common/docman/DocumentFactory.class.php
index d15ae53..f393958 100644
--- a/src/common/docman/DocumentFactory.class.php
+++ b/src/common/docman/DocumentFactory.class.php
@@ -97,7 +97,6 @@ class DocumentFactory extends FFError {
 
 	/**
 	 * @param	$Group
-	 * @internal	param	\The $object Group object to which this DocumentFactory is associated.
 	 */
 	function __construct(&$Group) {
 		parent::__construct();
@@ -298,7 +297,6 @@ class DocumentFactory extends FFError {
 	 * getDocuments - returns an array of Document objects.
 	 *
 	 * @param	int	$nocache	Force to reset the cached data if any available.
-	 * @internal	param	\no $integer cache : force reinit $this->Documents : default: cache is used
 	 * @return	array	Document objects.
 	 * @access	public
 	 */
diff --git a/src/common/docman/DocumentGroup.class.php b/src/common/docman/DocumentGroup.class.php
index 54fcd8e..3567cc8 100644
--- a/src/common/docman/DocumentGroup.class.php
+++ b/src/common/docman/DocumentGroup.class.php
@@ -99,8 +99,6 @@ class DocumentGroup extends FFError {
 	 *
 	 * @param	$Group
 	 * @param	bool	$data
-	 * @internal	param	\Group $object object.
-	 * @internal	param	array $OR doc_group id from database.
 	 */
 	function __construct(&$Group, $data = false) {
 		parent::__construct();
@@ -145,8 +143,7 @@ class DocumentGroup extends FFError {
 	 *							2 = deleted
 	 *							5 = private
 	 * @param	int	$createtimestamp	Timestamp of the directory creation
-	 * @internal	param	\Item $string name.
-	 * @return	boolean	true on success / false on failure.
+	 * @return	bool	true on success / false on failure.
 	 * @access	public
 	 */
 	function create($name, $parent_doc_group = 0, $state = 1, $createtimestamp = null, $forcecreate = false) {
@@ -229,8 +226,7 @@ class DocumentGroup extends FFError {
 	 *
 	 * @param	int	$doc_groupid
 	 * @param	int	$project_group_id
-	 * @internal	param	\Document $integer Group Id, integer Project Group Id
-	 * @return	boolean	success
+	 * @return	bool	success
 	 * @access	public
 	 */
 	function delete($doc_groupid, $project_group_id) {
@@ -421,8 +417,7 @@ class DocumentGroup extends FFError {
 	 * isMonitoredBy - get the monitored status of this document directory for a specific user id.
 	 *
 	 * @param	string	$userid
-	 * @internal	param	\User $int ID
-	 * @return	boolean	true if monitored by this user
+	 * @return	bool	true if monitored by this user
 	 */
 	function isMonitoredBy($userid = 'ALL') {
 		$MonitorElementObject = new MonitorElement('docgroup');
@@ -560,10 +555,7 @@ class DocumentGroup extends FFError {
 	 * @param	array	$nested_groups
 	 * @param	object	$document_factory
 	 * @param	int	$stateid
-	 * @internal	param	Array $array of nested groups information, fetched from DocumentGroupFactory class
-	 * @internal	param	\The $object DocumentFactory object
-	 * @internal	param	int $State of the documents
-	 * @return	boolean	success
+	 * @return	bool	success
 	 * @access	public
 	 */
 	function hasDocuments(&$nested_groups, &$document_factory, $stateid = 0) {
@@ -990,9 +982,7 @@ class DocumentGroup extends FFError {
 	 * @param	int	$stateLock	the status to be set
 	 * @param	string	$userid		the lock owner
 	 * @param	int	$thistime	the epoch time
-	 * @internal	param	\The $int status of the lock.
-	 * @internal	param	\The $int userid who set the lock.
-	 * @return	boolean	success or not.
+	 * @return	bool	success or not.
 	 */
 	function setLock($stateLock, $userid = NULL, $thistime = 0) {
 		$colArr = array('locked', 'locked_by', 'lockdate');
diff --git a/src/common/docman/DocumentManager.class.php b/src/common/docman/DocumentManager.class.php
index 9f4aa86..94c8777 100644
--- a/src/common/docman/DocumentManager.class.php
+++ b/src/common/docman/DocumentManager.class.php
@@ -46,7 +46,6 @@ class DocumentManager extends FFError {
 
 	/**
 	 * @param	$Group
-	 * @internal	param	\The $object Group object to which this document is associated.
 	 */
 	function __construct(&$Group) {
 		parent::__construct();
diff --git a/src/common/docman/DocumentReviewFactory.class.php b/src/common/docman/DocumentReviewFactory.class.php
index ffa73bb..ee1e126 100644
--- a/src/common/docman/DocumentReviewFactory.class.php
+++ b/src/common/docman/DocumentReviewFactory.class.php
@@ -39,7 +39,6 @@ class DocumentReviewFactory extends FFError {
 
 	/**
 	 * @param	$Document
-	 * @internal	param		\The $object Document object to which this review factory is associated.
 	 */
 	function __construct(&$Document) {
 		parent::__construct();
diff --git a/src/common/docman/DocumentVersion.class.php b/src/common/docman/DocumentVersion.class.php
index d0840ea..b6a23d6 100644
--- a/src/common/docman/DocumentVersion.class.php
+++ b/src/common/docman/DocumentVersion.class.php
@@ -74,19 +74,16 @@ class DocumentVersion extends FFError {
 	 * @param	$Document
 	 * @param	bool			$verid
 	 * @param	bool			$arr
-	 * @internal	param			\The $object Document object to which this version is associated.
-	 * @internal	param			\The $int verid.
-	 * @internal	param			\The $array associative array of data.
 	 */
 	function __construct(&$Document, $verid = false, $arr = false) {
 		parent::__construct();
 		if (!$Document || !is_object($Document)) {
 			$this->setError(_('No Valid Document Object'));
-			return false;
+			return;
 		}
 		if ($Document->isError()) {
 			$this->setError(_('Document Version')._(': ').$Document->getErrorMessage());
-			return false;
+			return;
 		}
 		$this->Document =& $Document;
 		if ($verid) {
diff --git a/src/common/docman/DocumentVersionFactory.class.php b/src/common/docman/DocumentVersionFactory.class.php
index 32964f3..9f76343 100644
--- a/src/common/docman/DocumentVersionFactory.class.php
+++ b/src/common/docman/DocumentVersionFactory.class.php
@@ -34,7 +34,6 @@ class DocumentVersionFactory extends FFError {
 
 	/**
 	 * @param	$Document
-	 * @internal	param		\The $object Document object to which this version factory is associated.
 	 */
 	function __construct(&$Document) {
 		parent::__construct();
diff --git a/src/common/forum/Forum.class.php b/src/common/forum/Forum.class.php
index 5d680ec..847a817 100644
--- a/src/common/forum/Forum.class.php
+++ b/src/common/forum/Forum.class.php
@@ -97,9 +97,6 @@ class Forum extends FFError {
 	 * @param	$Group
 	 * @param	bool	$group_forum_id
 	 * @param	bool	$arr
-	 * @internal	param	\The $object Group object to which this forum is associated.
-	 * @internal	param	\The $int group_forum_id.
-	 * @internal	param	\The $array associative array of data.
 	 */
 	function __construct(&$Group, $group_forum_id = false, $arr = false, $is_news = false) {
 		parent::__construct();
diff --git a/src/common/forum/ForumFactory.class.php b/src/common/forum/ForumFactory.class.php
index c35db7d..28eeeeb 100644
--- a/src/common/forum/ForumFactory.class.php
+++ b/src/common/forum/ForumFactory.class.php
@@ -169,9 +169,6 @@ class ForumFactory extends FFError {
 	 * @param	$group_forum_id
 	 * @param	$thread_id
 	 * @param	bool $old_forum_id
-	 * @internal	param \The $string forum ID
-	 * @internal	param \The $int thread_id of the tread to change.
-	 * @internal	param \The $string old forum ID
 	 *
 	 * Note: old forum ID is useless if forum_agg_msg_count table is no longer used
 	 *
diff --git a/src/common/frs/FRSPackage.class.php b/src/common/frs/FRSPackage.class.php
index 7f99729..ab93f33 100644
--- a/src/common/frs/FRSPackage.class.php
+++ b/src/common/frs/FRSPackage.class.php
@@ -111,9 +111,6 @@ class FRSPackage extends FFError {
 	 * @param	$Group
 	 * @param	bool	$package_id
 	 * @param	bool	$arr
-	 * @internal	param	\The $object Group object to which this FRSPackage is associated.
-	 * @internal	param	\The $int package_id.
-	 * @internal	param	\The $array associative array of data.
 	 */
 	function __construct(&$Group, $package_id = false, $arr = false) {
 		parent::__construct();
@@ -150,7 +147,6 @@ class FRSPackage extends FFError {
 	 * create - create a new FRSPackage in the database.
 	 *
 	 * @param	$name
-	 * @internal	param	\The $string name of this package.
 	 * @return	boolean	success.
 	 */
 	function create($name) {
@@ -503,9 +499,9 @@ class FRSPackage extends FFError {
 	/**
 	 * delete - delete this package and all its related data.
 	 *
-	 * @param	bool	I'm Sure.
-	 * @param	bool	I'm REALLY sure.
-	 * @return	bool	true/false;
+	 * @param	bool	$sure		I'm Sure.
+	 * @param	bool	$really_sure	I'm REALLY sure.
+	 * @return	bool
 	 */
 	function delete($sure, $really_sure) {
 		if (!$sure || !$really_sure) {
diff --git a/src/common/mail/MailingList.class.php b/src/common/mail/MailingList.class.php
index 80b7d5f..603dad9 100644
--- a/src/common/mail/MailingList.class.php
+++ b/src/common/mail/MailingList.class.php
@@ -53,9 +53,6 @@ class MailingList extends FFError {
 	 * @param	$Group
 	 * @param	bool	$groupListId
 	 * @param	bool	$dataArray
-	 * @internal	param	\The $object Group object to which this mailing list is associated.
-	 * @internal	param	\The $int group_list_id.
-	 * @internal	param	\The $array associative array of data.
 	 */
 	function __construct(&$Group, $groupListId = false, $dataArray = false) {
 		parent::__construct();
@@ -102,13 +99,10 @@ class MailingList extends FFError {
 	 * @param	$description
 	 * @param	string		$isPublic
 	 * @param	bool		$creator_id
-	 * @param	int		$is_external Pass (1) if it should be public (0) for private.
-	 *
-	 * @internal	param		\The $string name of the mailing list
-	 * @internal	param		\The $string description of the mailing list
-	 * @return	boolean		success.
+	 * @param	int			$is_external Pass (1) if it should be public (0) for private.
+	 * @return	bool		success.
 	 */
-	function create($listName, $description, $isPublic = MAIL__MAILING_LIST_IS_PUBLIC,$creator_id=false, $is_external=0) {
+	function create($listName, $description, $isPublic = MAIL__MAILING_LIST_IS_PUBLIC, $creator_id = false, $is_external = 0) {
 		//
 		//	During the group creation, the current user_id will not match the admin's id
 		//
@@ -140,7 +134,7 @@ class MailingList extends FFError {
 		}
 
 		$result = db_query_params ('SELECT 1 FROM mail_group_list WHERE lower(list_name)=$1',
-					   array ($realListName)) ;
+					   array ($realListName));
 
 		if (db_numrows($result) > 0) {
 			$this->setError(_('List Already Exists'));
@@ -149,7 +143,7 @@ class MailingList extends FFError {
 
 		$result_forum_samename = db_query_params ('SELECT 1 FROM forum_group_list WHERE forum_name=$1 AND group_id=$2',
 							  array ($listName,
-								 $this->Group->getID())) ;
+								 $this->Group->getID()));
 
 		if (db_numrows($result_forum_samename) > 0){
 			$this->setError(_('Forum exists with the same name'));
@@ -228,7 +222,7 @@ class MailingList extends FFError {
 	function fetchData($groupListId) {
 		$res = db_query_params ('SELECT * FROM mail_group_list WHERE group_list_id=$1 AND group_id=$2',
 					array ($groupListId,
-					       $this->Group->getID())) ;
+					       $this->Group->getID()));
 		if (!$res || db_numrows($res) < 1) {
 			$this->setError(_('Error Getting mailing list'));
 			return false;
@@ -264,7 +258,7 @@ class MailingList extends FFError {
 					       $description,
 					       $status,
 					       $this->groupMailingListId,
-					       $this->Group->getID())) ;
+					       $this->Group->getID()));
 
 		if (!$res || db_affected_rows($res) < 1) {
 			$this->setError(_('Error On Update')._(': ').db_error());
@@ -419,13 +413,13 @@ class MailingList extends FFError {
 		$res = db_query_params ('INSERT INTO deleted_mailing_lists (mailing_list_name,delete_date,isdeleted) VALUES ($1,$2,$3)',
 					array ($this->getName(),
 					       time(),
-					       0)) ;
+					       0));
 		if (!$res) {
 			$this->setError('Could Not Insert Into Delete Queue: '.db_error());
 			return false;
 		}
 		$res = db_query_params ('DELETE FROM mail_group_list WHERE group_list_id=$1',
-					array ($this->getID())) ;
+					array ($this->getID()));
 		if (!$res) {
 			$this->setError('Could Not Delete List: '.db_error());
 			return false;
diff --git a/src/common/pm/ProjectGroup.class.php b/src/common/pm/ProjectGroup.class.php
index d40bdc6..5c9e1bd 100644
--- a/src/common/pm/ProjectGroup.class.php
+++ b/src/common/pm/ProjectGroup.class.php
@@ -90,9 +90,6 @@ class ProjectGroup extends FFError {
 	 * @param	$Group
 	 * @param	bool	$group_project_id
 	 * @param	bool	$arr
-	 * @internal	param	\The $object Group object to which this forum is associated.
-	 * @internal	param	\The $int group_project_id.
-	 * @internal	param	\The $array associative array of data.
 	 */
 	function __construct(&$Group, $group_project_id = false, $arr = false) {
 		parent::__construct();
diff --git a/src/common/survey/Survey.class.php b/src/common/survey/Survey.class.php
index 75334e0..e5f0310 100644
--- a/src/common/survey/Survey.class.php
+++ b/src/common/survey/Survey.class.php
@@ -90,9 +90,6 @@ class Survey extends FFError {
 	 * @param	$Group
 	 * @param	bool	$survey_id
 	 * @param	bool	$arr
-	 * @internal	param	\The $object Group object to which this survey is associated.
-	 * @internal	param	\The $int survey_id.
-	 * @internal	param	\The $array associative array of data.
 	 */
 	function __construct(&$Group, $survey_id = false, $arr = false) {
 		parent::__construct();
@@ -130,13 +127,7 @@ class Survey extends FFError {
 	 * @param	int		$is_active 1: Active, 0: Inactive
 	 * @param	int		$is_result_public
 	 * @param	Allow|int	$double_vote
-	 * @internal	param		\The $string survey title
-	 * @internal	param		array	$int The question numbers to be added
-	 * @internal	param		$is_active 1: Active, 0: Inactive
-	 * For future options
-	 * @internal	param		$is_result_public 0: Admins Only, 1: Group Members, 2: FusionForge user, 3:voted user 4:Every body
-	 * @internal	param		\Allow $double_vote double vote if it is 1
-	 * @return boolean success.
+	 * @return	bool	success.
 	 */
 	function create($survey_title, $add_questions, $is_active = 0, $is_public = 1, $is_result_public = 0, $double_vote = 0) {
 		if (!$survey_title) {
@@ -178,13 +169,7 @@ class Survey extends FFError {
 	 * @param	int		$is_active 1: Active, 0: Inactive
 	 * @param	int		$is_result_public
 	 * @param	Allow|int	$double_vote
-	 * @internal	param		\The $string survey title
-	 * @internal	param		array $int The question numbers to be added
-	 * @internal	param		array $int The question numbers to be deleted
-	 * @internal	param		$is_active 1: Active, 0: Inactive
-	 * @internal	param		$is_result_public 0: Admins Only, 1: Group Members, 2: FusionForge user, 3:voted user 4:Every body
-	 * @internal	param		\Allow $double_vote double vote if it is 1
-	 * @return	boolean		success.
+	 * @return	bool		success.
 	 */
 	function update($survey_title, &$add_questions, &$del_questions, $is_active = 0, $is_public = 1, $is_result_public = 0, $double_vote = 0) {
 		if (!$survey_title) {
diff --git a/src/common/survey/SurveyQuestion.class.php b/src/common/survey/SurveyQuestion.class.php
index 5565a3b..84bb6ff 100644
--- a/src/common/survey/SurveyQuestion.class.php
+++ b/src/common/survey/SurveyQuestion.class.php
@@ -44,9 +44,6 @@ class SurveyQuestion extends FFError {
 	 * @param	$Group
 	 * @param	bool	$question_id
 	 * @param	bool	$arr
-	 * @internal	param	\The $object Group object to which this Survey Question is associated.
-	 * @internal	param	\The $int question_id.
-	 * @internal	param	\The $array associative array of data.
 	 */
 	function __construct(&$Group, $question_id = false, $arr = false) {
 		parent::__construct();
diff --git a/src/common/survey/SurveyResponse.class.php b/src/common/survey/SurveyResponse.class.php
index e7e65b7..82d1bbe 100644
--- a/src/common/survey/SurveyResponse.class.php
+++ b/src/common/survey/SurveyResponse.class.php
@@ -42,9 +42,6 @@ class SurveyResponse extends FFError {
 	/**
 	 * @param	$Group
 	 * @param	bool	$arr
-	 * @internal	param	\The $object Group object to which this Survey Response is associated.
-	 * @internal	param	\The $int question_id.
-	 * @internal	param	\The $array associative array of data.
 	 */
 	function __construct(&$Group, $arr=false) {
 		parent::__construct();
@@ -70,15 +67,7 @@ class SurveyResponse extends FFError {
 	 * @param	$survey_id
 	 * @param	$question_id
 	 * @param	$response
-	 * @internal	param		\The $string question
-	 * @internal	param		\The $int question type
-	 *				1: Radio Buttons 1-5
-	 *				2: Text Area
-	 *				3: Radio Buttons Yes/No
-	 *				4: Comment Only
-	 *				5: Text Field
-	 *				6: None
-	 * @return	boolean		success.
+	 * @return	bool		success.
 	 */
 	function create($user_id, $survey_id, $question_id, $response) {
 		$res = db_query_params ('INSERT INTO survey_responses (user_id,group_id,survey_id,question_id,response,post_date) VALUES ($1,$2,$3,$4,$5,$6)',

-----------------------------------------------------------------------

Summary of changes:
 src/common/docman/Document.class.php               | 10 ++-------
 src/common/docman/DocumentFactory.class.php        |  2 --
 src/common/docman/DocumentGroup.class.php          | 20 +++++-------------
 src/common/docman/DocumentManager.class.php        |  1 -
 src/common/docman/DocumentReviewFactory.class.php  |  1 -
 src/common/docman/DocumentVersion.class.php        |  7 ++-----
 src/common/docman/DocumentVersionFactory.class.php |  1 -
 src/common/forum/Forum.class.php                   |  3 ---
 src/common/forum/ForumFactory.class.php            |  3 ---
 src/common/frs/FRSPackage.class.php                | 10 +++------
 src/common/mail/MailingList.class.php              | 24 ++++++++--------------
 src/common/pm/ProjectGroup.class.php               |  3 ---
 src/common/survey/Survey.class.php                 | 19 ++---------------
 src/common/survey/SurveyQuestion.class.php         |  3 ---
 src/common/survey/SurveyResponse.class.php         | 13 +-----------
 15 files changed, 24 insertions(+), 96 deletions(-)


hooks/post-receive
-- 
FusionForge



More information about the Fusionforge-commits mailing list