Issues in MslsOutput.php - New Issues - Inspection of "Fix get_msls_permalink" - lloc/Multisite-Language-Switcher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 196f44...96e9ab )

by Dennis

created 2020-03-31 21:15 UTC

includes/MslsOutput.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * MslsOutput
 * @author Dennis Ploetner <[email protected]>
 * @since 0.9.8
 */

namespace lloc\Msls;

/**
 * Output in the frontend
 * @package Msls
 */
class MslsOutput extends MslsMain {

	/**
	 * Holds the format for the output
	 * @var array $tags
	 */
	protected $tags;

	/**
	 * Creates and gets the output as an array
	 *
	 * @param int $display
	 * @param bool $filter
	 * @param bool $exists
	 *
	 * @return array
	 * @uses MslsLink
	 * @uses MslsOptions
	 */
	public function get( $display, $filter = false, $exists = false ) {
		$arr = [];

		$blogs = $this->collection->get_filtered( $filter );
		if ( $blogs ) {
			$mydata = MslsOptions::create();
			$link   = MslsLink::create( $display );

			foreach ( $blogs as $blog ) {
				$language = $blog->get_language();

				$link->src = $this->options->get_flag_url( $language );
				$link->alt = $language;

				$is_current_blog = $this->collection->is_current_blog( $blog );
				if ( $is_current_blog ) {
					$url       = $mydata->get_current_link();
					$link->txt = $blog->get_description();
				} else {
					switch_to_blog( $blog->userblog_id );

					if ( $this->is_requirements_not_fulfilled( $mydata, $exists, $language ) ) {
						restore_current_blog();
						continue;
					} else {
						$url       = $mydata->get_permalink( $language );
						$link->txt = $blog->get_description();
					}

					restore_current_blog();
				}

				if ( has_filter( 'msls_output_get' ) ) {
					/**
					 * Returns HTML-link for an item of the output-arr
					 *
					 * @param string $url
					 * @param MslsLink $link
					 * @param bool $is_current_blog
					 *
					 * @since 0.9.8
					 *
					 */
					$arr[] = ( string ) apply_filters( 'msls_output_get', $url, $link, $is_current_blog );
				} else {
					$arr[] = sprintf(
						'<a href="%s" title="%s"%s>%s</a>',
						$url,
						$link->txt,
						$is_current_blog ? ' class="current_language"' : '',
						$link
					);
				}
			}
		}

		return $arr;
	}

	/**
	 * Get alternate links for the head section
	 *
	 * @return string
	 */
	public function get_alternate_links() {
		$blogs   = MslsBlogCollection::instance();
		$options = MslsOptions::create();
		$arr     = [];
		$default = '';

		foreach ( $blogs->get_objects() as $blog ) {
			$url = $blog->get_url( $options );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			if ( is_null( $url ) ) {
				continue;
			}

			$description = $blog->get_description();
			$hreflang    = $blog->get_hreflang();

			$format = '<link rel="alternate" hreflang="%s" href="%s" title="%s" />';
			if ( '' === $default ) {
				$default = sprintf( $format, 'x-default', $url, esc_attr( $description ) );
			}

			$arr[] = sprintf( $format, $hreflang, $url, esc_attr( $description ) );
		}

		return 1 === count( $arr ) ? $default : implode( PHP_EOL, $arr );
	}

	/**
	 * Returns a string when the object will be treated like a string
	 * @return string
	 */
	public function __toString() {
		$display = (int) $this->options->display;
		$filter  = false;
		$exists  = isset( $this->options->only_with_translation );

		$arr = $this->get( $display, $filter, $exists );
		if ( empty( $arr ) ) {
			return '';
		}

		$tags = $this->get_tags();

		return $tags['before_output'] . $tags['before_item'] .
		       implode( $tags['after_item'] . $tags['before_item'], $arr ) .
		       $tags['after_item'] . $tags['after_output'];
	}

	/**
	 * Gets tags for the output
	 * @return array
	 */
	public function get_tags() {
		if ( empty( $this->tags ) ) {
			$this->tags = [
				'before_item'   => $this->options->before_item,
				'after_item'    => $this->options->after_item,
				'before_output' => $this->options->before_output,
				'after_output'  => $this->options->after_output,
			];

			/**
			 * Returns tags array for the output
			 *
			 * @param array $tags
			 *
			 * @since 1.0
			 *
			 */
			$this->tags = ( array ) apply_filters( 'msls_output_get_tags', $this->tags );
		}

		return $this->tags;
	}

	/**
	 * Sets tags for the output
	 *
	 * @param array $arr
	 *
	 * @return MslsOutput
	 */
	public function set_tags( array $arr = [] ) {
		$this->tags = wp_parse_args( $this->get_tags(), $arr );

		return $this;
	}

	/**
	 * Returns true if the requirements not fulfilled
	 *
	 * @param MslsOptions|null $thing
	 * @param boolean $exists
	 * @param string $language
	 *
	 * @return boolean
	 */
	public function is_requirements_not_fulfilled( $thing, $exists, $language ) {
		if ( is_null( $thing ) ) {
			return $exists;
		}

		return MslsOptions::class != get_class( $thing ) && ! $thing->has_value( $language ) && $exists;
	}

}


