ansaurus

Question

How do I use ViewScripts on Zend_Form File Elements?

Answer 1

+1 A:

This is not a simple or ideal solution because it requires an extension of the File decorator... but it's rather frustrating that they didn't make the effort to separate the hidden element generation logic from the file input generation logic. I'm not sure if the file view helper handles the issue of an element being an array (that seems to be the reason they did it this way.)

Extension of File Decorator: (the commented out part is what causes the extra input to be generated.)

<?php

class Sys_Form_Decorator_File extends Zend_Form_Decorator_File {

  public function render($content) {

    $element = $this->getElement();
    if (!$element instanceof Zend_Form_Element) {return $content;}

    $view = $element->getView();
    if (!$view instanceof Zend_View_Interface) {return $content;}

    $name = $element->getName();
    $attribs = $this->getAttribs();
    if (!array_key_exists('id', $attribs)) {$attribs['id'] = $name;}

    $separator = $this->getSeparator();
    $placement = $this->getPlacement();
    $markup = array();
    $size = $element->getMaxFileSize();

    if ($size > 0) {

      $element->setMaxFileSize(0);
      $markup[] = $view->formHidden('MAX_FILE_SIZE', $size);

    }

    if (Zend_File_Transfer_Adapter_Http::isApcAvailable()) {

      $apcAttribs = array('id' => 'progress_key');
      $markup[] = $view->formHidden('APC_UPLOAD_PROGRESS', uniqid(), $apcAttribs);

    }

    else if (Zend_File_Transfer_Adapter_Http::isUploadProgressAvailable()) {

      $uploadIdAttribs = array('id' => 'progress_key');
      $markup[] = $view->formHidden('UPLOAD_IDENTIFIER', uniqid(), $uploadIdAttribs);

    }

    /*

    if ($element->isArray()) {

      $name .= "[]";
      $count = $element->getMultiFile();

      for ($i = 0; $i < $count; ++$i) {

        $htmlAttribs = $attribs;
        $htmlAttribs['id'] .= '-' . $i;
        $markup[] = $view->formFile($name, $htmlAttribs);

      }

    }

    else {$markup[] = $view->formFile($name, $attribs);} 

    */

    $markup = implode($separator, $markup);

    switch ($placement) {

      case self::PREPEND: return $markup . $separator . $content;
      case self::APPEND:
      default: return $content . $separator . $markup;

    }

  }

 }

?>

Form setup in controller action:

$form = new Zend_Form();
$form->addElement(new Zend_Form_Element_File('file'));
$form->file->setLabel('File');
$form->file->setDescription('Description goes here.');

$decorators = array();
$decorators[] = array('File' => new Sys_Form_Decorator_File());
$decorators[] = array('ViewScript', array('viewScript' => '_formElementFile.phtml'));
$form->file->setDecorators($decorators);

$this->view->form = $form;

In action view:

<?php echo $this->form; ?>

In element script:

<div class="field" id="field_<?php echo $this->element->getId(); ?>">

<?php if (0 < strlen($this->element->getLabel())) : ?>
<?php echo $this->formLabel($this->element->getName(), $this->element->getLabel());?>
<?php endif; ?>

<span class="value">
<?php 

echo $this->{$this->element->helper}(

  $this->element->getName(),
  $this->element->getValue(),
  $this->element->getAttribs()

);

?>
</span>

<?php if (0 < $this->element->getMessages()->length) : ?>
<?php echo $this->formErrors($this->element->getMessages()); ?>
<?php endif; ?>

<?php if (0 < strlen($this->element->getDescription())) : ?>
<span class="hint"><?php echo $this->element->getDescription(); ?></span>
<?php endif; ?>

</div>

Output should be:

<form enctype="multipart/form-data" action="" method="post">
<dl class="zend_form">
<input type="hidden" name="MAX_FILE_SIZE" value="134217728" id="MAX_FILE_SIZE" />
<div class="field" id="field_file">
<label for="file">File</label>
<span class="value"><input type="file" name="file" id="file" /></span>
<span class="hint">Description goes here.</span>
</div>
</dl>
</form>

A problem with this solution is that the hidden elements don't render within the viewscript; this might be a problem if you're using the div as a selector in a client-side script...

Robin Canaday 2010-01-27 17:47:35

Thanks for the suggestion Robin, but 'no file decorator' exception gets thrown when doing it that way too.

Sonny 2010-01-27 18:13:59

That's really odd. I tested it before posting my answer, and it's still working for me.

Robin Canaday 2010-01-27 19:44:40

