PHP Function Arguments: Array of Objects of a Specific Class

Question

I have a function that takes a member of a particular class:

public function addPage(My_Page $page)
{
  // ...
}

I'd like to make another function that takes an array of My_Page objects:

public function addPages($pages)
{
  // ...
}

I need to ensure that each element of $pages array is an instance of My_Page. I could do that with foreach($pages as $page) and check for instance of, but can I somehow specify in the function definition that the array has to be an array of My_Page objects? Improvising, something like:

public function addPages(array(My_Page)) // I realize this is improper PHP...

Thanks!

Jon · Accepted Answer · 2011-06-29 15:22:59Z

20

No, it's not possible to do directly. You might try this "clever" trick instead:

public function addPages(array $pages)
{
    foreach($pages as $page) addPage($page);
}

public function addPage(My_Page $page)
{
    //
}

But I 'm not sure if it's worth all the trouble. It would be a good approach if addPage is useful on its own.

answered Jun 29, 2011 at 15:22

Jon

439k85 gold badges756 silver badges820 bronze badges

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

Comments

barbushin · Accepted Answer · 2019-02-05 04:31:58Z

19

You can also add PhpDoc comment to get autocomplete in IDE

    /**
     * @param My_Page[] $pages
     */
    public function addPages(array $pages)
    {
      // ...
    }

answered Feb 5, 2019 at 4:31

barbushin

5,2925 gold badges40 silver badges44 bronze badges

2 Comments

Benyamin Limanto Over a year ago

This is helping and with VS code and the github.com/bmewburn/vscode-intelephense it's very helpful with the autocomplete :)

user2342558 Nov 13 at 8:45

This should be the accepted answer in 2025.

Arkowsky · Accepted Answer · 2021-03-10 11:40:10Z

3

From php5.6 you can use splat operator to type hint all array elements as function params. In this case you don't have more parameters than Pages stored in array so it should work fine:

public function addPages(Page ...$pages)

More info: https://www.php.net/manual/en/migration56.new-features.php

https://lornajane.net/posts/2014/php-5-6-and-the-splat-operator

answered Mar 10, 2021 at 11:40

Arkowsky

8917 silver badges20 bronze badges

1 Comment

user2342558 Nov 13 at 8:43

it throws the error Argument #1 must be of type Page, array given in php 8.2

phil294 · Accepted Answer · 2016-12-25 23:33:32Z

2

Instead of passing an array of objects (array(My_Page)), define your own class and require an instance of it in your function:

class MyPages { ... }

public function addPages(MyPages pages)

answered Dec 25, 2016 at 23:33

phil294

11.1k8 gold badges74 silver badges113 bronze badges

3 Comments

goose Over a year ago

and how exactly I'm able to store an indefinite amount of specific objects in that class?

phil294 Over a year ago

@goose I have no idea what I meant with this answer back then, sorry. This answer looks pretty useless to me

goose Over a year ago

xd it's kk. but it's weird that 2 dudes upvoted it and found this useful

sina · Accepted Answer · 2018-12-28 11:15:20Z

0

if you use the class, you can do some thing like this:

interface addPageInterface
{
   public function someThing();
}


class page implements addPageInterface
{
   public function someThing()
   {
      //for example: create a page
   }
}


class addPage
{
   public function __construct(addPageInterface $page)
   {
       //do some thing...

      return $page; //this will return just one page
   }
}


class addPages
{
   public function __construct(addPageInterface... $page)
   {
      //do some thing...

      return $page; //this will return an array which contains of page
   }
}

answered Dec 28, 2018 at 11:15

sina

1

1 Comment

Anmol Over a year ago

Give proper explanation with your answer with proper reasoning.

Fırat Taşkın · Accepted Answer · 2021-05-20 05:58:52Z

-2

<?php
        
    class Page{
            public $a;
    }
        
    
    function addPages(Page ...$pages){
        foreach($pages as $page){
        
        }
    }
        
        
    $pages = [];
    $pages[]  = new Page;
    $pages[]  = new Page;
    $pages[]  = new Page;
    addPages(...$pages);
    
?>

i think its better way

answered May 20, 2021 at 5:58

Fırat Taşkın

1156 bronze badges

4 Comments

law_81 Over a year ago

Explain why do you think this is a better way please.

Luxato Over a year ago

This will throw an error: Argument #1 must be type of Page, array given.

Fırat Taşkın Over a year ago

Its not throwing any error after version 7.0 its working successfuly

user2342558 Nov 13 at 8:42

it throws the error Argument #1 must be of type Page, array given in php 8.2

Collectives™ on Stack Overflow

PHP Function Arguments: Array of Objects of a Specific Class

6 Answers 6

Comments

2 Comments

1 Comment

3 Comments

1 Comment

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

Comments

2 Comments

1 Comment

3 Comments

1 Comment

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related