CODEWITHSUNDEEP
phpfunctionsymfony
Arthur Attout
Arthur Attout

Reputation: 2916

Double colon in function declaration

While reading a post on Medium, I stumbled upon a function signature I couldn't understand. 

public function index(): Response
{
    $posts = $this->getDoctrine()
                ->getRepository(Post::class)
                ->findAll();
    return $this->render('posts/list.html.twig', ['posts' => $posts]);
}

What is the purpose of : Response in this case ? Is it specific to Symfony ?

Upvotes: 3

Views: 3130

Answers (1)

goto
goto

Reputation: 8162

PHP 7 adds support for return type declarations. Similarly to argument type declarations, return type declarations specify the type of the value that will be returned from a function. The same types are available for return type declarations as are available for argument type declarations.

Strict typing also has an effect on return type declarations. In the default weak mode, returned values will be coerced to the correct type if they are not already of that type. In strong mode, the returned value must be of the correct type, otherwise a TypeError will be thrown.

PHP 7.1 adds a nullable return type, declared like : ?string

Some example:

function getNothing(): void {
    return; // valid
}

function getNothing(): void {
    // do nothing
    // valid
}

function getAge(): ?int  {
    return null; // valid
}

function getAge(): ?int  {
    return 18; // valid
}

function getAge(): int  {
    return 18; // valid
}

function getAge(): ?int  {
    return null; // valid
}

function getAge(): int  {
    return null; // error
}

Upvotes: 4

Related Questions