Skip to: categories | main content

Feb 17: Gewinnspiele auf diginights.com

Wie dem ein oder anderen Leser hier sicherlich schon aufgefallen ist, gibt es auf diginights.com seit geraumer Zeit nun eine Gewinnspiel-Section. Die grundlegende Idee dahinter war, dem User mehr Funktionalität auf der Seite zu bieten, was uns mit dieser Idee (denke ich zumindest) auch ziemlich gut gelungen ist. Um automatische Eintragungen zu verhindern wurde ein Captcha-Schutz eingebaut, der nun auf allen anderen Formularseiten Verwendung findet, da es in der Vergangenheit öfters vorkam, dass Spamer die Location-eintragen Seite für ihre Zwecke missbrauchten.

In diesem Beitrag will ich aber ein wenig über die Verlosung schreiben, bzw. die der zu Grunde liegenden Logik.

Es existieren drei von Propel generierte Klassen: LotteryItem enthält die allgemeinen Infos zu einem Gewinnspiel, wie Name und Beschreibung oder das Auslosedatum, in LotteryPrize finden sich die einzelnen Preise, die zu einem Gewinnspiel gewonnen werden können und LotteryParticipant hält die Teilnehmer der jeweiligen Gewinnspiele. Um die Komplexität zu verringern sind die folgenden Codebeispiele auf das Nötigste gekürzt, zudem sind die PHPDoc Kommentare leider auch nicht dabei, da sie von meiner Blogsoftware in strong-Tags umgebaut werden (das muss ich mir nochmal anschauen):

1. Die naive Implementierung:

  1. private function drawSingleLottery(LotteryItem $l) {
  2.   $prizes = $l->getLotteryPrizes();
  3.    
  4.   // TODO: this is pretty slow and should be replaced with a piece of faster code in future
  5.   $participants = $l->getLotteryParticipants();
  6.    
  7.   // determine winner array keys - exactly the amount of available prizes
  8.   $winnersKeys = array_rand($participants, $this->countTotalWinnersForPrizes($prizes));
  9.   if (!is_array($winnersKeys)) {
  10.     $winnersKeys = array($winnersKeys);
  11.   }
  12.   $winners = array();
  13.   $j = 0;
  14.   foreach ($prizes as $prize) { // loop all prizes
  15.     for ($i = 0; $i < $prize->getPrizeAmount(); $i++, $j++) {
  16.       $winner = $participants[$winnersKeys[$j]];
  17.       $winner->setLotteryPrize($prize);
  18.     }
  19.   }
  20.   $l->setIsDrawn(true);
  21.   $l->save();
  22. }


Der Code läuft zwar, ist aber nicht schön: Die Methode LotteryItem::getLotteryParticipants() liefert in einem Array sämtliche Objekte der Personen, die am Gewinnspiel teilgenommen haben. Desto mehr Teilnehmer es werden, desto langsamer wird es, da für jede Zeile des Datenbankresultats ein Objekt gebaut wird und die Instanziierung dessen eine teuere Operation ist.

Über array_rand() werden genausoviele Schlüssel dieses Arrays zurückgegeben wie die in der selben Klasse definierte Methode countTotalWinnersForPrizes() zurückgibt - sie zählt die gesamte Anzahl aller zu vergebenden Preise.
mixed array_rand ( array input [, int num_req] ) gibt ein Array mit den Schlüsseln zurück, wenn der 2. Parameter größer als 1 ist, ansonsten einen Schlüssel, also kein Array (als integer in unserem Falle), was ich an der Methodendefinition nicht besonders schön finde, da dieser Fall hier extra abgefragt werden muss.

Zum Schluss wird über die eigentlichen Preise iteriert, jedem Gewinner einen Preis zugeordnet und das Gewinnspiel gespeichert. Konstrukte wie $participants[$winnersKeys[$j]]; sind unschön weil sie schwer zu lesen sind bzw. es schwer fällt, diese später wieder zu verstehen.

Ein Refactoring muss also her ...


2. Die wesentlich eleganter-/performantere Implementierung:

  1. private function drawSingleLottery(LotteryItem $l) {
  2.   $prizes = $l->getLotteryPrizes();
  3.   $winners = $l->determineWinners();
  4.  
  5.   // set for every winner a prize
  6.   $winner_i = 0;
  7.   foreach ($prizes as $prize) { // loop all prizes
  8.     for ($i = 0; $i < $prize->getPrizeAmount(); $i++) {
  9.       $winner = $winners[$winner_i++];
  10.       $winner->setLotteryPrize($prize);
  11.     }
  12.   }
  13.  
  14.   $l->setIsDrawn(true);
  15.   $l->save();
  16. }


Alles, was im ersten Codefetzen hässlich war ist verschwunden und die neue Methode LotteryItem::determineWinners() erblickt das Licht der Welt - diese scheint wohl direkt die Gewinner anstatt nur deren Keys zurückzuliefern, was nach einem Blick in den Code klar wird:

  1. public function determineWinners() {
  2.   $amount = $this->countTotalWinnersForPrizes($this->getLotteryPrizes());
  3.   return LotteryParticipantPeer::retrieveRandomAmount($this, $amount);
  4. }


Durch das Refactoring hat die countTotalWinnersForPrizes() Methode die Klasse gewechselt, ihr Innenleben bleibt jedoch unverändert.

Abschließend interessiert nur noch die performantere Implementierung von LotteryParticipantPeer::retrieveRandomAmount():

  1. public static function retrieveRandomAmount(LotteryItem $l, $amount) {
  2.   if (!is_numeric($amount) || $amount < 1) throw new Exception('amount should be a positive integer');
  3.  
  4.   $con = sfContext::getInstance()->getDatabaseConnection('propel');
  5.   $sql = 'SELECT '.self::ID.' FROM '.self::TABLE_NAME.' '.
  6.          'WHERE '.self::LOTTERY_ITEM_ID.' = '.$l->getId().' '.
  7.          'ORDER BY RAND() '.
  8.          'LIMIT '.$amount;
  9.   $q = new Query($con, $sql);
  10.  
  11.   return self::retrieveByPKs($q->getCol(), $con);
  12. }


...Diese baut lediglich eine Query von Hand mit dem in der aktuellen Propel-Version noch nicht abbildbaren MySQL-spezifischen ORDER BY RAND(), das zufällig so viele Gewinner-IDs liefert, wie die Funktion als zweiten Parameter übergeben bekommt (MySQL LIMIT). Das Resultat liefert über LotteryParticipantPeer::retrieveByPKs() die gewünschten Objekte als Array zurück.

...So weit also mal ein kleiner Einblick in die Technik, die dahintersteckt - Ich habe euch hoffentlich nicht zu sehr gelangweilt :-D
Geschrieben von Christoph Hautzinger in diginights.com, PHP, Symfony Kommentare: (3) Trackbacks: (0)
« vorherige Seite   (Seite 1 von 1, insgesamt 1 Einträge)   nächste Seite »