Make WordPress Core

Changeset 40968


Ignore:
Timestamp:
06/30/2017 04:35:39 AM (7 years ago)
Author:
DrewAPicture
Message:

Tests: Add @method notations to factor class DocBlocks as a way to indicate expected return types from factory methods for the benefit of IDEs.

Props jdgrimes.
Fixes #37867.

Location:
trunk/tests/phpunit/includes/factory
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-blog.php

    r38935 r40968  
    11<?php
    22
     3/**
     4 * Unit test factory for sites on a multisite network.
     5 *
     6 * Note: The below @method notations are defined solely for the benefit of IDEs,
     7 * as a way to indicate expected return values from the given factory methods.
     8 *
     9 * @method int create( $args = array(), $generation_definitions = null )
     10 * @method WP_Site create_and_get( $args = array(), $generation_definitions = null )
     11 * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
     12 */
    313class WP_UnitTest_Factory_For_Blog extends WP_UnitTest_Factory_For_Thing {
    414
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-bookmark.php

    r37563 r40968  
    44 * Factory for creating fixtures for the deprecated Links/Bookmarks API.
    55 *
     6 * Note: The below @method notations are defined solely for the benefit of IDEs,
     7 * as a way to indicate expected return values from the given factory methods.
     8 *
    69 * @since 4.6.0
     10 *
     11 * @method int create( $args = array(), $generation_definitions = null )
     12 * @method object create_and_get( $args = array(), $generation_definitions = null )
     13 * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
    714 */
    815class WP_UnitTest_Factory_For_Bookmark extends WP_UnitTest_Factory_For_Thing {
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php

    r36347 r40968  
    11<?php
    22
     3/**
     4 * Unit test factory for comments.
     5 *
     6 * Note: The below @method notations are defined solely for the benefit of IDEs,
     7 * as a way to indicate expected return values from the given factory methods.
     8 *
     9 * @method int create( $args = array(), $generation_definitions = null )
     10 * @method WP_Comment create_and_get( $args = array(), $generation_definitions = null )
     11 * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
     12 */
    313class WP_UnitTest_Factory_For_Comment extends WP_UnitTest_Factory_For_Thing {
    414
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-network.php

    r39071 r40968  
    11<?php
    22
     3/**
     4 * Unit test factory for networks.
     5 *
     6 * Note: The below @method notations are defined solely for the benefit of IDEs,
     7 * as a way to indicate expected return values from the given factory methods.
     8 *
     9 * @method int create( $args = array(), $generation_definitions = null )
     10 * @method WP_Network create_and_get( $args = array(), $generation_definitions = null )
     11 * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
     12 */
    313class WP_UnitTest_Factory_For_Network extends WP_UnitTest_Factory_For_Thing {
    414
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-post.php

    r36347 r40968  
    11<?php
    22
     3/**
     4 * Unit test factory for posts.
     5 *
     6 * Note: The below @method notations are defined solely for the benefit of IDEs,
     7 * as a way to indicate expected return values from the given factory methods.
     8 *
     9 * @method int create( $args = array(), $generation_definitions = null )
     10 * @method WP_Post create_and_get( $args = array(), $generation_definitions = null )
     11 * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
     12 */
    313class WP_UnitTest_Factory_For_Post extends WP_UnitTest_Factory_For_Thing {
    414
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php

    r36347 r40968  
    11<?php
    22
     3/**
     4 * Unit test factory for terms.
     5 *
     6 * Note: The below @method notations are defined solely for the benefit of IDEs,
     7 * as a way to indicate expected return values from the given factory methods.
     8 *
     9 * @method int create( $args = array(), $generation_definitions = null )
     10 * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
     11 */
    312class WP_UnitTest_Factory_For_Term extends WP_UnitTest_Factory_For_Thing {
    413
     
    3645    }
    3746
     47    /**
     48     * @return array|null|WP_Error|WP_Term
     49     */
    3850    function create_and_get( $args = array(), $generation_definitions = null ) {
    3951        $term_id = $this->create( $args, $generation_definitions );
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-user.php

    r36347 r40968  
    11<?php
    22
     3/**
     4 * Unit test factory for users.
     5 *
     6 * Note: The below @method notations are defined solely for the benefit of IDEs,
     7 * as a way to indicate expected return values from the given factory methods.
     8 *
     9 * @method int create( $args = array(), $generation_definitions = null )
     10 * @method WP_User create_and_get( $args = array(), $generation_definitions = null )
     11 * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
     12 */
    313class WP_UnitTest_Factory_For_User extends WP_UnitTest_Factory_For_Thing {
    414
Note: See TracChangeset for help on using the changeset viewer.