[Fusionforge-commits] FusionForge branch master updated. ae3dfdbee573c5e494bf14f6c38de9e100e8c5e8

Franck VILLAUME nerville at fusionforge.org
Sat Jan 25 19:17:26 CET 2014


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  ae3dfdbee573c5e494bf14f6c38de9e100e8c5e8 (commit)
      from  dc26ef996ab1bd6532307c6a58240a73842ab877 (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 -----------------------------------------------------------------
commit ae3dfdbee573c5e494bf14f6c38de9e100e8c5e8
Author: Franck Villaume <franck.villaume at trivialdev.com>
Date:   Sat Jan 25 19:16:59 2014 +0100

    docman: indent, php doc

diff --git a/src/common/docman/Document.class.php b/src/common/docman/Document.class.php
index aa261b6..7b914f6 100644
--- a/src/common/docman/Document.class.php
+++ b/src/common/docman/Document.class.php
@@ -6,7 +6,7 @@
  * Copyright 2002-2003, Tim Perdue/GForge, LLC
  * Copyright 2009, Roland Mas
  * Copyright 2010-2011, Franck Villaume - Capgemini
- * Copyright 2011-2013, Franck Villaume - TrivialDev
+ * Copyright 2011-2014, Franck Villaume - TrivialDev
  * Copyright (C) 2011-2012 Alain Peyrat - Alcatel-Lucent
  * http://fusionforge.org
  *
@@ -430,7 +430,7 @@ class Document extends Error {
 	/**
 	 * getFileData - the filedata of this document.
 	 *
-	 * @param	boolean	update the download flag or not. default is true
+	 * @param	boolean	$download	update the download flag or not. default is true
 	 * @return	string	The filedata.
 	 */
 	function getFileData($download = true) {
@@ -579,7 +579,7 @@ class Document extends Error {
 	/**
 	 * removeMonitoredBy - remove this document for a specific user id for monitoring.
 	 *
-	 * @param	int	User ID
+	 * @param	int	$userid	User ID
 	 * @return	boolean	true if success
 	 */
 	function removeMonitoredBy($userid) {
@@ -596,7 +596,7 @@ class Document extends Error {
 	/**
 	 * addMonitoredBy - add this document for a specific user id for monitoring.
 	 *
-	 * @param	int	User ID
+	 * @param	int	$userid	User ID
 	 * @return	boolean	true if success
 	 */
 	function addMonitoredBy($userid) {
@@ -633,7 +633,7 @@ class Document extends Error {
 	/**
 	 * setState - set the stateid of the document.
 	 *
-	 * @param	int	The state id of the doc_states table.
+	 * @param	int	$stateid	The state id of the doc_states table.
 	 * @return	boolean	success or not.
 	 */
 	function setState($stateid) {
@@ -644,7 +644,7 @@ class Document extends Error {
 	/**
 	 * setDocGroupID - set the doc_group of the document.
 	 *
-	 * @param	int	The group_id of this document.
+	 * @param	int	$newdocgroupid	The group_id of this document.
 	 * @return	boolean	success or not.
 	 */
 	function setDocGroupID($newdocgroupid) {
@@ -654,12 +654,12 @@ class Document extends Error {
 	/**
 	 * setLock - set the locking status of the document.
 	 *
-	 * @param	$stateLock
-	 * @param	time		the epoch time.
-	 * @param	int		$thistime
-	 * @internal	param		\The $int status of the lock.
-	 * @internal	param		\The $int userid who set the lock.
-	 * @return	boolean		success or not.
+	 * @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.
 	 */
 	function setLock($stateLock, $userid = NULL, $thistime = 0) {
 		$res = db_query_params('UPDATE doc_data SET
diff --git a/src/common/docman/DocumentFactory.class.php b/src/common/docman/DocumentFactory.class.php
index 93399e9..bbc165a 100644
--- a/src/common/docman/DocumentFactory.class.php
+++ b/src/common/docman/DocumentFactory.class.php
@@ -7,7 +7,7 @@
  * Copyright 2009, Roland Mas
  * Copyright 2010-2011, Franck Villaume - Capgemini
  * Copyright (C) 2012 Alain Peyrat - Alcatel-Lucent
- * Copyright 2012-2013, Franck Villaume - TrivialDev
+ * Copyright 2012-2014, Franck Villaume - TrivialDev
  * http://fusionforge.org
  *
  * This file is part of FusionForge. FusionForge is free software;
@@ -252,7 +252,7 @@ class DocumentFactory extends Error {
 	 * setLimit - call this before getDocuments() if you want to limit number of documents retrieve.
 	 * default value is 0 which means : no limit.
 	 *
-	 * @param	int	$limit The limit of documents
+	 * @param	int	$limit	The limit of documents
 	 * @access	public
 	 */
 	function setLimit($limit) {
@@ -262,7 +262,7 @@ class DocumentFactory extends Error {
 	/**
 	 * getDocuments - returns an array of Document objects.
 	 *
-	 * @param	int	$nocache
+	 * @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 af194f8..20db449 100644
--- a/src/common/docman/DocumentGroup.class.php
+++ b/src/common/docman/DocumentGroup.class.php
@@ -7,7 +7,7 @@
  * Copyright 2009, Roland Mas
  * Copyright 2010, Franck Villaume - Capgemini
  * Copyright (C) 2011-2012 Alain Peyrat - Alcatel-Lucent
- * Copyright 2012-2013, Franck Villaume - TrivialDev
+ * Copyright 2012-2014, Franck Villaume - TrivialDev
  * http://fusionforge.org
  *
  * This file is part of FusionForge. FusionForge is free software;
@@ -87,8 +87,8 @@ class DocumentGroup extends Error {
 	/**
 	 * create - create a new item in the database.
 	 *
-	 * @param	$name
-	 * @param	int	$parent_doc_group
+	 * @param	string	$name			The name of the directory to create
+	 * @param	int	$parent_doc_group	The ID of the parent directory
 	 * @internal	param	\Item $string name.
 	 * @return	boolean	true on success / false on failure.
 	 * @access	public
@@ -168,10 +168,10 @@ class DocumentGroup extends Error {
 	 * delete - delete a DocumentGroup.
 	 * WARNING delete is recursive and permanent
 	 *
-	 * @param	$doc_groupid
-	 * @param	$project_group_id
-	 * @internal	param		\Document $integer Group Id, integer Project Group Id
-	 * @return	boolean		success
+	 * @param	int	$doc_groupid
+	 * @param	int	$project_group_id
+	 * @internal	param	\Document $integer Group Id, integer Project Group Id
+	 * @return	boolean	success
 	 * @access	public
 	 */
 	function delete($doc_groupid, $project_group_id) {
@@ -416,7 +416,7 @@ class DocumentGroup extends Error {
 	/**
 	 * addMonitoredBy - add this document for a specific user id for monitoring.
 	 *
-	 * @param	int	User ID
+	 * @param	int	$userid	User ID
 	 * @return	boolean	true if success
 	 */
 	function addMonitoredBy($userid) {
@@ -463,9 +463,9 @@ class DocumentGroup extends Error {
 	/**
 	 * update - update a DocumentGroup.
 	 *
-	 * @param	string	Name of the category.
-	 * @param	integer	the doc_group id of the parent. default = 0
-	 * @param	integer	update only the metadata : created_by, updatedate
+	 * @param	string	$name			Name of the category.
+	 * @param	int	$parent_doc_group	the doc_group id of the parent. default = 0
+	 * @param	int	$metadata		update only the metadata : created_by, updatedate
 	 * @return	boolean	success or not
 	 * @access	public
 	 */
@@ -533,13 +533,13 @@ class DocumentGroup extends Error {
 	 * A group has associated documents if and only if there are documents associated to this
 	 * group or to any of its childs
 	 *
-	 * @param	$nested_groups
-	 * @param	$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
+	 * @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
 	 * @access	public
 	 */
 	function hasDocuments(&$nested_groups, &$document_factory, $stateid = 0) {
@@ -584,7 +584,7 @@ class DocumentGroup extends Error {
 	/**
 	 * getNumberOfDocuments - get the number of files in this doc_group, group_id and for a document state
 	 *
-	 * @param	int	the state id
+	 * @param	int	$stateId	the state id
 	 * @return	int	the number of found documents
 	 */
 	function getNumberOfDocuments($stateId = 1) {
@@ -604,8 +604,8 @@ class DocumentGroup extends Error {
 	/**
 	 * hasSubgroup - Checks if this group has a specified subgroup associated to it
 	 *
-	 * @param	array	Array of nested groups information, fetched from DocumentGroupFactory class
-	 * @param	int	ID of the subgroup
+	 * @param	array	$nested_groups		Array of nested groups information, fetched from DocumentGroupFactory class
+	 * @param	int	$doc_subgroup_id	ID of the subgroup
 	 * @return	boolean	success
 	 * @access	public
 	 */
@@ -632,8 +632,8 @@ class DocumentGroup extends Error {
 	/**
 	 * getSubgroup - Return the ids of any sub folders (first level only) in specific folder
 	 *
-	 * @param	int	ID of the specific folder
-	 * @param	int	the state id of this specific folder (default is 1)
+	 * @param	int	$docGroupId	ID of the specific folder
+	 * @param	int	$stateId	the state id of this specific folder (default is 1)
 	 * @return	array	the ids of any sub folders
 	 */
 	function getSubgroup($docGroupId, $stateId = 1) {
@@ -654,8 +654,8 @@ class DocumentGroup extends Error {
 	/**
 	 * getPath - return the complete_path
 	 *
-	 * @param	boolean	does path is url clickable (default is false)
-	 * @param	boolean	does path include this document group name ? (default is true)
+	 * @param	boolean	$url		does path is url clickable (default is false)
+	 * @param	boolean	$includename	does path include this document group name ? (default is true)
 	 * @return	string	the complete_path
 	 * @access	public
 	 */
@@ -698,7 +698,7 @@ class DocumentGroup extends Error {
 	/**
 	 * setParentDocGroupId - set the parent doc_group id of this document group.
 	 *
-	 * @param	int	Parent Doc_group Id.
+	 * @param	int	$parentDocGroupId	Parent Doc_group Id.
 	 * @return	boolean	success or not.
 	 * @access	public
 	 */
@@ -709,7 +709,7 @@ class DocumentGroup extends Error {
 	/**
 	 * sendNotice - Notifies of directory submissions
 	 *
-	 * @param	boolean	true = new directory (default value)
+	 * @param	boolean	$new	true = new directory (default value)
 	 * @return	bool
 	 */
 	function sendNotice($new = true) {
@@ -777,7 +777,7 @@ class DocumentGroup extends Error {
 	/**
 	 * injectRar - private method to inject a rar archive tree and files
 	 *
-	 * @param	array	uploaded rar
+	 * @param	array	$uploadedRar	uploaded rar
 	 * @return	boolean	success or not
 	 * @access	private
 	 */
diff --git a/src/common/docman/DocumentGroupFactory.class.php b/src/common/docman/DocumentGroupFactory.class.php
index 8281c43..54d8518 100644
--- a/src/common/docman/DocumentGroupFactory.class.php
+++ b/src/common/docman/DocumentGroupFactory.class.php
@@ -6,7 +6,7 @@
  * Copyright 2002-2003, Tim Perdue/GForge, LLC
  * Copyright 2009, Roland Mas
  * Copyright 2010, Franck Villaume - Capgemini
- * Copyright 2012-2013, Franck Villaume - TrivialDev
+ * Copyright 2012-2014, Franck Villaume - TrivialDev
  * Copyright (C) 2012 Alain Peyrat - Alcatel-Lucent
  * http://fusionforge.org
  *
diff --git a/src/common/docman/DocumentManager.class.php b/src/common/docman/DocumentManager.class.php
index ae0b4bf..cd6786f 100644
--- a/src/common/docman/DocumentManager.class.php
+++ b/src/common/docman/DocumentManager.class.php
@@ -2,7 +2,7 @@
 /**
  * FusionForge document manager
  *
- * Copyright 2011-2013, Franck Villaume - TrivialDev
+ * Copyright 2011-2014, Franck Villaume - TrivialDev
  * Copyright (C) 2012 Alain Peyrat - Alcatel-Lucent
  * Copyright 2013, French Ministry of National Education
  * http://fusionforge.org
@@ -226,7 +226,7 @@ class DocumentManager extends Error {
 	 *
 	 * @param	string	$format		format of the return values. json returns : { name: id, }. Default is DB object.
 	 * @param	string	$removedval	skipped status id
-	 * @return resource|string
+	 * @return	resource|string
 	 */
 	function getStatusNameList($format = '', $removedval = '') {
 		if (!empty($removedval)) {
@@ -253,10 +253,10 @@ class DocumentManager extends Error {
 	/**
 	 * getDocGroupList - Returns as a string used in javascript the list of available folders
 	 *
-	 * @param	$nested_groups
-	 * @param	string	$format	must be json which is wrong, this function does not return any json object
+	 * @param	array	$nested_groups
+	 * @param	string	$format		must be json which is wrong, this function does not return any json object
 	 * @param	bool	$allow_none	allow the "None" which is the "/"
-	 * @param	int		$selected_id the selected folder id
+	 * @param	int	$selected_id	the selected folder id
 	 * @param	array	$dont_display	folders id to not display
 	 * @return	string
 	 */
@@ -285,8 +285,8 @@ class DocumentManager extends Error {
 	 * @param	array	$id_array	Reference to the array of ids that will be build
 	 * @param	array	$text_array	Reference to the array of group names
 	 * @param	array	$dont_display	Array of IDs of groups that should not be displayed
-	 * @param	int		$parent	The ID of the parent whose childs are being showed (0 for root groups)
-	 * @param	int		$level	The current level
+	 * @param	int	$parent	The ID of the parent whose childs are being showed (0 for root groups)
+	 * @param	int	$level	The current level
 	 */
 	function buildArrays($group_arr, &$id_array, &$text_array, &$dont_display, $parent = 0, $level = 0) {
 		if (!is_array($group_arr) || !array_key_exists("$parent", $group_arr)) return;
@@ -312,8 +312,8 @@ class DocumentManager extends Error {
 	 * getActivity - return the number of searched actions per sections between two dates
 	 *
 	 * @param	array	$sections	Sections to search for activity
-	 * @param	int		$begin		the start date time format time()
-	 * @param	int		$end		the end date time format time()
+	 * @param	int	$begin		the start date time format time()
+	 * @param	int	$end		the end date time format time()
 	 * @return	array	number per section of activities found between begin and end values
 	 */
 	function getActivity($sections, $begin, $end) {

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

Summary of changes:
 src/common/docman/Document.class.php             |   24 +++++-----
 src/common/docman/DocumentFactory.class.php      |    6 +--
 src/common/docman/DocumentGroup.class.php        |   56 +++++++++++-----------
 src/common/docman/DocumentGroupFactory.class.php |    2 +-
 src/common/docman/DocumentManager.class.php      |   18 +++----
 5 files changed, 53 insertions(+), 53 deletions(-)


hooks/post-receive
-- 
FusionForge



More information about the Fusionforge-commits mailing list