Using Zend_Form_Element_File in CRUD

When designing applications on the Zend Framework, the use of the Zend_Form component makes it much easier to work with entities - a once-created form with configured validators, filters, etc. is used both when creating and editing data in the database.
Entities very often contain elements of the File type - whether it is a picture preview, a file name for downloading or a photo in the gallery. That's only if you want to change the entity in the form of which there is a File element, it becomes clear that the standard decorator Zend_Form_Element_File is not suitable for the form of changing the entity - because it does not allow to display the presence of the downloaded file, does not allow to delete this file, etc.

In other words, when you open an entity for change, all other elements of the form are populated with values from the database - while Zend_Form_Element_File does not have this to do.
In this article I want to share my implementation of working with Zend_Form_Element_File as part of creating a CRUD (create-read-update-delete) on ZendFramework 1.11
')
Under Habrakat you will find a detailed description of how to create a decorator, how to attach it to the form and instructions for working with the controller.

Zend_Form_Element_File - general information, features

When adding a new entity to the database, Zend_Form_Element_File looks like this (standard):

When changing an entity, Zend_Form_Element_File by default looks similar. Our task is to bring the look of this element to this:

Accordingly, the current uploaded file name is displayed, the element itself to indicate the new file (the old one will be replaced by it) and the checkbox to delete the already uploaded file and reset the photo column for the entity being edited.

Create your own decorator for Zend_Form_Element_File

To do this, in the application / forms / Decorators folder create a File.php file with the following class

<? php
class Application_Form_Decorators_File extends Zend_Form_Decorator_Abstract
{
public function buildLabel ( )
{
$ element = $ this -> getElement ( ) ;
$ label = $ element -> getLabel ( ) ;
if ( $ translator = $ element -> getTranslator ( ) ) {
$ label = $ translator -> translate ( $ label ) ;
}
if ( $ element -> isRequired ( ) ) {
$ label . = '*' ;
}
$ label . = ':' ;
return $ element -> getView ( )
-> formLabel ( $ element -> getName ( ) , $ label ) ;
}
public function buildInput ( )
{
$ element = $ this -> getElement ( ) ;
$ helper = $ element -> helper ;
return $ element -> getView ( ) -> $ helper (
$ element -> getName ( ) ,
$ element -> getValue ( ) ,
$ element -> getAttribs ( ) ,
$ element -> options
) ;
}
public function buildErrors ( )
{
$ element = $ this -> getElement ( ) ;
$ messages = $ element -> getMessages ( ) ;
if ( empty ( $ messages ) ) {
return '' ;
}
return '<div class = "errors">' .
$ element -> getView ( ) -> formErrors ( $ messages ) . '</ div>' ;
}
public function buildDescription ( )
{
$ element = $ this -> getElement ( ) ;
$ desc = $ element -> getDescription ( ) ;
if ( empty ( $ desc ) ) {
return '' ;
}
return '<div class = "description">' . $ desc . '</ div>' ;
}
public function render ( $ content )
{
$ element = $ this -> getElement ( ) ;
if ( ! $ element instanceof Zend_Form_Element ) {
return $ content ;
}
if ( null === $ element -> getView ( ) ) {
return $ content ;
}
$ separator = $ this -> getSeparator ( ) ;
$ placement = $ this -> getPlacement ( ) ;
$ label = $ this -> buildLabel ( ) ;
$ input = $ this -> buildInput ( ) ;
$ errors = $ this -> buildErrors ( ) ;
$ desc = $ this -> buildDescription ( ) ;
$ renderedContent = $ element -> getView ( ) -> partial (
'decorators / file.phtml' ,
array ( 'element' => $ element ) ) ;
$ output = '<tr> <td>'
. $ label . '</ td> <td>' . $ renderedContent
. $ input
. $ errors
. $ desc
. '</ td> </ tr>' ;
switch ( $ placement ) {
case ( self :: PREPEND ) :
return $ output . $ separator . $ content ;
case ( self :: APPEND ) :
default :
return $ content . $ separator . $ output ;
}
}
}

Thus, we can assemble the appearance of the element “in parts” by adding the necessary information for the output. Using the instructions

