Documentation

Google_Service_CivicInfo_Contest extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

Table of Contents

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
$ballotPlacement  : mixed
$ballotTitle  : mixed
$electorateSpecifications  : mixed
$id  : mixed
$level  : mixed
$numberElected  : mixed
$numberVotingFor  : mixed
$office  : mixed
$primaryParties  : mixed
$primaryParty  : mixed
$referendumBallotResponses  : mixed
$referendumBrief  : mixed
$referendumConStatement  : mixed
$referendumEffectOfAbstain  : mixed
$referendumPassageThreshold  : mixed
$referendumProStatement  : mixed
$referendumSubtitle  : mixed
$referendumText  : mixed
$referendumTitle  : mixed
$referendumUrl  : mixed
$roles  : mixed
$special  : mixed
$type  : mixed
$candidatesDataType  : mixed
$candidatesType  : mixed
$collection_key  : mixed
$districtDataType  : mixed
$districtType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed
$sourcesDataType  : mixed
$sourcesType  : mixed
__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
count()  : mixed
current()  : mixed
getBallotPlacement()  : mixed
getBallotTitle()  : mixed
getCandidates()  : Google_Service_CivicInfo_Candidate
getDistrict()  : Google_Service_CivicInfo_ElectoralDistrict
getElectorateSpecifications()  : mixed
getId()  : mixed
getLevel()  : mixed
getNumberElected()  : mixed
getNumberVotingFor()  : mixed
getOffice()  : mixed
getPrimaryParties()  : mixed
getPrimaryParty()  : mixed
getReferendumBallotResponses()  : mixed
getReferendumBrief()  : mixed
getReferendumConStatement()  : mixed
getReferendumEffectOfAbstain()  : mixed
getReferendumPassageThreshold()  : mixed
getReferendumProStatement()  : mixed
getReferendumSubtitle()  : mixed
getReferendumText()  : mixed
getReferendumTitle()  : mixed
getReferendumUrl()  : mixed
getRoles()  : mixed
getSources()  : Google_Service_CivicInfo_Source
getSpecial()  : mixed
getType()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setBallotPlacement()  : mixed
setBallotTitle()  : mixed
setCandidates()  : mixed
setDistrict()  : mixed
setElectorateSpecifications()  : mixed
setId()  : mixed
setLevel()  : mixed
setNumberElected()  : mixed
setNumberVotingFor()  : mixed
setOffice()  : mixed
setPrimaryParties()  : mixed
setPrimaryParty()  : mixed
setReferendumBallotResponses()  : mixed
setReferendumBrief()  : mixed
setReferendumConStatement()  : mixed
setReferendumEffectOfAbstain()  : mixed
setReferendumPassageThreshold()  : mixed
setReferendumProStatement()  : mixed
setReferendumSubtitle()  : mixed
setReferendumText()  : mixed
setReferendumTitle()  : mixed
setReferendumUrl()  : mixed
setRoles()  : mixed
setSources()  : mixed
setSpecial()  : mixed
setType()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
valid()  : mixed
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
coerceType()  : mixed
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$ballotPlacement

public mixed $ballotPlacement

$ballotTitle

public mixed $ballotTitle

$electorateSpecifications

public mixed $electorateSpecifications

$numberElected

public mixed $numberElected

$numberVotingFor

public mixed $numberVotingFor

$primaryParties

public mixed $primaryParties

$primaryParty

public mixed $primaryParty

$referendumBallotResponses

public mixed $referendumBallotResponses

$referendumBrief

public mixed $referendumBrief

$referendumConStatement

public mixed $referendumConStatement

$referendumEffectOfAbstain

public mixed $referendumEffectOfAbstain

$referendumPassageThreshold

public mixed $referendumPassageThreshold

$referendumProStatement

public mixed $referendumProStatement

$referendumSubtitle

public mixed $referendumSubtitle

$referendumText

public mixed $referendumText

$referendumTitle

public mixed $referendumTitle

$referendumUrl

public mixed $referendumUrl

$candidatesDataType

protected mixed $candidatesDataType = 'array'

$candidatesType

protected mixed $candidatesType = 'Google_Service_CivicInfo_Candidate'

$collection_key

protected mixed $collection_key = 'sources'

$districtDataType

protected mixed $districtDataType = ''

$districtType

protected mixed $districtType = 'Google_Service_CivicInfo_ElectoralDistrict'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$sourcesDataType

protected mixed $sourcesDataType = 'array'

$sourcesType

protected mixed $sourcesType = 'Google_Service_CivicInfo_Source'

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed
Return values
mixed —

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed —

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed —

count()

public count() : mixed
Return values
mixed —

current()

public current() : mixed
Return values
mixed —

getBallotPlacement()

public getBallotPlacement() : mixed
Return values
mixed —

getBallotTitle()

public getBallotTitle() : mixed
Return values
mixed —

getElectorateSpecifications()

public getElectorateSpecifications() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getLevel()

public getLevel() : mixed
Return values
mixed —

getNumberElected()

public getNumberElected() : mixed
Return values
mixed —

getNumberVotingFor()

public getNumberVotingFor() : mixed
Return values
mixed —

getOffice()

public getOffice() : mixed
Return values
mixed —

getPrimaryParties()