Using Zend 1.96, by the way. I don't know if that would make a difference in this case or not.

Robin Canaday 2010-01-27 19:49:01

I am using 1.9.7, so maybe that is an issue. I tried again to make sure, but got the same error.

Sonny 2010-01-27 21:35:28

I see what I was doing wrong, and why I was getting the error, but your solution doesn't wrap the output of the 'File' decorator inside the ViewScript decorator. It renders first, with the ViewScript ouput after, similar to my output example above.

Sonny 2010-01-27 22:13:36

Yeah, I see what you mean. My bad, I didn't put anything else in my viewScript. I changed my answer...

Robin Canaday 2010-01-28 09:07:27

Thanks for all your work on this Robin!

Sonny 2010-01-28 14:43:08

Well, I was putting off figuring it out. So, thanks for asking :).

Robin Canaday 2010-01-28 16:14:12

Answer 2

A:

I've found a work-around that avoids the ViewScript altogether.

First, the element definition:

$this->addElement('file', 'upload_file', array(
    'disableLoadDefaultDecorators' => true,
    'decorators' => array(
        'File',
        array(array('Value'=>'HtmlTag'), array('tag'=>'span','class'=>'value')),
        'Errors',
        'Description',
        'Label',
        array(array('Field'=>'HtmlTag'), array('tag'=>'div','class'=>'field file')),
    ),
    'label' => 'Upload File',
    'required' => false,
    'filters' => array('StringTrim'),
    'validators' => array(),
));

Second, after the form class has been instantiated, I mimic the behavior of my ViewScript:

$field = $form->getElement('upload_file');
$decorator = $field->getDecorator('Field');
$options = $decorator->getOptions();
$options['id'] = 'field_' . $field->getId();
if ($field->hasErrors()) {
    $options['class'] .= ' errors';
}
$decorator->setOptions($options);

I guess that I should look into class-based decorators. Maybe there's more flexibility there?

Sonny 2010-01-27 22:23:31

I want to leave this question open, in case there's a way to do it with a ViewScript.

Sonny 2010-01-27 22:24:42

Answer 3

A:

The easiest thing to do is to add no markup at all to the output in your custom File Decorator:

class Custom_Form_Decorator_File extends Zend_Form_Decorator_File {
        public function render($content) {
                return $content;
        }
}

now you can do whatever you want in your viewscript for this file element (output the file input field and all hidden fields you need on your own).

Wolfgang 2010-03-19 09:30:42

I haven't had a chance to try your solution. I do want all the hidden fields that are supplied by the framework, I just wanted to wrap them in my preferred HTML elements. Does your solution accomplish that?

Sonny 2010-03-26 14:46:05

Answer 4

+3 A:

Hi There,

The answer is relatively simple as it happens. All you need do is specify the File decorator first, create a specific view script for the file input and specify false for the placement in the viewScript decorator arguments, this will effectively inject the output from the File decorator into the viewScript decorator e.g.

$element->setDecorators(array('File', array('ViewScript', array('viewScript' => 'decorators/file.phtml', 'placement' => false))));

Then in the new file element view script you simply echo $this->content in the script where you'd like the file input markup to be placed. Here's an example from a recent project, so ignore the markup if it looks a little odd, hopefully it will illustrate the point.

<label for="<?php echo $this->element->getName(); ?>" class="element <?php if ($this->element->hasErrors()): ?> error<?php endif; ?>" id="label_<?php echo $this->element->getName(); ?>"> 
<span><?php echo $this->element->getLabel(); ?></span>

<?php echo $this->content; ?>

<?php if ($this->element->hasErrors()): ?>

    <span class="error">
        <?php echo $this->formErrors($this->element->getMessages()); ?>
    </span>

<?php endif; ?>

</label>

When rendered you will see this html for the element

<label for="photo" class="element" id="label_photo"> 
<span>Photo</span>

<input type="hidden" name="MAX_FILE_SIZE" value="6291456" id="MAX_FILE_SIZE">
<input type="file" name="photo" id="photo">

</label>

Hope this helps.

Cheers

Shaun

Shaun Rowe 2010-06-07 21:08:52

This looks like exactly what I'm looking for. I try it and mark yours as the answer if it works as I need it!

Sonny 2010-06-08 15:30:46

I just tested your solution, and it works! Thanks Shaun!

Sonny 2010-06-14 21:15:33

I just wanted to thank you again, this is so much better than my previous solution.

Sonny 2010-06-25 13:48:36

ansaurus

tags:

views:

answers:

How do I use ViewScripts on Zend_Form File Elements?

related questions