New API function msls_options()

lloc · lloc · commit 97005f98482d · 2024-05-14T14:30:57.000+02:00
diff --git a/MultisiteLanguageSwitcher.php b/MultisiteLanguageSwitcher.php
@@ -30,7 +30,7 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-if ( file_exists( __DIR__ . '/vendor/autoload.php' ) ) {
+if ( file_exists(__DIR__ . '/vendor/autoload.php' ) ) {
 	require __DIR__ . '/vendor/autoload.php';
 }
 
@@ -128,8 +128,8 @@ function get_msls_permalink( string $locale, string $default = '' ): string {
 	}
 
 	/**
-	 * Gets a blog by locale
-	 *
+     * Looks for the MslsBlog instance for a specific locale
+     *
 	 * @param string $locale
 	 *
 	 * @return \lloc\Msls\MslsBlog|null
@@ -147,4 +147,12 @@ function msls_blog_collection(): \lloc\Msls\MslsBlogCollection {
 		return \lloc\Msls\MslsBlogCollection::instance();
 	}
 
+    /**
+     * Gets the MslsOptions instance
+     *
+     * @return \lloc\Msls\MslsOptions
+     */
+    function msls_options(): \lloc\Msls\MslsOptions {
+        return \lloc\Msls\MslsOptions::instance();
+    }
 }