public getPrimaryParties() : mixed
Return values
mixed —

getPrimaryParty()

public getPrimaryParty() : mixed
Return values
mixed —

getReferendumBallotResponses()

public getReferendumBallotResponses() : mixed
Return values
mixed —

getReferendumBrief()

public getReferendumBrief() : mixed
Return values
mixed —

getReferendumConStatement()

public getReferendumConStatement() : mixed
Return values
mixed —

getReferendumEffectOfAbstain()

public getReferendumEffectOfAbstain() : mixed
Return values
mixed —

getReferendumPassageThreshold()

public getReferendumPassageThreshold() : mixed
Return values
mixed —

getReferendumProStatement()

public getReferendumProStatement() : mixed
Return values
mixed —

getReferendumSubtitle()

public getReferendumSubtitle() : mixed
Return values
mixed —

getReferendumText()

public getReferendumText() : mixed
Return values
mixed —

getReferendumTitle()

public getReferendumTitle() : mixed
Return values
mixed —

getReferendumUrl()

public getReferendumUrl() : mixed
Return values
mixed —

getRoles()

public getRoles() : mixed
Return values
mixed —

getSpecial()

public getSpecial() : mixed
Return values
mixed —

getType()

public getType() : mixed
Return values
mixed —

key()

public key() : mixed
Return values
mixed —

next()

public next() : mixed
Return values
mixed —

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed —

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

rewind()

public rewind() : mixed
Return values
mixed —

setBallotPlacement()

public setBallotPlacement(mixed $ballotPlacement) : mixed
Parameters
$ballotPlacement : mixed
Return values
mixed —

setBallotTitle()

public setBallotTitle(mixed $ballotTitle) : mixed
Parameters
$ballotTitle : mixed
Return values
mixed —

setCandidates()

public setCandidates(mixed $candidates) : mixed
Parameters
$candidates : mixed
Return values
mixed —

setElectorateSpecifications()

public setElectorateSpecifications(mixed $electorateSpecifications) : mixed
Parameters
$electorateSpecifications : mixed
Return values
mixed —

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed —

setLevel()

public setLevel(mixed $level) : mixed
Parameters
$level : mixed
Return values
mixed —

setNumberElected()

public setNumberElected(mixed $numberElected) : mixed
Parameters
$numberElected : mixed
Return values
mixed —

setNumberVotingFor()

public setNumberVotingFor(mixed $numberVotingFor) : mixed
Parameters
$numberVotingFor : mixed
Return values
mixed —

setOffice()

public setOffice(mixed $office) : mixed
Parameters
$office : mixed
Return values
mixed —

setPrimaryParties()

public setPrimaryParties(mixed $primaryParties) : mixed
Parameters
$primaryParties : mixed
Return values
mixed —

setPrimaryParty()

public setPrimaryParty(mixed $primaryParty) : mixed
Parameters
$primaryParty : mixed
Return values
mixed —

setReferendumBallotResponses()

public setReferendumBallotResponses(mixed $referendumBallotResponses) : mixed
Parameters
$referendumBallotResponses : mixed
Return values
mixed —

setReferendumBrief()

public setReferendumBrief(mixed $referendumBrief) : mixed
Parameters
$referendumBrief : mixed
Return values
mixed —

setReferendumConStatement()

public setReferendumConStatement(mixed $referendumConStatement) : mixed
Parameters
$referendumConStatement : mixed
Return values
mixed —

setReferendumEffectOfAbstain()

public setReferendumEffectOfAbstain(mixed $referendumEffectOfAbstain) : mixed
Parameters
$referendumEffectOfAbstain : mixed
Return values
mixed —

setReferendumPassageThreshold()

public setReferendumPassageThreshold(mixed $referendumPassageThreshold) : mixed
Parameters
$referendumPassageThreshold : mixed
Return values
mixed —

setReferendumProStatement()

public setReferendumProStatement(mixed $referendumProStatement) : mixed
Parameters
$referendumProStatement : mixed
Return values
mixed —

setReferendumSubtitle()

public setReferendumSubtitle(mixed $referendumSubtitle) : mixed
Parameters
$referendumSubtitle : mixed
Return values
mixed —

setReferendumText()

public setReferendumText(mixed $referendumText) : mixed
Parameters
$referendumText : mixed
Return values
mixed —

setReferendumTitle()

public setReferendumTitle(mixed $referendumTitle) : mixed
Parameters
$referendumTitle : mixed
Return values
mixed —

setReferendumUrl()

public setReferendumUrl(mixed $referendumUrl) : mixed
Parameters
$referendumUrl : mixed
Return values
mixed —

setRoles()

public setRoles(mixed $roles) : mixed
Parameters
$roles : mixed
Return values
mixed —

setSources()

public setSources(mixed $sources) : mixed
Parameters
$sources : mixed
Return values
mixed —

setSpecial()

public setSpecial(mixed $special) : mixed
Parameters
$special : mixed
Return values
mixed —

setType()

public setType(mixed $type) : mixed
Parameters
$type : mixed
Return values
mixed —

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed
Return values
mixed —

valid()

public valid() : mixed
Return values
mixed —

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed
Return values
mixed —

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool —

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

Return values
void —

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string —

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

Search results