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 Variant

Represents a product variant.

Apptus\ESales\Connector\Variant implements IteratorAggregate
Namespace: Apptus\ESales\Connector
Located at Connector/Variant.php
Methods summary
public Apptus\ESales\Connector\Attribute
# getAttribute( string $name )

Get the attribute with the specified name or null if no such attribute exists for this variant.

Get the attribute with the specified name or null if no such attribute exists for this variant.

Parameters

$name
The name of the attribute to get.

Returns

Apptus\ESales\Connector\Attribute
The attribute with the specified name or null.
public string
# key( )

Return the key of this variant.

Return the key of this variant.

Returns

string
The key of this variant.
public string|mixed
# getValue( string $attributeName, mixed $defaultValue = null )

Get the value of the attribute with the specified $attributeName. The specified $defaultValue will be returned if no such attribute exists (defaults to null).

Get the value of the attribute with the specified $attributeName. The specified $defaultValue will be returned if no such attribute exists (defaults to null).

Parameters

$attributeName
The name of the attribute whose value to retrieve.
$defaultValue

The value to return if this variant doesn't have an attribute with the specified $attributeName. Defaults to null.

Returns

string|mixed

The attribute value of attribute with the specified $attributeName, or the supplied $defaultValue if this variant has no attribute matching the name.

public string
# getTicket( )

Get the notification ticket of this variant.

Get the notification ticket of this variant.

Returns

string
The ticket.
public
# getIterator( )

Implementation of

IteratorAggregate::getIterator()
public array
# getCategoryReferenceAttributes( )

Get the available category reference attributes in the variant.

Get the available category reference attributes in the variant.

Returns

array
The available category reference attributes in the variant as an array
public array
# getCategories( string $categoryReferenceAttribute )

Get the Category objects of the given category reference attribute.

Get the Category objects of the given category reference attribute.

Parameters

$categoryReferenceAttribute
The category reference attribute to get the categories for

Returns

array
The Category objects of the categoryReferenceAttribute as an array
public
# __toString( )
Apptus ESales Connector PHP API documentation generated by ApiGen