PHPFUI/InstaDoc
 
Copied!

Holds the description information used for page streaming.

CloneableInstantiable
Methods
public __construct(array $descriptor)
 
  • param array $descriptor { Required. @type string $requestPageTokenGetMethod the get method for the page token in the request object. @type string $requestPageTokenSetMethod the set method for the page token in the request object. @type string $responsePageTokenGetMethod the get method for the page token in the response object. @type string resourcesGetMethod the get method for the resources in the response object. 
    Optional.
@type string $requestPageSizeGetMethod the get method for the page size in the request object.
    }
public static createFromFields(array $fields)
 
  • param array $fields { Required. 
    @type string $requestPageTokenField the page token field in the request object.
@type string $responsePageTokenField the page token field in the response object.
@type string $resourceField the resource field in the response object.

Optional.
@type string $requestPageSizeField the page size field in the request object.
    }
  • return \PageStreamingDescriptor
public getRequestPageSizeGetMethod()
 
  • return string The page size get method on the request object
public getRequestPageSizeSetMethod()
 
  • return string The page size set method on the request object
public getRequestPageTokenGetMethod()
 
  • return string The page token get method on the request object
public getRequestPageTokenSetMethod()
 
  • return string The page token set method on the request object
public getResourcesGetMethod()
 
  • return string The resources get method on the response object
public getResponsePageTokenGetMethod()
 
  • return string The page token get method on the response object
public requestHasPageSizeField()
 
  • return bool True if the request object has a page size field
Properties
private $descriptor = NULL
Methods
private static getMethod(string $field)
private static setMethod(string $field)
private static validate(array $descriptor)
Methods
public static createFromFields(array $fields)
 
  • param array $fields { Required. 
    @type string $requestPageTokenField the page token field in the request object.
@type string $responsePageTokenField the page token field in the response object.
@type string $resourceField the resource field in the response object.

Optional.
@type string $requestPageSizeField the page size field in the request object.
    }
  • return \PageStreamingDescriptor
private static getMethod(string $field)
private static setMethod(string $field)
private static validate(array $descriptor)
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration