Translator::getTranslationStrings() - Code Metrics - Inspection of "refactor Translator" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d26ef1...d85e7c )

by Paul

created 2018-05-18 23:34 UTC

Translator::getTranslationStrings() A

↳ Parent: Translator

Complexity

Conditions	2
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	1
nop	2
dl	0
loc	5
ccs	0
cts	3
cp	0
crap	6
rs	9.4285
c	0
b	0
f	0

<?php

namespace GeminiLabs\SiteReviews\Modules;

use Exception;
use GeminiLabs\SiteReviews\Application;
use GeminiLabs\SiteReviews\Database\OptionManager;
use GeminiLabs\SiteReviews\Modules\Html;
use Sepia\PoParser\Parser;

class Translator
{
	const SEARCH_THRESHOLD = 3;

	/**
	 * @var array
	 */
	protected $entries;

	/**
	 * @var array
	 */
	protected $results;

	/**
	 * Returns all saved custom translations with translation context
	 * @return array
	 */
	public function all()
	{
		$translations = $this->getTranslations();
		$entries = $this->filter( $translations, $this->entries() )->results();
		array_walk( $translations, function( &$entry ) use( $entries ) {
			$entry['desc'] = array_key_exists( $entry['id'], $entries )
				? $this->getEntryString( $entries[$entry['id']], 'msgctxt' )
				: '';
		});
		return $translations;
	}

	/**
	 * @return array
	 */
	public function entries()
	{
		if( !isset( $this->entries )) {
			try {
				$entries = $this->normalize(
					Parser::parseFile( glsr()->path( 'languages/site-reviews.pot' ))->getEntries()
				);
			}
			catch( Exception $e ) {
				glsr_log()->error( $e->getMessage() );
			}
			foreach( $entries as $key => $entry ) {
				$this->entries[html_entity_decode( $key, ENT_COMPAT, 'UTF-8' )] = $entry;
			}
		}
		return $this->entries;
	}

	/**
	 * @param null|array $entriesToExclude
	 * @param null|array $entries
	 * @return static
	 */
	public function exclude( $entriesToExclude = null, $entries = null )
	{
		return $this->filter( $entriesToExclude, $entries, false );
	}

	/**
	 * @param null|array $filterWith
	 * @param null|array $entries
	 * @param bool $intersect
	 * @return static
	 */
	public function filter( $filterWith = null, $entries = null, $intersect = true )
	{
		if( !is_array( $entries )) {
			$entries = $this->results;
		}
		if( !is_array( $filterWith )) {
			$filterWith = $this->getTranslations();
		}
		$keys = array_flip( array_column( $filterWith, 'id' ));
		$this->results = $intersect
			? array_intersect_key( $entries, $keys )
			: array_diff_key( $entries, $keys );
		return $this;
	}

	/**
	 * @param string $translation
	 * @param string $text
	 * @param string $domain
	 * @return string
	 */
	public function filterGettext( $translation, $text, $domain )
	{
		return $this->translate( $translation, $domain, [
			'single' => $text,
		]);
	}

	/**
	 * @param string $translation
	 * @param string $text
	 * @param string $context
	 * @param string $domain
	 * @return string
	 */
	public function filterGettextWithContext( $translation, $text, $context, $domain )
	{
		return $this->translate( $translation, $domain, [
			'context' => $context,
			'single' => $text,
		]);
	}

	/**
	 * @param string $translation
	 * @param string $single
	 * @param string $plural
	 * @param int $number
	 * @param string $domain
	 * @return string
	 */
	public function filterNgettext( $translation, $single, $plural, $number, $domain )
	{
		return $this->translate( $translation, $domain, [
			'number' => $number,
			'plural' => $plural,
			'single' => $single,
		]);
	}

	/**
	 * @param string $translation
	 * @param string $single
	 * @param string $plural
	 * @param int $number
	 * @param string $context
	 * @param string $domain
	 * @return string
	 */
	public function filterNgettextWithContext( $translation, $single, $plural, $number, $context, $domain )
	{
		return $this->translate( $translation, $domain, [
			'context' => $context,
			'number' => $number,
			'plural' => $plural,
			'single' => $single,
		]);
	}

	/**
	 * @param string $template
	 * @return string
	 */
	public function render( $template, array $entry )
	{
		$data = array_combine(
			array_map( function( $key ) { return 'data.'.$key; }, array_keys( $entry )),
			$entry
		);
		ob_start();
		glsr( Html::class )->renderTemplate( 'translations/'.$template, $data );
		return ob_get_clean();
	}

