interface/modules/zend_modules/library/Zend/Form/FormInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Form;
  11
  12 use Zend\InputFilter\InputFilterInterface;
  13
  14 interface FormInterface extends FieldsetInterface
  15 {
  16     const BIND_ON_VALIDATE  = 0x00;
  17     const BIND_MANUAL       = 0x01;
  18     const VALIDATE_ALL      = 0x10;
  19     const VALUES_NORMALIZED = 0x11;
  20     const VALUES_RAW        = 0x12;
  21     const VALUES_AS_ARRAY   = 0x13;
  22
  23     /**
  24      * Set data to validate and/or populate elements
  25      *
  26      * Typically, also passes data on to the composed input filter.
  27      *
  28      * @param  array|\ArrayAccess $data
  29      * @return FormInterface
  30      */
  31     public function setData($data);
  32
  33     /**
  34      * Bind an object to the element
  35      *
  36      * Allows populating the object with validated values.
  37      *
  38      * @param  object $object
  39      * @param  int $flags
  40      * @return mixed
  41      */
  42     public function bind($object, $flags = FormInterface::VALUES_NORMALIZED);
  43
  44     /**
  45      * Whether or not to bind values to the bound object when validation succeeds
  46      *
  47      * @param  int $bindOnValidateFlag
  48      * @return void
  49      */
  50     public function setBindOnValidate($bindOnValidateFlag);
  51
  52     /**
  53      * Set input filter
  54      *
  55      * @param  InputFilterInterface $inputFilter
  56      * @return FormInterface
  57      */
  58     public function setInputFilter(InputFilterInterface $inputFilter);
  59
  60     /**
  61      * Retrieve input filter
  62      *
  63      * @return InputFilterInterface
  64      */
  65     public function getInputFilter();
  66
  67     /**
  68      * Validate the form
  69      *
  70      * Typically, will proxy to the composed input filter.
  71      *
  72      * @return bool
  73      */
  74     public function isValid();
  75
  76     /**
  77      * Retrieve the validated data
  78      *
  79      * By default, retrieves normalized values; pass one of the VALUES_*
  80      * constants to shape the behavior.
  81      *
  82      * @param  int $flag
  83      * @return array|object
  84      */
  85     public function getData($flag = FormInterface::VALUES_NORMALIZED);
  86
  87     /**
  88      * Set the validation group (set of values to validate)
  89      *
  90      * Typically, proxies to the composed input filter
  91      *
  92      * @return FormInterface
  93      */
  94     public function setValidationGroup();
  95 }