Znalazcy chciałbym jeszcze raz bardzo podziękować: dziękuję!

class Pager
{
  private
    $page = 1,
    $per_page = 10;

  public function calculate()
  {
    return $this->page * $this->per_page - $this-per_page + 1;
  }
}

Jedna mała pomyłka. Zamiast

$this->per_page

do kodu wkradło się:

$this-per_page

Co to zmienia? Na pierwszy rzut oka parser PHP powinien poinformować o błędzie… jednak linia kodu zawierająca błąd interpretowana jest następująco:

$this->page // 1

$this->per_page // 10

$this  // rzutowane na int to 1, bo obiekt istnieje

per_page // jako stała niezdefiniowana to 0

Wykonywane działanie matematyczne wygląda zatem następująco:

1 * 10 - 1 - 0 + 1

Wynik działania to o dziwo 10… Dlatego kocham PHP!

  public function addToCache($page_url, $image_url)
  {
    Debug::Log("Adding to cache");
    $this->cache[$page_url] = $image_url;
  }

  public function loadCache()
  {
    Debug::Log('Reading cache');
    if (file_exists("cache.csv"))
    {
      $fh = fopen("cache.csv", "r");
      while (($data = fgetcsv($fh, 1000, ",")) !== FALSE)
      {
        $this->cache[$data[0]] = $data[1];
      }
      fclose($fh);
      return $this->cache;
    }
  }

  public function saveCache()
  {
    Debug::Log("Saving cache");
    $fh = fopen('cache.csv', 'w');
    foreach ($this->cache as $page_url=>$image_url)
    {
      fputcsv($fh, array($page_url, $image_url));
    }
    fclose($fh);
  }

  public function isCached($page_url)
  {
    Debug::Log("Checking cache");
    if (empty($this->cache))
    {
      $this->loadCache();
    }
    if (isset($this->cache[$page_url]))
    {
      Debug::Log("Found in cache");
      return $this->cache[$page_url];
    }
    Debug::Log("Not found in cache");
    return false;
  }

oraz użyć ich w odpowiedni sposób. Cały plik wygląda następująco:

