PHP OOP chaining methods

Question

I have this code:

class one{ public $instance; function instance(){ $this->instance = 'instance was created'; } function execute(){ $this->instance .= "and something happened"; } } $class = new one; $class->instance(); $class->execute(); echo $class->instance;

And it does what i expect it to do, but how can i chain actions, for example how could i call these functions in one line:

$class->instance()->execute();

And i know it's possible to do it like this:

one::instance()->execute();

but in this case i would need to have static functions which makes things complicated, i need some explanation on these things

cdhowie · Accepted Answer · 2012-10-02 18:15:32Z

In order for chaining to work, you need to return $this from each method you want to be chainable:

class one{ public $instance; function instance(){ $this->instance = 'instance was created'; return $this; } function execute(){ $this->instance .= "and something happened"; return $this; } }

Also, it's a bad idea to give properties the same name as methods. It may be unambiguous to the parser, but it's confusing to developers.

Mike Brant · Accepted Answer · 2012-10-02 18:20:01Z

The general approach to chaining is to return $this as the return for any methods that needs to be chained. So, for your code, it might look like this.

class one{ public $instance; function instance(){ $this->instance = 'instance was created'; return $this; } function execute(){ $this->instance .= "and something happened"; return $this; } }

So you cold do:

$one = new one; $one->instance()->execute(); // would set one::instance to 'instance was createdand something happened' $one->instance()->instance()->instance(); // would set one::instance to 'instance was created'; $one->instance()->execute()->execute(); / would set one::instance to 'instance was createdand something happenedand something happened'

Rudu · Accepted Answer · 2012-10-02 18:15:57Z

You need to return the instance at the end of your functions:

class one{ public $instance; function instance(){ $this->instance = 'instance was created'; return $this; } function execute(){ $this->instance .= "and something happened"; return $this; } }

Then you can chain them.

By the way, this is probably just example code but your instance function doesn't actually create the instance ;)

Marcus · Accepted Answer · 2012-10-02 18:16:46Z

0

$class->instance()->execute();

Should work but you need to return your values in your methods.

answered Oct 2, 2012 at 18:16

Marcus

8,68811 gold badges68 silver badges93 bronze badges

Collectives™ on Stack Overflow

PHP OOP chaining methods

4 Answers 4

Comments

Comments

Comments

Comments

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

Comments

Related