	/**
	 * Returns a rendered string of all saved custom translations with translation context
	 * @return string
	 */
	public function renderAll()
	{
		$rendered = '';
		foreach( $this->all() as $index => $entry ) {
			$entry['index'] = $index;
			$entry['prefix'] = OptionManager::databaseKey();
			$rendered .= $this->render( $entry['type'], $entry );
		}
		return $rendered;
	}

	/**
	 * @param bool $resetAfterRender
	 * @return string
	 */
	public function renderResults( $resetAfterRender = true )
	{
		$rendered = '';
		foreach( $this->results as $id => $entry ) {
			$data = [
				'desc' => $this->getEntryString( $entry, 'msgctxt' ),
				'id' => $id,
				'p1' => $this->getEntryString( $entry, 'msgid_plural' ),
				's1' => $this->getEntryString( $entry, 'msgid' ),
			];
			$text = !empty( $data['p1'] )
				? sprintf( '%s | %s', $data['s1'], $data['p1'] )
				: $data['s1'];
			$rendered .= $this->render( 'result', [
				'entry' => wp_json_encode( $data ),
				'text' => wp_strip_all_tags( $text ),
			]);
		}
		if( $resetAfterRender ) {
			$this->reset();
		}
		return $rendered;
	}

	/**
	 * @return void
	 */
	public function reset()
	{
		$this->results = [];
	}

	/**
	 * @return array
	 */
	public function results()
	{
		$results = $this->results;
		$this->reset();
		return $results;
	}

	/**
	 * @param string $needle
	 * @return static
	 */
	public function search( $needle = '' )
	{
		$this->reset();
		$needle = trim( strtolower( $needle ));
		foreach( $this->entries() as $key => $entry ) {
			$single = strtolower( $this->getEntryString( $entry, 'msgid' ));
			$plural = strtolower( $this->getEntryString( $entry, 'msgid_plural' ));
			if( strlen( $needle ) < static::SEARCH_THRESHOLD ) {
				if( in_array( $needle, [$single, $plural] )) {
					$this->results[$key] = $entry;
				}
			}
			else if( strpos( sprintf( '%s %s', $single, $plural ), $needle ) !== false ) {
				$this->results[$key] = $entry;
			}
		}
		return $this;
	}

	/**
	 * @param string $original
	 * @param string $domain
	 * @return string
	 */
	public function translate( $original, $domain, array $args )
	{
		if( $domain != Application::ID ) {
			return $original;
		}
		$args = $this->normalizeTranslationArgs( $args );
		$strings = $this->getTranslationStrings( $args['single'], $args['plural'] );
		if( empty( $strings )) {
			return $original;
		}
		$string = current( $strings );
		return $string['type'] == 'plural'
			? $this->translatePlural( $domain, $string, $args )
			: $this->translateSingle( $domain, $string, $args );
	}

	/**
	 * @param string $key
	 * @return string
	 */
	protected function getEntryString( array $entry, $key )
	{
		return isset( $entry[$key] )
			? implode( '', (array) $entry[$key] )
			: '';
	}

	/**
	 * @return array
	 */
	protected function getTranslations()
	{
		$settings = glsr( OptionManager::class )->get( 'settings' );
		return isset( $settings['translations'] )
			? $this->normalizeSettings( (array) $settings['translations'] )
			: [];
	}

	/**
	 * @param string $singleText
	 * @param string $pluralText
	 * @return array
	 */
	protected function getTranslationStrings( $singleText, $pluralText )
	{
		return array_filter( $this->getTranslations(), function( $string ) use( $args ) {

			return $string['s1'] == html_entity_decode( $singleText, ENT_COMPAT, 'UTF-8' )

				&& $string['p1'] == html_entity_decode( $pluralText, ENT_COMPAT, 'UTF-8' );

		});
	}

	/**
	 * @return array
	 */
	protected function normalize( array $entries )
	{
		$keys = [
			'msgctxt', 'msgid', 'msgid_plural', 'msgstr', 'msgstr[0]', 'msgstr[1]',
		];
		array_walk( $entries, function( &$entry ) use( $keys ) {
			foreach( $keys as $key ) {
				$entry = $this->normalizeEntryString( $entry, $key );
			}
		});
		return $entries;
	}

	/**
	 * @param string $key
	 * @return array
	 */
	protected function normalizeEntryString( array $entry, $key )
	{
		if( isset( $entry[$key] )) {
			$entry[$key] = $this->getEntryString( $entry, $key );
		}
		return $entry;
	}

