podlove / podlove-subscribe-button-wp-plugin

inc/Migration.php

<?php

Filenames should be all lowercase with hyphens as word separators. Expected migration.php, but found Migration.php.

Class file names should be based on the class name with "class-" prepended. Expected class-migration.php, but found Migration.php.

/**
 * @author    Podlove <podlove@podlove.org>
 * @copyright Copyright (c) 2014-2018, Podlove
 * @license   https://github.com/podlove/podlove-subscribe-button-wp-plugin/blob/master/LICENSE MIT
 * @package   Podlove\PodloveSubscribeButton
 */

/**
 * Version management for database migrations.
 *
 * Database changes require special care:
 * - the model has to be adjusted for users installing the plugin
 * - the current setup has to be migrated for current users
 *
 * These migrations are a way to handle current users. They do *not*
 * run on plugin activation.
 *
 * Pattern:
 *
 * - increment \PodloveSubscribeButton\DATABASE_VERSION constant by 1, e.g.
 * 		```php
 * 		define( __NAMESPACE__ . '\DATABASE_VERSION', 2 );
 * 		```
 *
 * - add a case in `\PodloveSubscribeButton\run_migrations_for_version`, e.g.
 * 		```php
 * 		function run_migrations_for_version( $version ) {
 *			global $wpdb;
 *			switch ( $version ) {
 *				case 2:
 *					$wbdb-> // run sql or whatever
 *					break;
 *			}
 *		}
 *		```
 *
 *		Feel free to move the migration code into a separate function if it's
 *		rather complex.
 *
 * - adjust the main model / setup process so new users installing the plugin
 *   will have these changes too
 *
 * - Test the migrations! :)
 */

namespace PodloveSubscribeButton;
use \PodloveSubscribeButton\Model;

define( __NAMESPACE__ . '\DATABASE_VERSION', 3 );

class Migration {

Missing doc comment for class Migration

	public static function eval_db() {

Method name "Migration::eval_db" is not in camel caps format

Missing doc comment for function eval_db()

		add_action( 'admin_init', array( 'PodloveSubscribeButton\Migration', 'maybe_run_database_migrations' ) );
		add_action( 'admin_init', array( 'PodloveSubscribeButton\Migration', 'run_database_migrations' ), 5 );
	}

Expected 1 blank line before closing function brace; 0 found

	public static function maybe_run_database_migrations() {

Method name "Migration::maybe_run_database_migrations" is not in camel caps format

Missing doc comment for function maybe_run_database_migrations()

		$database_version = get_option( 'podlove_subscribe_button_plugin_database_version' );

		if ( $database_version === false ) {
			// plugin has just been installed or Plugin Version < 1.3
			update_option( 'podlove_subscribe_button_plugin_database_version', DATABASE_VERSION );
		}

	}

	public static function run_database_migrations() {

Method name "Migration::run_database_migrations" is not in camel caps format

Missing doc comment for function run_database_migrations()

		if ( get_option( 'podlove_subscribe_button_plugin_database_version' ) >= DATABASE_VERSION ) {
			return;
		}

		if ( is_multisite() ) {
			set_time_limit( 0 ); // may take a while, depending on network size
			Helpers::for_every_podcast_blog( function() { self::migrate_for_current_blog(); });

Expected 1 spaces before closing bracket; 0 found

Opening brace must be the last content on the line

Closing brace of nested function must be on a new line

It is generally recommended to place each PHP statement on a line by itself.

		} else {
			self::migrate_for_current_blog();
		}

		if ( isset( $_REQUEST[ '_wp_http_referer' ] ) && $_REQUEST[ '_wp_http_referer' ] ) {
			wp_redirect( $_REQUEST[ '_wp_http_referer' ] );
			exit;
		}
	}

	public static function migrate_for_current_blog() {

Method name "Migration::migrate_for_current_blog" is not in camel caps format

Missing doc comment for function migrate_for_current_blog()

		$database_version = get_option( 'podlove_subscribe_button_plugin_database_version' );

		for ( $i = $database_version + 1; $i <= DATABASE_VERSION; $i++ ) {
			self::run_migrations_for_version( $i );
			update_option( 'podlove_subscribe_button_plugin_database_version', $i );
		}

	}

	/**
	 * Find and run migration for given version number.
	 *
	 * @todo  move migrations into separate files
	 *
	 * @param  int $version
	 */
	private static function run_migrations_for_version( $version ) {

Method name "Migration::run_migrations_for_version" is not in camel caps format

		global $wpdb;

		switch ( $version ) {
			case 3:
				self::migration_case_3();
				break;
		}

	}

	private static function migration_case_3() {

Method name "Migration::migration_case_3" is not in camel caps format

Missing doc comment for function migration_case_3()

		/** @todo */

Missing short description in doc comment

		// 1. multiple options -> 1 option as associative array

There should be no blank line after an inline comment.

		// 2. DB !?

There must be no blank line following an inline comment

	}

}