Zend Framework 2 Integration in Zend Studio

To create a new local PHP project in Zend Studio:

1. In Zend Studio, go to File | New | Local PHP Project.
   The New Local PHP Project wizard is displayed.

2. Name your new mobile project.

3. Select the file location for the project.
4. Select to create the new project with ZF2 libraries:
   1. In the Content field, select Zend Framework.
   2. In the Version field, click the drop-sown menu and select Zend Framework 2.0.3 (Built in).

   Note:

   For the purpose of deployment, in this tutorial we will be creating our project with Zend Application Deployment (steps 5-9), though this is not mandatory to get your ZF2 project up and running. If you do not want to deploy the project, skip to step 10.

5. Click Next.
   The Launch Settings dialog is displayed.
6. Select Launch with Zend Application Deployment, and then the phpcloud icon.
   The Add Phpcloud Target dialog is displayed.
7. Enter your Zend Developer Cloud credentials, and your SSH Private Key (Click Generate to create a new key).
8. Click Test Connection, and if no problems arise, Finish.
9. Back in the New Local PHP Project wizard, the new target is added to the targets list.

10. Click Finish.
    The new ZF2 project is created, and displayed in the PHP Explorer represented by a Zend Framework icon

The generated project includes a Zend Framework 2 application skeleton with pre-configured dependencies and there is therefore no need to take any additional actions (e.g., running Composer) before actually running the project in a browser.

To deploy the application:

1. In the PHP Explorer, open the 'deployment.xml' file (automatically opened and displayed after the project was created).
2. In the Testing area, click Launch a PHP Application.
   The Launch a PHP Application dialog is displayed with the defined target selected in the Deploy to field.
3. Click Finish.
   The ZF2 skeleton application is deployed and launched in Zend Studio's internal browser.

After being deployed for the first time, Zend Studio is configured by default to upload any changes made to the project to the cloud. So, after saving your changes, all you have to do to view them is refresh your browser.

To add a new ZF2 module:

1. In the PHP Explorer, right-click the project, and select New | Zend Framework Item.
   The Select a wizard dialog is displayed.

2. Select Zend Module, and click Next.
   The New Zend Module dialog is displayed.

3. Rename the module and controller names 'Downloads', and click Finish.
   The new Downloads module is added to your modules folder in the PHP Explorer.

The newly created module is automatically registered in the project's 'application.config.php' configuration file.

To configure the new Downloads module:

1. Open the new module's configuration file (module | Downloads | config | module.config.php).
2. In the 'router' array, enter '/download' as the module-specific route:

