Zend Framework Tutorial
Upcoming SlideShare
Loading in...5
×
 

Zend Framework Tutorial

on

  • 12,511 views

Introduction to Zend Framework, covering birds-eye overview of the project, how to download and install it, basic building blocks (autoloading, plugins, and configuration), and creating a sample ...

Introduction to Zend Framework, covering birds-eye overview of the project, how to download and install it, basic building blocks (autoloading, plugins, and configuration), and creating a sample Pastebin application do demonstrate aspects of the ZF MVC layer.

Building the sample application is approximately the final 2 hours of the presentation, and is done as a hands-on tutorial. The sample application will be uploaded elsewhere for review.

Statistics

Views

Total Views
12,511
Views on SlideShare
12,455
Embed Views
56

Actions

Likes
9
Downloads
435
Comments
0

5 Embeds 56

http://www.slideshare.net 43
http://zend-me.overblog.com 5
http://coderwall.com 4
http://www.mefeedia.com 3
http://www.linkedin.com 1

Accessibility

Categories

Upload Details

Uploaded via as OpenOffice

Usage Rights

CC Attribution-NonCommercial-ShareAlike LicenseCC Attribution-NonCommercial-ShareAlike LicenseCC Attribution-NonCommercial-ShareAlike License

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment
  • Note that it actually calls “dispatch()” on the action controller, which then attempts to call the appropriate action method.

