sharing knowledge

Posts in category Zend Framework

Using Zend_Reflection to generate API docs

Aug08
2009 Leave a Comment Cesar Miquel Written by Cesar Miquel

Today I needed to generate source code documentation for a webservice APIs we are in coding. One of the guys in the office suggested I take a look at Zend_Reflection. It turns out its quite simple to write PHP code to parse source files and extract the documentation from them. I took a little time to write this sample program.

This program is quite simple: it has a single class called TestClass with one method: addIntegers(). Below this class I wrote a little code which parses the file and then outputs the information. You can use this and a templating system to generate doc. I used it to write the documentation so that we can easily add it to our Wiki.

The script I wrote parses the documentation style used in Zend Framework. Here’s a sample class:

< ?php

/**
 * This is a sample test class.
 *
 * This class has only one method: addIntegers() which adds
 * two integers. Its a sample class for our test.
 *
 */
class TestClass
{
    /**
     * This method adds two integers.
     *
     * This method adds the two given integers and returns
     * its sum. If only one integer is given it sums zero.
     *
     * @param int $number1  The first integer
     * @param int $number2  The second integer
     * @return int The sum of $number1 and $number2.
     *
     */
    public function addIntegers( $number1, $number2 = 0 ) {
         return $number1 + $number2;
    }
}

 

Read the rest of the post to see how to easily parse this code…
Continue reading “Using Zend_Reflection to generate API docs” »

Posted in PHP

Initializing only one module per request in Zend_Framework.

Aug04
2009 1 Comment Written by adji

Zend Framework recently introduced the concept of modules so that your applications become more manegable. The application on startup will load the resources defined in the main application.ini file. To configure each module there is a resource called modules that calls the bootstraping code for each module on every request. If you want to load resources on a per module basis you need to write a bootstrap for each module. This can also generate clashes if two modules try to load the same resource. Additionally this process can have a negative impact on your applications performance.

In this blog I propose a different strategy: I created a controller action plugin that will load resources dynamically using the main bootstraping code. The idea is that after the routes are parsed and before the action is executed this code will load the module’s config file and call the bootstrap again so that it will load the resources defined in this config.

This method has several advantages: only the resources for the module that is being called are loaded. Becuase only one config file is read there is no possiblity of clashes.

Here’s the code:

Continue reading “Initializing only one module per request in Zend_Framework.” »

Optimizar Zend Framework – Cachear paginas

Nov19
2008 Leave a Comment Written by Pablo Morales




El concepto de cachear contenido es simple. Cada vez que generamos una pagina con contenido dinamicamente con PHP, lo que hacemos desde el lado del servidor es procesar los .php, estos generalmente tienen cierta logica, para generar el contenido que vamos a mostrar, como buscar en la base datos, llamar algun webservice, y depende el sistema mas o menos cosas. Con Zend_Cache nos evitamos de estos pasos.

Lo que hacemos con Zend_Cache, es generar el html(xml, json, etc) final, y almacenarlo en el file system. De esta manera cada vez que hagamos llamen a nuestra web vamos a llamar a nuestro html final, y no volver a generar el html que generamos en peticiones anteriores. Esto sirve para web donde el contenido no cambia constantemente.

Por ejemplo si tuvieramos un diario, como www.clarin.com.ar donde acceden millones de personas mensualmente, pero sabemos que el unico momento donde se cambia la portada es cuando aparece una nueva nota, aunque las paginas internas siguen siendo las mismas.

Para este caso es ideal algo como Zend_Cache, podemos Cachear toda portada, y cada una de las paginas internas, si desde la administracion se carga una nueva nota, se borra el cache anterior y se genera uno nuevo muy facilmente.

Pero hasta ahora solo vimos la teoria.

Manos a la obra

Lo primero que tenemos que hacer antes de cachear nuestras paginas es configurar como queremos que funcione Zend_Cache. En este ejemplo le vamos a dar un tiempo de vida determinado, vamos a indicarle donde queremos que almacene las paginas cacheadas, y vamos a decirle que actions y vistas queremos que cachee. Este codigo podemos ponerlo en nuestro bootstrap.

<?php

/**
 * You should avoid putting too many lines before the cache section.
 * For example, for optimal performances, "require_once" or
 * "Zend_Loader::loadClass" should be after the cache section.
 */

$frontendOptions = array(
   ‘lifetime’ => 7200,
   ‘debug_header’ => true, // for debugging
   ‘regexps’ => array(
       // cache the whole IndexController
       ‘^/$’ => array(‘cache’ => true),

       // cache the whole IndexController
       ‘^/index’ => array(‘cache’ => true),

       ‘^/home’ => array(‘cache’ => true),
       // we don’t cache the ArticleController…

       // we don’t cache the ArticleController…
       ‘^/news’ => array(‘cache’ => true),

       // we don’t cache the ArticleController…
       

       // … but we cache the "view" action of this ArticleController
       ‘^/news/list/view’ => array(
           ‘cache’ => true
       )
   ),
   ‘default_options’ => array(
           ‘make_id_with_post_variables’ => true,
           ‘make_id_with_cookie_variables’ => true,
           ‘cache_with_cookie_variables’ => true
    )
   
);

$backendOptions = array(
    ‘cache_dir’ => ‘/tmp/zend_cache’
);

// getting a Zend_Cache_Frontend_Page object
$cache = Zend_Cache::factory(‘Page’,
                             ‘File’,
                             $frontendOptions,
                             $backendOptions);
$cache->start();
?>
 

En este ejemplo estamos cacheando los controller news, home, index. Ademas le indicamos que el directorio para los files es /tmp/zend_cache (hay que crearlo!!)

Los tiempos que se reducen dependen de la cantidad de datos que busquemos en la base de datos, webservice, o que dependa de cierta logica.

