Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CDN
      • Resource
    • CloudMonitoring
      • Collection
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Enum
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

  • LoadBalancerIterator
  • Overview
  • Namespace
  • Class
  • Tree

Class LoadBalancerIterator

Class ResourceIterator is tasked with iterating over resource collections - many of which are paginated. Based on a base URL, the iterator will append elements based on further requests to the API. Each time this happens, query parameters (marker) are updated based on the current value.

OpenCloud\Common\ArrayAccess implements ArrayAccess
Extended by OpenCloud\Common\Collection\ArrayCollection implements Countable
Extended by OpenCloud\Common\Collection\ResourceIterator implements Iterator
Extended by OpenCloud\Common\Collection\PaginatedIterator implements Iterator
Extended by OpenCloud\LoadBalancer\Collection\LoadBalancerIterator
Namespace: OpenCloud\LoadBalancer\Collection
Package: OpenCloud\Common\Collection
Since: 1.8.0
Located at OpenCloud/LoadBalancer/Collection/LoadBalancerIterator.php
Methods summary
public Url|string
# constructNextUrl( )

Make the next page URL.

Make the next page URL.

Returns

Url|string
Url|string

Overrides

OpenCloud\Common\Collection\PaginatedIterator::constructNextUrl()
public
# updateMarkerToCurrent( )

Update the current marker based on the current element. The marker will be based on a particular property of this current element, so you must retrieve it first.

Update the current marker based on the current element. The marker will be based on a particular property of this current element, so you must retrieve it first.

Overrides

OpenCloud\Common\Collection\PaginatedIterator::updateMarkerToCurrent()
public array
# parseResponseBody( mixed $body )

Based on the response from the API, parse it for the data we need (i.e. an meaningful array of elements).

Based on the response from the API, parse it for the data we need (i.e. an meaningful array of elements).

Parameters

$body

Returns

array
array

Overrides

OpenCloud\Common\Collection\PaginatedIterator::parseResponseBody()
Methods inherited from OpenCloud\Common\Collection\PaginatedIterator
appendElements(), appendNewCollection(), current(), extractNextLink(), factory(), key(), next(), populateAll(), rewind(), setBaseUrl(), setMarkerFromElement(), shouldAppend(), valid()
Methods inherited from OpenCloud\Common\Collection\ResourceIterator
constructResource(), currentElement(), getElement(), getOption(), getOptions(), parseOptions(), search(), setOption(), setOptions(), setResourceParent(), sort()
Methods inherited from OpenCloud\Common\Collection\ArrayCollection
__construct(), append(), count(), setElements(), valueExists()
Methods inherited from OpenCloud\Common\ArrayAccess
offsetExists(), offsetGet(), offsetSet(), offsetUnset()
Constants inherited from OpenCloud\Common\Collection\PaginatedIterator
LIMIT, MARKER
Properties inherited from OpenCloud\Common\Collection\PaginatedIterator
$currentMarker, $defaults, $nextUrl, $required
Properties inherited from OpenCloud\Common\Collection\ResourceIterator
$options, $position, $resourceParent
Properties inherited from OpenCloud\Common\Collection\ArrayCollection
$elements
API documentation generated by ApiGen 2.8.0