Wordpress/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php
Gary Pendergast ae62335191 Docs: Add docblocks for the PHPUnit factory objects.
Props andizer.
Fixes #44521.


git-svn-id: https://develop.svn.wordpress.org/trunk@44497 602fd350-edb4-49c9-b593-d223f7449a82
2019-01-09 05:43:14 +00:00

75 lines
2.3 KiB
PHP

<?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 {
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 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;
return wp_update_comment( $this->addslashes_deep( $fields ) );
}
/**
* 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;
return $this->create_many( $count, $args, $generation_definitions );
}
/**
* 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 );
}
}