Para un blog, o un portal con muchos hits diarios esto es indispensable al menos que tengamos hardware de sobra. En este blog yo uso WP-Cache de Ricardo Galli que hace lo mismo que Zend_Cache.

fuente

Tagged , ,

Optimizar Zend Framework – Metadata de Zend Db Table

Nov17
2008 Leave a Comment Written by Pablo Morales

Cada vez que instanciamos un Zend_Db_Table, ZF hace un describe de la/las tablas que vamos a usar en nuestros query, recolectar esta info consume tiempo y recurso. ZF nos da la posibilidad de Cachear estos datos, usando Zend_Cache. Esto si bien podria estar como default, para reducir bastante los tiempos, no lo esta debido a que si cambiamos el nombre o datos de nuestra tabla, deberiamos limpiar el cache, y para evitar problemas que pueda llegar a generar esto no viene activo por default.

Si queremos hacerlo en nuestro sistema usando Sqllite la forma es muy simple. Basta habilitar sqllite en nuestro php.ini y crear una carpeta para que guarde este cache, podemos elegir la misma ruta que usamos para guardar nuestras paginas con Zend_Cache, todo esto es totalmente personalizable.

El codigo para que guarde la metada lo tenemos que aplicar antes de instanciar cualquier modelo, esto lo podemos hacer desde el bootstrap, pero tambien hay otras formas, cada uno puede implementar la forma que mas le convenga.

Los datos a continuacion tenemos que guardarlos en nuestro archivo de configuracion, yo uso los .ini en el ejemplo
config.ini
[metadata_cache]
frontend.automatic_serialization = true
frontend.lifetime = 3600
; Lugar donde vamos a guardar el cache
backend.cache_db_complete_path= “/tmp/zend_cache_db”

Y este es el codigo que deberia ir en nuestro bootstrap

bootstrap.php

<?php
// ... Configuracion inicial

// ... Ahora configuramos el cache
$cache = Zend_Cache::factory( 'Core', 'Sqlite', metadata_cache->frontend, $config->metadata_cache->backend );
$cache->clean( Zend_Cache::CLEANING_MODE_ALL );
Zend_Db_Table_Abstract::setDefaultMetadataCache( $cache );
?>

Enlaces

Documentacion oficial de Zend_Db_Table
Documentacion de webinar sobre acceso a la base de datos con Zend Db

Tagged , , ,

Executing PL/SQL code in Zend Framework

Oct21
2008 4 Comments Cesar Miquel Written by Cesar Miquel

ZF
In the Oracle world, a lot of the code of an application is stored in procedures inside the database. This gives the best possible performance since the data never leaves the database avoiding data to be sent to and from the client. Code in stored procedures in Oracle is written using the PL/SQL language.

On the other hand, writing web applications is best done in scripting languages like PHP or Python. In addition, it is always recommended to use some type of framework. In PHP you can use CakePHP, Symfony, Codeigniter or, the one we are currently using: Zend Framework.

Calling PL/SQL code from PHP can be tricky sometimes, specially when the PL/SQL procedure has input and output parameters. In this posting I will show you how to call a procedure from the PHP using Zend Framework. I will assume you have some experience using Zend Framework, specially the Database module (Zend_db).

Lets start by creating in the database a simple PL/SQL procedure. Log into sqlplus or sqldeveloper and create the following package and package body:

CREATE OR REPLACE package test_pk AS
  /* Return a greeting message. */
  procedure say_hello(
    name       IN VARCHAR2,
    greeting   OUT NOCOPY VARCHAR2
  );
end test_pk;
/

CREATE OR REPLACE
package body test_pk AS
  /* Return a greeting message. */
  procedure say_hello(
    name       IN VARCHAR2,
    greeting   OUT NOCOPY VARCHAR2)
  IS
    lResult   VARCHAR2(40) := ”;
  begin
    lResult := ‘Hello, ‘ || name;
    greeting := lResult;
  end;
end test_pk;

This code will create a procedure say_hello which receives two parameters: as input, name and an output variable, greeting. The procedure will write in the out parameter ‘Greeting, XXXXX‘ where XXXXX will be replaced by the name input parameter.

Now lets see how we can call the PL/SQL code from PHP. Take a look at the following code:

<?php

  // SQL which will call the PL/SQL code.
  $sql = ‘begin test_pk.say_hello(:p1, :p2); end;’;

  // we create a statement with the DB connection
  // and the SQL code.
  $statement = new Zend_Db_Statement_Oracle( $db, $sql );

  // create output variable. Reserve enough space for answer
  $greeting = sprintf( "%20s", ” );

  // write params (notice the ‘&’!)
  $params = array(
    ‘p1′=> ‘Cesar’,
    ‘p2′=> &$greeting
  );

  // execute the PL/SQL code
  $statement->execute( $params );

  // display results
  var_dump( $params );

To execute the code you need a database connection called $db. When you run this PHP code you will get:

  array(2) {
    ["p1"]=>
      string(5) "Cesar"
    ["p2"]=>
      &string(12) "Hello, Cesar"
  }

It is important to note a couple of things:

  1. In Zend Framework you must use named parameters since positional parameters are not supported when using the Oracle adapter.
  2. You must reserve space for our output. The best way is to create a string with enough blank spaces for the longest possible answer. You will get the following message if its too short: ORA-06502: PL/SQL: numeric or value error: character string buffer too small
  3. When you add output variable you must do so by reference (notice the ‘&’ sign in the $params array).

Hope this helps someone!

Posted in Database, PHP, SQL Developer
Stop SOPA!

SOPA breaks our internet freedom!
Any site can be shut down whether or not we've done anything wrong.

Stop SOPA!