Fix types with annotations [MAILPOET-2488]

This commit is contained in:
wxa
2019-12-26 18:07:52 +03:00
committed by amine-mp
parent bd1a84c5c3
commit 09a1411c81
18 changed files with 36 additions and 20 deletions

View File

@@ -162,7 +162,7 @@ class Mailer {
}
/**
* @param \MailPoet\Models\Subscriber|array $subscriber
* @param \MailPoet\Models\Subscriber|array|string $subscriber
*/
public function formatSubscriberNameAndEmailAddress($subscriber) {
$subscriber = (is_object($subscriber)) ? $subscriber->asArray() : $subscriber;

View File

@@ -54,12 +54,14 @@ use MailPoet\WP\Functions as WPFunctions;
* @method static $this whereNotEqual($column_name, $value=null)
* @method $this whereIdIs($id)
* @method $this whereAnyIs($values, $operator='=')
* @method static $this whereAnyIs($values, $operator='=')
* @method $this whereIdIn($ids)
* @method static static whereIdIn($ids)
* @method $this whereLike($column_name, $value=null)
* @method static $this whereLike($column_name, $value=null)
* @method $this whereNotLike($column_name, $value=null)
* @method $this whereGt($column_name, $value=null)
* @method static $this whereGt($column_name, $value=null)
* @method static $this whereLt($column_name, $value=null)
* @method $this whereGte($column_name, $value=null)
* @method $this whereLte($column_name, $value=null)

View File

@@ -11,7 +11,7 @@ use MailPoet\WP\Functions as WPFunctions;
* @property int $count_processed
* @property int $count_to_process
* @property int $count_total
* @property string $newsletter_rendered_body
* @property string|array $newsletter_rendered_body
* @property string $newsletter_rendered_subject
* @property int $task_id
* @property int $newsletter_id

View File

@@ -17,7 +17,7 @@ use function MailPoetVendor\array_column;
* @property int $id
* @property int $newsletter_id
* @property string $newsletter_rendered_subject
* @property string $newsletter_rendered_body
* @property string|array $newsletter_rendered_body
* @property bool $non_existent_column
*/
class Sending {

View File

@@ -12,7 +12,7 @@ use MailPoet\Settings\UserFlagsRepository;
class UserFlagsTest extends \MailPoetTest {
/** @var Settings */
/** @var UserFlags */
private $endpoint;
/** @var UserFlagsController */

View File

@@ -49,6 +49,7 @@ class ShortcodesTest extends \MailPoetTest {
WordPress::releaseFunction('apply_filters');
$dom = \pQuery::parseStr($result);
$link = $dom->query('a');
/** @var string $link */
$link = $link->attr('href');
expect($link)->contains('endpoint=view_in_browser');
// request data object contains newsletter hash but not newsletter id

View File

@@ -55,6 +55,7 @@ class SimpleWorkerTest extends \MailPoetTest {
public function testItCalculatesNextRunDateWithinNextWeekBoundaries() {
$current_date = Carbon::createFromTimestamp(WPFunctions::get()->currentTime('timestamp'));
/** @var Carbon $next_run_date */
$next_run_date = (new MockSimpleWorker())->getNextRunDate();
$difference = $next_run_date->diffInDays($current_date);
// Subtract days left in the current week

View File

@@ -26,7 +26,7 @@ class ValidatedEntity {
*/
private $name;
/** @return int */
/** @return int|null */
public function getId() {
return $this->id;
}

View File

@@ -51,6 +51,7 @@ class ValidationTest extends \MailPoetTest {
$name = 'Test name';
$this->connection->executeUpdate("INSERT INTO $this->table_name (id, name) VALUES (?, ?)", [$id, $name]);
/** @var ValidatedEntity $entity */
$entity = $this->entity_manager->find(ValidatedEntity::class, $id);
$entity->setName('x');
try {

View File

@@ -72,10 +72,14 @@ class LoaderTest extends \MailPoetTest {
$filters1 = $data[1]->getFilters();
expect($filters0)->count(1);
expect($filters1)->count(1);
expect($filters0[0])->isInstanceOf('\MailPoet\DynamicSegments\Filters\UserRole');
expect($filters1[0])->isInstanceOf('\MailPoet\DynamicSegments\Filters\UserRole');
expect($filters0[0]->getRole())->equals('Editor');
expect($filters1[0]->getRole())->equals('Administrator');
/** @var UserRole $filter0 */
$filter0 = $filters0[0];
/** @var UserRole $filter1 */
$filter1 = $filters1[0];
expect($filter0)->isInstanceOf('\MailPoet\DynamicSegments\Filters\UserRole');
expect($filter1)->isInstanceOf('\MailPoet\DynamicSegments\Filters\UserRole');
expect($filter0->getRole())->equals('Editor');
expect($filter1->getRole())->equals('Administrator');
}
public function _after() {

View File

@@ -52,8 +52,10 @@ class SingleSegmentLoaderTest extends \MailPoetTest {
$data = $this->loader->load($this->segment->id);
$filters0 = $data->getFilters();
expect($filters0)->count(1);
expect($filters0[0])->isInstanceOf('\MailPoet\DynamicSegments\Filters\UserRole');
expect($filters0[0]->getRole())->equals('Administrator');
/** @var UserRole $filter0 */
$filter0 = $filters0[0];
expect($filter0)->isInstanceOf('\MailPoet\DynamicSegments\Filters\UserRole');
expect($filter0->getRole())->equals('Administrator');
}
public function _after() {

View File

@@ -125,8 +125,10 @@ class ScheduledTaskTest extends \MailPoetTest {
$task = ScheduledTask::findOne($task->id);
expect(Helpers::isJson($task->meta))->true();
expect(json_decode($task->meta, true))->equals($meta);
/** @var string $task_meta */
$task_meta = $task->meta;
expect(Helpers::isJson($task_meta))->true();
expect(json_decode($task_meta, true))->equals($meta);
}
public function testItDoesNotJsonEncodesMetaEqualToNull() {

View File

@@ -75,8 +75,10 @@ class SendingQueueTest extends \MailPoetTest {
$queue = SendingQueue::findOne($queue->id);
expect(Helpers::isJson($queue->newsletter_rendered_body))->true();
expect(json_decode($queue->newsletter_rendered_body, true))->equals($data);
/** @var string queue_newsletter_rendered_body */
$queue_newsletter_rendered_body = $queue->newsletter_rendered_body;
expect(Helpers::isJson($queue_newsletter_rendered_body))->true();
expect(json_decode($queue_newsletter_rendered_body, true))->equals($data);
}
public function testItJsonEncodesMetaWhenSaving() {

View File

@@ -243,7 +243,7 @@ class PostContentTransformerTest extends \MailPoetTest {
$post = [];
$expected_with_post_class = true;
/** @var MockObject $extractor */
/** @var PostTransformerContentsExtractor&MockObject $extractor */
$extractor = $this->make(
PostTransformerContentsExtractor::class,
[
@@ -274,7 +274,7 @@ class PostContentTransformerTest extends \MailPoetTest {
$post = [];
$expected_with_post_class = false;
/** @var MockObject $extractor */
/** @var PostTransformerContentsExtractor&MockObject $extractor */
$extractor = $this->make(
PostTransformerContentsExtractor::class,
[

View File

@@ -228,7 +228,7 @@ class BridgeTest extends \MailPoetTest {
public function testItChecksAndStoresKeysOnSettingsSave() {
$response = ['abc' => 'def'];
/** @var MockObject $bridge */
/** @var Bridge&MockObject $bridge */
$bridge = Stub::makeEmptyExcept(
$this->bridge,
'onSettingsSave',

View File

@@ -238,7 +238,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
}
/**
* @param $email
* @param string $email
* @param int $created_days_ago
* @param string $status
* @return Subscriber

View File

@@ -40,6 +40,7 @@ class FunctionsTest extends \MailPoetTest {
];
// Save the data
/** @var int $id */
$id = wp_insert_attachment($attachment, $upload['file'], $parent_post_id);
$metadata = wp_generate_attachment_metadata($id, $upload['file']);
wp_update_attachment_metadata($id, $metadata);

View File

@@ -175,7 +175,7 @@ abstract class MailPoetTest extends \Codeception\TestCase\Test {
/**
* Call protected/private method of a class.
*
* @param object &$object Instantiated object that we will run method on.
* @param object $object Instantiated object that we will run method on.
* @param string $methodName Method name to call
* @param array $parameters Array of parameters to pass into method.
*