humanmade / backupwordpress

classes/backup/class-site-backup.php

Doc Comments +9 added lines

@@ -72,6 +72,9 @@ 
 
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public function set_type( $type ) {
 		$this->type = $type;
 	}
@@ -80,10 +83,16 @@ 
 		$this->excludes = $excludes;
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public function set_database_dump_filename( $filename ) {
 		$this->database_dump_filename = $filename;
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public function set_backup_filename( $filename ) {
 		$this->backup_filename = $filename;
 	}

classes/class-backup.php

Doc Comments +7 added lines, -3 removed lines

@@ -221,6 +221,9 @@ 
 
 	}
 
+	/**
+	 * @param string $ini_setting
+	 */
 	protected static function is_function_disabled( $ini_setting ) {
 
 		if ( array_intersect( array(
@@ -442,7 +445,7 @@ 
 	 *
 	 * @param string $existing_archive_filepath
 	 *
-	 * @return null
+	 * @return \WP_Error|null
 	 */
 	public function set_existing_archive_filepath( $existing_archive_filepath ) {
 
@@ -1370,6 +1373,7 @@ 
 	/**
 	 * Get the errors
 	 *
+	 * @param string $context
 	 */
 	public function get_errors( $context = null ) {
 
@@ -1385,7 +1389,7 @@ 
 	 * Add an error to the errors stack
 	 *
 	 * @param string $context
-	 * @param mixed $error
+	 * @param string $error
 	 */
 	public function error( $context, $error ) {
 
@@ -1402,7 +1406,7 @@ 
 	/**
 	 * Migrate errors to warnings
 	 *
-	 * @param null $context
+	 * @param string $context
 	 */
 	private function errors_to_warnings( $context = null ) {
 

classes/class-path.php

Doc Comments +1 added lines, -2 removed lines

@@ -137,7 +137,7 @@ 
 	/**
 	 * Set the path directly, overriding the default
 	 *
-	 * @param $path
+	 * @param boolean $path
 	 */
 	public function set_path( $path ) {
 
@@ -363,7 +363,6 @@ 
 	 * Move backup files from an existing directory and the new
 	 * location
 	 *
-	 * @param string $path 	The path to move the backups from
 	 */
 	public function move_old_backups( $from ) {
 

classes/class-requirement.php

Doc Comments +3 added lines, -3 removed lines

@@ -19,14 +19,14 @@ 
 	abstract protected function test();
 
 	/**
-	 * @return mixed
+	 * @return string
 	 */
 	public function name() {
 		return $this->name;
 	}
 
 	/**
-	 * @return mixed|string
+	 * @return string
 	 */
 	public function result() {
 
@@ -524,7 +524,7 @@ 
 	var $name = 'WP Cron Test Failed';
 
 	/**
-	 * @return mixed
+	 * @return boolean
 	 */
 	protected function test() {
 		return (bool) get_option( 'hmbkp_wp_cron_test_failed' );

classes/class-site-size.php

Doc Comments +1 added lines, -2 removed lines

@@ -53,7 +53,6 @@ 
 	/**
 	 * Convenience function to format the file size
 	 *
-	 * @param bool $cached
 	 *
 	 * @return bool|string
 	 */
@@ -64,7 +63,7 @@ 
 	/**
 	 * Whether the total filesize is being calculated
 	 *
-	 * @return int            The total of the file or directory
+	 * @return boolean            The total of the file or directory
 	 */
 	public static function is_site_size_being_calculated() {
 		return false !== get_transient( 'hmbkp_directory_filesizes_running' );

classes/class-schedule.php

Doc Comments +5 added lines, -2 removed lines

@@ -166,7 +166,7 @@ 
 	/**
 	 * Set the exclude rules
 	 *
-	 * @param mixed $excludes A comma separated list or array of exclude rules
+	 * @param mixed $exclude_rules A comma separated list or array of exclude rules
 	 * @param bool $append Whether to replace or append to existing rules
 	 *
 	 * @return string
@@ -208,7 +208,7 @@ 
 	 * Get the array of services options for this schedule
 	 *
 	 * @param      $service
-	 * @param null $option
+	 * @param string $option
 	 *
 	 * @return array
 	 */
@@ -285,6 +285,7 @@ 
 	/**
 	 * Get the schedule reoccurrence
 	 *
+	 * @return string
 	 */
 	public function get_reoccurrence() {
 		return $this->options['reoccurrence'];
@@ -661,6 +662,8 @@ 
 	 * Calculate schedule run time.
 	 *
 	 * @param int Timestamp $end
+	 * @param integer $start
+	 * @param integer $end
 	 */
 	public function update_average_schedule_run_time( $start, $end ) {
 

classes/backup/class-backup-engine-database-mysqldump.php

Doc Comments +1 added lines, -1 removed lines

@@ -177,7 +177,7 @@
 	/**
 	 * Get the connection args for the mysqldump command
 	 *
-	 * @return array The array of connection args
+	 * @return string[] The array of connection args
 	 */
 	public function get_mysql_connection_args() {
 

classes/backup/class-backup-engine.php

Doc Comments -1 removed lines

@@ -141,7 +141,6 @@
 	 * issues with the backup process.
 	 *
 	 * @param  string $context The context for the warning.
-	 * @param  string $error   The warning that was encountered.
 	 */
 	private function warning( $context, $warning ) {
 

classes/backup/class-backup-utilities.php

Doc Comments +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
 	/**
 	 * Attempt to work out path to a cli executable.
 	 *
-	 * @param  array $paths An array of paths to check against.
+	 * @param  string[] $paths An array of paths to check against.
 	 *
 	 * @return string|false        The path to the executable.
 	 */