1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 |
- <?php
- /**
- * Unit test factory for comments.
- *
- * Note: The below @method notations are defined solely for the benefit of IDEs,
- * as a way to indicate expected return values from the given factory methods.
- *
- * @method int create( $args = array(), $generation_definitions = null )
- * @method WP_Comment create_and_get( $args = array(), $generation_definitions = null )
- * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
- */
- class WP_UnitTest_Factory_For_Comment extends WP_UnitTest_Factory_For_Thing {
- public function __construct( $factory = null ) {
- parent::__construct( $factory );
- $this->default_generation_definitions = array(
- 'comment_author' => new WP_UnitTest_Generator_Sequence( 'Commenter %s' ),
- 'comment_author_url' => new WP_UnitTest_Generator_Sequence( 'http://example.com/%s/' ),
- 'comment_approved' => 1,
- 'comment_content' => 'This is a comment',
- );
- }
- /**
- * Inserts a comment.
- *
- * @param array $args The comment details.
- *
- * @return int|false The comment's ID on success, false on failure.
- */
- public 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 The value 1 if the comment was updated, 0 if not updated.
- */
- public function update_object( $comment_id, $fields ) {
- $fields['comment_ID'] = $comment_id;
- return wp_update_comment( $this->addslashes_deep( $fields ) );
- }
- /**
- * Creates multiple comments on a given post.
- *
- * @param int $post_id ID of the post 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.
- */
- public function create_post_comments( $post_id, $count = 1, $args = array(), $generation_definitions = null ) {
- $args['comment_post_ID'] = $post_id;
- return $this->create_many( $count, $args, $generation_definitions );
- }
- /**
- * Retrieves a comment by a given ID.
- *
- * @param int $comment_id ID of the comment to retrieve.
- *
- * @return WP_Comment|null WP_Comment object on success, null on failure.
- */
- public function get_object_by_id( $comment_id ) {
- return get_comment( $comment_id );
- }
- }
|