1			<?php
2			/**
3			* MslsOutput
4			* @author Dennis Ploetner <[email protected]>
5			* @since 0.9.8
6			*/
7
8			namespace lloc\Msls;
9
10			/**
11			* Output in the frontend
12			* @package Msls
13			*/
14			class MslsOutput extends MslsMain {
15
16			/**
17			* Holds the format for the output
18			* @var array $tags
19			*/
20			protected $tags;
21
22			/**
23			* Creates and gets the output as an array
24			*
25			* @param int $display
26			* @param bool $filter
27			* @param bool $exists
28			*
29			* @return array
30			* @uses MslsLink
31			* @uses MslsOptions
32			*/
33			public function get( $display, $filter = false, $exists = false ) {
34			$arr = [];
35
36			$blogs = $this->collection->get_filtered( $filter );
37			if ( $blogs ) {
38			$mydata = MslsOptions::create();
39			$link = MslsLink::create( $display );
40
41			foreach ( $blogs as $blog ) {
42			$language = $blog->get_language();
43
44			$link->src = $this->options->get_flag_url( $language );
45			$link->alt = $language;
46
47			$is_current_blog = $this->collection->is_current_blog( $blog );
48			if ( $is_current_blog ) {
49			$url = $mydata->get_current_link();
50			$link->txt = $blog->get_description();
51			} else {
52			switch_to_blog( $blog->userblog_id );
53
54			if ( $this->is_requirements_not_fulfilled( $mydata, $exists, $language ) ) {
55			restore_current_blog();
56			continue;
57			} else {
58			$url = $mydata->get_permalink( $language );
59			$link->txt = $blog->get_description();
60			}
61
62			restore_current_blog();
63			}
64
65			if ( has_filter( 'msls_output_get' ) ) {
66			/**
67			* Returns HTML-link for an item of the output-arr
68			*
69			* @param string $url
70			* @param MslsLink $link
71			* @param bool $is_current_blog
72			*
73			* @since 0.9.8
74			*
75			*/
76			$arr[] = ( string ) apply_filters( 'msls_output_get', $url, $link, $is_current_blog );
77			} else {
78			$arr[] = sprintf(
79			'<a href="%s" title="%s"%s>%s</a>',
80			$url,
81			$link->txt,
82			$is_current_blog ? ' class="current_language"' : '',
83			$link
84			);
85			}
86			}
87			}
88
89			return $arr;
90			}
91
92			/**
93			* Get alternate links for the head section
94			*
95			* @return string
96			*/
97			public function get_alternate_links() {
98			$blogs = MslsBlogCollection::instance();
99			$options = MslsOptions::create();
100			$arr = [];
101			$default = '';
102
103			foreach ( $blogs->get_objects() as $blog ) {
104			$url = $blog->get_url( $options );
			0 ignored issues – show Bug introduced 2020-03-31 21:16 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$options` defined by `\lloc\Msls\MslsOptions::create()` on line `99` can be `null`; however, `lloc\Msls\MslsBlog::get_url()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
105			if ( is_null( $url ) ) {
106			continue;
107			}
108
109			$description = $blog->get_description();
110			$hreflang = $blog->get_hreflang();
111
112			$format = '<link rel="alternate" hreflang="%s" href="%s" title="%s" />';
113			if ( '' === $default ) {
114			$default = sprintf( $format, 'x-default', $url, esc_attr( $description ) );
115			}
116
117			$arr[] = sprintf( $format, $hreflang, $url, esc_attr( $description ) );
118			}
119
120			return 1 === count( $arr ) ? $default : implode( PHP_EOL, $arr );
121			}
122
123			/**
124			* Returns a string when the object will be treated like a string
125			* @return string
126			*/
127			public function __toString() {
128			$display = (int) $this->options->display;
129			$filter = false;
130			$exists = isset( $this->options->only_with_translation );
131
132			$arr = $this->get( $display, $filter, $exists );
133			if ( empty( $arr ) ) {
134			return '';
135			}
136
137			$tags = $this->get_tags();
138
139			return $tags['before_output'] . $tags['before_item'] .
140			implode( $tags['after_item'] . $tags['before_item'], $arr ) .
141			$tags['after_item'] . $tags['after_output'];
142			}
143
144			/**
145			* Gets tags for the output
146			* @return array
147			*/
148			public function get_tags() {
149			if ( empty( $this->tags ) ) {
150			$this->tags = [
151			'before_item' => $this->options->before_item,
152			'after_item' => $this->options->after_item,
153			'before_output' => $this->options->before_output,
154			'after_output' => $this->options->after_output,
155			];
156
157			/**
158			* Returns tags array for the output
159			*
160			* @param array $tags
161			*
162			* @since 1.0
163			*
164			*/
165			$this->tags = ( array ) apply_filters( 'msls_output_get_tags', $this->tags );
166			}
167
168			return $this->tags;
169			}
170
171			/**
172			* Sets tags for the output
173			*
174			* @param array $arr
175			*
176			* @return MslsOutput
177			*/
178			public function set_tags( array $arr = [] ) {
179			$this->tags = wp_parse_args( $this->get_tags(), $arr );
180
181			return $this;
182			}
183
184			/**
185			* Returns true if the requirements not fulfilled
186			*
187			* @param MslsOptions\|null $thing
188			* @param boolean $exists
189			* @param string $language
190			*
191			* @return boolean
192			*/
193			public function is_requirements_not_fulfilled( $thing, $exists, $language ) {
194			if ( is_null( $thing ) ) {
195			return $exists;
196			}
197
198			return MslsOptions::class != get_class( $thing ) && ! $thing->has_value( $language ) && $exists;
199			}
200
201			}
202

lloc / Multisite-Language-Switcher

Push — master ( 196f44...96e9ab )

includes/MslsOutput.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like