/includes/skip/elements/forms/hidden.php

  1. <?php 
  2. /** 
  3.  * Skip Hidden Field class 
  4.  * @package Skip\Forms 
  5.  * @since 1.0 
  6.  * @ignore 
  7.  */ 
  8.   
  9. namespace skip\v1_0_0; 
  10.  
  11. class Hidden extends Form_Element{ 
  12.   /** 
  13.    * Constructor 
  14.    * @since 1.0 
  15.    * @param string $name The name of field. 
  16.     * @param array/string $args List of Arguments. 
  17.    */ 
  18.   function __construct( $name, $args = array() ) { 
  19.       global $post, $skip_form_option_group; 
  20.        
  21.       $args = wp_parse_args( $args ); 
  22.       extract( $args , EXTR_SKIP ); 
  23.        
  24.       $args[ 'close_tag' ] = FALSE; // No Close tag for Input type Text 
  25.       parent::__construct( 'input', $name, $args ); 
  26.        
  27.       $this->add_param( 'type', 'hidden' ); // This is a text field! 
  28.   } 
  29. } 
  30. /** 
  31.  * Hidden Field getter Function 
  32.  * @see skip_hidden() 
  33.  * @ignore 
  34.  */ 
  35. function get_hidden( $name, $args = array(), $return = 'html' ) { 
  36.   $hidden = new Hidden( $name, $args ); 
  37.   return element_return( $hidden, $return ); 
  38. } 
  39. /** 
  40.  * <pre>skip_hidden( $name, $args )</pre> 
  41.  *  
  42.  * Adding a Hidden field. 
  43.  *  
  44.  * <b>Default Usage</b> 
  45.  * <code> 
  46.  * skip_hidden( 'myhiddenfield' ); 
  47.  * </code> 
  48.  * This will create an automated saved hidden field. 
  49.  *  
  50.  * <b>Parameters</b> 
  51.  *  
  52.  * <code> 
  53.  * $name // (string) (required) The name of the field. 
  54.  * $args // (array) (optional) Values for further settings. 
  55.  * </code> 
  56.  *  
  57.  * <b>$args Settings</b> 
  58.  *  
  59.  * <ul> 
  60.  *     <li>id (string) ID if the HTML Element.</li>  
  61.  *     <li>label  (string) Label for Element.</li>  
  62.  *     <li>default (string) Default Value if no Value is set before.</li> 
  63.  *     <li>classes (string) Name of CSS Classes which will be inserted into HTML seperated by empty space.</li> 
  64.  *     <li>before_element (string) Content before the element.</li> 
  65.  *    <li>after_element (string) Content after the element.</li> 
  66.  *     <li>save (boolean) TRUE if value of field have to be saved in Database, FALSE if not (default TRUE).</li> 
  67.  * </ul> 
  68.  *  
  69.  * <b>Example</b> 
  70.  *  
  71.  * Creating a hidden field in an automatic saved form. 
  72.  * <code> 
  73.  * skip_form_start( 'myformname' ); 
  74.  *  
  75.  * $args = array( 
  76.  *     'id' = 'myelementid',  
  77.  *     'label' => 'Content' 
  78.  * ); 
  79.  * skip_editor( 'myhiddenfield', $args ); 
  80.  *  
  81.  * skip_form_end(); 
  82.  * </code> 
  83.  *  
  84.  * Getting back the saved data. 
  85.  * <code> 
  86.  * $value = skip_value( 'myformname', 'myhiddenfield' ); 
  87.  * </code> 
  88.  * @package Skip\Forms 
  89.  * @since 1.0 
  90.  * @param string $name Name of field. 
  91.  * @param array/string $args List of Arguments. 
  92.  */ 
  93. function hidden( $name, $args = array() ) { 
  94.   echo get_hidden( $name, $args, 'echo' ); 
  95. } 
.