ZEND FRAMEWORK Advanced Training

ZEND FRAMEWORK Advanced Training

http://kb.vteamslabs.com 1

By: Raza Mehdi

Topics Covered in Previous Session• What is Zend Framework?• What is Model-View-Controller Pattern?• Coding Guidelines for Zend Framework.• Difference between Zend Framework versions.• Development of a simple Application using Zend Framework

to showcase its various features.

2http://kb.vteamslabs.com

TOPICS FOR SESSION

• Themes using Zend_Layout & Zend_View• Zend_Pagination• Managing Table Relationships using Zend_Db• Handling Security in Zend Framework.• Site Search Using Zend_Search_Lucene.• Modules in Zend Framework.


THEMES Using Zend_Layout & Zend_View


1. Layout & Views Folders


2. Changed Layout & Views Folders for Themes


3. Change Bootstrap.php to load Themes


• Add a constructor function to load theme of choice:

3. Change Bootstrap.php to load Themes (cont ..)


• Add a _initLayout function to load layout files of selected theme:

3. Change Bootstrap.php to load Themes (cont ..)


• Add a _initView function to load view files of selected theme:

4. Create Theme Configuration File


• The template.xml in each theme folder may hold theme config information as well as theme’s CSS & JS filenames. For example:

5. Create View Helper To Load Theme Config

Create a file called LoadTemplate.php in application/views/helpers folder to load

information from template.xml.


5.1 Loading Theme Config Data


5.2 Saving Configuration Data


• Next we will save the retrieved configuration data as array.

5.3 Adding Configuration Data To Layout


• Finally we will add the items to the Layout.


6. Update Layout Files


USING Zend_Paginator to paginate records


1. Update Model’s method to return Zend_Paginator object


2. Update Controller’s method which lists records


3. Update View File


4. Creating Paginator Template


• Create a new folder named partials in application/views/scripts.

• Now create a file pagination-control.phtml.• Put in the following code in the file

4.1 Adding Request Parameters to URL


4.2 Adding Previous Page Control to Paginator


4.3 Adding Total Pages List to Paginator


4.4 Adding Next Page Control to Paginator




Managing table relationships using Zend_Db


1. Defining Relationship Between Database Tables• In this case, we will take example of a simple CMS.

– Have two tables page & node.– A page can have multiple nodes. – A Page can be parent to another page.


2. Creating Models for Tables


3. Defining Relationships for Models


• Since pages table has a One-to-many Relationship with the content_nodes table, we need to do the following:

– Model_Page: Tell Zend_Db_Table that the pages table is dependent on the content_nodes table.

– Model_ContentNode: Tell Zend_Db_Table that the content_nodes table is related to the pages table, by doing the following:• Setting the related columns. • Adding reference table class (Model_Page). • Setting the referenced table columns.

4. ContentNode to Page Relationship


• Add the following code to the application/models/ContentNode.php:

5. Page to Page Relationship


• Add the following code to the application/models/Page.php:

6. Fetching Dependent Rows


7. Fetching Parent Rows


HANDLING SECURITY IN ZEND FRAMEWORK


• Security in Zend Framework is done through:– Zend_Auth solely concerned with authenticating

(and persisting) the application users.

– Zend_Acl handles resources, roles (user roles), and which roles can access which resources.


1. Managing Users• Normally we have two user types in a CMS:

– Users: These are registered users who don’t have admin privileges.

– Administrators: These are the site managers who can access any area of the CMS.

Fields for Users Table:• `id`• `username`• `password`• `first_name` • `last_name` • `role`


2. Creating User Model Class


User Authentication using Zend_Auth


LIST OF AVAILABLE ZEND_AUTH ADAPTERS• Some of the common Zend_Auth adapters are:

– Database table authentication.– Digest authentication.– LDAP authentication.– Open ID.

Here, we will use Zend_Auth_Adapter_DbTable.


SAMPLE USAGE OF Zend_Auth


CREATING THE USER LOGIN


1. Adding the Login Form to Controller


2. Adding the Login Form to View


3. Adding User Authentication

First validate the form. If valid, then get the posted data:


3. Adding User Authentication (continued …)

• Creating Zend_Auth Adapter.• Pass the username & password.• Do the authentication.


3. Adding User Authentication (continued …)

• Get the Zend_Auth authentication data.– Store the valid Zend_Auth data in storage (PHP session).

Then redirect the user to some page.– Show error message in case of invalid result.



LOGOUT FOR AUTHENTICATED USERS



Controlling Access using Zend_Acl


SAMPLE USAGE OF Zend_Acl


SECURING RESOURCES USING ZEND_ACL


1. Creating a Controller Plugin• Create a folder CMS in application/library.• Create a folder Controller in CMS folder.• Create another folder Plugin in the Controller folder.• Create a file Acl.php in the Plugin folder.


2. Creating ACL Instance, roles & resourcesCreating a Zend_Acl instance, and then adding relevant roles & resources:


3. Access Rules for Roles & Resources


4. Authenticating User Requests



5. Registering Plugin for Controller

Open the application/configs/application.ini, and add the following lines:

resources.frontController.plugins.acl = "CMS_Controller_Plugin_Acl"


6. Adding Unauthorized Access Landing Page• Add the noauth action to the

application/controller/ErrorController.php file, and the add the following code to its relevant view file:


Site Search using Zend_Search_Lucene


What Is Zend_Search_Lucene?• Zend_Search_Lucene provides a very straightforward

way to build and search indexes of content. Through this, you can do the following:

– Create Search Indexes.– Add Documents for searching content.– Create fields to add to documents for search.


IMPLEMENTING SEARCH


1. Adding the Search Controller

• Create a file SearchController.php in the applications/controllers file.

• Add the following methods to the file, and create the relevant view files in the application/views/scripts/search folder:– indexAction()– buildAction()– searchAction()


2. Securing the Search Functionality

• Add the following code to Acl.php in the application/library/CMS/Controller/Plugin folder:


3. Create the folder to store search indexes

Create a folder indexes in the application folder


4. BUILDING THE SEARCH INDEX


4.1 Create search index & fetch all records

Add the following code to buildAction method for SearchController.php file.


4.2 Create search document for every record


4.3 Optimizing the index & displaying indexing results


4.4 Updating Search index view file


5. SEARCHING THE SITE


5.1 Creating the Search Form Create a file Search.php in the application/forms folder:


5.2 Adding Search Form to LayoutAdding the following code to layout.phtml file in the application/layouts/scripts folder:


5.3 Processing a Search Request


5.3 Rendering Search Results


ADDING MODULES IN ZEND FRAMEWORK APPLICATION


1. Creating Modules• Create a new folder in the application folder named

modules.• Create a module folder name of your choice e.g.

contact.• Create subfolders in the your module folder in this

order:– application/modules/contact/controllers– application/modules/contact/models– application/modules/contact/views

• application/modules/contact/views/scripts• application/modules/contact/views/helpers

. http://kb.vteamslabs.com 79

Run this command:zf create module contact

in the terminal or command prompt in the project directory


Creating Resources in Modules

• Any custom functionality must be done in the modules’s Bootstrap.php file. This must be done with care.

• For every resource you need to add prefix [module_name] to class definition. For example:

– For Controller: [module_name]_IndexController.php– For Model: [module_name]_Model_Page.php– For Form: [module_name]_Form_User.php


Thank You

QUESTIONS
