Add Indexable visibility columns

composer.json

@@ -78,7 +78,7 @@
  "Yoast\\WP\\SEO\\Composer\\Actions::check_coding_standards"
  ],
  "check-cs-thresholds": [
- "@putenv YOASTCS_THRESHOLD_ERRORS=251",
+ "@putenv YOASTCS_THRESHOLD_ERRORS=252",
  "@putenv YOASTCS_THRESHOLD_WARNINGS=220",
  "Yoast\\WP\\SEO\\Composer\\Actions::check_cs_thresholds"
  ],

lib/migrations/adapter.php

@@ -331,7 +331,7 @@ public function select_one( $query ) {
  return false;
  }
 
- return $wpdb->last_result[0];
+ return (array) $wpdb->last_result[0];
  }
 
  return false;

lib/model.php

@@ -94,6 +94,13 @@ class Model implements JsonSerializable {
  */
  protected $float_columns = [];
 
+ /**
+ * Which columns are deprecated.
+ *
+ * @var array
+ */
+ protected $deprecated_columns = [];
+
  /**
  * Hacks around the Model to provide WordPress prefix to tables.
  *
@@ -504,15 +511,18 @@ public function set_orm( $orm ) {
  * @return mixed The value of the property
  */
  public function __get( $property ) {
- $value = $this->orm->get( $property );
+ $original_property = $property;
+ $property = $this->handle_deprecation( $property );
+ $value = $this->orm->get( $property );
 
- if ( $value !== null && \in_array( $property, $this->boolean_columns, true ) ) {
+ // The types of a deprecated property and its replacement may differ. To prevent this kind of deprecation from being a breaking change, use the old/originally requested type.
+ if ( $value !== null && \in_array( $original_property, $this->boolean_columns, true ) ) {
  return (bool) $value;
  }
- if ( $value !== null && \in_array( $property, $this->int_columns, true ) ) {
+ if ( $value !== null && \in_array( $original_property, $this->int_columns, true ) ) {
  return (int) $value;
  }
- if ( $value !== null && \in_array( $property, $this->float_columns, true ) ) {
+ if ( $value !== null && \in_array( $original_property, $this->float_columns, true ) ) {
  return (float) $value;
  }
 
@@ -528,6 +538,7 @@ public function __get( $property ) {
  * @return void
  */
  public function __set( $property, $value ) {
+ $property = $this->handle_deprecation( $property );
  if ( $value !== null && \in_array( $property, $this->boolean_columns, true ) ) {
  $value = ( $value ) ? '1' : '0';
  }
@@ -549,6 +560,7 @@ public function __set( $property, $value ) {
  * @return void
  */
  public function __unset( $property ) {
+ $property = $this->handle_deprecation( $property );
  $this->orm->__unset( $property );
  }
 
@@ -578,6 +590,7 @@ public function __debugInfo() {
  * @return bool True when value is set.
  */
  public function __isset( $property ) {
+ $property = $this->handle_deprecation( $property );
  return $this->orm->__isset( $property );
  }
 
@@ -589,6 +602,8 @@ public function __isset( $property ) {
  * @return string The value of a property.
  */
  public function get( $property ) {
+ $property = $this->handle_deprecation( $property );
+
  return $this->orm->get( $property );
  }
 
@@ -601,6 +616,37 @@ public function get( $property ) {
  * @return static Current object.
  */
  public function set( $property, $value = null ) {
+ $property = $this->handle_deprecation( $property );
+ $this->orm->set( $property, $value );
+
+ return $this;
+ }
+
+ /**
+ * Setter method for model properties that are deprecated, but still need to updated while they wait to be removed.
+ *
+ * @param string|array $property The property to set.
+ * @param string|null $value The value to give.
+ *
+ * @return static Current object.
+ *
+ * @internal
+ */
+ public function set_deprecated_property( $property, $value = null ) {
+ if ( ! array_key_exists( $property, $this->deprecated_columns ) ) {
+ return $this;
+ }
+
+ if ( $value !== null && \in_array( $property, $this->boolean_columns, true ) ) {
+ $value = ( $value ) ? '1' : '0';
+ }
+ if ( $value !== null && \in_array( $property, $this->int_columns, true ) ) {
+ $value = (string) $value;
+ }
+ if ( $value !== null && \in_array( $property, $this->float_columns, true ) ) {
+ $value = (string) $value;
+ }
+
  $this->orm->set( $property, $value );
 
  return $this;
@@ -615,6 +661,7 @@ public function set( $property, $value = null ) {
  * @return static Current object.
  */
  public function set_expr( $property, $value = null ) {
+ $property = $this->handle_deprecation( $property );
  $this->orm->set_expr( $property, $value );
 
  return $this;
@@ -628,6 +675,7 @@ public function set_expr( $property, $value = null ) {
  * @return bool True when field is changed.
  */
  public function is_dirty( $property ) {
+ $property = $this->handle_deprecation( $property );
  return $this->orm->is_dirty( $property );
  }
 
@@ -718,4 +766,37 @@ public static function __callStatic( $method, $arguments ) {
 
  return \call_user_func_array( [ $model, $method ], $arguments );
  }
+
+ /**
+ * Checks if a property is deprecated and handles notifications and replacement.
+ *
+ * @param string $property The property to check for deprecation.
+ *
+ * @return string The deprecated property name. Or its replacement if available.
+ */
+ protected function handle_deprecation( $property ) {
+ if ( ! array_key_exists( $property, $this->deprecated_columns ) ) {
+ return $property;
+ }
+ $deprecation = $this->deprecated_columns[ $property ];
+
+ if ( ! empty( $deprecation['replacement'] ) ) {
+ // There is no _deprecated_property. This matches our usecase best.
+ \_deprecated_argument(
+ __FUNCTION__,
+ esc_html( $deprecation['since'] ),
+ 'Use the \"' . esc_html( $deprecation['replacement'] ) . '\" property instead of \"' . esc_html( $property ) . '\" '
+ );
+
+ if ( $deprecation['automatically_use_replacement'] === true ) {
+ return $deprecation['replacement'];
+ }
+
+ return $property;
+ }
+ // There is no _deprecated_property. This matches our usecase best.
+ \_deprecated_argument( __FUNCTION__, esc_html( $deprecation['since'] ), 'The \"' . esc_html( $property ) . '\" property will be removed in a future version' );
+
+ return $property;
+ }
 }

lib/orm.php

@@ -48,7 +48,6 @@
  * @see http:https://www.php-fig.org/psr/psr-1/
  */
 class ORM implements \ArrayAccess {
-
  /*
  * --- CLASS CONSTANTS ---
  */

src/builders/indexable-author-builder.php

@@ -87,22 +87,35 @@ public function build( $user_id, Indexable $indexable ) {
  $indexable->is_robots_noarchive = null;
  $indexable->is_robots_noimageindex = null;
  $indexable->is_robots_nosnippet = null;
- $indexable->is_public = ( $indexable->is_robots_noindex ) ? false : null;
- $indexable->has_public_posts = $this->author_archive->author_has_public_posts( $user_id );
  $indexable->blog_id = \get_current_blog_id();
+ $indexable->set_deprecated_property( 'is_public', ( $indexable->is_robots_noindex ) ? false : null );
 
  $this->reset_social_images( $indexable );
  $this->handle_social_images( $indexable );
 
- $timestamps = $this->get_object_timestamps( $user_id );
- $indexable->object_published_at = $timestamps->published_at;
- $indexable->object_last_modified = $timestamps->last_modified;
+ $indexable = $this->set_aggregate_values( $indexable );
 
  $indexable->version = $this->version;
 
  return $indexable;
  }
 
+ /**
+ * Sets the aggregate values for an author indexable.
+ *
+ * @param Indexable $indexable The indexable to set the aggregates for.
+ *
+ * @return Indexable The indexable with set aggregates.
+ */
+ public function set_aggregate_values( Indexable $indexable ) {
+ $aggregates = $this->get_public_post_archive_aggregates( $indexable->object_id );
+ $indexable->object_published_at = $aggregates->first_published_at;
+ $indexable->object_last_modified = max( $indexable->object_last_modified, $aggregates->most_recent_last_modified );
+ $indexable->number_of_publicly_viewable_posts = $aggregates->number_of_public_posts;
+
+ return $indexable;
+ }
+
  /**
  * Retrieves the meta data for this indexable.
  *
@@ -168,24 +181,28 @@ protected function find_alternative_image( Indexable $indexable ) {
  }
 
  /**
- * Returns the timestamps for a given author.
+ * Returns public post aggregates for a given author.
  *
- * @param int $author_id  The author ID.
+ * @param int $author_id The author ID.
  *
- * @return object An object with last_modified and published_at timestamps.
+ * @return object  An object with the number of public posts, most recent last modified and first published at timestamps.
  */
- protected function get_object_timestamps( $author_id ) {
+ protected function get_public_post_archive_aggregates( $author_id ) {
  $post_statuses = $this->post_helper->get_public_post_statuses();
+ $post_types = $this->author_archive->get_author_archive_post_types();
 
  $sql = "
- SELECT MAX(p.post_modified_gmt) AS last_modified, MIN(p.post_date_gmt) AS published_at
+ SELECT 
+ COUNT(p.ID) as number_of_public_posts,
+ MAX(p.post_modified_gmt) AS most_recent_last_modified,
+ MIN(p.post_date_gmt) AS first_published_at
  FROM {$this->wpdb->posts} AS p
- WHERE p.post_status IN (" . implode( ', ', array_fill( 0, count( $post_statuses ), '%s' ) ) . ")
- AND p.post_password = ''
+ WHERE p.post_status IN (" . implode( ', ', array_fill( 0, count( $post_statuses ), '%s' ) ) . ')
  AND p.post_author = %d
- ";
+ AND p.post_type IN (' . implode( ', ', array_fill( 0, count( $post_types ), '%s' ) ) . ')
+ ';
 
- $replacements = \array_merge( $post_statuses, [ $author_id ] );
+ $replacements = \array_merge( $post_statuses, [ $author_id ], $post_types );
 
  // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- We are using wpdb prepare.
  return $this->wpdb->get_row( $this->wpdb->prepare( $sql, $replacements ) );

src/builders/indexable-builder.php

@@ -219,6 +219,7 @@ public function build_for_post_type_archive( $post_type, $indexable = false ) {
  'object_type' => 'post-type-archive',
  'object_sub_type' => $post_type,
  ];
+
  return $this->build( $indexable, $defaults );
  }
 
@@ -235,6 +236,7 @@ public function build_for_system_page( $page_type, $indexable = false ) {
  'object_type' => 'system-page',
  'object_sub_type' => $page_type,
  ];
+
  return $this->build( $indexable, $defaults );
  }
 
@@ -372,8 +374,7 @@ public function build( $indexable, $defaults = null ) {
  }
 
  return $this->save_indexable( $indexable, $indexable_before );
- }
- catch ( Source_Exception $exception ) {
+ } catch ( Source_Exception $exception ) {
  /**
  * The current indexable could not be indexed. Create a placeholder indexable, so we can
  * skip this indexable in future indexing runs.
@@ -396,4 +397,43 @@ public function build( $indexable, $defaults = null ) {
  return $this->save_indexable( $indexable, $indexable_before );
  }
  }
+
+ /**
+ * Recalculates indexable aggregates.
+ *
+ * @param Indexable $indexable The Indexable to (re)build.
+ *
+ * @return Indexable The resulting Indexable.
+ */
+ public function recalculate_aggregates( Indexable $indexable ) {
+ // Backup the previous Indexable, if there was one.
+ $indexable_before = $this->deep_copy_indexable( $indexable );
+
+ switch ( $indexable->object_type ) {
+ case 'system-page':
+ case 'date-archive':
+ case 'post':
+ // Nothing to recalculate.
+ break;
+
+ case 'user':
+ $indexable = $this->author_builder->set_aggregate_values( $indexable );
+ break;
+
+ case 'term':
+ $indexable = $this->term_builder->set_aggregate_values( $indexable );
+ break;
+
+ case 'home-page':
+ $indexable = $this->home_page_builder->set_aggregate_values( $indexable );
+ break;
+
+ case 'post-type-archive':
+ $indexable = $this->post_type_archive_builder->set_aggregate_values( $indexable );
+ break;
+ }
+
+ return $this->save_indexable( $indexable, $indexable_before );
+ }
 }
+

src/builders/indexable-date-archive-builder.php

@@ -51,14 +51,15 @@ public function __construct(
  * @return Indexable The extended indexable.
  */
  public function build( $indexable ) {
- $indexable->object_type = 'date-archive';
- $indexable->title = $this->options->get( 'title-archive-wpseo' );
- $indexable->description = $this->options->get( 'metadesc-archive-wpseo' );
- $indexable->is_robots_noindex = $this->options->get( 'noindex-archive-wpseo' );
- $indexable->is_public = ( (int) $indexable->is_robots_noindex !== 1 );
- $indexable->blog_id = \get_current_blog_id();
- $indexable->permalink = null;
- $indexable->version = $this->version;
+ $indexable->object_type = 'date-archive';
+ $indexable->title = $this->options->get( 'title-archive-wpseo' );
+ $indexable->description = $this->options->get( 'metadesc-archive-wpseo' );
+ $indexable->is_robots_noindex = $this->options->get( 'noindex-archive-wpseo' );
+ $indexable->is_publicly_viewable = ! (bool) $this->options->get( 'disable-date' );
+ $indexable->blog_id = \get_current_blog_id();
+ $indexable->permalink = null;
+ $indexable->version = $this->version;
+ $indexable->set_deprecated_property( 'is_public', (int) $indexable->is_robots_noindex !== 1 );
 
  return $indexable;
  }