diff --git a/includes/ContentImport/Service.php b/includes/ContentImport/Service.php
@@ -21,7 +21,7 @@ class Service extends MslsRegistryInstance {
 	 * @return bool Whether the content import functionality support classes where hooked or not.
 	 */
 	public function register() {
-		if ( ! MslsOptions::instance()->activate_content_import ) {
+		if ( ! msls_options()->activate_content_import ) {
 			return false;
 		}
 
diff --git a/includes/MslsAdmin.php b/includes/MslsAdmin.php
@@ -37,10 +37,9 @@ class MslsAdmin extends MslsMain {
 	 */
 	public static function init() {
 		if ( ! ( $obj = MslsRegistry::get_object( __CLASS__ ) ) ) {
-			$options    = MslsOptions::instance();
 			$collection = msls_blog_collection();
 
-			$obj = new static( $options, $collection );
+			$obj = new static( msls_options(), $collection );
 
 			MslsRegistry::set_object( __CLASS__, $obj );
 
diff --git a/includes/MslsBlogCollection.php b/includes/MslsBlogCollection.php
@@ -7,8 +7,6 @@
 
 namespace lloc\Msls;
 
-use const Patchwork\CodeManipulation\Actions\RedefinitionOfNew\publicizeConstructors;
-
 /**
  * Collection of blog-objects
  *
@@ -62,7 +60,7 @@ public function __construct() {
 
 		$this->current_blog_id = get_current_blog_id();
 
-		$options = MslsOptions::instance();
+		$options = msls_options();
 
 		$this->current_blog_output = isset( $options->output_current_blog );
 		$this->objects_order       = $options->get_order();
diff --git a/includes/MslsCustomColumn.php b/includes/MslsCustomColumn.php
@@ -22,7 +22,7 @@ class MslsCustomColumn extends MslsMain {
 	 * @return MslsCustomColumn
 	 */
 	public static function init() {
-		$options    = MslsOptions::instance();
+		$options    = msls_options();
 		$collection = msls_blog_collection();
 		$obj        = new static( $options, $collection );
 
diff --git a/includes/MslsCustomColumnTaxonomy.php b/includes/MslsCustomColumnTaxonomy.php
@@ -22,7 +22,7 @@ class MslsCustomColumnTaxonomy extends MslsCustomColumn {
 	 * @return MslsCustomColumnTaxonomy
 	 */
 	public static function init() {
-		$options    = MslsOptions::instance();
+		$options    = msls_options();
 		$collection = msls_blog_collection();
 		$obj        = new static( $options, $collection );
 
diff --git a/includes/MslsCustomFilter.php b/includes/MslsCustomFilter.php
@@ -22,7 +22,7 @@ class MslsCustomFilter extends MslsMain {
 	 * @return MslsCustomFilter
 	 */
 	public static function init() {
-		$options = MslsOptions::instance();
+		$options = msls_options();
 		$collection = msls_blog_collection();
 		$obj = new static( $options, $collection );
 
diff --git a/includes/MslsMain.php b/includes/MslsMain.php
@@ -47,10 +47,7 @@ public function __construct( MslsOptions $options, MslsBlogCollection $collectio
 	 * @return static
 	 */
 	public static function init() {
-		$options    = MslsOptions::instance();
-		$collection = msls_blog_collection();
-
-		return new static( $options, $collection );
+		return new static( msls_options(), msls_blog_collection() );
 	}
 
 	/**
diff --git a/includes/MslsMetaBox.php b/includes/MslsMetaBox.php
@@ -1,4 +1,5 @@
-<?php
+<?php declare( strict_types=1 );
+
 /**
  * MslsMetaBox
  * @author Dennis Ploetner <re@lloc.de>
@@ -82,7 +83,6 @@ public static function get_suggested_fields( $json, $args ) {
 			 *
 			 */
 			$my_query->post = apply_filters( 'msls_meta_box_suggest_post', $my_query->post );
-
 			if ( is_object( $my_query->post ) ) {
 				$json->add( get_the_ID(), get_the_title() );
 			}
@@ -102,9 +102,8 @@ public static function get_suggested_fields( $json, $args ) {
 	 * @return MslsMetaBox
 	 */
 	public static function init() {
-		$options    = MslsOptions::instance();
-		$collection = msls_blog_collection();
-		$obj        = new static( $options, $collection );
+		$options = msls_options();
+		$obj     = new static( $options, msls_blog_collection() );
 
 		if ( ! $options->is_excluded() ) {
 			add_action( 'add_meta_boxes', [ $obj, 'add' ] );
@@ -129,7 +128,7 @@ public function add() {
 				[
 					$this,
 					(
-					MslsOptions::instance()->activate_autocomplete ?
+					msls_options()->activate_autocomplete ?
 						'render_input' :
 						'render_select'
 					),
@@ -139,7 +138,7 @@ public function add() {
 				'high'
 			);
 
-			if ( MslsOptions::instance()->activate_content_import ) {
+			if ( msls_options()->activate_content_import ) {
 				add_meta_box(
 					'msls-content-import',
 					apply_filters(
@@ -252,7 +251,7 @@ public function render_select() {
 	 *
 	 * @return string
 	 */
-	public function render_options( $type, $msls_id ) {
+	public function render_options( $type, $msls_id ): string {
 		$options = [];
 
 		$my_query = new \WP_Query( [
diff --git a/includes/MslsOptions.php b/includes/MslsOptions.php
@@ -105,23 +105,26 @@ public static function create( $id = 0 ) {
 	}
 
 	/**
-	 * Checks if the current page is a home, front or 404 page
-	 * @return boolean
+	 * Determines if the current page is the main page (front page, search, 404).
+     *
+     * @return boolean
 	 */
 	public static function is_main_page() {
 		return is_front_page() || is_search() || is_404();
 	}
 
 	/**
-	 * Checks if the current page is a category, tag or any other tax archive
+	 * Determines if the current page is a category, tag or taxonomy page.
+     *
 	 * @return boolean
 	 */
 	public static function is_tax_page() {
 		return is_category() || is_tag() || is_tax();
 	}
 
 	/**
-	 * Checks if the current page is a date, author any other post_type archive
+	 * Determines if the current page is an archive page for a date, author, or any other post type.
+     *
 	 * @return boolean
 	 */
 	public static function is_query_page() {
@@ -139,8 +142,8 @@ public function __construct() {
 
 	/**
 	 * Gets an element of arg by index
-	 * The returning value is casted to the type of $retval or will be the
-	 * value of $retval if nothing is set at this index.
+     *
+	 * The returned value will either be cast to the type of `$retval` or, if nothing is set at this index, it will be the value of `$retval`.
 	 *
 	 * @param int $idx
 	 * @param mixed $val
diff --git a/includes/MslsPlugin.php b/includes/MslsPlugin.php
@@ -38,8 +38,7 @@ public function __construct( MslsOptions $options ) {
 	 * @return MslsPlugin
 	 */
 	public static function init() {
-		$options = MslsOptions::instance();
-		$obj     = new self( $options );
+		$obj     = new self( msls_options() );
 
 		add_action( 'plugins_loaded', [ $obj, 'init_i18n_support' ] );
 
@@ -124,7 +123,7 @@ public static function get_output() {
 	 * @return void
 	 */
 	public static function update_adminbar( \WP_Admin_Bar $wp_admin_bar ): void {
-		$icon_type = MslsOptions::instance()->get_icon_type();
+		$icon_type = msls_options()->get_icon_type();
 
 		$blog_collection = msls_blog_collection();
 		foreach ( $blog_collection->get_plugin_active_blogs() as $blog ) {
diff --git a/includes/MslsPostTag.php b/includes/MslsPostTag.php
@@ -79,7 +79,7 @@ public static function suggest() {
 	 * @return MslsPostTag
 	 */
 	public static function init() {
-		$options    = MslsOptions::instance();
+		$options    = msls_options();
 		$collection = msls_blog_collection();
 		$class      = $options->activate_autocomplete ? MslsPostTag::class : MslsPostTagClassic::class;
 		$obj        = new $class( $options, $collection );
diff --git a/includes/MslsTaxonomy.php b/includes/MslsTaxonomy.php
@@ -73,7 +73,7 @@ public function is_taxonomy() {
 	 * @return string
 	 */
 	public function acl_request() {
-		if ( ! MslsOptions::instance()->is_excluded() ) {
+		if ( ! msls_options()->is_excluded() ) {
 			$request = $this->get_request();
 
 			$tax = get_taxonomy( $request );
diff --git a/tests/TestMslsBlogCollection.php b/tests/TestMslsBlogCollection.php
@@ -17,22 +17,26 @@ class TestMslsBlogCollection extends MslsUnitTestCase {
 	protected function setUp(): void {
 		parent::setUp(); // TODO: Change the autogenerated stub
 
-		$a              = \Mockery::mock( MslsBlog::class );
-		$a->userblog_id = 1;
+        $options = \Mockery::mock( MslsOptions::class );
+        $options->shouldReceive( 'get_order' )->andReturn( 'description' );
+        $options->shouldReceive( 'is_excluded' )->andReturn( false );
+        $options->shouldReceive( 'has_value' )->andReturn( false );
 
-		$b              = \Mockery::mock( MslsBlog::class );
-		$b->userblog_id = 2;
+        Functions\expect( 'msls_options' )->atLeast()->once()->andReturn( $options );
 
-		$c              = \Mockery::mock( MslsBlog::class );
-		$c->userblog_id = 3;
+        $a = \Mockery::mock( MslsBlog::class );
+        $b = \Mockery::mock( MslsBlog::class );
+        $c = \Mockery::mock( MslsBlog::class );
 
-		Functions\expect( 'get_current_blog_id' )->atLeast( 1 )->andReturn( 1 );
+        $a->userblog_id = 1;
+        $b->userblog_id = 2;
+        $c->userblog_id = 3;
+
+        Functions\expect( 'get_current_blog_id' )->atLeast()->once()->andReturn( 1 );
 		Functions\expect( 'get_users' )->atLeast()->once()->andReturn( [] );
 		Functions\expect( 'get_blogs_of_user' )->atLeast()->once()->andReturn( [ $a, $b, $c ] );
 
-		Functions\expect( 'get_option' )->andReturn( [ 'output_current_blog' => true ] );
-
-		Functions\expect( 'get_blog_option' )->atLeast( 1 )->andReturnUsing( function ( $blog_id, $option ) {
+		Functions\expect( 'get_blog_option' )->atLeast()->once()->andReturnUsing( function ( $blog_id, $option ) {
 			$wplang = [
 				1 => 'de_DE',
 				2 => 'it_IT',
diff --git a/tests/TestMslsTaxonomy.php b/tests/TestMslsTaxonomy.php
@@ -9,12 +9,23 @@
 
 class TestMslsTaxonomy extends MslsUnitTestCase {
 
-	public function get_test(): MslsTaxonomy {
-		Functions\when( 'apply_filters' )->returnArg( 2 );
-		Functions\when( 'get_option' )->justReturn( [] );
+    /**
+     * @param bool $exluded
+     *
+     * @return MslsTaxonomy
+     */
+    public function get_test( bool $exluded = false ): MslsTaxonomy {
+        parent::setUp();
+
+        $options = \Mockery::mock( MslsOptions::class );
+        $options->shouldReceive( 'is_excluded' )->andReturn( $exluded );
+
+        Functions\expect( 'msls_options' )->zeroOrMoreTimes()->andReturn( $options );
+
+        Functions\expect( 'apply_filters' )->atLeast()->once();
 
 		Functions\expect( 'get_taxonomies' )->atLeast()->once()->andReturn( [] );
-		Functions\expect( 'get_query_var' )->with( 'taxonomy' )->andReturn( 'category' );
+		Functions\expect( 'get_query_var' )->atLeast()->once()->with( 'taxonomy' )->andReturn( 'category' );
 
 		return new MslsTaxonomy();
 	}
@@ -24,10 +35,6 @@ public function get_test(): MslsTaxonomy {
 	 * @preserveGlobalState disabled
 	 */
 	public function test_acl_request_included(): void {
-		$mock = \Mockery::mock( 'overload:' . MslsOptions::class );
-		$mock->shouldReceive( 'instance' )->andReturnSelf();
-		$mock->shouldReceive( 'is_excluded' )->andReturnFalse();
-
 		$cap               = new \stdClass();
 		$cap->manage_terms = 'manage_categories';
 		$taxonomy          = new \stdClass();
@@ -44,11 +51,7 @@ public function test_acl_request_included(): void {
 	 * @preserveGlobalState disabled
 	 */
 	public function test_acl_request_excluded(): void {
-		$mock = \Mockery::mock( 'overload:' . MslsOptions::class );
-		$mock->shouldReceive( 'instance' )->andReturnSelf();
-		$mock->shouldReceive( 'is_excluded' )->andReturnTrue();
-
-		$this->assertEquals( '', $this->get_test()->acl_request() );
+		$this->assertEquals( '', $this->get_test( true )->acl_request() );
 	}
 
 	public function test_get_post_type(): void {
@@ -63,15 +66,8 @@ public function test_is_taxonomy(): void {
 		$this->assertTrue( $this->get_test()->is_taxonomy() );
 	}
 
-	/**
-	 * @runInSeparateProcess
-	 * @preserveGlobalState disabled
-	 */
 	public function test_get_request(): void {
-		$plugin = \Mockery::mock( 'alias:' . MslsPlugin::class );
-		$plugin->shouldReceive( 'get_superglobals' )->andReturn( [ 'taxonomy' => 'abc' ] );
-
-		$this->assertEquals( 'abc', $this->get_test()->get_request() );
+		$this->assertEquals( 'category', $this->get_test()->get_request() );
 	}
 
 }
diff --git a/tests/TestMslsWidget.php b/tests/TestMslsWidget.php
@@ -4,6 +4,7 @@
 
 use Brain\Monkey\Functions;
 use lloc\Msls\MslsBlogCollection;
+use lloc\Msls\MslsOptions;
 use lloc\Msls\MslsWidget;
 
 class TestMslsWidget extends MslsUnitTestCase {
@@ -28,7 +29,10 @@ public function test_widget(): void {
 		];
 
 		Functions\expect( 'wp_parse_args' )->once()->andReturn( $arr );
-		Functions\expect( 'get_option' )->andReturn( [] );
+
+        $options = \Mockery::mock( MslsOptions::class );
+
+		Functions\expect( 'msls_options' )->andReturn( $options );
 		Functions\expect( 'msls_blog_collection' )->once()->andReturn( $collection );
 
 		$this->expectOutputString( '<div><h3>Test</h3>No available translations found</div>' );

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA`
`31`	`31`	`*/`
`32`	`32`
`33`		`-if ( file_exists( __DIR__ . '/vendor/autoload.php' ) ) {`
	`33`	`+if ( file_exists(__DIR__ . '/vendor/autoload.php' ) ) {`
`34`	`34`	`require __DIR__ . '/vendor/autoload.php';`
`35`	`35`	`}`
`36`	`36`
`@@ -128,8 +128,8 @@ function get_msls_permalink( string $locale, string $default = '' ): string {`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`/**`
`131`		`- * Gets a blog by locale`
`132`		`- *`
	`131`	`+ * Looks for the MslsBlog instance for a specific locale`
	`132`	`+ *`
`133`	`133`	`* @param string $locale`
`134`	`134`	`*`
`135`	`135`	`* @return \lloc\Msls\MslsBlog\|null`
`@@ -147,4 +147,12 @@ function msls_blog_collection(): \lloc\Msls\MslsBlogCollection {`
`147`	`147`	`return \lloc\Msls\MslsBlogCollection::instance();`
`148`	`148`	`}`
`149`	`149`
	`150`	`+ /**`
	`151`	`+ * Gets the MslsOptions instance`
	`152`	`+ *`
	`153`	`+ * @return \lloc\Msls\MslsOptions`
	`154`	`+ */`
	`155`	`+ function msls_options(): \lloc\Msls\MslsOptions {`
	`156`	`+ return \lloc\Msls\MslsOptions::instance();`
	`157`	`+ }`
`150`	`158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class Service extends MslsRegistryInstance {`
`21`	`21`	`* @return bool Whether the content import functionality support classes where hooked or not.`
`22`	`22`	`*/`
`23`	`23`	`public function register() {`
`24`		`- if ( ! MslsOptions::instance()->activate_content_import ) {`
	`24`	`+ if ( ! msls_options()->activate_content_import ) {`
`25`	`25`	`return false;`
`26`	`26`	`}`
`27`	`27`