Changeset 44497 for trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php

Timestamp:

01/09/2019 05:43:14 AM (6 months ago)

Author:

pento

Message:

Docs: Add docblocks for the PHPUnit factory objects.

Props andizer.
Fixes #44521.

File:

• trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php (modified) (3 diffs)

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php

@@ -23 +23 @@
     }
 
+    /**
+     * Inserts a comment.
+     *
+     * @param array $args The comment details.
+     *
+     * @return false|int The comment's ID on success, false on failure.
+     */
     function create_object( $args ) {
         return wp_insert_comment( $this->addslashes_deep( $args ) );
     }
 
+    /**
+     * Updates a comment.
+     *
+     * @param int   $comment_id The comment id.
+     * @param array $fields     The comment details.
+     *
+     * @return int When updated 1, not update 0.
+     */
     function update_object( $comment_id, $fields ) {
         $fields['comment_ID'] = $comment_id;
@@ -32 +47 @@
     }
 
+    /**
+     * Creates multiple comments on given post.
+     *
+     * @param int   $post_id                The post id to create comments for.
+     * @param int   $count                  Total amount of comments to create.
+     * @param array $args                   The comment details.
+     * @param null  $generation_definitions Default values.
+     *
+     * @return int[] Array with the comment ids.
+     */
     function create_post_comments( $post_id, $count = 1, $args = array(), $generation_definitions = null ) {
         $args['comment_post_ID'] = $post_id;
@@ -37 +62 @@
     }
 
+    /**
+     * Returns a comment.
+     *
+     * @param int $comment_id The comment id.
+     *
+     * @return null|WP_Comment WP_Comment when found, null when not found.
+     */
     function get_object_by_id( $comment_id ) {
         return get_comment( $comment_id );