Zend Framework Tutorial Zend Framework Tutorial Presentation Transcript

  • Zend Framework Tutorial Matthew Weier O'Phinney Project Lead Zend Framework CodeWorks 2009 28 Sep – 4 Oct 2009 ATL, Miami, DC, NYC
  • About me:
    • ZF Contributor since January 2006
    • Assigned to the ZF team in July 2007
    • Promoted to Software Architect in April 2008
    • Project Lead since April 2009
    Photo © 2009, Chris Shiflett
  • What we'll cover
    • What is Zend Framework?
    • Getting and Installing Zend Framework
    • Utilities and Patterns used throughout ZF
    • Using ZF's MVC layer: Hands-on demonstration: Pastebin
  • What is Zend Framework?
  • Full Stack Framework?
  • Component Library?
  • Both.
  •  
  • Getting and Installing Zend Framework
  • Always found at: http://framework.zend.com /download/latest
  • CDN Links are at top
  • Direct Links are below
    • Use CLI: % tar xzf ZendFramework-1.9.2-minimal.tar.gz % unzip ZendFramework-1.9.2-minimal.zip
    • Or use a GUI file manager
    Unzip/Untar
  • Add to your include_path ; UNIX: "/path1:/path2" include_path = ".:/home/matthew/zf/library"
  • Add to your include_path # Goes in either a <VirtualHost>, # <Directory> or .htaccess: php_value include_path &quot;.:/home/matthew/zf/library&quot;
  • Add to your include_path <?php set_include_path( implode (PATH_SEPARATOR, array ( '.' , '/home/matthew/zf/library' , get_include_path(), )));
  • Utilities and Patterns Used throughout Zend Framework
  • The Autoloader
    • Class names have a 1:1 relationship with the FileSystem: Zend_Db => Zend/Db.php
    • The initial class prefix is called the “vendor” or “namespace” prefix: “Zend_”, “ZendX_”
    • Register either namespace prefixes or actual autoloader callbacks with the ZF autoloader
    Rules
  • Initialize the autoloader require_once 'Zend/Loader/Autoloader.php' ; Zend_Loader_Autoloader::getInstance();
  • Register namespaces $al = Zend_Loader_Autoloader::getInstance(); $al ->registerNamespace( 'Foo_' ); $al ->registerNamespace( array ( 'Foo_' , 'Bar_' ));
  • Register other autoloaders $al = Zend_Loader_Autoloader::getInstance(); $al ->registerNamespace( 'Doctrine' ); $al ->pushAutoloader( array ( 'Doctrine' , 'autoload' ), 'Doctrine_' );
    • Groups of resources with a common vendor prefix/namespace
    • No 1:1 mapping between class name and filename
    • Define arbitrary mappings, or use Zend_Application_Module_Autoloader for use with MVC modules
    Resource Autoloaders
  • Create a resource autoloader // Initialize resource autoloader: $loader = new Zend_Loader_Autoloader_Resource( array ( 'namespace' => 'Foo' , 'basePath' => $path , )); // Map $path/forms/*.php to Foo_Form_*: $loader ->addResourceType( 'form' , 'forms' , 'Form' );
  • Create a module autoloader /* * Maps: * - forms/ -> Foo_Form_* * - models/ -> Foo_Model_* * - models/DbTable -> Foo_Model_DbTable_* * - plugins -> Foo_Plugin_* * - services -> Foo_Service_* * - views/helpers -> Foo_View_Helper_* * - views/filters -> Foo_View_Filter_* */ $loader = new Zend_Application_Module_Autoloader( array ( 'namespace' => 'Foo' , 'basePath' => dirname (__FILE__), ));
  • Plugins
    • For those times when 1:1 doesn't work (e.g., application code)
    • Standard pattern: “all code in this location shares the same class prefix” (aka PrefixPath)
    • Plugin loader is passed a “short name,” and attempts to resolve it to a known PrefixPath
    Rules
  • Example $element ->addPrefixPath( 'Foo_Validate' , // PREFIX 'foo/plugins/validators/' , // PATH 'validate' ); foo/ |-- plugins/ | |-- validators/ | | |-- Even.php | | |-- Dozens.php | | |-- Int.php
  • Invoking plugins $element ->addValidator( 'NotEmpty' ) ->addValidator( 'Int' ) ->addValidator( 'Even' ) ->addValidator( 'Dozens' ); New, custom validators Custom validator overriding existing validator
  • Zend_Config
    • Zend Framework is configurationless, but often your applications are not
    • Many common configuration formats: XML, INI, PHP
    • Access to configuration values should not vary between backends
    • Configuration inheritance is useful
    Why Zend_Config?
  • Sample INI config [production] app.name = &quot;Foo!&quot; db.adapter = &quot;Pdo_Mysql&quot; db.params.username = &quot;foo&quot; db.params.password = &quot;bar&quot; db.params.dbname = &quot;foodb&quot; db.params.host = &quot;127.0.0.1&quot; [testing : production] db.adapter = &quot;Pdo_Sqlite&quot; db.params.dbname = APPLICATION_PATH &quot;/data/test.db&quot;
  • Sample XML config <?xml version = &quot;1.0&quot; ?> <config> <production> <app><name> Foo! </name></app> <db> <adapter> Pdo_Mysql </adapter> <params username = &quot;foo&quot; password = &quot;bar&quot; dbname = &quot;foodb&quot; host = &quot;127.0.0.1&quot; /> </db> </production> <testing extends = &quot;production&quot; > <db> <adapter> Pdo_Sqlite </adapter> <params dbname = &quot;/data/test.db&quot; /> </db> </testing> </config>
  • Sample PHP config $production = include 'production.conf.php' ; $config = array ( 'db' => array ( 'adapter' => 'Pdo_Sqlite' , 'params' => array ( 'dbname' => APP_PATH . '/../data/test.db' , ), ) ); $config = $production + $config ; return $config ;
  • Instantiating a Config object // Load 'testing' section of INI configuration: $config = new Zend_Config_Ini( $fileName , 'testing' ); // Load 'testing' section of XML configuration: $config = new Zend_Config_Xml( $fileName , 'testing' ); // Load 'testing' configuration via PHP array: $config = include 'testing.conf.php' ; $config = new Zend_Config( $config );
  • Using Config objects // Multiple levels: $appName = $config ->app->name; // Using config object as argument $db = Zend_Db::factory( $config ->db);
  • Using Zend Framework's MVC Layer
    • Learn how to create a new ZF MVC project
    • Learn how to use various MVC components:
      • Zend_Application, Zend_Controller_Front, Zend_Controller_Action, Zend_Controller_Router, Zend_Db_Table, Zend_View, Action Helpers, View Helpers, Zend_Form, Zend_Layout, etc.
    • Learn concepts related to separation of concerns
    Goals
    • Create “pastes” with optional expiry; allow listing pastes by username
    • Single table is ideal for demonstrating simple component interactions
    • Ask questions as you have them!
    The Application: Pastebin
    • A Paste consists of:
      • code: content (required)
      • summary: (optional)
      • code_type: content type (required, default to plain text)
      • username: (optional)
      • timestamp: (required; created on commit)
      • expiry: (optional)
      • identifier: (required; a unique hash)
    Pastebin Specification
    • Each paste will have a unique URL
    • Pastes may optionally expire, in which case they won't be displayed
    • Pastes may be listed by username
    Pastebin Specification
  • Step 1: Create the project
    • In bin/zf.sh or bin/zf.bat of your ZF install (choose based on your OS)
    • Place bin/ in your path, or create an alias on your path: alias zf=/path/to/bin/zf.sh
    • Or use pear.zfcampus.org PEAR channel
    Locate the zf utility
  • Create the project # Unix: % zf.sh create project quickstart # DOS/Windows: C:> zf.bat create project quickstart
  • Add ZF to the project # Symlink: % cd library; ln -s path/to/ZendFramework/library/Zend . # Copy: % cd library; cp -r path/to/ZendFramework/library/Zend .
  • Create a vhost <VirtualHost *: 80 > ServerAdmin you@atyour.tld DocumentRoot /abs/path/to/quickstart/public ServerName quickstart <Directory /abs/path/to/quickstart/public > DirectoryIndex index.php AllowOverride All Order allow,deny Allow from all </Directory> </VirtualHost>
  • Add a hosts entry 127.0.0.1 quickstart
  • Fire up your browser!
  • Looking under the hood
  • The directory tree quickstart |-- application | |-- Bootstrap.php | |-- configs | | `-- application.ini | |-- controllers | | |-- ErrorController.php | | ` -- IndexController.php | |-- models | `-- views | |-- helpers | ` -- scripts | |-- error | | `-- error.phtml | ` -- index | `-- index.phtml |-- library |-- public | ` -- index.php `-- tests |-- application | ` -- bootstrap.php |-- library | `-- bootstrap.php ` -- phpunit.xml 14 directories, 10 files
  • The bootstrap <?php class Bootstrap extends Zend_Application_Bootstrap_Bootstrap { }
  • Configuration [production] phpSettings.display_startup_errors = 0 phpSettings.display_errors = 0 includePaths.library = APPLICATION_PATH &quot;/../library&quot; bootstrap.path = APPLICATION_PATH &quot;/Bootstrap.php&quot; bootstrap.class = &quot;Bootstrap&quot; resources.frontController.controllerDirectory = APPLICATION_PATH &quot;/controllers&quot; [staging : production] [testing : production] phpSettings.display_startup_errors = 1 phpSettings.display_errors = 1 [development : production] phpSettings.display_startup_errors = 1 phpSettings.display_errors = 1
  • Index (default) controller <?php class IndexController extends Zend_Controller_Action { public function init() { /* Initialize action controller here */ } public function indexAction() { // action body } }
  • Error controller class ErrorController extends Zend_Controller_Action { public function errorAction() { $errors = $this ->_getParam( 'error_handler' ); switch ( $errors ->type) { case 'EXCEPTION_NO_CONTROLLER': case 'EXCEPTION_NO_ACTION': // 404 error -- controller or action not found $this ->getResponse()->setHttpResponseCode( 404 ); $this ->view->message = 'Page not found' ; break ; default: // application error $this ->getResponse()->setHttpResponseCode( 500 ); $this ->view->message = 'Application error' ; break ; } $this ->view->exception = $errors ->exception; $this ->view->request = $errors ->request; } }
  • Index view (home page) <center> <div id = &quot;welcome&quot; > <h1> Welcome to the Zend Framework! </h1> <h3> This is your project's main page </h3> <!-- and a little bit more markup --> </div> </center>
  • Error view <h1>An error occurred</h1> <h2><?php echo $this ->message ?></h2> <?php if ( 'development' == APPLICATION_ENV): ?> <h3>Exception information:</h3> <p> <b>Message:</b> <?php echo $this ->exception->getMessage() ?> </p> <h3>Stack trace:</h3> <pre> <?php echo $this ->exception->getTraceAsString() ?> </pre> <h3>Request Parameters:</h3> <pre> <?php var_dump ( $this ->request->getParams()) ?> </pre> <?php endif ?>
  • .htaccess file SetEnv APPLICATION_ENV development RewriteEngine On RewriteCond %{REQUEST_FILENAME} -s [OR] RewriteCond %{REQUEST_FILENAME} -l [OR] RewriteCond %{REQUEST_FILENAME} -d RewriteRule ^.*$ - [NC,L] RewriteRule ^.*$ index.php [NC,L]
  • index.php (environment) <?php // Define path to application directory defined ( 'APPLICATION_PATH' ) || define ( 'APPLICATION_PATH' , realpath ( dirname (__FILE__) . '/../application' )); // Define application environment defined ( 'APPLICATION_ENV' ) || define ( 'APPLICATION_ENV' , ( getenv ( 'APPLICATION_ENV' ) ? getenv ( 'APPLICATION_ENV' ) : 'production' )); // Ensure library/ is on include_path set_include_path( implode (PATH_SEPARATOR, array ( realpath (APPLICATION_PATH . '/../library' ), get_include_path(), )));
  • index.php (application) /** Zend_Application */ require_once 'Zend/Application.php' ; // Create application, bootstrap, and run $application = new Zend_Application( APPLICATION_ENV, APPLICATION_PATH . '/configs/application.ini' ); $application ->bootstrap() ->run();
  • Step 2: Create the model
  • Step 3: Create a form
  • Step 4: Create a controller
  • Step 5: Create new routes
  • Step 6: Create controller actions
  • Step 7: Create views
  • Step 8: Create a layout
  • Step 9: Update the default view
  • Step 10: Check it out!
  • Further Steps
    • Add Dojo handling for code highlighting
    • Add CSS for forms
    • Add CSS for errors
    • Add some layout specific styling and/or use dojo containers to improve layout
    • Add Navigation elements to provide a menu/breadcrumbs
    • Add caching (pastes may not be updated; cache forever)
    Make it prettier
  • Summary or, “The fat guy sings”
    • What Zend Framework is
    • Some common utilities/patterns used (autoloading, plugins, configuration)
    • How to build a ZF MVC application
    We looked at:
  • Questions? or, “Your turn!”
  • Thank you. http://framework.zend.com/ http://twitter.com/weierophinney http://slideshare.net/weierophinney Feedback? http://joind.in/talk/view/864