url = $url;
  }

  /*
   *  Read remote rss file
   */
  public function getOrginalContent()
  {
    if (is_null($this->url))
    {
      throw new FeedException("You have to set url first!");
    }

    $this->orginalContent = Remote::get_remote_file_content($this->url);
    return $this->orginalContent;
  }

  /*
   * Create a DOMDocument from rss.xml file
   */
  public function getDomOrginalContent()
  {
    if (false === $this->orginalContent || is_null($this->orginalContent))
    {
      throw new FeedException("Can not download rss file");
    }

    $domDocument = new DOMDocument();
    $domDocument->loadXML($this->orginalContent);
    return $domDocument;
  }

  public function addToCache($page_url, $image_url)
  {
    Debug::Log("Adding to cache");
    $this->cache[$page_url] = $image_url;
  }

  public function loadCache()
  {
    Debug::Log('Reading cache');
    if (file_exists("cache.csv"))
    {
      $fh = fopen("cache.csv", "r");
      while (($data = fgetcsv($fh, 1000, ",")) !== FALSE)
      {
        $this->cache[$data[0]] = $data[1];
      }
      fclose($fh);
      return $this->cache;
    }
  }

  public function saveCache()
  {
    Debug::Log("Saving cache");
    $fh = fopen('cache.csv', 'w');
    foreach ($this->cache as $page_url=>$image_url)
    {
      fputcsv($fh, array($page_url, $image_url));
    }
    fclose($fh);
  }

  public function isCached($page_url)
  {
    Debug::Log("Checking cache");
    if (empty($this->cache))
    {
      $this->loadCache();
    }
    if (isset($this->cache[$page_url]))
    {
      Debug::Log("Found in cache");
      return $this->cache[$page_url];
    }
    Debug::Log("Not found in cache");
    return false;
  }
  /*
   * Get image URL from remote webpage
   */
  public function getImage($item)
  {
    if ('link' == $item->nodeName)
    {
      if ($cache = $this->isCached($item->nodeValue))
      {
        return $cache;
      }
      $htmlContent = Remote::get_remote_file_content($item->nodeValue);
      if (false !== $htmlContent)
      {
        //Search image tag
        $pattern = "/bigurl=\".*\"/";
        preg_match($pattern, $htmlContent, $urls);

        //Finally url to the image
        $url = substr($urls[0], 8, -1);
        $this->addToCache($item->nodeValue, $url);
        return $url;
      }
      return 'http://demotywatory.pl/res/img/demotywatory-logo.gif';
    }
  }

  /*
   * Set new description for current item
   */
  public function setImage($item)
  {
    //Find element link
    foreach ($item->childNodes as $rssDomItemChild)
    {
      if ('link' == $rssDomItemChild->nodeName)
      {
        //Download demot page
        $url = $this->getImage($rssDomItemChild);
        break;
      }
    }

    //Find element description
    foreach ($item->childNodes as $rssDomItemChild)
    {
      if ('description' == $rssDomItemChild->nodeName)
      {
        $rssDomItemChild->nodeValue = '<img src="'.$url.'">';
        break;
      }
    }
    Debug::Log('Found url: ['.$url.']');
  }

  /*
   * Convert rss.xml to rss.xml with images in description
   */
  public function transform()
  {
    //Get DOMDocument
    $this->transformedDom = $this->getDomOrginalContent();
    //Find all items
    $rssItems = $this->transformedDom->getElementsByTagName('item');

    //Foreach feed
    Debug::Log('Starting retriving feeds');

    foreach ($rssItems as $rssItem)
    {
      //Set image in description for node
      $this->setImage($rssItem);
    }
    Debug::Log('Finished retriving feeds!');
  }

  /*
   * Get transformed XML
   */
  public function getResults()
  {
    return $this->transformedDom->saveXml();
  }

  /*
   * Save results to file (xml)
   */
  public function save($filename)
  {
    Debug::Log('Saving file ('.$filename.')');
    $fh = fopen($filename, 'w');
    if (!$fh)
    {
      throw new FeedException('Can not open file ('.$filename.') to write!');
    }
    fwrite($fh, $this->getResults());
    fclose($fh);
  }
}

Należy jeszcze zmienić skrypt wywołujący, czyli index.php:

setUrl('http://demotywatory.pl/rss.xml');
//Get rss file content
$feed->getOrginalContent();
//Convert to new format
$feed->transform();
//Save to file
$feed->save('result.xml');
$feed->saveCache();

I to wszystko. Teraz skrypt pobierze informacje jedynie o nowych rssach. Informacje które już posiada w razie potrzeby zostaną użyte ponownie.
Efekt działania można zobaczyć na http://drymek.hostei.com/.
Gotowy do użycia plik rss znajduje się tutaj: http://feeds.feedburner.com/demotywatorator?format=xml

Zestaw wszystkich plików do ściagnięcia: Demotywatorator2

1. Remote.php
2. FeedException.php
3. Debug.php
4. Feed.php
5. index.php

Pierwszy z nich, rozbudowany aż nadto co powinien być, jednak faza testowania wymagała porównania prędkości działania kilku rozwiązań. Curl został domyślnym, ze względu na jego szybkość i niezawodność.

<?php

/*
 * Read remote file with some methods
 *
 * @author drymek
 *
 */
class Remote
{
  /*
   * Read file with default method
   */
  public static function get_remote_file_content($url)
  {
    return self::get_with_curl($url);
  }

  /*
   * Curl - default method for Remote
   */
  public function get_with_curl($url)
  {
    // create a new cURL resource
    $ch = curl_init();

    // set URL and other appropriate options
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HEADER, 0);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    // grab URL and pass it to the browser
    $content = curl_exec($ch);

    // close cURL resource, and free up system resources
    curl_close($ch);
    return $content;
  }

  /*
   * file_get_contents use buildin PHP function
   */
  public function get_with_file_get_contents($url)
  {
    return file_get_contents($url);
  }

  /*
   * fopen and fgets functions to read file
   */
  public function get_with_fopen($url)
  {
    $fh = fopen($url, 'rb');
    if (!$fh)
    {
      return '';
    }

    $content = '';
    while (!feof($fh))
    {
      $content .= fgets($fh, 1024);
    }
    fclose($fh);
    return $content;
  }
}