$ renderedContent = $ element -> getView ( ) -> partial (
'decorators / file.phtml' ,
array ( 'element' => $ element ) ) ;

Along the way, we pass information about the current element (Zend_Form_Element_File) as $ element (needed for
Render the application / views / scripts / decorators / file.phtml file with the following contents:

You uploaded a photo ' <? Php echo $ this -> element -> getDescription ( ) ; ?> '. <br>
You can change the photo by specifying a new file. If a photo change is not required, leave this field blank. <br>
To remove a photo, check the box:
<input name = " <? php echo $ this -> element -> getName ( ) ; ?> _checkbox" type = "checkbox" value = "on" /> <br />

The use of decorators in the form

Since a custom decorator is needed only when the entity is changed, when adding an entity, we leave the standard decorator:

if ( $ this -> _options [ 'type' ] == 'edit' && ! is_null ( $ this -> _options [ 'photo_file' ] ) ) {
$ photo -> setDescription ( $ this -> _options [ 'photo_file' ] ) ;
$ photo -> setDecorators ( array (
array ( 'ViewScript' , array ( 'viewScript' => 'decorators / file.phtml' ) ) ,
'File' ,
'Errors' ,
array ( array ( 'data' => 'HtmlTag' ) , array ( 'tag' => 'td' , 'class' => 'element' ) ) ,
array ( 'Label' , array ( 'tag' => 'td' ) ) ,
array ( array ( 'row' => 'HtmlTag' ) , array ( 'tag' => 'tr' ) )
) )
} else {
$ photo -> setDecorators ( array (
'File' ,
'Errors' ,
array ( array ( 'data' => 'HtmlTag' ) , array ( 'tag' => 'td' , 'class' => 'element' ) ) ,
array ( 'Label' , array ( 'tag' => 'td' ) ) ,
array ( array ( 'row' => 'HtmlTag' ) , array ( 'tag' => 'tr' ) )
) )
}

Using decorator in controller:

For each loaded picture, a preview is created using a filter — accordingly, when deleting a picture, you also need to delete the preview.

// if a check mark for deletion is set, then delete the file and food in the database null
if ( ! is_null ( $ this -> getRequest ( ) -> getParam ( 'photo_checkbox' ) ) && $ this -> getRequest ( ) -> getParam ( 'photo_checkbox' ) == 'on' ) {
if ( file_exists ( PUBLIC_PATH . '/ userfiles / images / full /' . $ item -> photo ) )
unlink ( PUBLIC_PATH . '/ userfiles / images / full /' . $ item -> photo ) ;
if ( file_exists ( PUBLIC_PATH . '/ userfiles / images / thumb /' . $ item -> photo ) )
unlink ( PUBLIC_PATH . '/ userfiles / images / thumb /' . $ item -> photo ) ;
$ item -> photo = null ;
}
// if a new file is specified and it is loaded, then delete the old file and write a new one to the database.
// if the File element is empty, $ form-> photo-> getFileName () == array (null);
if ( ! is_null ( $ form -> photo -> getFileName ( ) ) && count ( $ form -> photo -> getFileName ( ) ) ! = 0 ) {
if ( file_exists ( PUBLIC_PATH . '/ userfiles / images / full /' . $ item -> photo ) ) {
unlink ( PUBLIC_PATH . '/ userfiles / images / full /' . $ item -> photo ) ;
}
if ( file_exists ( PUBLIC_PATH . '/ userfiles / images / thumb /' . $ item -> photo ) ) {
unlink ( PUBLIC_PATH . '/ userfiles / images / thumb /' . $ item -> photo ) ;
}
$ item -> photo = $ form -> getValue ( 'photo' ) ;
}

Source codes:

If the topic is relevant, then there is more material about writing filters for image processing loaded via Zend_Form_Element_File (gdlib and imagic).

Thank you for your attention, comments and suggestions are accepted. Not so long ago, I began to study the Zend Framework, I did not find a solution to this problem - I had to figure it out myself. If something is done is not entirely correct and (or) not in the style of ZF - please unsubscribe in the comments, I will correct.

The current implementation is working successfully.

Source: https://habr.com/ru/post/136438/

All Articles