VinaBB / VinaBB.vn

ext/vinabb/web/acp/bbook_chapters_module.php

Indentation +17 added lines, -17 removed lines

@@ -47,11 +47,11 @@ 
 	private $chapter_id;
 
 	/**
-	* Main method of the module
-	*
-	* @param string	$id		Module basename
-	* @param string	$mode	Module mode
-	*/
+	 * Main method of the module
+	 *
+	 * @param string	$id		Module basename
+	 * @param string	$mode	Module mode
+	 */
 	public function main($id, $mode)
 	{
 		global $phpbb_container;
@@ -82,16 +82,16 @@ 
 	}
 
 	/**
-	* Module action: Display (Default)
-	*/
+	 * Module action: Display (Default)
+	 */
 	private function action_display()
 	{
 		$this->controller->display_chapters($this->parent_id);
 	}
 
 	/**
-	* Module action: Add
-	*/
+	 * Module action: Add
+	 */
 	private function action_add()
 	{
 		$this->tpl_name = 'acp_bbook_chapters_edit';
@@ -100,8 +100,8 @@ 
 	}
 
 	/**
-	* Module action: Edit
-	*/
+	 * Module action: Edit
+	 */
 	private function action_edit()
 	{
 		$this->tpl_name = 'acp_bbook_chapters_edit';
@@ -110,8 +110,8 @@ 
 	}
 
 	/**
-	* Module action: Move Down
-	*/
+	 * Module action: Move Down
+	 */
 	private function action_move_down()
 	{
 		$this->controller->move_chapter($this->chapter_id, 'down');
@@ -119,8 +119,8 @@ 
 	}
 
 	/**
-	* Module action: Move Up
-	*/
+	 * Module action: Move Up
+	 */
 	private function action_move_up()
 	{
 		$this->controller->move_chapter($this->chapter_id, 'up');
@@ -128,8 +128,8 @@ 
 	}
 
 	/**
-	* Module action: Delete
-	*/
+	 * Module action: Delete
+	 */
 	private function action_delete()
 	{
 		if (confirm_box(true))

ext/vinabb/web/operators/bbook_chapter_interface.php

Indentation +44 added lines, -44 removed lines

@@ -14,70 +14,70 @@
 interface bbook_chapter_interface
 {
 	/**
-	* Get number of chapters
-	*
-	* @param int $book_id Book ID
-	* @return int
-	*/
+	 * Get number of chapters
+	 *
+	 * @param int $book_id Book ID
+	 * @return int
+	 */
 	public function count_chapters($book_id = 0);
 
 	/**
-	* Get all chapters
-	*
-	* @param int $book_id	Book ID
-	* @param int $parent_id	Parent ID
-	* @return array
-	*/
+	 * Get all chapters
+	 *
+	 * @param int $book_id	Book ID
+	 * @param int $parent_id	Parent ID
+	 * @return array
+	 */
 	public function get_chapters($book_id = 0, $parent_id = 0);
 
 	/**
-	* Add a chapter
-	*
-	* @param \vinabb\web\entities\bbook_chapter_interface	$entity		Chapter entity
-	* @param int											$parent_id	Parent ID
-	* @return \vinabb\web\entities\bbook_chapter_interface
-	*/
+	 * Add a chapter
+	 *
+	 * @param \vinabb\web\entities\bbook_chapter_interface	$entity		Chapter entity
+	 * @param int											$parent_id	Parent ID
+	 * @return \vinabb\web\entities\bbook_chapter_interface
+	 */
 	public function add_chapter(\vinabb\web\entities\bbook_chapter_interface $entity, $parent_id = 0);
 
 	/**
-	* Move a chapter up/down
-	*
-	* @param int	$id			Chapter ID
-	* @param string	$direction	The direction: up|down
-	* @param int	$amount		The number of places to move
-	* @throws \vinabb\web\exceptions\out_of_bounds
-	*/
+	 * Move a chapter up/down
+	 *
+	 * @param int	$id			Chapter ID
+	 * @param string	$direction	The direction: up|down
+	 * @param int	$amount		The number of places to move
+	 * @throws \vinabb\web\exceptions\out_of_bounds
+	 */
 	public function move_chapter($id, $direction = 'up', $amount = 1);
 
 	/**
-	* Change the parent
-	*
-	* @param int	$id				Chapter ID
-	* @param int	$new_parent_id	New parent ID
-	* @throws \vinabb\web\exceptions\out_of_bounds
-	*/
+	 * Change the parent
+	 *
+	 * @param int	$id				Chapter ID
+	 * @param int	$new_parent_id	New parent ID
+	 * @throws \vinabb\web\exceptions\out_of_bounds
+	 */
 	public function change_parent($id, $new_parent_id);
 
 	/**
-	* Get a chapter's parent chapters (for use in breadcrumbs)
-	*
-	* @param int $parent_id Parent ID
-	* @return array
-	*/
+	 * Get a chapter's parent chapters (for use in breadcrumbs)
+	 *
+	 * @param int $parent_id Parent ID
+	 * @return array
+	 */
 	public function get_parents($parent_id);
 
 	/**
-	* Update the view counter
-	*
-	* @param int $id Chapter ID
-	*/
+	 * Update the view counter
+	 *
+	 * @param int $id Chapter ID
+	 */
 	public function increase_views($id);
 
 	/**
-	* Delete a chapter
-	*
-	* @param int $id Chapter ID
-	* @throws \vinabb\web\exceptions\out_of_bounds
-	*/
+	 * Delete a chapter
+	 *
+	 * @param int $id Chapter ID
+	 * @throws \vinabb\web\exceptions\out_of_bounds
+	 */
 	public function delete_chapter($id);
 }

ext/vinabb/web/operators/nestedset_bbook_chapters.php

Indentation +20 added lines, -20 removed lines

@@ -14,12 +14,12 @@ 
 class nestedset_bbook_chapters extends \phpbb\tree\nestedset
 {
 	/**
-	* Construct
-	*
-	* @param \phpbb\db\driver\driver_interface	$db			Database object
-	* @param \phpbb\lock\db						$lock		Lock the table when moving entities around
-	* @param string								$table_name	Table name
-	*/
+	 * Construct
+	 *
+	 * @param \phpbb\db\driver\driver_interface	$db			Database object
+	 * @param \phpbb\lock\db						$lock		Lock the table when moving entities around
+	 * @param string								$table_name	Table name
+	 */
 	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\lock\db $lock, $table_name)
 	{
 		parent::__construct(
@@ -40,32 +40,32 @@ 
 	}
 
 	/**
-	* Update $this->sql_where to display chapters by the book ID
-	*
-	* @param int $book_id Book ID
-	*/
+	 * Update $this->sql_where to display chapters by the book ID
+	 *
+	 * @param int $book_id Book ID
+	 */
 	public function set_sql_where($book_id)
 	{
 		$this->sql_where = 'book_id = ' . (int) $book_id;
 	}
 
 	/**
-	* Get the chapter data from the database
-	*
-	* @param int $parent_id Parent to display chapters from, 0 for all
-	* @return array
-	*/
+	 * Get the chapter data from the database
+	 *
+	 * @param int $parent_id Parent to display chapters from, 0 for all
+	 * @return array
+	 */
 	public function get_chapter_data($parent_id)
 	{
 		return $parent_id ? $this->get_subtree_data($parent_id, true, false) : $this->get_all_tree_data();
 	}
 
 	/**
-	* Update the tree for an item inserted in the database
-	*
-	* @param int $item_id The item to be added
-	* @return array
-	*/
+	 * Update the tree for an item inserted in the database
+	 *
+	 * @param int $item_id The item to be added
+	 * @return array
+	 */
 	public function add_to_nestedset($item_id)
 	{
 		return $this->add_item_to_nestedset($item_id);

ext/vinabb/web/operators/bbook_chapter.php

Indentation +51 added lines, -51 removed lines

@@ -28,13 +28,13 @@ 
 	protected $table_name;
 
 	/**
-	* Constructor
-	*
-	* @param ContainerInterface								$container	Container object
-	* @param \vinabb\web\operators\nestedset_bbook_chapters	$nestedset	Nestedset object for tree functionality
-	* @param \phpbb\db\driver\driver_interface				$db			Database object
-	* @param string											$table_name	Table name
-	*/
+	 * Constructor
+	 *
+	 * @param ContainerInterface								$container	Container object
+	 * @param \vinabb\web\operators\nestedset_bbook_chapters	$nestedset	Nestedset object for tree functionality
+	 * @param \phpbb\db\driver\driver_interface				$db			Database object
+	 * @param string											$table_name	Table name
+	 */
 	public function __construct(
 		ContainerInterface $container,
 		\phpbb\db\driver\driver_interface $db,
@@ -49,11 +49,11 @@ 
 	}
 
 	/**
-	* Get number of chapters
-	*
-	* @param int $book_id Book ID
-	* @return int
-	*/
+	 * Get number of chapters
+	 *
+	 * @param int $book_id Book ID
+	 * @return int
+	 */
 	public function count_chapters($book_id = 0)
 	{
 		$sql_where = $book_id ? 'WHERE book_id = ' . (int) $book_id : 'WHERE book_id > 0';
@@ -69,12 +69,12 @@ 
 	}
 
 	/**
-	* Get all chapters
-	*
-	* @param int $book_id	Book ID
-	* @param int $parent_id	Parent ID
-	* @return array
-	*/
+	 * Get all chapters
+	 *
+	 * @param int $book_id	Book ID
+	 * @param int $parent_id	Parent ID
+	 * @return array
+	 */
 	public function get_chapters($book_id = 0, $parent_id = 0)
 	{
 		$entities = [];
@@ -94,12 +94,12 @@ 
 	}
 
 	/**
-	* Add a chapter
-	*
-	* @param \vinabb\web\entities\bbook_chapter_interface	$entity		Chapter entity
-	* @param int											$parent_id	Parent ID
-	* @return \vinabb\web\entities\bbook_chapter_interface
-	*/
+	 * Add a chapter
+	 *
+	 * @param \vinabb\web\entities\bbook_chapter_interface	$entity		Chapter entity
+	 * @param int											$parent_id	Parent ID
+	 * @return \vinabb\web\entities\bbook_chapter_interface
+	 */
 	public function add_chapter(\vinabb\web\entities\bbook_chapter_interface $entity, $parent_id = 0)
 	{
 		// Insert the entity to the database
@@ -122,13 +122,13 @@ 
 	}
 
 	/**
-	* Move a chapter up/down
-	*
-	* @param int	$id			Chapter ID
-	* @param string	$direction	The direction: up|down
-	* @param int	$amount		The number of places to move
-	* @throws \vinabb\web\exceptions\out_of_bounds
-	*/
+	 * Move a chapter up/down
+	 *
+	 * @param int	$id			Chapter ID
+	 * @param string	$direction	The direction: up|down
+	 * @param int	$amount		The number of places to move
+	 * @throws \vinabb\web\exceptions\out_of_bounds
+	 */
 	public function move_chapter($id, $direction = 'up', $amount = 1)
 	{
 		$id = (int) $id;
@@ -145,12 +145,12 @@ 
 	}
 
 	/**
-	* Change the parent
-	*
-	* @param int	$id				Chapter ID
-	* @param int	$new_parent_id	New parent ID
-	* @throws \vinabb\web\exceptions\out_of_bounds
-	*/
+	 * Change the parent
+	 *
+	 * @param int	$id				Chapter ID
+	 * @param int	$new_parent_id	New parent ID
+	 * @throws \vinabb\web\exceptions\out_of_bounds
+	 */
 	public function change_parent($id, $new_parent_id)
 	{
 		$id = (int) $id;
@@ -168,11 +168,11 @@ 
 	}
 
 	/**
-	* Get a chapter's parent chapters (for use in breadcrumbs)
-	*
-	* @param int $parent_id Parent ID
-	* @return array
-	*/
+	 * Get a chapter's parent chapters (for use in breadcrumbs)
+	 *
+	 * @param int $parent_id Parent ID
+	 * @return array
+	 */
 	public function get_parents($parent_id)
 	{
 		$entities = [];
@@ -189,10 +189,10 @@ 
 	}
 
 	/**
-	* Update the view counter
-	*
-	* @param int $id Chapter ID
-	*/
+	 * Update the view counter
+	 *
+	 * @param int $id Chapter ID
+	 */
 	public function increase_views($id)
 	{
 		$sql = 'UPDATE ' . $this->table_name . '
@@ -202,11 +202,11 @@ 
 	}
 
 	/**
-	* Delete a chapter
-	*
-	* @param int $id Chapter ID
-	* @throws \vinabb\web\exceptions\out_of_bounds
-	*/
+	 * Delete a chapter
+	 *
+	 * @param int $id Chapter ID
+	 * @throws \vinabb\web\exceptions\out_of_bounds
+	 */
 	public function delete_chapter($id)
 	{
 		$id = (int) $id;

ext/vinabb/web/controllers/acp/bbook_chapters.php

Indentation +72 added lines, -72 removed lines

@@ -61,20 +61,20 @@ 
 	protected $errors;
 
 	/**
-	* Constructor
-	*
-	* @param \vinabb\web\controllers\cache\service_interface	$cache			Cache service
-	* @param ContainerInterface									$container		Container object
-	* @param \phpbb\language\language							$language		Language object
-	* @param \phpbb\log\log										$log			Log object
-	* @param \vinabb\web\operators\bbook_chapter_interface		$operator		Chapter operators
-	* @param \phpbb\request\request								$request		Request object
-	* @param \phpbb\template\template							$template		Template object
-	* @param \phpbb\user										$user			User object
-	* @param \vinabb\web\controllers\helper\helper_interface	$ext_helper		Extension helper
-	* @param string												$root_path		phpBB root path
-	* @param string												$php_ext		PHP file extension
-	*/
+	 * Constructor
+	 *
+	 * @param \vinabb\web\controllers\cache\service_interface	$cache			Cache service
+	 * @param ContainerInterface									$container		Container object
+	 * @param \phpbb\language\language							$language		Language object
+	 * @param \phpbb\log\log										$log			Log object
+	 * @param \vinabb\web\operators\bbook_chapter_interface		$operator		Chapter operators
+	 * @param \phpbb\request\request								$request		Request object
+	 * @param \phpbb\template\template							$template		Template object
+	 * @param \phpbb\user										$user			User object
+	 * @param \vinabb\web\controllers\helper\helper_interface	$ext_helper		Extension helper
+	 * @param string												$root_path		phpBB root path
+	 * @param string												$php_ext		PHP file extension
+	 */
 	public function __construct(
 		\vinabb\web\controllers\cache\service_interface $cache,
 		ContainerInterface $container,
@@ -103,10 +103,10 @@ 
 	}
 
 	/**
-	* Set form data
-	*
-	* @param array $data Form data
-	*/
+	 * Set form data
+	 *
+	 * @param array $data Form data
+	 */
 	public function set_form_data($data)
 	{
 		$this->book_id = $data['book_id'];
@@ -114,10 +114,10 @@ 
 	}
 
 	/**
-	* Display chapters
-	*
-	* @param int $parent_id Parent ID
-	*/
+	 * Display chapters
+	 *
+	 * @param int $parent_id Parent ID
+	 */
 	public function display_chapters($parent_id = 0)
 	{
 		// Grab all from database
@@ -174,10 +174,10 @@ 
 	}
 
 	/**
-	* Add a chapter
-	*
-	* @param int $parent_id Parent ID
-	*/
+	 * Add a chapter
+	 *
+	 * @param int $parent_id Parent ID
+	 */
 	public function add_chapter($parent_id = 0)
 	{
 		// Initiate an entity
@@ -199,10 +199,10 @@ 
 	}
 
 	/**
-	* Edit a chapter
-	*
-	* @param int $chapter_id Chapter ID
-	*/
+	 * Edit a chapter
+	 *
+	 * @param int $chapter_id Chapter ID
+	 */
 	public function edit_chapter($chapter_id)
 	{
 		// Initiate and load the entity
@@ -225,10 +225,10 @@ 
 	}
 
 	/**
-	* Process data to be added or edited
-	*
-	* @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
-	*/
+	 * Process data to be added or edited
+	 *
+	 * @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
+	 */
 	public function add_edit_data(\vinabb\web\entities\bbook_chapter_interface $entity)
 	{
 		$submit = $this->request->is_set_post('submit');
@@ -273,8 +273,8 @@ 
 	}
 
 	/**
-	* Request data from the form
-	*/
+	 * Request data from the form
+	 */
 	protected function request_data()
 	{
 		$this->data = [
@@ -286,14 +286,14 @@ 
 	}
 
 	/**
-	* Grab the form data's parsing options and set them to the entity
-	*
-	* If submit, use data from the form
-	* In edit mode, use data stored in the entity
-	* In add mode, use default values
-	*
-	* @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
-	*/
+	 * Grab the form data's parsing options and set them to the entity
+	 *
+	 * If submit, use data from the form
+	 * In edit mode, use data stored in the entity
+	 * In add mode, use default values
+	 *
+	 * @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
+	 */
 	protected function set_bbcode_options(\vinabb\web\entities\bbook_chapter_interface $entity, $submit)
 	{
 		$entity->text_enable_bbcode($submit ? $this->request->is_set_post('text_bbcode') : ($entity->get_id() ? $entity->text_bbcode_enabled() : true));
@@ -302,10 +302,10 @@ 
 	}
 
 	/**
-	* Map the form data fields to setters and set them to the entity
-	*
-	* @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
-	*/
+	 * Map the form data fields to setters and set them to the entity
+	 *
+	 * @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
+	 */
 	protected function map_set_data(\vinabb\web\entities\bbook_chapter_interface $entity)
 	{
 		$map_fields = [
@@ -334,10 +334,10 @@ 
 	}
 
 	/**
-	* Insert or update data, then log actions and clear cache if needed
-	*
-	* @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
-	*/
+	 * Insert or update data, then log actions and clear cache if needed
+	 *
+	 * @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
+	 */
 	protected function save_data(\vinabb\web\entities\bbook_chapter_interface $entity)
 	{
 		if ($entity->get_id())
@@ -376,10 +376,10 @@ 
 	}
 
 	/**
-	* Output entity data to template variables
-	*
-	* @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
-	*/
+	 * Output entity data to template variables
+	 *
+	 * @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
+	 */
 	protected function data_to_tpl(\vinabb\web\entities\bbook_chapter_interface $entity)
 	{
 		$this->template->assign_vars([
@@ -389,12 +389,12 @@ 
 	}
 
 	/**
-	* Move a rule up/down
-	*
-	* @param int	$chapter_id	Chapter ID
-	* @param string	$direction	The direction (up|down)
-	* @param int	$amount		The number of places to move
-	*/
+	 * Move a rule up/down
+	 *
+	 * @param int	$chapter_id	Chapter ID
+	 * @param string	$direction	The direction (up|down)
+	 * @param int	$amount		The number of places to move
+	 */
 	public function move_chapter($chapter_id, $direction, $amount = 1)
 	{
 		// Check the valid link hash
@@ -428,10 +428,10 @@ 
 	}
 
 	/**
-	* Delete a chapter
-	*
-	* @param int $chapter_id Chapter ID
-	*/
+	 * Delete a chapter
+	 *
+	 * @param int $chapter_id Chapter ID
+	 */
 	public function delete_chapter($chapter_id)
 	{
 		/** @var \vinabb\web\entities\bbook_chapter_interface $entity */
@@ -461,12 +461,12 @@ 
 	}
 
 	/**
-	* Generate options of available parents
-	*
-	* @param \vinabb\web\entities\bbook_chapter_interface	$entity		Chapter entity
-	* @param int											$parent_id	Parent ID
-	* @param string											$mode		Add or edit mode?
-	*/
+	 * Generate options of available parents
+	 *
+	 * @param \vinabb\web\entities\bbook_chapter_interface	$entity		Chapter entity
+	 * @param int											$parent_id	Parent ID
+	 * @param string											$mode		Add or edit mode?
+	 */
 	protected function build_parent_options(\vinabb\web\entities\bbook_chapter_interface $entity, $parent_id = 0, $mode = 'edit')
 	{
 		$options = $this->operator->get_chapters($this->book_id);

ext/vinabb/web/controllers/acp/bbook_chapters_interface.php

Indentation +30 added lines, -30 removed lines

@@ -14,53 +14,53 @@
 interface bbook_chapters_interface
 {
 	/**
-	* Set form data
-	*
-	* @param array $data Form data
-	*/
+	 * Set form data
+	 *
+	 * @param array $data Form data
+	 */
 	public function set_form_data($data);
 
 	/**
-	* Display chapters
-	*
-	* @param int $parent_id Parent ID
-	*/
+	 * Display chapters
+	 *
+	 * @param int $parent_id Parent ID
+	 */
 	public function display_chapters($parent_id = 0);
 
 	/**
-	* Add a chapter
-	*
-	* @param int $parent_id Parent ID
-	*/
+	 * Add a chapter
+	 *
+	 * @param int $parent_id Parent ID
+	 */
 	public function add_chapter($parent_id = 0);
 
 	/**
-	* Edit a chapter
-	*
-	* @param int $chapter_id Chapter ID
-	*/
+	 * Edit a chapter
+	 *
+	 * @param int $chapter_id Chapter ID
+	 */
 	public function edit_chapter($chapter_id);
 
 	/**
-	* Process data to be added or edited
-	*
-	* @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
-	*/
+	 * Process data to be added or edited
+	 *
+	 * @param \vinabb\web\entities\bbook_chapter_interface $entity Chapter entity
+	 */
 	public function add_edit_data(\vinabb\web\entities\bbook_chapter_interface $entity);
 
 	/**
-	* Move a rule up/down
-	*
-	* @param int	$chapter_id	Chapter ID
-	* @param string	$direction	The direction (up|down)
-	* @param int	$amount		The number of places to move
-	*/
+	 * Move a rule up/down
+	 *
+	 * @param int	$chapter_id	Chapter ID
+	 * @param string	$direction	The direction (up|down)
+	 * @param int	$amount		The number of places to move
+	 */
 	public function move_chapter($chapter_id, $direction, $amount = 1);
 
 	/**
-	* Delete a chapter
-	*
-	* @param int $chapter_id Chapter ID
-	*/
+	 * Delete a chapter
+	 *
+	 * @param int $chapter_id Chapter ID
+	 */
 	public function delete_chapter($chapter_id);
 }