Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP

Classes

  • Ad
  • Ads
  • ArgMap
  • Attribute
  • AttributeValidation
  • Authorization
  • Category
  • CategoryData
  • CategoryList
  • CategoryNode
  • CloudConnector
  • ClusterUriIterator
  • Completion
  • Completions
  • CompressionMode
  • Connector
  • ConnectorSettingsBuilder
  • Correction
  • Corrections
  • Count
  • CssClass
  • CustomerKeyAuthentication
  • DynamicPage
  • EventDataJobResult
  • FacetList
  • FacetRange
  • Facets
  • Filter
  • FilterBuilder
  • ImportData
  • JavaScriptNotifier
  • MessageAuthentication
  • OnPremConnector
  • Order
  • OrderLine
  • Panel
  • PanelContent
  • Path
  • Phrase
  • Phrases
  • Product
  • Products
  • Reporter
  • ResultType
  • Session
  • Status
  • Subpanel
  • Value
  • Values
  • Variant

Interfaces

  • Facet
  • Result

Exceptions

  • BusyClusterException
  • ClusterUnavailableException
  • DuplicateSubpanelException
  • FetchClusterException
  • IOException
  • MalformedJsonException
  • MalformedURLException
  • MissingSubpanelException
  • PanelException
  • ParseException
  • ReportException
  • RequestFailedException
  • ResultTypeException
  • Overview
  • Namespace
  • Class
  • Tree

Class ArgMap

Convenience class for passing arguments to a panel request. Automaticly casts all keys and values to strings.

Apptus\ESales\Connector\ArgMap implements ArrayAccess, Countable, IteratorAggregate
Namespace: Apptus\ESales\Connector
Located at Connector/ArgMap.php
Methods summary
public
# put( mixed $key, mixed $value )

Put an argument into the ArgMap. Both the key and the value will be casted to strings.

Put an argument into the ArgMap. Both the key and the value will be casted to strings.

Alternative syntax:
$argmap[$key] = $value;

Parameters

$key
$value
public
# putAll( array|Apptus\ESales\Connector\ArgMap|null $args )

Put all arguments from an array or another ArgMap into the ArgMap.

Put all arguments from an array or another ArgMap into the ArgMap.

Parameters

$args
public boolean
# hasKey( mixed $key )

Check if a key exists in the ArgMap.

Check if a key exists in the ArgMap.

Alternative syntax:
isset($argmap[$key]);

Parameters

$key
key to check.

Returns

boolean
True if the key exists in the ArgMap, false otherwise.
public string|mixed
# get( mixed $key, mixed $default = null )

Get the value for a key.

Get the value for a key.

Alternative syntax:
$argmap[$key];

Parameters

$key
to get the value for.
$default
to return if the key is not in the ArgMap. Defaults to null.

Returns

string|mixed
The value if found, otherwise $default.
public array
# getArgs( )

Return an array representing the arguments in the ArgMap.

Return an array representing the arguments in the ArgMap.

Returns

array
A regular array representing the arguments in the ArgMap.
public
# offsetExists( $offset )

Implementation of

ArrayAccess::offsetExists()
public
# offsetGet( $offset )

Implementation of

ArrayAccess::offsetGet()
public
# offsetSet( $offset, $value )

Implementation of

ArrayAccess::offsetSet()
public
# offsetUnset( $offset )

Implementation of

ArrayAccess::offsetUnset()
public
# count( )

Implementation of

Countable::count()
public
# getIterator( )

Implementation of

IteratorAggregate::getIterator()
Apptus ESales Connector PHP API documentation generated by ApiGen