	/**
	 * @return array
	 */
	protected function normalizeSettings( array $strings )
	{
		$defaultString = array_fill_keys( ['id', 's1', 's2', 'p1', 'p2'], '' );
		$strings = array_filter( $strings, 'is_array' );
		foreach( $strings as &$string ) {
			$string['type'] = isset( $string['p1'] ) ? 'plural' : 'single';
			$string = wp_parse_args( $string, $defaultString );
		}
		return array_filter( $strings, function( $string ) {
			return !empty( $string['id'] );
		});
	}

	/**
	 * @return array
	 */
	protected function normalizeTranslationArgs( array $args )
	{
		$defaults = [
			'context' => '',
			'number' => 1,
			'plural' => '',
			'single' => '',
		];
		return shortcode_atts( $defaults, $args );
	}

	/**
	 * @param string $domain
	 * @return string
	 */
	protected function translatePlural( $domain, array $string, array $args )
	{
		if( !empty( $string['p2'] )) {
			$args['plural'] = $string['p2'];
		}
		return get_translations_for_domain( $domain )->translate_plural(
			$args['single'],
			$args['plural'],
			$args['number'],
			$args['context']
		);
	}

	/**
	 * @param string $domain
	 * @return string
	 */
	protected function translateSingle( $domain, array $string, array $args )
	{
		if( !empty( $string['s2'] )) {
			$args['single'] = $string['s2'];
		}
		return get_translations_for_domain( $domain )->translate(
			$args['single'],
			$args['context']
		);
	}
}