...
'router' => array(
	'routes' => array(
		'module-name-here' => array(
			'type'    => 'Literal',
			'options' => array(
			// Change this to something specific to your module
			'route'    => '/download',
			'defaults' => array(
				// Change this value to reflect the namespace in which
				// the controllers for your module are found
				'__NAMESPACE__' => 'Downloads\Controller',
				'controller'    => 'Downloads',
				'action'        => 'index',
			),
		),
...

3. Save the file.
4. Open the application's entry-point file (module | Application | view | application | index | index.phtml).
5. Configure the link and the button to the new module:

...
<p><a class="btn btn-success btn-large" href="download" target="_blank"><?php echo $this->translate('Download') ?> &raquo;</a></p>
...

6. Save the file.

7. Refresh your browser. You will notice that the Download button in the Welcome page's header leads to the newly added module.

To add variables to the controller:

1. Open the Downloads module's 'index.phtml' file (module | Downloads | view | downloads | downloads | index.phtml).
2. Add a heading to the page:

<h1>My Downloads</h1>

3. Open the module's controller file (module | Downloads | src | Downloads | Controller | DownloadsController.php).
4. Add the filesList, filesPath and filesSize variables:

<?php
namespace Downloads\Controller;
use Zend\Mvc\Controller\AbstractActionController;
class DownloadsController extends AbstractActionController
{
	public function indexAction(){
		return array("filesList"=> array("download1", "download2"),
		"filePath" => "http://download.eclipse.org/tools/pdt/",
		"fileSize" => 2000000);
	}
	public function fooAction()
	{
	// This shows the :controller and :action parameters in default route
	// are working when you browse to /module-specific-root/downloads/foo
	return array();
	}
}

5. Save the file.
6. Back in the Downloads module's 'index.phtml' file, use Content Assist to enter a 'foreach' statement for the variables defined above:
   1. Under the heading we added earlier, add PHP opening declaration.
   2. Add a 'foreach' function.
   3. In the brackets, begin typing '$f'.
      Content Assist displays the controller variables.

   

   4. Select the 'fileList' variable, and continue to develop the function using Content Assist:

<?php
foreach ($filesList as $file) {
	echo '<a href="'.$filePath.'">'.$file.'</a>'.$fileSize.'bytes<br>';
}
?>

7. Save the file.
8. Refresh your browser. The Downloads module now displays the newly defined controller variables.

To create a new service:

1. In the PHP Explorer, go to module | Downloads | src, and right-click the Downloads folder.
2. Select New | Class.
   The New PHP Class dialog is displayed.

3. Name the new class 'DownloadsService', and in the Namespace field enter 'Downloads'.
4. Click Finish.
   The new PHP class is added and opened in your editor.
5. Enter the following code:

<?php
namespace Downloads;
class DownloadsService {
	function getFilesList() {
		return array("download1.zip", "download2.zip");
	}
	function getFilesPath() {
		return "http://...";
	}
	function getFilesSize(){
		return 50;
	}
}
?>

6. Save the file.
7. Open the module's controller file (module | Downloads | src | Downloads | Controller | DownloadsController.php).
8. Add a new variable to the 'indexAction' public function:
   1. Begin typing '$downloadService = $this->get'.
      Content Assist will display get options.

2. Select getServiceLocator and continue typing:

$downloadService = $this->getServiceLocator()->get('downloadsService');

9. In the line below, type '$downloadService->' and press Ctrl + Space to bring up Content Assist.
   Content Assist does not display any of the methods defined in the downloadService class, meaning that Zend Studio cannot figure out what PHP object should be returned by the Service Locator.
10. To solve this, map the service name to the PHP class using the project properties:
    1. In the PHP Explorer, right-click your project, and select Properties.
    2. Select Zend Framework | Service Locator, and in the Service Locator dialog, click Add.
    3. Under the Name column, enter the name of the service - downloadService.
    4. Under the type column, type 'Download', and press Ctrl+Space.
       Content Assist displays the PHP Class.

    

    5. Select the DownloadsService class, and click OK.
11. Back in the controller file, press Ctrl + Space after '$downloadService->' to bring up Content Assist.
    This time, Content Assist lists the relevant PHP objects.

12. Now we can finish developing the controller by replacing the mock data with service calls. Use Content Assist to call the PHP methods:

<?php
namespace Downloads\Controller;
use Zend\Mvc\Controller\AbstractActionController;
class DownloadsController extends AbstractActionController
{
	public function indexAction()
	{
	$downloadService = $this->getServiceLocator()->get('downloadsService');
 
		return array("filesList"=> $downloadService->getFilesList(),
			"filePath" => $downloadService->getFilesPath(),
			"fileSize" => $downloadService->getFilesSize());
	}
	public function fooAction()
	{
		// This shows the :controller and :action parameters in default route
		// are working when you browse to /module-specific-root/downloads/foo
		return array();
	}
}

13. Save the file.
14. Register the service in the module configuration file:
    1. Open the Downloads module's configuration file (module | Downloads | config | module.config.php).
    2. Add a new blank line before the ending parentheses in the file, and press Ctrl+Space to display Content Assist.
    3. Select 'service_manager'.
    4. In the 'service_manager' array, add an 'invokables' array.
    5. In this second array, type ''downloadsService'=>'Downloads\'.
       Content Assist displays the DownloadsService service.

15. Select it, and save the file.
    The finished code should look as follows:

<?php
return array(
	'controllers' => array(
		'invokables' => array(
			'Downloads\Controller\Downloads' => 'Downloads\Controller\DownloadsController',
		),
	),
	'router' => array(
		'routes' => array(
			'module-name-here' => array(
				'type'    => 'Literal',
				'options' => array(
					'route'    => '/download',
					'defaults' => array(
						'__NAMESPACE__' => 'Downloads\Controller',
						'controller'    => 'Downloads',
						'action'        => 'index',
					),
				),
				'may_terminate' => true,
				'child_routes' => array(
					'default' => array(
						'type'    => 'Segment',
						'options' => array(
							'route'    => '/[:controller[/:action]]',
							'constraints' => array(
								'controller' => '[a-zA-Z][a-zA-Z0-9_-]*',
								'action'     => '[a-zA-Z][a-zA-Z0-9_-]*',
							),
							'defaults' => array(
							),
						),
					),
				),
			),	
		),
	),
	'view_manager' => array(
		'template_path_stack' => array(
			'Downloads' => __DIR__ . '/../view',
		),
	),
	'service_manager' => array(
		'invokables' => array(
			'downloadsService'=>'Downloads\DownloadsService',
		),
	),
);

16. Refresh your browser. Note that the Downloads module now displays values defined in the DownloadService.

To add a view helper:

1. In the PHP Explorer, go to Module | Downloads | src, right-click the Downloads folder, and select New | Zend Framework Item.
   The Select a Wizard dialog is displayed.
2. Select Zend View helper.
   The New Zend View Helper dialog is displayed.
3. Name the helper 'readableBytes', and click Next.
   The Select PHP Template dialog is displayed.
4. Select the ZF2 template, and click Finish.
   The new view helper file is created and opened in your editor.

The newly created view helper is automatically registered in the module configuration file (module | Downloads | Config | module.config.php).

To configure the view helper:

In the newly added view helper file, copy and paste the following code:

class readableBytes extends AbstractHelper {
	public function __invoke($bytes) {
		return $bytes/ (1024*1024).'Mb';
	}
}

To use the view helper:

1. Open the Downloads module's 'index.phtml' file (module | Downloads | view | downloads | downloads | index.phtml).
2. Edit the 'foreach' statement:
   1. On line 7, edit the existing echo statement as follows:

   echo '<a href="'.$filePath.'">'.$file.'</a>';

   2. On line 8, begin typing a new echo statement: 'echo this=>reada'.
      Content Assist will suggest the view helper.

   

   3. Select it, and using Content Assist, complete the statement as follows:

   echo $this=>readableBytes($fileSize).'<br>';

3. Open the 'DownloadsService' file (module | Downloads | src | Downloads | DownloadsService.php), and enter '50000000' as the return value for the 'getFilesSize' function.
4. Refresh your browser. The file size called by the DownloadService displays bytes in the way defined in the view helper.

To use the MVC Outline view to overview your project:

1. The view is automatically displayed when creating your first Zend Framework project, but you can also manually open it by going to Window | Show View | MVC Outline.

2. Expand the structure tree to view all project components.