ovidiul / XCloner-Wordpress

includes/class-xcloner-archive.php

Doc Comments +26 added lines

@@ -44,6 +44,11 @@ 
 	 * Rename backup archive
 	 * 
 	 */ 
+
+	/**
+	 * @param string $old_name
+	 * @param string $new_name
+	 */
 	public function rename_archive($old_name, $new_name)
 	{
 		$this->logger->info(sprintf("Renaming backup archive %s to %s", $old_name, $new_name));
@@ -108,6 +113,10 @@ 
 	 * Send notification error by E-Mail
 	 * 
 	 */
+
+	/**
+	 * @param string $error_message
+	 */
 	public function send_notification_error($to, $from, $subject, $backup_name, $params, $error_message)
 	{
 		
@@ -132,6 +141,11 @@ 
 	 * Send backup archive notfication by E-Mail
 	 * 
 	 */ 
+
+	/**
+	 * @param string $from
+	 * @param string $subject
+	 */
 	public function send_notification($to, $from, $subject, $backup_name, $params, $error_message="")
 	{
 		if(!$from)
@@ -204,6 +218,10 @@ 
 	 * Incremental Backup method
 	 * 
 	 */ 
+
+	/**
+	 * @param integer $init
+	 */
 	public function start_incremental_backup($backup_params, $extra_params, $init)
 	{
 		if(!isset($extra_params['backup_part']))
@@ -416,6 +434,10 @@ 
 	 * Write multipart file components
 	 * 
 	 */ 
+
+	/**
+	 * @param string $path
+	 */
 	private function write_multipart_file($path)
 	{
 		$path = $this->get_archive_name_with_extension();
@@ -475,6 +497,10 @@ 
 	 * Add file to archive
 	 * 
 	 */ 
+
+	/**
+	 * @param integer $append
+	 */
 	public function add_file_to_archive($file_info, $start_at_byte, $byte_limit = 0, $append, $filesystem)
 	{
 		

includes/class-xcloner-database.php

Doc Comments +5 added lines

@@ -469,6 +469,11 @@
 	 * 		handler $fd - file handler where to write the records
 	 * @return
 	 */
+
+	/**
+	 * @param integer $start
+	 * @param integer $limit
+	 */
 	public function export_table($databaseName, $tableName, $start, $limit, $dumpfile)
 	{
 		$this->logger->debug(sprintf(("Exporting table  %s.%s data"), $databaseName, $tableName));

includes/class-xcloner-file-transfer.php

Doc Comments +3 added lines

@@ -87,6 +87,9 @@
 		return ftell($fp);
 	}
 	
+	/**
+	 * @param string $filename
+	 */
 	function curl_file_create($filename, $mimetype = '', $postname = '') {
 		if (!function_exists('curl_file_create')) {
 	        

includes/class-xcloner-remote-storage.php

Doc Comments +3 added lines

@@ -142,6 +142,9 @@
 		
 	}
 	
+	/**
+	 * @param string $storage_type
+	 */
 	public function verify_filesystem($storage_type)
 	{
 		$method = "get_".$storage_type."_filesystem";

includes/class-xcloner-settings.php

Doc Comments +9 added lines

@@ -22,6 +22,9 @@ 
 		return $filename;
 	}
 	
+	/**
+	 * @return string
+	 */
 	public function get_xcloner_start_path()
 	{
 		if(!get_option('xcloner_start_path') or !is_dir(get_option('xcloner_start_path')))
@@ -39,6 +42,9 @@ 
 		return $path;
 	}
 	
+	/**
+	 * @return string
+	 */
 	public function get_xcloner_store_path()
 	{
 		if(!get_option('xcloner_store_path')  or !is_dir(get_option('xcloner_store_path')))
@@ -175,6 +181,9 @@ 
 		return $wpdb->prefix;
 	}
 	
+	/**
+	 * @param string $option
+	 */
 	public function get_xcloner_option($option)
 	{
 		$data = get_option($option);

includes/class-xcloner.php

Doc Comments +3 added lines

@@ -115,6 +115,9 @@
 		
 	}
 	
+	/**
+	 * @param string $message
+	 */
 	public function trigger_message($message, $status = "error", $message_param1 = "", $message_param2 = "", $message_param3 = "")
 	{
 			$message = sprintf(__($message), $message_param1, $message_param2, $message_param3);

includes/class-xcloner-file-system.php

Doc Comments +9 added lines

@@ -186,6 +186,9 @@ 
 		return $total;		
 	}
 	
+	/**
+	 * @param string $backup_name
+	 */
 	public function is_part($backup_name)
 	{
 		if(stristr($backup_name, "-part"))
@@ -576,6 +579,9 @@ 
 		
 	}
 	
+	/**
+	 * @param string $tmp_file
+	 */
 	public function estimate_reading_time($tmp_file)
 	{
 		$this->logger->debug(sprintf(("Estimating file system reading time")));
@@ -635,6 +641,9 @@ 
         //return ($a ($direction == 'desc' ? '>' : '<')  $b) ? -1 : 1;
 	}
 	
+	/**
+	 * @param string $field
+	 */
 	public function sort_by( &$array, $field, $direction = 'asc')
 	{
 		$this->sort_direction = strtolower($direction);