ErnadoO / qte

qte.php

Doc Comments +2 added lines, -2 removed lines

@@ -680,7 +680,7 @@ 
 	* Generate list of groups
 	*
 	* @param int	$group_ids		The default groups id to mark as selected
-	* @param array	$exclude_ids	The group ids to exclude from the list, false (default) if you whish to exclude no id
+	* @param boolean	$exclude_ids	The group ids to exclude from the list, false (default) if you whish to exclude no id
 	* @param bool	$manage_founder If set to false (default) all groups are returned, if 0 only those groups returned not being managed by founders only, if 1 only those groups returned managed by founders only.
 	*
 	* @return string The list of options.
@@ -776,7 +776,7 @@ 
 	*
 	* @param	array	$user_groups	User's groups
 	* @param	array	$hide_attr		Groups which can't delete attribute in a forum
-	* @return	bool
+	* @return	boolean|null
 	*/
 	private function _check_auth_remove_attr(&$user_groups, $hide_attr)
 	{

Indentation +131 added lines, -131 removed lines

@@ -54,19 +54,19 @@ 
 	private $_name = array();
 
 	/**
-	* Constructor
-	*
-	* @param \phpbb\request\request					$request			Request object
-	* @param \phpbb\cache\driver\driver_interface	$cache				Cache object
-	* @param \phpbb\config\config					$config				Config object
-	* @param \phpbb\db\driver\driver_interface 		$db					Database object
-	* @param \phpbb\template\template				$template			Template object
-	* @param \phpbb\user							$user				User object
-	* @param \phpbb\log\log							$log				Log object
-	* @param string									$root_path			phpBB root path
-	* @param string									$php_ext   			phpEx
-	* @param string									$table_prefix   	Prefix tables
-	*/
+	 * Constructor
+	 *
+	 * @param \phpbb\request\request					$request			Request object
+	 * @param \phpbb\cache\driver\driver_interface	$cache				Cache object
+	 * @param \phpbb\config\config					$config				Config object
+	 * @param \phpbb\db\driver\driver_interface 		$db					Database object
+	 * @param \phpbb\template\template				$template			Template object
+	 * @param \phpbb\user							$user				User object
+	 * @param \phpbb\log\log							$log				Log object
+	 * @param string									$root_path			phpBB root path
+	 * @param string									$php_ext   			phpEx
+	 * @param string									$table_prefix   	Prefix tables
+	 */
 	public function __construct(\phpbb\request\request $request, \phpbb\cache\driver\driver_interface $cache, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\template\template $template, \phpbb\user $user, \phpbb\log\log $log, $root_path, $php_ext, $table_prefix)
 	{
 		$this->request		= $request;
@@ -85,12 +85,12 @@ 
 	}
 
 	/**
-	* Get topic attributes username
-	*
-	* @param	array	$topic_list	Topic ids
-	*
-	* @return	null
-	*/
+	 * Get topic attributes username
+	 *
+	 * @param	array	$topic_list	Topic ids
+	 *
+	 * @return	null
+	 */
 	public function get_users_by_topic_id($topic_list)
 	{
 		if (!empty($topic_list))
@@ -115,24 +115,24 @@ 
 	}
 
 	/**
-	* Get attribute name
-	*
-	* @param	int		$attr_id	The attribute id
-	*
-	* @return	string
-	*/
+	 * Get attribute name
+	 *
+	 * @param	int		$attr_id	The attribute id
+	 *
+	 * @return	string
+	 */
 	public function get_attr_name_by_id($attr_id)
 	{
 		return $this->_attr[$attr_id]['attr_name'];
 	}
 
 	/**
-	* Get attribute author
-	*
-	* @param	int		$user_id	User id
-	*
-	* @return	string
-	*/
+	 * Get attribute author
+	 *
+	 * @param	int		$user_id	User id
+	 *
+	 * @return	string
+	 */
 	public function get_users_by_user_id($user_id)
 	{
 		$sql = 'SELECT user_id, username, user_colour
@@ -153,16 +153,16 @@ 
 	}
 
 	/**
-	* Generate a list of attributes based on permissions
-	*
-	* @param	int		$forum_id		Forum id
-	* @param	int		$author_id		Topic author id
-	* @param	int		$attribute_id	Current attribute id
-	* @param	array	$hide_attr		Groups which can't delete attribute in this forum
-	* @param	string	$viewtopic_url	Topic's url
-	*
-	* @return	null
-	*/
+	 * Generate a list of attributes based on permissions
+	 *
+	 * @param	int		$forum_id		Forum id
+	 * @param	int		$author_id		Topic author id
+	 * @param	int		$attribute_id	Current attribute id
+	 * @param	array	$hide_attr		Groups which can't delete attribute in this forum
+	 * @param	string	$viewtopic_url	Topic's url
+	 *
+	 * @return	null
+	 */
 	public function attr_select($forum_id = 0, $author_id = 0, $attribute_id = 0, $hide_attr = array(), $viewtopic_url = '')
 	{
 		// load language
@@ -233,10 +233,10 @@ 
 	}
 
 	/**
-	* Generate a list of all attributes for search page
-	*
-	* @return	null
-	*/
+	 * Generate a list of all attributes for search page
+	 *
+	 * @return	null
+	 */
 	public function attr_search()
 	{
 		// load language
@@ -286,13 +286,13 @@ 
 	}
 
 	/**
-	* Generate a list of attributes for viewforum page
-	*
-	* @param	int		$forum_id		Forum id
-	* @param	int		$attribute_id	Current attribute id
-	*
-	* @return	null
-	*/
+	 * Generate a list of attributes for viewforum page
+	 *
+	 * @param	int		$forum_id		Forum id
+	 * @param	int		$attribute_id	Current attribute id
+	 *
+	 * @return	null
+	 */
 	public function attr_sort($forum_id = 0, $attribute_id = 0)
 	{
 		// load language
@@ -349,13 +349,13 @@ 
 	}
 
 	/**
-	* Generate a default attribute list for a forum
-	*
-	* @param	int		$forum_id		Forum id
-	* @param	int		$attribute_id	Current attribute id
-	*
-	* @return	null
-	*/
+	 * Generate a default attribute list for a forum
+	 *
+	 * @param	int		$forum_id		Forum id
+	 * @param	int		$attribute_id	Current attribute id
+	 *
+	 * @return	null
+	 */
 	public function attr_default($forum_id = 0, $attribute_id = 0)
 	{
 		// load language
@@ -412,14 +412,14 @@ 
 	}
 
 	/**
-	* Generate attribute for topic title
-	*
-	* @param	int		$attribute_id	Current attribute id
-	* @param	int		$user_id		Current attribute user id
-	* @param	int		$timestamp		Attribute timestamp
-	*
-	* @return	string					Attribute html code
-	*/
+	 * Generate attribute for topic title
+	 *
+	 * @param	int		$attribute_id	Current attribute id
+	 * @param	int		$user_id		Current attribute user id
+	 * @param	int		$timestamp		Attribute timestamp
+	 *
+	 * @return	string					Attribute html code
+	 */
 	public function attr_display($attribute_id = 0, $user_id = 0, $timestamp = 0)
 	{
 		if (empty($attribute_id) || empty($user_id) || empty($timestamp))
@@ -449,14 +449,14 @@ 
 	}
 
 	/**
-	* Generate attribute for page title
-	*
-	* @param	int		$attribute_id	Current attribute id
-	* @param	int		$user_id		Current attribute user id
-	* @param	int		$timestamp		Attribute timestamp
-	*
-	* @return	string					attribute html code
-	*/
+	 * Generate attribute for page title
+	 *
+	 * @param	int		$attribute_id	Current attribute id
+	 * @param	int		$user_id		Current attribute user id
+	 * @param	int		$timestamp		Attribute timestamp
+	 *
+	 * @return	string					attribute html code
+	 */
 	public function attr_title($attribute_id = 0, $user_id = 0, $timestamp = 0)
 	{
 		if (empty($attribute_id) || empty($user_id) || empty($timestamp))
@@ -485,16 +485,16 @@ 
 
 
 	/**
-	* Change topic attribute
-	*
-	* @param	int		$attribute_id		New attribute id
-	* @param	int		$topic_id			The id of the topic
-	* @param	int		$forum_id			The id of the forum
-	* @param	int		$topic_attribute	Current attribute id
-	* @param	array	$hide_attr			Groups which can't delete attribute in this forum
-	*
-	* @return	null
-	*/
+	 * Change topic attribute
+	 *
+	 * @param	int		$attribute_id		New attribute id
+	 * @param	int		$topic_id			The id of the topic
+	 * @param	int		$forum_id			The id of the forum
+	 * @param	int		$topic_attribute	Current attribute id
+	 * @param	array	$hide_attr			Groups which can't delete attribute in this forum
+	 *
+	 * @return	null
+	 */
 	public function attr_apply($attribute_id = 0, $topic_id = 0, $forum_id = 0, $topic_attribute = 0, $hide_attr = array())
 	{
 		if (empty($topic_id) || empty($forum_id) || empty($attribute_id))
@@ -573,13 +573,13 @@ 
 	}
 
 	/**
-	* Change topic attribute in mcp
-	*
-	* @param	int		$attribute_id		New attribute id
-	* @param	array	$topic_ids			Topics ids
-	*
-	* @return	null
-	*/
+	 * Change topic attribute in mcp
+	 *
+	 * @param	int		$attribute_id		New attribute id
+	 * @param	array	$topic_ids			Topics ids
+	 *
+	 * @return	null
+	 */
 	public function mcp_attr_apply($attribute_id = 0, $topic_ids = array())
 	{
 		// load language
@@ -667,24 +667,24 @@ 
 	}
 
 	/**
-	* Getter...
-	*
-	* @return	array
-	*/
+	 * Getter...
+	 *
+	 * @return	array
+	 */
 	public function getAttr()
 	{
 		return $this->_attr;
 	}
 
 	/**
-	* Generate list of groups
-	*
-	* @param int	$group_ids		The default groups id to mark as selected
-	* @param array	$exclude_ids	The group ids to exclude from the list, false (default) if you whish to exclude no id
-	* @param bool	$manage_founder If set to false (default) all groups are returned, if 0 only those groups returned not being managed by founders only, if 1 only those groups returned managed by founders only.
-	*
-	* @return string The list of options.
-	*/
+	 * Generate list of groups
+	 *
+	 * @param int	$group_ids		The default groups id to mark as selected
+	 * @param array	$exclude_ids	The group ids to exclude from the list, false (default) if you whish to exclude no id
+	 * @param bool	$manage_founder If set to false (default) all groups are returned, if 0 only those groups returned not being managed by founders only, if 1 only those groups returned managed by founders only.
+	 *
+	 * @return string The list of options.
+	 */
 	public function qte_group_select($group_ids, $exclude_ids = array(), $manage_founder = false)
 	{
 		$exclude_sql = ($exclude_ids !== false && sizeof($exclude_ids)) ? 'WHERE ' . $this->db->sql_in_set('group_id', array_map('intval', $exclude_ids), true) : '';
@@ -711,9 +711,9 @@ 
 	}
 
 	/**
-	* borrowed from "Categories Hierarchy" : used to check if a language key exists
-	* @todo delete
-	*/
+	 * borrowed from "Categories Hierarchy" : used to check if a language key exists
+	 * @todo delete
+	 */
 	public function attr_lng_key($key)
 	{
 		// load language
@@ -729,12 +729,12 @@ 
 	}
 
 	/**
-	* Build class and style attribute
-	*
-	* @param	string	$a_name			Attribute name
-	* @param	string	$a_colour		Attribute color
-	* @return	string					html code
-	*/
+	 * Build class and style attribute
+	 *
+	 * @param	string	$a_name			Attribute name
+	 * @param	string	$a_colour		Attribute color
+	 * @return	string					html code
+	 */
 	public function attr_colour($a_name, $a_colour)
 	{
 		$a_name = preg_replace("#[^a-z0-9 _-]#", '', strtolower($a_name));
@@ -747,14 +747,14 @@ 
 	}
 
 	/**
-	* Check if user can apply an attribute
-	*
-	* @param	array	$attr_auth		Forum auth
-	* @param	int		$forum_id		Forum id
-	* @param	array	$user_groups	User's groups
-	* @param	int		$author_id		Topic author id
-	* @return	bool
-	*/
+	 * Check if user can apply an attribute
+	 *
+	 * @param	array	$attr_auth		Forum auth
+	 * @param	int		$forum_id		Forum id
+	 * @param	array	$user_groups	User's groups
+	 * @param	int		$author_id		Topic author id
+	 * @return	bool
+	 */
 	private function _check_auth_attribute($attr_auth, $forum_id, $user_groups, $author_id)
 	{
 		$forum_ids = $attr_auth['forums_ids'];
@@ -772,12 +772,12 @@ 
 	}
 
 	/**
-	* Check if user can delete an attribute
-	*
-	* @param	array	$user_groups	User's groups
-	* @param	array	$hide_attr		Groups which can't delete attribute in a forum
-	* @return	bool
-	*/
+	 * Check if user can delete an attribute
+	 *
+	 * @param	array	$user_groups	User's groups
+	 * @param	array	$hide_attr		Groups which can't delete attribute in a forum
+	 * @return	bool
+	 */
 	private function _check_auth_remove_attr(&$user_groups, $hide_attr)
 	{
 		// include that file !
@@ -806,10 +806,10 @@ 
 	}
 
 	/**
-	* Get attributes from database
-	*
-	* @return	null
-	*/
+	 * Get attributes from database
+	 *
+	 * @return	null
+	 */
 	private function _get_attributes()
 	{
 		if (($this->_attr = $this->cache->get('_attr')) === false)