info/DesignPatternsPHP
1
0
Fork 0
mirror of https://github.com/DesignPatternsPHP/DesignPatternsPHP.git synced 2025-07-31 20:20:15 +02:00
Code Issues Projects Releases Wiki Activity

cs TemplateMethod

Browse Source
This commit is contained in:
Dominik Liebler
2013-09-12 11:27:01 +02:00
parent 1c9a83bea1
commit efd71b48e1
4 changed files with 23 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
TemplateMethod/BeachJourney.php
View File

@@ -1,9 +1,5 @@
<?php <?php
/*
* DesignPatternPHP
*/
namespace DesignPatterns\TemplateMethod; namespace DesignPatterns\TemplateMethod;
/** /**
@@ -11,10 +7,11 @@ namespace DesignPatterns\TemplateMethod;
*/ */
class BeachJourney extends Journey class BeachJourney extends Journey
{ {
/**
* prints what to do to enjoy your vacation
*/
protected function enjoyVacation() protected function enjoyVacation()
{ {
echo "Swimming and sun-bathing\n"; echo "Swimming and sun-bathing\n";
} }
}
}

15
TemplateMethod/CityJouney.php → TemplateMethod/CityJourney.php
View File

@@ -1,20 +1,17 @@
<?php <?php
/*
* DesignPatternPHP
*/
namespace DesignPatterns\TemplateMethod; namespace DesignPatterns\TemplateMethod;
/** /**
* CityJouney is a journey in a city * CityJourney is a journey in a city
*/ */
class CityJouney extends Journey class CityJourney extends Journey
{ {
/**
* prints what to do in your journey to enjoy vacation
*/
protected function enjoyVacation() protected function enjoyVacation()
{ {
echo "Eat, drink, take photos and sleep\n"; echo "Eat, drink, take photos and sleep\n";
} }
}
}

26
TemplateMethod/Journey.php
View File

@@ -1,15 +1,11 @@
<?php <?php
/*
* DesignPatternPHP
*/
namespace DesignPatterns\TemplateMethod; namespace DesignPatterns\TemplateMethod;
/** /**
* Template Method is a behavioral design pattern. * Template Method is a behavioral design pattern.
* *
* Perhaps you have encoutered it many times already. The idea is to let subclasses * Perhaps you have encountered it many times already. The idea is to let subclasses
* of this abstract template "finish" the behavior of an algorithm. * of this abstract template "finish" the behavior of an algorithm.
* *
* A.k.a the "Hollywood principle" : "" Don't call us, we call you. "" * A.k.a the "Hollywood principle" : "" Don't call us, we call you. ""
@@ -25,14 +21,13 @@ namespace DesignPatterns\TemplateMethod;
*/ */
abstract class Journey abstract class Journey
{ {
/** /**
* This is the public service provided by this class and its subclasses. * This is the public service provided by this class and its subclasses.
* Notice it is final to "freeze" the global behavior of algorithm. * Notice it is final to "freeze" the global behavior of algorithm.
* If you want to override this contract, make an interface with only takeATrip() * If you want to override this contract, make an interface with only takeATrip()
* and subclass it. * and subclass it.
*/ */
public final function takeATrip() final public function takeATrip()
{ {
$this->buyAFlight(); $this->buyAFlight();
$this->takePlane(); $this->takePlane();
@@ -53,24 +48,27 @@ abstract class Journey
*/ */
protected function buyGift() protected function buyGift()
{ {
} }
// this method will be unknown by subclasses (better) /**
* this method will be unknown by subclasses (better)
*/
private function buyAFlight() private function buyAFlight()
{ {
echo "Buying a flight\n"; echo "Buying a flight\n";
} }
// sbclasses will get access to this method but cannot override it and /**
// compromise this algorithm (warning : cause of cyclic depedencies) * sbclasses will get access to this method but cannot override it and
* compromise this algorithm (warning : cause of cyclic dependencies)
*/
final protected function takePlane() final protected function takePlane()
{ {
echo "Taking the plane\n"; echo "Taking the plane\n";
} }
// A note regarding the keyword "final" : don't use it when you start coding : // A note regarding the keyword "final" : don't use it when you start coding :
// add it after you narrow and know exacly what change and what remain unchanged // add it after you narrow and know exactly what change and what remain unchanged
// in this algorithm. // in this algorithm.
// [abstract] x [3 access] x [final] = 12 combinations, it can be hard ! // [abstract] x [3 access] x [final] = 12 combinations, it can be hard !
} }

2
Tests/TemplateMethod/JourneyTest.php
View File

@@ -23,7 +23,7 @@ class JourneyTest extends \PHPUnit_Framework_TestCase
public function testCity() public function testCity()
{ {
$journey = new TemplateMethod\CityJouney(); $journey = new TemplateMethod\CityJourney();
$this->expectOutputRegex('#drink#'); $this->expectOutputRegex('#drink#');
$journey->takeATrip(); $journey->takeATrip();
} }