Wzorzec projektowy – Płynny interfejs (Fluent Interface)

Płynny interfejs (ang. Fluent Interface) to wzorzec stosowany w celu zwiększenia czytelności kodu. Można wykorzystać go na przykład do konfiguracji obiektu.

Przykładowa postać:

$object = new Class();
$object->doSomething()->somethingElse()->more();

1 2	$object = new Class(); $object->doSomething()->somethingElse()->more();

Preferowany zapis:

$object = (new Class())
          ->doSomething()
          ->somethingElse()
          ->more();

$object = (new Class())

->doSomething()

->somethingElse()

->more();

Przykład funkcji użytej w powyższym zapisie:

private $value;

public function doSomething($value) {
    $this->value = $value;
    return $this;
}

private $value;

public function doSomething($value) {

$this->value = $value;

return $this;

}

Zauważ, że funkcja zwraca instancję obiektu: return $this. W ten sposób możemy łączyć metody operatorem „->” w łańcuch i nie musimy powielać instancji obiektu, jak w przypadku klasycznego podejścia:

$object = new Class();

$object->doSomething();
$object->somethingElse();
$object->more();

$object = new Class();

$object->doSomething();

$object->somethingElse();

$object->more();

Jeżeli korzystasz z jakiegoś frameworka, to na pewno spotkałeś się już z tym wzorcem, choćby nawet w jQuery 🙂 :

$("div").addClass("blue").css("display","block").fadeIn();

1	$("div").addClass("blue").css("display","block").fadeIn();

PRZYKŁAD

Poniższa klasa Mail posłuży do wysyłania poczty elektronicznej. Wzorzec Fluent Interface wykorzystamy do ustawienia parametrów funkcji mail. To naprawdę prosty przykład, który co nieco wyjaśni.

<?php
class Mail
{
    private $from;
    private $to;
    private $subject;
    private $message;
    public function From($from)
    {
        $this->from = $from;
        return $this;
    }
    public function addTo($to)
    {
        $this->to = $to;
        return $this;
    }
    public function Subject($subject)
    {
        $this->subject = $subject;
        return $this;
    }
    public function Message($message)
    {
        $this->message = $message;
        return $this;
    }  
    public function send()
    {
        $success = mail(
            $this->to, 
            $this->subject, 
            $this->message, 
            'From: '.$this->from
        );
        if ( !$success ) {
            print_r(error_get_last()['message']);
        } else {
            print "Message was sent.";
        }
    }
}
$mail = (new Mail())
        ->From('tester@example.com')
        ->addTo('contact@example.com')
        ->Subject('Fluent Interface')
        ->Message('Hello World !')
        ->send();

<?php

class Mail

{

private $from;

private $to;

private $subject;

private $message;

public function From($from)

{

$this->from = $from;

return $this;

}

public function addTo($to)

{

$this->to = $to;

return $this;

}

public function Subject($subject)

{

$this->subject = $subject;

return $this;

}

public function Message($message)

{

$this->message = $message;

return $this;

}

public function send()

{

$success = mail(

$this->to,

$this->subject,

$this->message,

'From: '.$this->from

);

if ( !$success ) {

print_r(error_get_last()['message']);

} else {

print "Message was sent.";

}

$mail = (new Mail())

->From('tester@example.com')

->addTo('contact@example.com')

->Subject('Fluent Interface')

->Message('Hello World !')

->send();

Przykład na GitHub →

#fluent Interface #php #płynny interfejs #wzorce

Wzorzec projektowy – Płynny interfejs (Fluent Interface)

PRZYKŁAD

KOMENTARZE