Drugi z plików zapewnia jedynie możliwość wyrzucania wyjątków z klasy Feed.

<?php
/*
 * Feed Exception class
 *
 * @author drymek
 *
 */
class FeedException extends Exception
{
}

Klasa Debug umożliwia wypisywanie informacji kontrolnych podczas pisania kodu:

<?php
/*
 * Simple debug class
 *
 * @author drymek
 *
 */
class Debug
{
  /*
   * Print debug message on default output
   */
  public static function Log($message)
  {
    //Check debug mode
    if (DEBUG)
    {
      echo $message."\n";
    }
  }
}

Klasa Feed! Czyli mięso właściwe. To co pobiera wszystkie informacje, przetwarza je i zapisuje:

<?php
require_once 'Remote.php';        //Read remote files
require_once 'FeedException.php'; //Implementation of Feed Exception
require_once 'Debug.php';         //Debug message

/*
 * Class to convert demotywatory.pl rss
 *
 * @author drymek
 *
 */
class Feed
{
  private
    $url,             //rss.xml file url
    $orginalContent,  //rss.xml file content
    $transformedDom;  //rss.xml file DOMDocument

  /*
   * Set feed url
   */
  public function setUrl($url)
  {
    $this->url = $url;
  }

  /*
   *  Read remote rss file
   */
  public function getOrginalContent()
  {
    if (is_null($this->url))
    {
      throw new FeedException("You have to set url first!");
    }

    $this->orginalContent = Remote::get_remote_file_content($this->url);
    return $this->orginalContent;
  }

  /*
   * Create a DOMDocument from rss.xml file
   */
  public function getDomOrginalContent()
  {
    if (false === $this->orginalContent || is_null($this->orginalContent))
    {
      throw new FeedException("Can not download rss file");
    }

    $domDocument = new DOMDocument();
    $domDocument->loadXML($this->orginalContent);
    return $domDocument;
  }

  /*
   * Get image URL from remote webpage
   */
  public function getImage($item)
  {
    if ('link' == $item->nodeName)
    {
      $htmlContent = Remote::get_remote_file_content($item->nodeValue);
      if (false !== $htmlContent)
      {
        //Search image tag
        $pattern = "/bigurl=\".*\"/";
        preg_match($pattern, $htmlContent, $urls);

        //Finally url to the image
        return substr($urls[0], 8, -1);
      }
      return 'http://demotywatory.pl/res/img/demotywatory-logo.gif';
    }
  }

  /*
   * Set new description for current item
   */
  public function setImage($item)
  {
    //Find element link
    foreach ($item->childNodes as $rssDomItemChild)
    {
      if ('link' == $rssDomItemChild->nodeName)
      {
        //Download demot page
        $url = $this->getImage($rssDomItemChild);
        break;
      }
    }

    //Find element description
    foreach ($item->childNodes as $rssDomItemChild)
    {
      if ('description' == $rssDomItemChild->nodeName)
      {
        $rssDomItemChild->nodeValue = '<img src="'.$url.'">';
        break;
      }
    }
    Debug::Log('Found url: ['.$url.']');
  }

  /*
   * Convert rss.xml to rss.xml with images in description
   */
  public function transform()
  {
    //Get DOMDocument
    $this->transformedDom = $this->getDomOrginalContent();
    //Find all items
    $rssItems = $this->transformedDom->getElementsByTagName('item');

    //Foreach feed
    Debug::Log('Starting retriving feeds');

    foreach ($rssItems as $rssItem)
    {
      //Set image in description for node
      $this->setImage($rssItem);
    }
    Debug::Log('Finished retriving feeds!');
  }

  /*
   * Get transformed XML
   */
  public function getResults()
  {
    return $this->transformedDom->saveXml();
  }

  /*
   * Save results to file (xml)
   */
  public function save($filename)
  {
    Debug::Log('Saving file ('.$filename.')');
    $fh = fopen($filename, 'w');
    if (!$fh)
    {
      throw new FeedException('Can not open file ('.$filename.') to write!');
    }
    fwrite($fh, $this->getResults());
    fclose($fh);
  }
}

I ostatni z plików który wszystko uruchamia:

<?php
define('DEBUG', true);    //Set debug on
require_once 'Feed.php';  //Include Feed class

//Create new Feed instance
$feed = new Feed();
//Set feed url
$feed->setUrl('http://demotywatory.pl/rss.xml');
//Get rss file content
$feed->getOrginalContent();
//Convert to new format
$feed->transform();
//Save to file
$feed->save('result.xml');

Teraz wystarczy umieścić pliki na serwerze lub jeśli takiego nie posiadamy to można skorzytać np. z hostei.com (webhosting umożliwiający otwieranie plikow curl/fopen).
I magia! Mamy rss z obrazkami demotywatorów w wiadomości! (Należy oczywiście odświeżać co jakiś czas nasze domotywatory, jednak użycie crona i wgeta w tej sytuacji jest w 100% wystarczające

Demotywatorator

« Druga część.

Jednak tak ogromne narzędzie ma jedną sporą wadę – trzeba mu poświęcić mu trochę czasu zanim stanie się ono użyteczne. W pierwszej kolejności po narysowaniu poprawnego diagramu klas chciałem wygenerować diagram DDL. Co z tego wszystkiego wynikło opisuję poniżej.

Opis zawiera uniwersalny sposób generacji DDL, jednak znacząco jest ukierunkowany na zgodność z symfony (zgodność nazw atrybutów, klas modelu itp.)

1. Utworzyłem nowy projekt:
   Klikając kolejno: File > New project wpisując nazwę pod którą będę trzymać plik projektu (wszystkie informacje zawarte są w pojedynczym pliku) kontynuowałem przyciskiem Zapisz.
2. Moim oczom ukazało się okno w którym mogę wybrać rodzaj diagramu który automatycznie chciałbym dołączyć do projektu. Zaznaczam jedynie Class, bo o eksporcie tego diagramy jest ten artykuł.



3. Po zatwierdzeniu modelu w przeglądarce projektu (Project Browser) ukazał się pakiet (package) o nazwie Class Model, a w nim przykładowy model klas. Usunąłem z niego zarówno folder Systems jak i Frameworks oraz zawartość diagramu. Teraz mogę przystąpić do właściwego projektowania diagramu klas. Metodą przeciągnij i upuść z okna narzędzi (Tools) przeciągnąłem interesujące nas elementy diagramu. Ja w przykładzie wykorzystałem taki diagram:



4. Teraz pora na transformacje na DDL. W przeglądarce projektu klikając na pakiet prawym klawiszem myszy mam dostępną opcję transformacji aktualnego pakietu (Transform Current Package). Zaznaczając wszystkie dostępne elementy oraz transformację DDL (określając docelowe miejsce położenia) korzystam z przycisku „Do Transform”. Po kilu sekundach został utworzony pakiet DDL wraz z jego diagramem.



5. W zasadzie w tym momencie mogłbym wygenerować z diagramu plik SQL gotowy do użycia w bazie danych, gdyby nie jedna niezgodność. Zauważmy, że utworzone klucze główne oraz obce są w formacie {nazwa}ID (kategoriaID, artykulID). Symfony posiada inną konwencję ({nazwa}_id). Aby poprawnie skonfigurować nazewnictwo skorzystałem z edycji szablonów transformacji.
6. Wybierając Setting > Transformation Templates otworzyłem edytor szablonów



7. Aby skonfigurować poprawnie nazwy identifikatorów tabel oraz nazwy kluczy obcych należy wyedytowałem dwa szablony: Class oraz Connector. Odnajdując linię:

   name=%qt%%CONVERT_NAME(className, "Pascal Case","Camel Case")%ID%qt%

   zmieniłem ją na następującą:

   name=%qt%%CONVERT_NAME(className, "Pascal Case","Underscored")%_id%qt%

   Zostaje do wprowadzenia w szablonie Connector dziesięć analogicznych zmian.

8. Po wykonaniu wszystkich zmian, ponownie przegenerowałem diagram DDL (jak w punkcie 4). W wyniku czego otrzymałem diagram zgodny z konwencjami symfony (wcześniej należy usunąć poprzedni diagram DDL w celu wygenerowania nowych, poprawnych nazw kluczy obcych:



9. Nareszcie to czego oczekiwałem od samego początku! Pozostaje skorzystać z Project > Database Engineering > Generate Package DDL, w którym zaznaczając Generate Primary/Foreign Key Constrains oraz określając plik wynikowy File Generation > Single File generuje za pomocą Generate plik sql. W tym momencie mam gotowy skrypt SQL do wczytania do bazy danych.
10. Co jednak jeśli nie chcielibyśmy tych wszystkich kroków wykonywać na każdej stacji klienckiej z Enterprise Architectem lub po prostu podzielić się ze znajomym wykonaną pracą? Nic prostrzego. Korzystając z Tools > Export Reference Data możemy zaznaczyć interesujący nas DDL_Transform_Template i wyeksportować go do pliku xml. Taki plik możemy wczytać w dowolnym momencie do każdej stacji klienckiej korzystając z Tools > Import Reference Data

Na pierwszy ogień testów poszedł phpCodeBeautifier. Szybko jednak okazało się, że klamra otwierająca zawartość klasy musi znajdować się w tej samej linii co jej deklaracja. Istnieje opcja:

--space-before-start-angle-bracket

która pozwala wymusić jeden znak spacji przed „{„. Czemu autorzy nie pomyśleli o

--newline-before-start-angle-bracket

? Cieżko powiedzieć. Kod jest zamknięty, więc się tego nie dopisze samemu.

Istnieje jednak PHP_CodeSniffer (phpcs), który połączony z odpowiednim standardem sprawdzi składnie pliku.

Zainstalujmy „to” wszystko… Na początek instalacja samego phpcs:

apt-get install php-codesniffer

Aby aplikacja mogła sprawdzać formatowanie zgodne z symfony należy jeszcze doinstalować standard symfony. Można go znaleźć w repozytorium svn pod adresem http://subversion.assembla.com/svn/phpsymfony/Symfony%20Code%20sniffer%20standards/Symfony/.

 cd /usr/share/php/PHP/CodeSniffer/Standards && sudo svn co http://subversion.assembla.com/svn/phpsymfony/Symfony%20Code%20sniffer%20standards/ .

Do przetestowania programu stwórzymy plik:

vim ~/test.php

z odpowiednią zawartością:

<?php
class TestKlasa
{
  public function testFunction()
  {
  }
}

Uf, nareszcie możemy sprawdzić czy nasz kod jest poprawny:

phpcs --standard=Symfony ~/test.php

W wyniku czego otrzymamy:

FILE: ~/test.php
--------------------------------------------------------------------------------
FOUND 3 ERROR(S) AND 0 WARNING(S) AFFECTING 2 LINE(S)
--------------------------------------------------------------------------------
2 | ERROR | Missing file doc comment
2 | ERROR | Missing class doc comment
4 | ERROR | Missing function doc comment
--------------------------------------------------------------------------------

Działa! To znaczy są błędy, ale o to właśnie nam chodziło – aby je wykrywać. Poprawmy więc zawartość pliku:

<?php
/**
* Test file for PHP_CodeSniffer
*
* PHP versions 4 and 5
*
* @category Tests
* @package  XX
* @author   Marcin Dryka <marcin.dryka@xsolve.pl>
* @license  http://www.opensource.org/licenses/lgpl-license.php LGPL
* @version  SVN: 1
* @filesource
*/

/**
* TestKlasa
*
* @package XX
* @author  Marcin Dryka <marcin.dryka@xsolve.pl>
* @version Release: 1
*/
class TestKlasa
{
  /**
  * testFunction
  *
  * @author Marcin Dryka <marcin.dryka@xsolve.pl>
  * @access public
  * @return void
  */
  public function testFunction()
  {
  }
}

Przy tak wyglądającym pliku wynik działania phpcs jest pusty, brak błędów oznacza poprawnie sformatowany plik. Teraz potrzebna jest tylko silna wola, aby używać skryptu do sprawdzania wszystkich plików. Przy starszych aplikacjach będzie to dość kłopotliwe. Zdarzają się jednak pliki pisane od tak zwanego zera. Gdzie możemy w pełni stosować konwencje ustalone przez autorów symfony (i nie tylko).