1			<?php
2
3			namespace GeminiLabs\SiteReviews\Modules;
4
5			use Exception;
6			use GeminiLabs\SiteReviews\Application;
7			use GeminiLabs\SiteReviews\Database\OptionManager;
8			use GeminiLabs\SiteReviews\Modules\Html;
9			use Sepia\PoParser\Parser;
10
11			class Translator
12			{
13			const SEARCH_THRESHOLD = 3;
14
15			/**
16			* @var array
17			*/
18			protected $entries;
19
20			/**
21			* @var array
22			*/
23			protected $results;
24
25			/**
26			* Returns all saved custom translations with translation context
27			* @return array
28			*/
29			public function all()
30			{
31			$translations = $this->getTranslations();
32			$entries = $this->filter( $translations, $this->entries() )->results();
33			array_walk( $translations, function( &$entry ) use( $entries ) {
34			$entry['desc'] = array_key_exists( $entry['id'], $entries )
35			? $this->getEntryString( $entries[$entry['id']], 'msgctxt' )
36			: '';
37			});
38			return $translations;
39			}
40
41			/**
42			* @return array
43			*/
44			public function entries()
45			{
46			if( !isset( $this->entries )) {
47			try {
48			$entries = $this->normalize(
49			Parser::parseFile( glsr()->path( 'languages/site-reviews.pot' ))->getEntries()
50			);
51			}
52			catch( Exception $e ) {
53			glsr_log()->error( $e->getMessage() );
54			}
55			foreach( $entries as $key => $entry ) {
56			$this->entries[html_entity_decode( $key, ENT_COMPAT, 'UTF-8' )] = $entry;
57			}
58			}
59			return $this->entries;
60			}
61
62			/**
63			* @param null\|array $entriesToExclude
64			* @param null\|array $entries
65			* @return static
66			*/
67			public function exclude( $entriesToExclude = null, $entries = null )
68			{
69			return $this->filter( $entriesToExclude, $entries, false );
70			}
71
72			/**
73			* @param null\|array $filterWith
74			* @param null\|array $entries
75			* @param bool $intersect
76			* @return static
77			*/
78			public function filter( $filterWith = null, $entries = null, $intersect = true )
79			{
80			if( !is_array( $entries )) {
81			$entries = $this->results;
82			}
83			if( !is_array( $filterWith )) {
84			$filterWith = $this->getTranslations();
85			}
86			$keys = array_flip( array_column( $filterWith, 'id' ));
87			$this->results = $intersect
88			? array_intersect_key( $entries, $keys )
89			: array_diff_key( $entries, $keys );
90			return $this;
91			}
92
93			/**
94			* @param string $translation
95			* @param string $text
96			* @param string $domain
97			* @return string
98			*/
99			public function filterGettext( $translation, $text, $domain )
100			{
101			return $this->translate( $translation, $domain, [
102			'single' => $text,
103			]);
104			}
105
106			/**
107			* @param string $translation
108			* @param string $text
109			* @param string $context
110			* @param string $domain
111			* @return string
112			*/
113			public function filterGettextWithContext( $translation, $text, $context, $domain )
114			{
115			return $this->translate( $translation, $domain, [
116			'context' => $context,
117			'single' => $text,
118			]);
119			}
120
121			/**
122			* @param string $translation
123			* @param string $single
124			* @param string $plural
125			* @param int $number
126			* @param string $domain
127			* @return string
128			*/
129			public function filterNgettext( $translation, $single, $plural, $number, $domain )
130			{
131			return $this->translate( $translation, $domain, [
132			'number' => $number,
133			'plural' => $plural,
134			'single' => $single,
135			]);
136			}
137
138			/**
139			* @param string $translation
140			* @param string $single
141			* @param string $plural
142			* @param int $number
143			* @param string $context
144			* @param string $domain
145			* @return string
146			*/
147			public function filterNgettextWithContext( $translation, $single, $plural, $number, $context, $domain )
148			{
149			return $this->translate( $translation, $domain, [
150			'context' => $context,
151			'number' => $number,
152			'plural' => $plural,
153			'single' => $single,
154			]);
155			}
156
157			/**
158			* @param string $template
159			* @return string
160			*/
161			public function render( $template, array $entry )
162			{
163			$data = array_combine(
164			array_map( function( $key ) { return 'data.'.$key; }, array_keys( $entry )),
165			$entry
166			);
167			ob_start();
168			glsr( Html::class )->renderTemplate( 'translations/'.$template, $data );
169			return ob_get_clean();
170			}
171
172			/**
173			* Returns a rendered string of all saved custom translations with translation context
174			* @return string
175			*/
176			public function renderAll()
177			{
178			$rendered = '';
179			foreach( $this->all() as $index => $entry ) {
180			$entry['index'] = $index;
181			$entry['prefix'] = OptionManager::databaseKey();
182			$rendered .= $this->render( $entry['type'], $entry );
183			}
184			return $rendered;
185			}
186
187			/**
188			* @param bool $resetAfterRender
189			* @return string
190			*/
191			public function renderResults( $resetAfterRender = true )
192			{
193			$rendered = '';
194			foreach( $this->results as $id => $entry ) {
195			$data = [
196			'desc' => $this->getEntryString( $entry, 'msgctxt' ),
197			'id' => $id,
198			'p1' => $this->getEntryString( $entry, 'msgid_plural' ),
199			's1' => $this->getEntryString( $entry, 'msgid' ),
200			];
201			$text = !empty( $data['p1'] )
202			? sprintf( '%s \| %s', $data['s1'], $data['p1'] )
203			: $data['s1'];
204			$rendered .= $this->render( 'result', [
205			'entry' => wp_json_encode( $data ),
206			'text' => wp_strip_all_tags( $text ),
207			]);
208			}
209			if( $resetAfterRender ) {
210			$this->reset();
211			}
212			return $rendered;
213			}
214
215			/**
216			* @return void
217			*/
218			public function reset()
219			{
220			$this->results = [];
221			}
222
223			/**
224			* @return array
225			*/
226			public function results()
227			{
228			$results = $this->results;
229			$this->reset();
230			return $results;
231			}
232
233			/**
234			* @param string $needle
235			* @return static
236			*/
237			public function search( $needle = '' )
238			{
239			$this->reset();
240			$needle = trim( strtolower( $needle ));
241			foreach( $this->entries() as $key => $entry ) {
242			$single = strtolower( $this->getEntryString( $entry, 'msgid' ));
243			$plural = strtolower( $this->getEntryString( $entry, 'msgid_plural' ));
244			if( strlen( $needle ) < static::SEARCH_THRESHOLD ) {
245			if( in_array( $needle, [$single, $plural] )) {
246			$this->results[$key] = $entry;
247			}
248			}
249			else if( strpos( sprintf( '%s %s', $single, $plural ), $needle ) !== false ) {
250			$this->results[$key] = $entry;
251			}
252			}
253			return $this;
254			}
255
256			/**
257			* @param string $original
258			* @param string $domain
259			* @return string
260			*/
261			public function translate( $original, $domain, array $args )
262			{
263			if( $domain != Application::ID ) {
264			return $original;
265			}
266			$args = $this->normalizeTranslationArgs( $args );
267			$strings = $this->getTranslationStrings( $args['single'], $args['plural'] );
268			if( empty( $strings )) {
269			return $original;
270			}
271			$string = current( $strings );
272			return $string['type'] == 'plural'
273			? $this->translatePlural( $domain, $string, $args )
274			: $this->translateSingle( $domain, $string, $args );
275			}
276
277			/**
278			* @param string $key
279			* @return string
280			*/
281			protected function getEntryString( array $entry, $key )
282			{
283			return isset( $entry[$key] )
284			? implode( '', (array) $entry[$key] )
285			: '';
286			}
287
288			/**
289			* @return array
290			*/
291			protected function getTranslations()
292			{
293			$settings = glsr( OptionManager::class )->get( 'settings' );
294			return isset( $settings['translations'] )
295			? $this->normalizeSettings( (array) $settings['translations'] )
296			: [];
297			}
298
299			/**
300			* @param string $singleText
301			* @param string $pluralText
302			* @return array
303			*/
304			protected function getTranslationStrings( $singleText, $pluralText )
305			{
306			return array_filter( $this->getTranslations(), function( $string ) use( $args ) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-05-18 23:38 UTC by Report Bug Copy Issue Report The variable `$args` seems to be never defined. Loading history... Unused Code introduced 2018-05-18 23:38 UTC by Report Bug Copy Issue Report The import `$args` is not used and could be removed. This check looks for imports that have been defined, but are not used in the scope. Loading history...
307			return $string['s1'] == html_entity_decode( $singleText, ENT_COMPAT, 'UTF-8' )
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-05-18 23:38 UTC by Report Bug Copy Issue Report The variable `$singleText` seems to be never defined. Loading history...
308			&& $string['p1'] == html_entity_decode( $pluralText, ENT_COMPAT, 'UTF-8' );
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-05-18 23:38 UTC by Report Bug Copy Issue Report The variable `$pluralText` seems to be never defined. Loading history...
309			});
310			}
311
312			/**
313			* @return array
314			*/
315			protected function normalize( array $entries )
316			{
317			$keys = [
318			'msgctxt', 'msgid', 'msgid_plural', 'msgstr', 'msgstr[0]', 'msgstr[1]',
319			];
320			array_walk( $entries, function( &$entry ) use( $keys ) {
321			foreach( $keys as $key ) {
322			$entry = $this->normalizeEntryString( $entry, $key );
323			}
324			});
325			return $entries;
326			}
327
328			/**
329			* @param string $key
330			* @return array
331			*/
332			protected function normalizeEntryString( array $entry, $key )
333			{
334			if( isset( $entry[$key] )) {
335			$entry[$key] = $this->getEntryString( $entry, $key );
336			}
337			return $entry;
338			}
339
340			/**
341			* @return array
342			*/
343			protected function normalizeSettings( array $strings )
344			{
345			$defaultString = array_fill_keys( ['id', 's1', 's2', 'p1', 'p2'], '' );
346			$strings = array_filter( $strings, 'is_array' );
347			foreach( $strings as &$string ) {
348			$string['type'] = isset( $string['p1'] ) ? 'plural' : 'single';
349			$string = wp_parse_args( $string, $defaultString );
350			}
351			return array_filter( $strings, function( $string ) {
352			return !empty( $string['id'] );
353			});
354			}
355
356			/**
357			* @return array
358			*/
359			protected function normalizeTranslationArgs( array $args )
360			{
361			$defaults = [
362			'context' => '',
363			'number' => 1,
364			'plural' => '',
365			'single' => '',
366			];
367			return shortcode_atts( $defaults, $args );
368			}
369
370			/**
371			* @param string $domain
372			* @return string
373			*/
374			protected function translatePlural( $domain, array $string, array $args )
375			{
376			if( !empty( $string['p2'] )) {
377			$args['plural'] = $string['p2'];
378			}
379			return get_translations_for_domain( $domain )->translate_plural(
380			$args['single'],
381			$args['plural'],
382			$args['number'],
383			$args['context']
384			);
385			}
386
387			/**
388			* @param string $domain
389			* @return string
390			*/
391			protected function translateSingle( $domain, array $string, array $args )
392			{
393			if( !empty( $string['s2'] )) {
394			$args['single'] = $string['s2'];
395			}
396			return get_translations_for_domain( $domain )->translate(
397			$args['single'],
398			$args['context']
399			);
400			}
401			}
402

pryley / site-reviews

Push — master ( d26ef1...d85e7c )

Translator::getTranslationStrings() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like