New MantisSourceBase class

This new plugin base class is used to provide a common ancestor for all
Source Integration Framework Plugin classes.

Author: dregad

Source/MantisSourceBase.class.php

@@ -0,0 +1,23 @@
+<?php
+
+# Copyright (c) 2017 Damien Regad
+# Licensed under the MIT license
+
+require_once( config_get_global( 'class_path' ) . 'MantisPlugin.class.php' );
+
+/**
+ * Class MantisSourceBase
+ *
+ * Base class for all Source Integration Plugin classes
+ */
+abstract class MantisSourceBase extends MantisPlugin
+{
+	/**
+	 * Source Integration framework version.
+	 *
+	 * Numbering follows Semantic Versioning. Major version increments indicate
+	 * a change in the minimum required MantisBT version: 0=1.2; 1=1.3, 2=2.x.
+	 * The framework version is incremented when the plugin's core file change.
+	 */
+	const FRAMEWORK_VERSION = '1.3.1';
+}

Source/MantisSourcePlugin.class.php

@@ -3,11 +3,13 @@
 # Copyright (c) 2012 John Reese
 # Licensed under the MIT license
 
+require_once( 'MantisSourceBase.class.php' );
+
 /**
  * Abstract class for simplifying creation of source control plugins.
  * @author John Reese
  */
-abstract class MantisSourcePlugin extends MantisPlugin {
+abstract class MantisSourcePlugin extends MantisSourceBase {
 	public function hooks() {
 		return array(
 			'EVENT_SOURCE_INTEGRATION'		=> 'integration',
@@ -172,7 +174,7 @@ final public function _precommit( $p_event ) {
 class SourceGenericPlugin extends MantisSourcePlugin {
 	function register() {
 		$this->name = plugin_lang_get( 'title', 'Source' );
-		$this->version = SourcePlugin::$framework_version;
+		$this->version = self::FRAMEWORK_VERSION;
 	}
 
 	public $type = 'generic';

Source/Source.php

@@ -3,14 +3,14 @@
 # Copyright (c) 2012 John Reese
 # Licensed under the MIT license
 
-require_once( config_get_global( 'class_path' ) . 'MantisPlugin.class.php' );
+require_once( 'MantisSourceBase.class.php' );
 
 /**
  * Creates an extensible API for integrating source control applications
  * with the Mantis bug tracker software.
  */
-class SourcePlugin extends MantisPlugin {
-	static $framework_version = '1.3.1';
+class SourcePlugin extends MantisSourceBase {
+
 	static $cache = array();
 
 	/**
@@ -28,7 +28,7 @@ function register() {
 		$this->name = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );
 
-		$this->version = self::$framework_version;
+		$this->version = self::FRAMEWORK_VERSION;
 		$this->requires = array(
 			'MantisCore' => '1.3.0',
 		);

Source/SourceIntegration.php

@@ -3,10 +3,10 @@
 # Copyright (c) 2012 John Reese
 # Licensed under the MIT license
 
-final class SourceIntegrationPlugin extends MantisPlugin {
+final class SourceIntegrationPlugin extends MantisSourceBase {
 	function register() {
 		$this->name = plugin_lang_get( 'title', 'Source' );
-		$this->version = SourcePlugin::$framework_version;
+		$this->version = self::FRAMEWORK_VERSION;
 	}
 
 	function hooks() {