pryley / site-reviews

plugin/Modules/Schema.php

Spacing +97 added lines, -97 removed lines

@@ -30,18 +30,18 @@ 
     /**
      * @return array
      */
-    public function build(array $args = [])
+    public function build( array $args = [] )
     {
         $this->args = $args;
-        $schema = $this->buildSummary($args);
-        if (!empty($schema)) {
+        $schema = $this->buildSummary( $args );
+        if( !empty($schema) ) {
             $reviews = $this->buildReviews();
-            foreach ($reviews as &$review) {
+            foreach( $reviews as &$review ) {
                 unset($review['@context']);
                 unset($review['itemReviewed']);
             });
         }
-        if (!empty($reviews)) {
+        if( !empty($reviews) ) {
             $schema['review'] = $reviews;
         }
         return $schema;
@@ -51,25 +51,25 @@ 
      * @param array|null $args
      * @return array
      */
-    public function buildSummary($args = null)
+    public function buildSummary( $args = null )
     {
-        if (is_array($args)) {
+        if( is_array( $args ) ) {
             $this->args = $args;
         }
-        $buildSummary = Helper::buildMethodName($this->getSchemaOptionValue('type'), 'buildSummaryFor');
-        if ($count = array_sum($this->getRatingCounts())) {
-            $schema = method_exists($this, $buildSummary)
+        $buildSummary = Helper::buildMethodName( $this->getSchemaOptionValue( 'type' ), 'buildSummaryFor' );
+        if( $count = array_sum( $this->getRatingCounts() ) ) {
+            $schema = method_exists( $this, $buildSummary )
                 ? $this->$buildSummary()
                 : $this->buildSummaryForCustom();
             $schema->aggregateRating(
-                $this->getSchemaType('AggregateRating')
-                    ->ratingValue($this->getRatingValue())
-                    ->reviewCount($count)
-                    ->bestRating(glsr()->constant('MAX_RATING', Rating::class))
-                    ->worstRating(glsr()->constant('MIN_RATING', Rating::class))
+                $this->getSchemaType( 'AggregateRating' )
+                    ->ratingValue( $this->getRatingValue() )
+                    ->reviewCount( $count )
+                    ->bestRating( glsr()->constant( 'MAX_RATING', Rating::class ) )
+                    ->worstRating( glsr()->constant( 'MIN_RATING', Rating::class ) )
             );
             $schema = $schema->toArray();
-            return apply_filters('site-reviews/schema/'.$schema['@type'], $schema, $args);
+            return apply_filters( 'site-reviews/schema/'.$schema['@type'], $schema, $args );
         }
         return [];
     }
@@ -79,53 +79,53 @@ 
      */
     public function render()
     {
-        if (empty(glsr()->schemas)) {
+        if( empty(glsr()->schemas) ) {
             return;
         }
-        printf('<script type="application/ld+json">%s</script>', json_encode(
-            apply_filters('site-reviews/schema/all', glsr()->schemas),
+        printf( '<script type="application/ld+json">%s</script>', json_encode(
+            apply_filters( 'site-reviews/schema/all', glsr()->schemas ),
             JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES
-        ));
+        ) );
     }
 
     /**
      * @return void
      */
-    public function store(array $schema)
+    public function store( array $schema )
     {
-        if (empty($schema)) {
+        if( empty($schema) ) {
             return;
         }
         $schemas = glsr()->schemas;
         $schemas[] = $schema;
-        glsr()->schemas = array_map('unserialize', array_unique(array_map('serialize', $schemas)));
+        glsr()->schemas = array_map( 'unserialize', array_unique( array_map( 'serialize', $schemas ) ) );
     }
 
     /**
      * @param Review $review
      * @return array
      */
-    protected function buildReview($review)
+    protected function buildReview( $review )
     {
-        $schema = $this->getSchemaType('Review')
-            ->doIf(!in_array('title', $this->args['hide']), function ($schema) use ($review) {
-                $schema->name($review->title);
+        $schema = $this->getSchemaType( 'Review' )
+            ->doIf( !in_array( 'title', $this->args['hide'] ), function( $schema ) use ($review) {
+                $schema->name( $review->title );
             })
-            ->doIf(!in_array('excerpt', $this->args['hide']), function ($schema) use ($review) {
-                $schema->reviewBody($review->content);
+            ->doIf( !in_array( 'excerpt', $this->args['hide'] ), function( $schema ) use ($review) {
+                $schema->reviewBody( $review->content );
             })
-            ->datePublished((new DateTime($review->date)))
-            ->author($this->getSchemaType('Person')->name($review->author))
-            ->itemReviewed($this->getSchemaType()->name($this->getSchemaOptionValue('name')));
-        if (!empty($review->rating)) {
+            ->datePublished( (new DateTime( $review->date )) )
+            ->author( $this->getSchemaType( 'Person' )->name( $review->author ) )
+            ->itemReviewed( $this->getSchemaType()->name( $this->getSchemaOptionValue( 'name' ) ) );
+        if( !empty($review->rating) ) {
             $schema->reviewRating(
-                $this->getSchemaType('Rating')
-                    ->ratingValue($review->rating)
-                    ->bestRating(glsr()->constant('MAX_RATING', Rating::class))
-                    ->worstRating(glsr()->constant('MIN_RATING', Rating::class))
+                $this->getSchemaType( 'Rating' )
+                    ->ratingValue( $review->rating )
+                    ->bestRating( glsr()->constant( 'MAX_RATING', Rating::class ) )
+                    ->worstRating( glsr()->constant( 'MIN_RATING', Rating::class ) )
             );
         }
-        return apply_filters('site-reviews/schema/review', $schema->toArray(), $review, $this->args);
+        return apply_filters( 'site-reviews/schema/review', $schema->toArray(), $review, $this->args );
     }
 
     /**
@@ -134,11 +134,11 @@ 
     protected function buildReviews()
     {
         $reviews = [];
-        foreach (glsr(ReviewManager::class)->get($this->args) as $review) {
+        foreach( glsr( ReviewManager::class )->get( $this->args ) as $review ) {
             // Only include critic reviews that have been directly produced by your site, not reviews from third-party sites or syndicated reviews.
             // @see https://developers.google.com/search/docs/data-types/review
-            if ('local' === $review->review_type) {
-                $reviews[] = $this->buildReview($review);
+            if( 'local' === $review->review_type ) {
+                $reviews[] = $this->buildReview( $review );
             }
         }
         return $reviews;
@@ -148,14 +148,14 @@ 
      * @param mixed $schema
      * @return mixed
      */
-    protected function buildSchemaValues($schema, array $values = [])
+    protected function buildSchemaValues( $schema, array $values = [] )
     {
-        foreach ($values as $value) {
-            $option = $this->getSchemaOptionValue($value);
-            if (empty($option)) {
+        foreach( $values as $value ) {
+            $option = $this->getSchemaOptionValue( $value );
+            if( empty($option) ) {
                 continue;
             }
-            $schema->$value($option);
+            $schema->$value( $option );
         }
         return $schema;
     }
@@ -165,9 +165,9 @@ 
      */
     protected function buildSummaryForCustom()
     {
-        return $this->buildSchemaValues($this->getSchemaType(), [
+        return $this->buildSchemaValues( $this->getSchemaType(), [
             'description', 'image', 'name', 'url',
-        ]);
+        ] );
     }
 
     /**
@@ -175,9 +175,9 @@ 
      */
     protected function buildSummaryForLocalBusiness()
     {
-        return $this->buildSchemaValues($this->buildSummaryForCustom(), [
+        return $this->buildSchemaValues( $this->buildSummaryForCustom(), [
             'address', 'priceRange', 'telephone',
-        ]);
+        ] );
     }
 
     /**
@@ -185,15 +185,15 @@ 
      */
     protected function buildSummaryForProduct()
     {
-        $offerType = $this->getSchemaOption('offerType', 'AggregateOffer');
-        $offers = $this->buildSchemaValues($this->getSchemaType($offerType), [
+        $offerType = $this->getSchemaOption( 'offerType', 'AggregateOffer' );
+        $offers = $this->buildSchemaValues( $this->getSchemaType( $offerType ), [
             'highPrice', 'lowPrice', 'price', 'priceCurrency',
-        ]);
+        ] );
         return $this->buildSummaryForCustom()
-            ->doIf(!empty($offers->getProperties()), function ($schema) use ($offers) {
-                $schema->offers($offers);
+            ->doIf( !empty($offers->getProperties()), function( $schema ) use ($offers) {
+                $schema->offers( $offers );
             })
-            ->setProperty('@id', $this->getSchemaOptionValue('url').'#product');
+            ->setProperty( '@id', $this->getSchemaOptionValue( 'url' ).'#product' );
     }
 
     /**
@@ -201,8 +201,8 @@ 
      */
     protected function getRatingCounts()
     {
-        if (!isset($this->ratingCounts)) {
-            $this->ratingCounts = glsr(ReviewManager::class)->getRatingCounts($this->args);
+        if( !isset($this->ratingCounts) ) {
+            $this->ratingCounts = glsr( ReviewManager::class )->getRatingCounts( $this->args );
         }
         return $this->ratingCounts;
     }
@@ -212,7 +212,7 @@ 
      */
     protected function getRatingValue()
     {
-        return glsr(Rating::class)->getAverage($this->getRatingCounts());
+        return glsr( Rating::class )->getAverage( $this->getRatingCounts() );
     }
 
     /**
@@ -220,15 +220,15 @@ 
      * @param string $fallback
      * @return string
      */
-    protected function getSchemaOption($option, $fallback)
+    protected function getSchemaOption( $option, $fallback )
     {
-        $option = strtolower($option);
-        if ($schemaOption = trim((string) get_post_meta(intval(get_the_ID()), 'schema_'.$option, true))) {
+        $option = strtolower( $option );
+        if( $schemaOption = trim( (string)get_post_meta( intval( get_the_ID() ), 'schema_'.$option, true ) ) ) {
             return $schemaOption;
         }
-        $setting = glsr(OptionManager::class)->get('settings.schema.'.$option);
-        if (is_array($setting)) {
-            return $this->getSchemaOptionDefault($setting, $fallback);
+        $setting = glsr( OptionManager::class )->get( 'settings.schema.'.$option );
+        if( is_array( $setting ) ) {
+            return $this->getSchemaOptionDefault( $setting, $fallback );
         }
         return !empty($setting)
             ? $setting
@@ -239,12 +239,12 @@ 
      * @param string $fallback
      * @return string
      */
-    protected function getSchemaOptionDefault(array $setting, $fallback)
+    protected function getSchemaOptionDefault( array $setting, $fallback )
     {
-        $setting = wp_parse_args($setting, [
+        $setting = wp_parse_args( $setting, [
             'custom' => '',
             'default' => $fallback,
-        ]);
+        ] );
         return 'custom' != $setting['default']
             ? $setting['default']
             : $setting['custom'];
@@ -255,21 +255,21 @@ 
      * @param string $fallback
      * @return void|string
      */
-    protected function getSchemaOptionValue($option, $fallback = 'post')
+    protected function getSchemaOptionValue( $option, $fallback = 'post' )
     {
-        if (array_key_exists($option, $this->keyValues)) {
+        if( array_key_exists( $option, $this->keyValues ) ) {
             return $this->keyValues[$option];
         }
-        $value = $this->getSchemaOption($option, $fallback);
-        if ($value != $fallback) {
-            return $this->setAndGetKeyValue($option, $value);
+        $value = $this->getSchemaOption( $option, $fallback );
+        if( $value != $fallback ) {
+            return $this->setAndGetKeyValue( $option, $value );
         }
-        if (!is_single() && !is_page()) {
+        if( !is_single() && !is_page() ) {
             return;
         }
-        $method = Helper::buildMethodName($option, 'getThing');
-        if (method_exists($this, $method)) {
-            return $this->setAndGetKeyValue($option, $this->$method());
+        $method = Helper::buildMethodName( $option, 'getThing' );
+        if( method_exists( $this, $method ) ) {
+            return $this->setAndGetKeyValue( $option, $this->$method() );
         }
     }
 
@@ -277,15 +277,15 @@ 
      * @param string|null $type
      * @return mixed
      */
-    protected function getSchemaType($type = null)
+    protected function getSchemaType( $type = null )
     {
-        if (!is_string($type)) {
-            $type = $this->getSchemaOption('type', 'LocalBusiness');
+        if( !is_string( $type ) ) {
+            $type = $this->getSchemaOption( 'type', 'LocalBusiness' );
         }
-        $className = Helper::buildClassName($type, 'Modules\Schema');
-        return class_exists($className)
+        $className = Helper::buildClassName( $type, 'Modules\Schema' );
+        return class_exists( $className )
             ? new $className()
-            : new UnknownType($type);
+            : new UnknownType( $type );
     }
 
     /**
@@ -294,19 +294,19 @@ 
     protected function getThingDescription()
     {
         $post = get_post();
-        $text = Arr::get($post, 'post_excerpt');
-        if (empty($text)) {
-            $text = Arr::get($post, 'post_content');
+        $text = Arr::get( $post, 'post_excerpt' );
+        if( empty($text) ) {
+            $text = Arr::get( $post, 'post_content' );
         }
-        if (function_exists('excerpt_remove_blocks')) {
-            $text = excerpt_remove_blocks($text);
+        if( function_exists( 'excerpt_remove_blocks' ) ) {
+            $text = excerpt_remove_blocks( $text );
         }
-        $text = strip_shortcodes($text);
-        $text = wpautop($text);
-        $text = wptexturize($text);
-        $text = wp_strip_all_tags($text);
-        $text = str_replace(']]>', ']]&gt;', $text);
-        return wp_trim_words($text, apply_filters('excerpt_length', 55));
+        $text = strip_shortcodes( $text );
+        $text = wpautop( $text );
+        $text = wptexturize( $text );
+        $text = wp_strip_all_tags( $text );
+        $text = str_replace( ']]>', ']]&gt;', $text );
+        return wp_trim_words( $text, apply_filters( 'excerpt_length', 55 ) );
     }
 
     /**
@@ -314,7 +314,7 @@ 
      */
     protected function getThingImage()
     {
-        return (string) get_the_post_thumbnail_url(null, 'large');
+        return (string)get_the_post_thumbnail_url( null, 'large' );
     }
 
     /**
@@ -330,7 +330,7 @@ 
      */
     protected function getThingUrl()
     {
-        return (string) get_the_permalink();
+        return (string)get_the_permalink();
     }
 
     /**
@@ -338,7 +338,7 @@ 
      * @param string $value
      * @return string
      */
-    protected function setAndGetKeyValue($option, $value)
+    protected function setAndGetKeyValue( $option, $value )
     {
         $this->keyValues[$option] = $value;
         return $value;