Documentation

Google_Service_CivicInfo_Resource_Representatives extends Google_Service_Resource
in package

The "representatives" collection of methods.

Typical usage is: $civicinfoService = new Google_Service_CivicInfo(...); $representatives = $civicinfoService->representatives;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
representativeInfoByAddress()  : Google_Service_CivicInfo_RepresentativeInfoResponse
Looks up political geography and representative information for a single address. (representatives.representativeInfoByAddress)
representativeInfoByDivision()  : Google_Service_CivicInfo_RepresentativeInfoData
Looks up representative information for a single geographic division.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

representativeInfoByAddress()

Looks up political geography and representative information for a single address. (representatives.representativeInfoByAddress)

public representativeInfoByAddress([array<string|int, mixed> $optParams = array() ]) : Google_Service_CivicInfo_RepresentativeInfoResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool includeOffices Whether to return information about offices and officials. If false, only the top-level district information will be returned.

opt_param

string levels A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.

opt_param

string roles A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.

opt_param

string address The address to look up. May only be specified if the field ocdId is not given in the URL

Return values
Google_Service_CivicInfo_RepresentativeInfoResponse —

representativeInfoByDivision()

Looks up representative information for a single geographic division.

public representativeInfoByDivision(string $ocdId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CivicInfo_RepresentativeInfoData

(representatives.representativeInfoByDivision)

Parameters
$ocdId : string

The Open Civic Data division identifier of the division to look up.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string roles A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.

opt_param

bool recursive If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.

opt_param

string levels A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.

Return values
Google_Service_CivicInfo_RepresentativeInfoData —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results