Overview

Namespaces

  • None
  • PHP

Classes

  • RESTian
  • RESTian_Application_Json_Parser
  • RESTian_Application_Serialized_Php_Parser
  • RESTian_Application_Xml_Parser
  • RESTian_Auth_Provider_Base
  • RESTian_Base
  • RESTian_Basic_Http_Auth_Provider
  • RESTian_Client
  • RESTian_Http_Agent_Base
  • RESTian_Not_Applicable_Provider
  • RESTian_Parser_Base
  • RESTian_Php_Curl_Http_Agent
  • RESTian_Request
  • RESTian_Response
  • RESTian_Service
  • RESTian_Settings
  • RESTian_Text_Csv_Parser
  • RESTian_Text_Html_Parser
  • RESTian_Text_Plain_Parser
  • RESTian_Var
  • RESTian_WordPress_Http_Agent
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class RESTian_Var

Located at core-classes/class-var.php
Methods summary
public
# __construct( string $var_name, array $args = array() )

Parameters

$var_name
string
$var_name
$args
array
$args

Throws

Exception
public
# apply_transforms( mixed $value )
Properties summary
public string $name
#

Actual name of URL query argument. Defaults to same value as $this->name.

Actual name of URL query argument. Defaults to same value as $this->name.

public string $requires false
#

if specified, indicates what this param is used for. Basically it's a description.

if specified, indicates what this param is used for. Basically it's a description.

public boolean|array $not_vars false
#

List of other parameter names that make this parameter invalid when they appear. If in "name=value" format then only invalid when the parameter appears with the specified value.

List of other parameter names that make this parameter invalid when they appear. If in "name=value" format then only invalid when the parameter appears with the specified value.

public boolean|array $options false
#

List of options that are valid for this parameter.

List of options that are valid for this parameter.

public boolean|string $usage 'query'
#

Specifies how this param is used; as part of the URL 'path', in the URL 'query', or 'both'.

Specifies how this param is used; as part of the URL 'path', in the URL 'query', or 'both'.

public boolean|string $type 'string'
#

Specifies the data type expected. Currently just 'string' or 'number'.

Specifies the data type expected. Currently just 'string' or 'number'.

public boolean|array $transforms array()
#

List of Transforms that can be applied to value, i.e. fill[/] replaces whitespace with '/'

List of Transforms that can be applied to value, i.e. fill[/] replaces whitespace with '/'

API documentation generated by ApiGen 2.8.0