Merge pull request #1148 from xwp/feature/connector-unregister-function

Adds connector unregister functionality
xwp · Aug 6, 2020 · 80477f7 · 80477f7
2 parents 0223f7e + 1369b68
commit 80477f7
Show file tree

Hide file tree

Showing 4 changed files with 141 additions and 1 deletion.
diff --git a/classes/class-connector.php b/classes/class-connector.php
@@ -54,15 +54,54 @@ abstract class Connector {
 	 */
 	public $register_frontend = true;
 
+	/**
+	 * Holds connector registration status flag.
+	 *
+	 * @var bool
+	 */
+	private $is_registered = false;
+
+	/**
+	 * Is the connector currently registered?
+	 *
+	 * @return boolean
+	 */
+	public function is_registered() {
+		return $this->is_registered;
+	}
+
 	/**
 	 * Register all context hooks
 	 */
 	public function register() {
+		if ( $this->is_registered ) {
+			return;
+		}
+
 		foreach ( $this->actions as $action ) {
 			add_action( $action, array( $this, 'callback' ), 10, 99 );
 		}
 
 		add_filter( 'wp_stream_action_links_' . $this->name, array( $this, 'action_links' ), 10, 2 );
+
+		$this->is_registered = true;
+	}
+
+	/**
+	 * Unregister all context hooks
+	 */
+	public function unregister() {
+		if ( ! $this->is_registered ) {
+			return;
+		}
+
+		foreach ( $this->actions as $action ) {
+			remove_action( $action, array( $this, 'callback' ), 10, 99 );
+		}
+
+		remove_filter( 'wp_stream_action_links_' . $this->name, array( $this, 'action_links' ), 10, 2 );
+
+		$this->is_registered = false;
 	}
 
 	/**

diff --git a/classes/class-connectors.php b/classes/class-connectors.php
@@ -234,4 +234,44 @@ public function load_connectors() {
 		 */
 		do_action( 'wp_stream_after_connectors_registration', $labels, $this );
 	}
+
+	/**
+	 * Unregisters the context hooks for all connectors.
+	 */
+	public function unload_connectors() {
+		foreach ( $this->connectors as $connector ) {
+			$connector->unregister();
+		}
+	}
+
+	/**
+	 * Reregisters the context hooks for all connectors.
+	 */
+	public function reload_connectors() {
+		foreach ( $this->connectors as $connector ) {
+			$connector->register();
+		}
+	}
+
+	/**
+	 * Unregisters the context hooks for a connectors.
+	 *
+	 * @param string $name  Name of the connector.
+	 */
+	public function unload_connector( $name ) {
+		if ( ! empty( $this->connectors[ $name ] ) ) {
+			$this->connectors[ $name ]->unregister();
+		}
+	}
+
+	/**
+	 * Reregisters the context hooks for a connector.
+	 *
+	 * @param string $name  Name of the connector.
+	 */
+	public function reload_connector( $name ) {
+		if ( ! empty( $this->connectors[ $name ] ) ) {
+			$this->connectors[ $name ]->register();
+		}
+	}
 }
diff --git a/tests/tests/test-class-connector.php b/tests/tests/test-class-connector.php
@@ -28,6 +28,20 @@ public function test_register() {
 		}
 	}
 
+	public function test_unregister() {
+		$this->connector->register();
+
+		foreach ( $this->connector->actions as $tag ) {
+			$this->assertGreaterThan( 0, has_action( $tag ) );
+		}
+
+		$this->connector->unregister();
+
+		foreach ( $this->connector->actions as $tag ) {
+			$this->assertFalse( has_action( $tag ) );
+		}
+	}
+
 	public function test_callback() {
 		global $wp_current_filter;
 		$action = $this->connector->actions[0];
@@ -222,4 +236,4 @@ public function callback_simulate_fault() {
 		// This is used to check if this callback method actually ran
 		do_action( 'wp_stream_test_child_callback_simulate_fault' );
 	}
-}
+}
diff --git a/tests/tests/test-class-connectors.php b/tests/tests/test-class-connectors.php
@@ -35,4 +35,51 @@ public function test_load_connectors() {
 
 		$this->assertEmpty( $notices );
 	}
+
+	public function test_unload_connectors() {
+		$this->connectors->load_connectors();
+		$this->assertNotEmpty( $this->connectors->connectors );
+
+		foreach( $this->connectors->connectors as $connector ) {
+			$this->assertTrue( $connector->is_registered() );
+		}
+
+		$this->connectors->unload_connectors();
+		foreach( $this->connectors->connectors as $connector ) {
+			$this->assertFalse( $connector->is_registered() );
+		}
+	}
+
+	public function test_reload_connectors() {
+		$this->connectors->load_connectors();
+		$this->assertNotEmpty( $this->connectors->connectors );
+		$this->connectors->unload_connectors();
+		foreach( $this->connectors->connectors as $connector ) {
+			$this->assertFalse( $connector->is_registered() );
+		}
+
+		$this->connectors->reload_connectors();
+		foreach( $this->connectors->connectors as $connector ) {
+			$this->assertTrue( $connector->is_registered() );
+		}
+	}
+
+	public function test_unload_connector() {
+		$this->connectors->load_connectors();
+		$this->assertNotEmpty( $this->connectors->connectors['posts'] );
+		$this->assertTrue( $this->connectors->connectors['posts']->is_registered() );
+
+		$this->connectors->unload_connector( 'posts' );
+		$this->assertFalse( $this->connectors->connectors['posts']->is_registered() );
+	}
+
+	public function test_reload_connector() {
+		$this->connectors->load_connectors();
+		$this->assertNotEmpty( $this->connectors->connectors['posts'] );
+		$this->connectors->unload_connector( 'posts' );
+		$this->assertFalse( $this->connectors->connectors['posts']->is_registered() );
+
+		$this->connectors->reload_connector( 'posts' );
+		$this->assertTrue( $this->connectors->connectors['posts']->is_registered() );
+	}
 }