gapi_forms.inc

function validateError( $type,    $input,    $val  =  "" )

Validates the information based on the type

Note

This function is named validateError rather than just validate in order to make the following statement sound more logical

if ( $myElement->validateError( 'req', $input ) )
  echo "There was an error";

However, even though it’s not documented, you can use validateError() and validate() interchangeably without an issue

Parameters

Validation Types

Example

$atLeastError  = gapiForms::validateError('min', $input , 3);
$lessThanError = gapiForms::validateError('max', $input , 10);

if ( ! $atLeastError && ! $lessThanError )
  echo "This is a valid input!";
elseif ( $atLeastError )
  echo $atLeastError;
elseif ( $lessThanError )
  echo $lessThanError;

Example of Custom Validation (No Error)

$validate = true;
gapiForms::validateError('customValidation', $validate);

Example of Custom Validation (Error)

$validate = "Error message";
gapiForms::validateError('customValidation', $validate);

Returns

function get( $option )

Get an option’s value

Parameters

Options

Example

echo $element->get('value');

function set( $option, $value )

Set an option’s value

Parameters

Example

$element->set('value', 'New Value!');

function setAttribute( $attribute, $value )

Set an attribute of the element

Parameters

Example

$element->setAttribute('class', 'testClass');

function getAttribute( $attribute )

Get an attributes value

Parameters

Example

echo $element->getAttribute('class');

function validate( $isolate  =  false, $validate  =  false )

Validate an element

Example

$textfield = new gapiTextBox( 'newelement',
  array(
    'value'=>'test',
    'attributes'=> array(
      'size'=>5
    )
  ) );

echo $textfield->toString( );

// <input id="newelement" name="newelement" type="text" value="test" size="5" / >

Arguments

Returns

Array of errors (key is validation type, value is error message)

function toString( $return  =  "both" )

Outputs a HTML string representation of the element

Example

$textfield = new gapiTextBox( 'newelement',
  array(
    'value'=>'test',
    'attributes'=> array(
      'size'=>5
    )
  ) );

echo $textfield->toString( );

// <input id="newelement" name="newelement" type="text" value="test" size="5" / >

Arguments

Returns

HTML output

function isSubmitted( )

Check if the form was submitted

Will only work if one of the elements passed into the form is submitted

Example

if( $myForm->isSubmitted( ) )
  echo "Congrats!  The form was submitted";
 else
  echo "Please fill out the form";

Returns

function isError( )

Check if theres an error

Example

if( $myForm->isSubmitted( ) )
{
  if( $myForm->isError( ) )
  {
    echo "There was an error in your submitted form";
  }
   else
  {
    echo "Congrats!  The form was submitted and there are no errors!";
  }
}
 else
{
  echo "Please fill out the form";
}

Returns

function getElements( )

Returns an array of elements in the form

Returns

function save( )

Saves the form in a mySQL database

Parameters

Returns

Returns

Note

In regards to the return, to check if the save was successful, you need to use the identity operator (===).

if( $myForm->save() === true)
  // Means the form was saved

if( $myForm->save() !== true )
  // Means the form was NOT saved

if( $myForm->save() == true)
  //This will always be true