Overview

Packages

  • Jyxo_Beholder
  • Jyxo_Charset
  • Jyxo_Color
  • Jyxo_Css
  • Jyxo_ErrorHandling
  • Jyxo_FirePhp
  • Jyxo_Gettext
    • Parser
  • Jyxo_Html
  • Jyxo_Input
    • Chain
    • Filter
    • Validator
  • Jyxo_Mail
    • Email
    • Parser
    • Sender
  • Jyxo_Rpc
    • Json
    • Xml
  • Jyxo_Shell
  • Jyxo_SpamFilter
  • Jyxo_Spl
  • Jyxo_String
  • Jyxo_Svn
  • Jyxo_Time
  • Jyxo_Timer
  • Jyxo_Webdav
  • Jyxo_XmlReader
  • PHP

Classes

  • Jyxo_Input_Factory
  • Jyxo_Input_Fluent
  • Jyxo_Input_Upload

Exceptions

  • Jyxo_Input_Exception
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class Jyxo_Input_Fluent

Class implementing "fluent" design pattern for Jyxo_Input.

Allows chaining multiple validators and checking multiple values in one validation cycle.

Category: Jyxo
Package: Jyxo_Input
Copyright: Copyright (c) 2005-2011 Jyxo, s.r.o.
License: https://github.com/jyxo/php/blob/master/license.txt
Author: Jakub Tománek
Located at Input/Fluent.php
Methods summary
public
# __construct( )

Constructor.

Constructor.

public Jyxo_Input_Fluent
# check( mixed $var, string $name )

Starts a new value checking.

Starts a new value checking.

Parameters

$var
mixed
Value to check.
$name
string
Variable name

Returns

Jyxo_Input_Fluent
public Jyxo_Input_Fluent
# all( )

Validates all variables.

Validates all variables.

Returns

Jyxo_Input_Fluent
public Jyxo_Input_Fluent
# defaultValue( mixed $value )

Sets a default value in case the validation fails.

Sets a default value in case the validation fails.

Parameters

$value
mixed
Default value

Returns

Jyxo_Input_Fluent

Throws

BadMethodCallException
There is no active variable.
public Jyxo_Input_Fluent
# validate( string $name, string $errorMessage = null, mixed $param = null )

Adds a validator to the chain.

Adds a validator to the chain.

Parameters

$name
string
Validator name
$errorMessage
string
Validator error message
$param
mixed
Additional validator parameter

Returns

Jyxo_Input_Fluent
public Jyxo_Input_Fluent
# filter( string $name, mixed $param = null )

Adds a filter to the chain.s

Adds a filter to the chain.s

Parameters

$name
string
Filter name
$param
mixed
Additional filter parameter

Returns

Jyxo_Input_Fluent
public Jyxo_Input_Fluent
# walk( boolean $addFilter = true )

Adds a subchain to the current chain that treats the value a an array. Automatically adds the isArray validator.

Adds a subchain to the current chain that treats the value a an array. Automatically adds the isArray validator.

Parameters

$addFilter
boolean
Add the Trim filter (removes empty elements)

Returns

Jyxo_Input_Fluent
public Jyxo_Input_Fluent
# condition( string $name, mixed $param = null )

Adds a conditional chain.

Adds a conditional chain.

If there are conditions in the current chain, adds the condition as a subchain.

Parameters

$name
string
Validator name
$param
mixed
Additional validator parameter

Returns

Jyxo_Input_Fluent

Throws

BadMethodCallException
There is no active variable
public Jyxo_Input_Fluent
# close( )

Closes a chain.

Closes a chain.

Returns

Jyxo_Input_Fluent
public boolean
# isValid( boolean $assocErrors = false )

Performs validation and filtering of all variables.

Performs validation and filtering of all variables.

Parameters

$assocErrors
boolean
Return error messages in an associative array

Returns

boolean
public
# validateAll( )

Calls isValid(), but throws an exception on error.

Calls isValid(), but throws an exception on error.

The exception contains only the first validation error message.

Throws

Jyxo_Input_Validator_Exception
Validation failed
public array
# getValues( )

Returns all values.

Returns all values.

Returns

array
public mixed
# getValue( string $name )

Returns a value by name.

Returns a value by name.

Parameters

$name
string
Variable name

Returns

mixed

Throws

Jyxo_Input_Exception
No variable with the given name
public array
# getErrors( )

Returns errors.

Returns errors.

Returns

array
public Jyxo_Input_Fluent
# post( string $name, mixed $default = null )

Checks a POST variable.

Checks a POST variable.

Parameters

$name
string
Variable name
$default
mixed
Default value

Returns

Jyxo_Input_Fluent
public Jyxo_Input_Fluent
# query( string $name, mixed $default = null )

Checks a GET variable.

Checks a GET variable.

Parameters

$name
string
Variable name
$default
mixed
Default value

Returns

Jyxo_Input_Fluent
public Jyxo_Input_Fluent
# request( string $name, mixed $default = null )

Checks a POST/GET variable

Checks a POST/GET variable

Parameters

$name
string
Variable name
$default
mixed
Default value

Returns

Jyxo_Input_Fluent
public Jyxo_Input_Fluent
# file( string $index )

Checks file upload.

Checks file upload.

Requires Jyxo_Input_Upload.

Parameters

$index
string
File index

Returns

Jyxo_Input_Fluent

See

Jyxo_Input_Upload
public mixed
# __get( string $offset )

Magic getter for easier retrieving of values.

Magic getter for easier retrieving of values.

Parameters

$offset
string
Value name

Returns

mixed

Throws

Jyxo_Input_Exception
No variable with the given name
Constants summary
string VALIDATORS_PREFIX 'Jyxo_Input_Validator_'
#

Validator class names prefix.

Validator class names prefix.

string FILTERS_PREFIX 'Jyxo_Input_Filter_'
#

Filter class names prefix.

Filter class names prefix.

Jyxo PHP Library API documentation generated by ApiGen 2.3.0