Archive for the ‘Tips & Tricks’ Category

Void functies in classes

Monday, July 6th, 2009

Void functies zijn de functies die niets returnen. Over het algemeen gaat het om setters en functies die de state van de classe veranderen.

Een voorbeeld

class Car
{
    protected $speed = 50;
    // Hieronder zie je een void functie (= geen return)
    public function setSpeed($speed)
    {
        $this->speed = $speed;
    }
    /* Meer code */
}

De code om dit aan te roepen ziet er dan bijvoorbeeld zo uit:

$c = new Car();
$c->setColor(Color::RED);
$c->setSpeed(0);
$c->openDoor(1);
$c->setSpeed(100);

Wanneer echter je variable naam ($c) een beetje groot wordt ($eenOfAnderMerkAutoNaam) is dit een typewerk waar je u tegen zegt. Daarnaast wordt het er ook een stuk minder leesbaar op.
Om dit tegen te gaan laat ik alle void functies $this returnen. Zo krijg je de volgende code:

class Car
{
    protected $speed = 50;
    // Hieronder zie je een void functie (= geen return)
    public function setSpeed($speed)
    {
        $this->speed = $speed;

        return $this;
    }
    /* Meer code */
}
$c = new Car();
$c->setColor(Color::RED)
  ->setSpeed(0)
  ->openDoor(1)
  ->setSpeed(100);

En kijk eens aan, je hoeft de variable maar 1 keer aan te roepen!

Check je!

Onzichtbare setters en getters part 2

Tuesday, June 30th, 2009

Hallo trouwe lezers.. Het leven is op ‘t moment te druk voor woorden, kom niet eens toe aan world of warcraft spelen. Duidelijk tijd tekort dus. Maar dan nu toch een artikel.

Vorige keer heb ik een artikel geschreven over Onzichtbare getters en setters, opzich een leuk concept, als je het van de andere kant bekijkt, zou je alleen altijd getters en setters moeten hebben voor het geval je valdatie toe wilt voegen. Natuurlijk kan je dat allemaal doen met een goede IDE. Aangezien ik op werk met vim zit te klooien, heb ik een leuk alternatief verzonnen.

/** Vergeet niet dat deze functie binnen een class thuishoort **/
public function __call($function, $args)
{
    // Set method, match en sla de variable-naam op in $matches
    if ( preg_match('/^set([A-Z])([0-9a-zA-Z]*)$/', $function, $matches) )
    {
        // Maak de eerste letter lowercase
        $key = strtolower($matches[1]).$matches[2];
        // Zet de variable
        $this->$key = array_shift($args);

        // Mijn gewoonte met void functies
        return $this;
    }

    // Set method, match en sla de variable-naam op in $matches
    if ( preg_match('/^get([A-Z])([0-9a-zA-Z]*)$/', $function, $matches) )
    {
        // Maak de eerste letter lowercase
        $key = strtolower($matches[1]).$matches[2];

        // Als de variable niet bestaat, return dan null
        if ( !isset($this->$key) )
        {
            return null;
        }

        // Return de waarde
        return $this->$key;
    }

    throw new Exception('Calling undefined function.');
} 

Werkt prima zo, alle variablen die gewoon met een letter beginnen hebben op deze manier een setter en een getter (maak ze wel protected of private). Wil je echt dat een bepaalde variable niet aangesproken kan worden buiten de classe, laat hem dan met een underscore “_” beginnen.

En zoals altijd, comments zijn welkom, scheld me alsjeblieft uit dat ik niet actief op mijn blog ben geweest…

Cheers!

Voorbeeld

Ga er vanuit dat de classe B de bovenstaande functie bevat.

class A extends B
{
    protected $var1;
    protected $test;
    protected $testVar2 = 'hallo';
}

$a = new A();
// Setters
$a->setVar1('test')
  ->setTest('Sup?');

// Getter
echo $a->getTestVar2();

// Nog een Setter
$a->setTestVar2('iets anders');

// Het resultaat
print_r($a);

Onzichtbare getters en setters

Thursday, June 18th, 2009

In een poging de grenzen van php te verkennen, heb ik een methode gevonden om setters en getters “onzichtbaar” te implementeren. Het lijkt in je code net of je de attributen direct aanspreekt, maar in werkelijkheid, kun je er daadwerkelijk validatie aan hangen, iets waar je normaal gesproken een setter of een getter nodig hebt.

Voorbeeld

class Example
{
    // Attribuut
    public $attribute;
    // Setter
    public function setAttribute($value)
    {
        // Validation
        $this->attribute = $value;
    }
}

$example = new Example();

// Direct
$example->attribute = 1;

// Via setter
$example->setAttribute(1);

Waarom?

Goeie vraag, geen idee, zoals ik al zei, ik was de grenzen aan het verkennen, erg nuttig is het dus niet, maar wel interessant :) .

Doel?

Het doel is dus dat je achteraf je validatie / filters op een bepaald attribuut kan toevoegen, zonder dat je daar functies voor aan hoeft te roepen, natuurlijk moet je de setter of de getter wel aanmaken. Om dit te realiseren maak ik gebruik van de magische functies __set en __get, die alleen aangesproken worden wanneer php het betreffende attribuut kan bereiken omdat deze bijvoorbeeld private, protected is of zelfs niet bestaat.

Code!

Hieronder zie je hoe ik de classe geschreven heb.

class AutoGetSet
{
    public function __set($key, $value)
    {
        // De naam van de set methode
        $method = 'set'.ucfirst($key);
        try
        {
            // Roep de functie aan
            call_user_func(
                array($this, $method),
                $value
            );
        }
        catch ( InvalidFunctionException $ex )
        {
            throw new Exception('No setter defined for '.$key.'.');
        }
    }

    public function __get($key)
    {
        // De naam van de set
        $method = 'get'.ucfirst($key);
        try
        {
            // Roep de functie aan en return het resultaat
            return call_user_func(
                array($this, $method)
            );
        }
        catch ( InvalidFunctionException $ex )
        {
            throw new Exception('No setter defined for '.$key.'.');
        }
    }

    // Als er een functie aangeroepen wordt die niet bestaat, gooi dan een Exception.
    public function __call($function, $args)
    {
        throw new InvalidFunctionException('Function '.$function.' does not exist in '.__CLASS__.'.');
    }
}

Om te zorgen dat de set en getters aangesproken worden, moet je het attribuut protected maken.

Conclusie

Het is me dus uiteindelijk gelukt om de setters en getters “onzichtbaar” te maken. Hoewel ik het zelf niet gebruik vond ik het toch wel een geslaagde test.

Nog wat voorbeelden
Zonder setter en getter zal de code er zo uitzien en werkt hij gewoon zoals je van php gewend bent.

class Example
{
    public $attribute;
}

$example = new Example();
$example->attribute = 'Test';
echo $example->attribute;

Vervolgens kun je de setter en de getter toevoegen. Let op het attribuut is protected geworden.

class Example extends AutoGetSet
{
    // Let op protected!
    protected $attribute;

    // Setter
    public function setAttribute($value)
    {
        echo 'SET attribute to '.$value;
        $this->attribute = $value;
    }

    // Getter
    public function getAttribute()
    {
        echo 'GET attribute';
        return $this->attribute;
    }
}

$example = new Example();
$example->attribute = 'Test';
echo $example->attribute;

Als je nu de output bekijkt zul je zien dat de setter en de getter automatisch aangeroepen worden.

Ik ben benieuwd wat vindt jij ervan? Nog leuke ideeen voor situaties waarbij dit bruikbaar is?