ErnadoO / ext-phpbb-directory

acp/phpbbdirectory_module.php

Indentation +14 added lines, -14 removed lines

@@ -15,10 +15,10 @@ 
 	public $u_action;
 
 	/**
-	*
-	* @param int	$id
-	* @param string	$mode
-	*/
+	 *
+	 * @param int	$id
+	 * @param string	$mode
+	 */
 	public function main($id, $mode)
 	{
 		global $request, $phpbb_container;
@@ -183,11 +183,11 @@ 
 	}
 
 	/**
-	* Display thumb services available
-	*
-	* @param 	string	$url_selected
-	* @return 	string
-	*/
+	 * Display thumb services available
+	 *
+	 * @param 	string	$url_selected
+	 * @return 	string
+	 */
 	public function get_thumb_service_list($url_selected)
 	{
 		$thumbshot = array(
@@ -207,11 +207,11 @@ 
 	}
 
 	/**
-	* Display order drop-down list
-	*
-	* @param	string	$order_selected
-	* @return	string
-	*/
+	 * Display order drop-down list
+	 *
+	 * @param	string	$order_selected
+	 * @return	string
+	 */
 	public function get_order_list($order_selected)
 	{
 		global $user;

core/helper.php

Indentation +29 added lines, -29 removed lines

@@ -22,11 +22,11 @@ 
 	private $ext_name = 'ernadoo/phpbbdirectory';
 
 	/**
-	* Constructor
-	*
-	* @param \phpbb\extension\manager 		$phpbb_extension_manager	Extension manager helper
-	* @param \phpbb\path_helper				$path_helper				Controller path helper object
-	*/
+	 * Constructor
+	 *
+	 * @param \phpbb\extension\manager 		$phpbb_extension_manager	Extension manager helper
+	 * @param \phpbb\path_helper				$path_helper				Controller path helper object
+	 */
 	public function __construct(\phpbb\extension\manager $phpbb_extension_manager, \phpbb\path_helper $path_helper)
 	{
 		$this->extension_manager	= $phpbb_extension_manager;
@@ -34,48 +34,48 @@ 
 	}
 
 	/**
-	* Return ext name
-	*
-	* @param	bool	$web_root_path Whether the path should be relative to web root
-	* @return	string					Path to an extension
-	*/
+	 * Return ext name
+	 *
+	 * @param	bool	$web_root_path Whether the path should be relative to web root
+	 * @return	string					Path to an extension
+	 */
 	public function get_ext_name($web_root_path = false)
 	{
 		return (($web_root_path) ? $this->path_helper->get_web_root_path() : '') . $this->extension_manager->get_extension_path($this->ext_name);
 	}
 
 	/**
-	* Return path to resource image
-	*
-	* @param	string $type	is ressource type (flags|icons)
-	* @param	string $image	is the resource to display
-	* @return	string			The relative path to ressource
-	*/
+	 * Return path to resource image
+	 *
+	 * @param	string $type	is ressource type (flags|icons)
+	 * @param	string $image	is the resource to display
+	 * @return	string			The relative path to ressource
+	 */
 	public function get_img_path($type, $image = '')
 	{
 		return $this->get_ext_name(true) . 'images/' . $type . '/' . $image;
 	}
 
 	/**
-	* Return path to banner
-	*
-	* @param	string	$banner	is the physical name
-	* @return	string			The relative path to banner
-	*/
+	 * Return path to banner
+	 *
+	 * @param	string	$banner	is the physical name
+	 * @return	string			The relative path to banner
+	 */
 	public function get_banner_path($banner = '')
 	{
 		return 'files/' . $this->get_ext_name() . 'banners/' . $banner;
 	}
 
 	/**
-	* Return array entries that match the pattern
-	*
-	* @link http://php.net/manual/fr/function.preg-grep.php#95787
-	*
-	* @param 	string	$pattern	The pattern to search for
-	* @param	array	$input		The input array
-	* @return	array	$vals		Returns an array indexed using the keys from the input array
-	*/
+	 * Return array entries that match the pattern
+	 *
+	 * @link http://php.net/manual/fr/function.preg-grep.php#95787
+	 *
+	 * @param 	string	$pattern	The pattern to search for
+	 * @param	array	$input		The input array
+	 * @return	array	$vals		Returns an array indexed using the keys from the input array
+	 */
 	public function preg_grep_keys($pattern, $input)
 	{
 		$keys = preg_grep($pattern, array_keys($input));

cron/task/core/prune_categorie.php

Indentation +37 added lines, -37 removed lines

@@ -28,13 +28,13 @@ 
 	private $cat_data;
 
 	/**
-	* Constructor.
-	*
-	* @param \phpbb\db\driver\driver_interface 	$db				Database object
-	* @param \phpbb\config\config 				$config			Config object
-	* @param \ernadoo\phpbbdirectory\core\link	$directory_cron	PhpBB Directory extension link object
-	* @param string								$php_ext		phpEx
-	*/
+	 * Constructor.
+	 *
+	 * @param \phpbb\db\driver\driver_interface 	$db				Database object
+	 * @param \phpbb\config\config 				$config			Config object
+	 * @param \ernadoo\phpbbdirectory\core\link	$directory_cron	PhpBB Directory extension link object
+	 * @param string								$php_ext		phpEx
+	 */
 	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \ernadoo\phpbbdirectory\core\link $directory_cron, $php_ext)
 	{
 		$this->db 				= $db;
@@ -44,66 +44,66 @@ 
 	}
 
 	/**
-	* Manually set categorie data.
-	*
-	* @param array $cat_data Information about a category to be pruned.
-	*/
+	 * Manually set categorie data.
+	 *
+	 * @param array $cat_data Information about a category to be pruned.
+	 */
 	public function set_categorie_data($cat_data)
 	{
 		$this->cat_data = $cat_data;
 	}
 
 	/**
-	* Runs this cron task.
-	*
-	* @return null
-	*/
+	 * Runs this cron task.
+	 *
+	 * @return null
+	 */
 	public function run()
 	{
 		$this->dir_cron->auto_check($this->cat_data);
 	}
 
 	/**
-	* Returns whether this cron task can run, given current board configuration.
-	*
-	* @return bool
-	*/
+	 * Returns whether this cron task can run, given current board configuration.
+	 *
+	 * @return bool
+	 */
 	public function is_runnable()
 	{
 		return !$this->config['use_system_cron'] && !empty($this->cat_data);
 	}
 
 	/**
-	* Returns whether this cron task should run now, because enough time
-	* has passed since it was last run.
-	*
-	* @return bool
-	*/
+	 * Returns whether this cron task should run now, because enough time
+	 * has passed since it was last run.
+	 *
+	 * @return bool
+	 */
 	public function should_run()
 	{
 		return $this->cat_data['cat_cron_enable'] && $this->cat_data['cat_cron_next'] < time();
 	}
 
 	/**
-	* Returns parameters of this cron task as an array.
-	* The array has one key, c, whose value is id of the category to be pruned.
-	*
-	* @return array
-	*/
+	 * Returns parameters of this cron task as an array.
+	 * The array has one key, c, whose value is id of the category to be pruned.
+	 *
+	 * @return array
+	 */
 	public function get_parameters()
 	{
 		return array('c' => $this->cat_data['cat_id']);
 	}
 
 	/**
-	* Parses parameters found in $request, which is an instance of
-	* \phpbb\request\request_interface.
-	*
-	* It is expected to have a key f whose value is id of the forum to be pruned.
-	*
-	* @param	\phpbb\request\request_interface	$request Request object.
-	* @return	null
-	*/
+	 * Parses parameters found in $request, which is an instance of
+	 * \phpbb\request\request_interface.
+	 *
+	 * It is expected to have a key f whose value is id of the forum to be pruned.
+	 *
+	 * @param	\phpbb\request\request_interface	$request Request object.
+	 * @return	null
+	 */
 	public function parse_parameters(\phpbb\request\request_interface $request)
 	{
 		$this->cat_data = array();

ext.php

Indentation +30 added lines, -30 removed lines

@@ -17,11 +17,11 @@ 
 class ext extends \phpbb\extension\base
 {
 	/**
-	* Enable extension if requirements are met
-	*
-	* @return bool
-	* @aceess public
-	*/
+	 * Enable extension if requirements are met
+	 *
+	 * @return bool
+	 * @aceess public
+	 */
 	public function is_enableable()
 	{
 		$config = $this->container->get('config');
@@ -42,11 +42,11 @@ 
 	}
 
 	/**
-	* Single enable step that installs any included migrations
-	*
-	* @param mixed $old_state State returned by previous call of this method
-	* @return mixed Returns false after last step, otherwise temporary state
-	*/
+	 * Single enable step that installs any included migrations
+	 *
+	 * @param mixed $old_state State returned by previous call of this method
+	 * @return mixed Returns false after last step, otherwise temporary state
+	 */
 	public function enable_step($old_state)
 	{
 		switch ($old_state)
@@ -74,11 +74,11 @@ 
 	}
 
 	/**
-	* Single disable step that does nothing
-	*
-	* @param mixed $old_state State returned by previous call of this method
-	* @return mixed Returns false after last step, otherwise temporary state
-	*/
+	 * Single disable step that does nothing
+	 *
+	 * @param mixed $old_state State returned by previous call of this method
+	 * @return mixed Returns false after last step, otherwise temporary state
+	 */
 	public function disable_step($old_state)
 	{
 		switch ($old_state)
@@ -106,11 +106,11 @@ 
 	}
 
 	/**
-	* Single purge step that reverts any included and installed migrations
-	*
-	* @param mixed $old_state State returned by previous call of this method
-	* @return mixed Returns false after last step, otherwise temporary state
-	*/
+	 * Single purge step that reverts any included and installed migrations
+	 *
+	 * @param mixed $old_state State returned by previous call of this method
+	 * @return mixed Returns false after last step, otherwise temporary state
+	 */
 	public function purge_step($old_state)
 	{
 		switch ($old_state)
@@ -138,16 +138,16 @@ 
 	}
 
 	/**
-	* Notification handler to call notification enable/disable/purge steps
-	*
-	* @author VSEphpbb (Matt Friedman)
-	* @copyright (c) 2014 phpBB Limited <https://www.phpbb.com>
-	* @license GNU General Public License, version 2 (GPL-2.0)
-	* @param string $step The step (enable, disable, purge)
-	* @param array $notification_types The notification type names
-	* @return string Return notifications as temporary state
-	* @access protected
-	*/
+	 * Notification handler to call notification enable/disable/purge steps
+	 *
+	 * @author VSEphpbb (Matt Friedman)
+	 * @copyright (c) 2014 phpBB Limited <https://www.phpbb.com>
+	 * @license GNU General Public License, version 2 (GPL-2.0)
+	 * @param string $step The step (enable, disable, purge)
+	 * @param array $notification_types The notification type names
+	 * @return string Return notifications as temporary state
+	 * @access protected
+	 */
 	protected function notification_handler($step, $notification_types)
 	{
 		$phpbb_notifications = $this->container->get('notification_manager');

language/nl/info_acp_directory.php

Indentation +3 added lines, -3 removed lines

@@ -5,9 +5,9 @@
 *
 * @copyright (c) 2014 ErnadoO <http://www.phpbb-services.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
- * Dutch translation by Dutch Translators (https://github.com/dutch-translators)
- *
- */
+	 * Dutch translation by Dutch Translators (https://github.com/dutch-translators)
+	 *
+	 */
 
 /**
  * DO NOT CHANGE

migrations/converter/convert_module.php

Indentation +10 added lines, -10 removed lines

@@ -16,11 +16,11 @@ 
 class convert_module extends \phpbb\db\migration\migration
 {
 	/**
-	* Skip this migration if an ACP_DIRECTORY module does not exist
-	*
-	* @return	bool	True if table does not exist
-	* @access	public
-	*/
+	 * Skip this migration if an ACP_DIRECTORY module does not exist
+	 *
+	 * @return	bool	True if table does not exist
+	 * @access	public
+	 */
 	public function effectively_installed()
 	{
 		$sql = 'SELECT module_id
@@ -37,11 +37,11 @@ 
 	}
 
 	/**
-	* Add or update data in the database
-	*
-	* @return	array Array of table data
-	* @access	public
-	*/
+	 * Add or update data in the database
+	 *
+	 * @return	array Array of table data
+	 * @access	public
+	 */
 	public function update_data()
 	{
 		return array(

migrations/converter/convert_notifications.php

Indentation +14 added lines, -14 removed lines

@@ -16,11 +16,11 @@ 
 class convert_notifications extends \phpbb\db\migration\migration
 {
 	/**
-	* Skip this migration if phpbb_directory_notifications table does not exist
-	*
-	* @return	bool	True if table does not exist
-	* @access	public
-	*/
+	 * Skip this migration if phpbb_directory_notifications table does not exist
+	 *
+	 * @return	bool	True if table does not exist
+	 * @access	public
+	 */
 	public function effectively_installed()
 	{
 		return !$this->db_tools->sql_table_exists($this->table_prefix . 'directory_notifications');
@@ -34,11 +34,11 @@ 
 	}
 
 	/**
-	* Add or update data in the database
-	*
-	* @return	array Array of table data
-	* @access	public
-	*/
+	 * Add or update data in the database
+	 *
+	 * @return	array Array of table data
+	 * @access	public
+	 */
 	public function update_data()
 	{
 		return array(
@@ -47,10 +47,10 @@ 
 	}
 
 	/**
-	* Copy category track from 3.0.x table
-	*
-	* @return null
-	*/
+	 * Copy category track from 3.0.x table
+	 *
+	 * @return null
+	 */
 	public function copy_from_notifications()
 	{
 		$sql = 'SELECT n_user_id, n_cat_id

migrations/v10x/v1_0_0.php

Indentation +17 added lines, -17 removed lines

@@ -259,10 +259,10 @@ 
 	}
 
 	/**
-	* Create directories for banners/icons uploaded
-	*
-	* @return null
-	*/
+	 * Create directories for banners/icons uploaded
+	 *
+	 * @return null
+	 */
 	public function create_directories()
 	{
 		$directories = array(
@@ -281,10 +281,10 @@ 
 	}
 
 	/**
-	* Remove directories for banners/icons uploaded
-	*
-	* @return null
-	*/
+	 * Remove directories for banners/icons uploaded
+	 *
+	 * @return null
+	 */
 	public function remove_directories()
 	{
 		$dir = $this->phpbb_root_path . 'files/ext/ernadoo/phpbbdirectory/';
@@ -293,15 +293,15 @@ 
 	}
 
 	/**
-	* Attempts to remove recursively the directory named by dirname.
-	*
-	* @author Mehdi Kabab <http://pioupioum.fr>
-	* @copyright Copyright (C) 2009 Mehdi Kabab
-	* @license http://www.gnu.org/licenses/gpl.html  GNU GPL version 3 or later
-	*
-	* @param	string	$dirname		Path to the directory.
-	* @return	null
-	*/
+	 * Attempts to remove recursively the directory named by dirname.
+	 *
+	 * @author Mehdi Kabab <http://pioupioum.fr>
+	 * @copyright Copyright (C) 2009 Mehdi Kabab
+	 * @license http://www.gnu.org/licenses/gpl.html  GNU GPL version 3 or later
+	 *
+	 * @param	string	$dirname		Path to the directory.
+	 * @return	null
+	 */
 	private function _recursive_rmdir($dirname)
 	{
 		if (is_dir($dirname) && !is_link($dirname))

notification/type/directory_website.php

Indentation +57 added lines, -57 removed lines

@@ -18,21 +18,21 @@ 
 class directory_website extends \phpbb\notification\type\base
 {
 	/**
-	* Get notification type name
-	*
-	* @return string
-	*/
+	 * Get notification type name
+	 *
+	 * @return string
+	 */
 	public function get_type()
 	{
 		return 'ernadoo.phpbbdirectory.notification.type.directory_website';
 	}
 
 	/**
-	* Notification option data (for outputting to the user)
-	*
-	* @var bool|array False if the service should use it's default data
-	* 					Array of data (including keys 'id', 'lang', and 'group')
-	*/
+	 * Notification option data (for outputting to the user)
+	 *
+	 * @var bool|array False if the service should use it's default data
+	 * 					Array of data (including keys 'id', 'lang', and 'group')
+	 */
 	public static $notification_option = array(
 		'lang'	=> 'NOTIFICATION_TYPE_DIR_UCP_WEBSITE',
 		'group'	=> 'NOTIFICATION_DIR_UCP',
@@ -47,31 +47,31 @@ 
 	}
 
 	/**
-	* Is available
-	*
-	* @return bool True/False whether or not this is available to the user
-	*/
+	 * Is available
+	 *
+	 * @return bool True/False whether or not this is available to the user
+	 */
 	public function is_available()
 	{
 		return true;
 	}
 
 	/**
-	* Get link id
-	*
-	* @param array $data The data from the link
-	* @return int
-	*/
+	 * Get link id
+	 *
+	 * @param array $data The data from the link
+	 * @return int
+	 */
 	static public function get_item_id($data)
 	{
 		return (int) $data['link_id'];
 	}
 
 	/**
-	* Get parent id - it's not used
-	*
-	* @param array $data The data from the link
-	*/
+	 * Get parent id - it's not used
+	 *
+	 * @param array $data The data from the link
+	 */
 	static public function get_item_parent_id($data)
 	{
 		// No parent
@@ -79,12 +79,12 @@ 
 	}
 
 	/**
-	* Find the users who want to receive notifications
-	*
-	* @param	array	$data		Data from submit link
-	* @param	array	$options	Options for finding users for notification
-	* @return	array
-	*/
+	 * Find the users who want to receive notifications
+	 *
+	 * @param	array	$data		Data from submit link
+	 * @param	array	$options	Options for finding users for notification
+	 * @return	array
+	 */
 	public function find_users_for_notification($data, $options = array())
 	{
 		$options = array_merge(array(
@@ -118,8 +118,8 @@ 
 	}
 
 	/**
-	* Get the user's avatar
-	*/
+	 * Get the user's avatar
+	 */
 	public function get_avatar()
 	{
 		return $this->user_loader->get_avatar($this->get_data('user_from'), false, true);
@@ -127,10 +127,10 @@ 
 
 
 	/**
-	* Get the HTML formatted title of this notification
-	*
-	* @return string
-	*/
+	 * Get the HTML formatted title of this notification
+	 *
+	 * @return string
+	 */
 
 	public function get_title()
 	{
@@ -143,20 +143,20 @@ 
 
 
 	/**
-	* Get email template
-	*
-	* @return string
-	*/
+	 * Get email template
+	 *
+	 * @return string
+	 */
 	public function get_email_template()
 	{
 		return '@ernadoo_phpbbdirectory/directory_website';
 	}
 
 	/**
-	* Get email template variables
-	*
-	* @return array
-	*/
+	 * Get email template variables
+	 *
+	 * @return array
+	 */
 	public function get_email_template_variables()
 	{
 		return array(
@@ -168,33 +168,33 @@ 
 	}
 
 	/**
-	* Get the url to this item
-	*
-	* @return string URL
-	*/
+	 * Get the url to this item
+	 *
+	 * @return string URL
+	 */
 	public function get_url()
 	{
 		return append_sid($this->phpbb_root_path . 'directory/categorie/' .  (int) $this->get_data('cat_id'));
 	}
 
 	/**
-	* Users needed to query before this notification can be displayed
-	*
-	* @return array Array of user_ids
-	*/
+	 * Users needed to query before this notification can be displayed
+	 *
+	 * @return array Array of user_ids
+	 */
 	public function users_to_query()
 	{
 		return array($this->get_data('user_from'));
 	}
 
 	/**
-	* Function for preparing the data for insertion in an SQL query
-	* (The service handles insertion)
-	*
-	* @param	array	$data				Data from submit link
-	* @param	array	$pre_create_data	Data from pre_create_insert_array()
-	* @return	array						Array of data ready to be inserted into the database
-	*/
+	 * Function for preparing the data for insertion in an SQL query
+	 * (The service handles insertion)
+	 *
+	 * @param	array	$data				Data from submit link
+	 * @param	array	$pre_create_data	Data from pre_create_insert_array()
+	 * @return	array						Array of data ready to be inserted into the database
+	 */
 	public function create_insert_array($data, $pre_create_data = array())
 	{
 		$this->set_data('link_name', $data['link_name']);