Add docstrings and a missing constant

Author: adamziel

packages/playground/data-liberation/src/entity-readers/WP_HTML_Entity_Reader.php

@@ -1,11 +1,7 @@
 <?php
 
-use WordPress\Data_Liberation\Block_Markup\WP_HTML_To_Blocks;
-
 /**
- * Converts a single HTML file into a stream of WordPress entities.
- *
- * @TODO: Support post meta.
+ * Converts a single HTML file into a stream of WordPress posts and post meta.
  */
 class WP_HTML_Entity_Reader extends WP_Entity_Reader {
 
@@ -19,6 +15,11 @@ public function __construct( $html, $post_id ) {
 		$this->post_id = $post_id;
 	}
 
+	/**
+	 * Advances to the next entity.
+	 *
+	 * @return bool Whether the next entity was found.
+	 */
 	public function next_entity() {
 		// If we're finished, we're finished.
 		if ( $this->finished ) {
@@ -78,17 +79,32 @@ public function next_entity() {
 		return true;
 	}
 
+	/**
+	 * Returns the current entity.
+	 *
+	 * @return WP_Imported_Entity|false The current entity, or false if there are no entities left.
+	 */
 	public function get_entity() {
 		if ( $this->is_finished() ) {
 			return false;
 		}
 		return $this->entities[0];
 	}
 
+	/**
+	 * Checks if this reader has finished yet.
+	 *
+	 * @return bool Whether the reader has finished.
+	 */
 	public function is_finished(): bool {
 		return $this->finished;
 	}
 
+	/**
+	 * Returns the last error that occurred when processing the HTML.
+	 *
+	 * @return string|null The last error, or null if there was no error.
+	 */
 	public function get_last_error(): ?string {
 		return null;
 	}

packages/playground/data-liberation/src/import/WP_Imported_Entity.php

@@ -1,5 +1,9 @@
 <?php
 
+/**
+ * Represents a single entity, whether a WordPress post, post meta,
+ * a single SQL record, or something entirely different.
+ */
 class WP_Imported_Entity {
 
 	const TYPE_POST         = 'post';
@@ -12,6 +16,32 @@ class WP_Imported_Entity {
 	const TYPE_USER         = 'user';
 	const TYPE_SITE_OPTION  = 'site_option';
 
+	const POST_FIELDS = array(
+		'post_title',
+		'link',
+		'guid',
+		'post_excerpt',
+		'post_published_at',
+		'post_author',
+		'post_content',
+		'post_excerpt',
+		'post_id',
+		'post_status',
+		'post_date',
+		'post_date_gmt',
+		'post_modified',
+		'post_modified_gmt',
+		'comment_status',
+		'ping_status',
+		'post_name',
+		'post_parent',
+		'menu_order',
+		'post_type',
+		'post_password',
+		'is_sticky',
+		'attachment_url',
+	);
+
 	private $type;
 	private $data;