PHP type hinting inline when calling a function

Question

Is it possible to type hint a parameter directly inline during a function call?

public function load(ObjectManager $manager)
{
    $product = $this->createProduct(
        "T-SHIRT",
        $this->getReference('brand-4') /** @var Brand <=== NOT WORKING */ 
    );
    $manager->persist($product);
    $this->addReference('product-1', $product);
}

/**
 * @param string $name
 * @param Brand  $brand
 */
private function createProduct($name, $brand)
{
    $product = new Product();
    $product
        ->setName($name)
        ->setBrand($brand) // <== this setter needs a Brand entity
    ;

    // [...]
}

Of course phpstan is giving me an error because getReference returns an object and the function expects a Brand object:

Parameter #2 $brand of method AppBundle\DataFixtures\ORM\ProductFixtures::createProduct() expects AppBundle\Entity\Brand, object given.

I would NOT like to explicity declare a variable like this:

/** @var Brand */
$brand = $this->getReference('brand-4');
$product = $this->createProduct(
    "T-SHIRT",
    $brand
);

It would save me a lot of time!

Because createProduct will call setBrand on a newly created Product object and it expects a Brand entity. — StockBreak
– StockBreak, Commented Mar 5, 2020 at 16:43
I see, the getReference returns various types of class according to reference, so you cannot hint its return type. But you are sure that it will return a Brand object from brand-4 so you want a way to hint this type in-line. — glinda93
– glinda93, Commented Mar 5, 2020 at 16:49
A workaround would be to change the createProduct hint anyway, and use instanceof in it to assert you have a Brand but I guess it's not much better than defining a variable. On another hand it could allow you to make sure getReference's return is indeed a Brand and manage the errors. — Altherius
– Altherius, Commented Mar 5, 2020 at 16:50

Code Spirit · Accepted Answer · 2021-06-30 14:22:57Z

1

I had the same problem implementing a generic like structure. This solution works when you want to override method signature. You can accomplish this using @method doc comments but you need 2 classes for it:

class AbstractRepository {
  /**
   * @param mixed $id
   * @return object
   */
  public function getReference($id) {
     /* ... */
  }
}

/**
 * @method ConcreteResult getReference($id)
 */
class ConcreteRepository extends AbstractRepository {

}

$repo = new ConcreteRepository();
$repo->getReference(123); // Has ConcreteResult return type

This works in PHPStorm for example. I have not checked if it works with PHPStan.

answered Jun 30, 2021 at 14:22

Code Spirit

5,1776 gold badges30 silver badges50 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

PHP type hinting inline when calling a function

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related