Documentation

Google_Service_Sheets_Sheet 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.
$bandedRangesDataType  : mixed
$bandedRangesType  : mixed
$basicFilterDataType  : mixed
$basicFilterType  : mixed
$chartsDataType  : mixed
$chartsType  : mixed
$collection_key  : mixed
$columnGroupsDataType  : mixed
$columnGroupsType  : mixed
$conditionalFormatsDataType  : mixed
$conditionalFormatsType  : mixed
$dataDataType  : mixed
$dataType  : mixed
$developerMetadataDataType  : mixed
$developerMetadataType  : mixed
$filterViewsDataType  : mixed
$filterViewsType  : mixed
$internal_gapi_mappings  : mixed
$mergesDataType  : mixed
$mergesType  : mixed
$modelData  : mixed
$processed  : mixed
$propertiesDataType  : mixed
$propertiesType  : mixed
$protectedRangesDataType  : mixed
$protectedRangesType  : mixed
$rowGroupsDataType  : mixed
$rowGroupsType  : mixed
$slicersDataType  : mixed
$slicersType  : 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
getBandedRanges()  : Google_Service_Sheets_BandedRange
getBasicFilter()  : Google_Service_Sheets_BasicFilter
getCharts()  : Google_Service_Sheets_EmbeddedChart
getColumnGroups()  : Google_Service_Sheets_DimensionGroup
getConditionalFormats()  : Google_Service_Sheets_ConditionalFormatRule
getData()  : Google_Service_Sheets_GridData
getDeveloperMetadata()  : Google_Service_Sheets_DeveloperMetadata
getFilterViews()  : Google_Service_Sheets_FilterView
getMerges()  : Google_Service_Sheets_GridRange
getProperties()  : Google_Service_Sheets_SheetProperties
getProtectedRanges()  : Google_Service_Sheets_ProtectedRange
getRowGroups()  : Google_Service_Sheets_DimensionGroup
getSlicers()  : Google_Service_Sheets_Slicer
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setBandedRanges()  : mixed
setBasicFilter()  : mixed
setCharts()  : mixed
setColumnGroups()  : mixed
setConditionalFormats()  : mixed
setData()  : mixed
setDeveloperMetadata()  : mixed
setFilterViews()  : mixed
setMerges()  : mixed
setProperties()  : mixed
setProtectedRanges()  : mixed
setRowGroups()  : mixed
setSlicers()  : 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

$bandedRangesDataType

protected mixed $bandedRangesDataType = 'array'

$bandedRangesType

protected mixed $bandedRangesType = 'Google_Service_Sheets_BandedRange'

$basicFilterDataType

protected mixed $basicFilterDataType = ''

$basicFilterType

protected mixed $basicFilterType = 'Google_Service_Sheets_BasicFilter'

$chartsDataType

protected mixed $chartsDataType = 'array'

$chartsType

protected mixed $chartsType = 'Google_Service_Sheets_EmbeddedChart'

$collection_key

protected mixed $collection_key = 'slicers'

$columnGroupsDataType

protected mixed $columnGroupsDataType = 'array'

$columnGroupsType

protected mixed $columnGroupsType = 'Google_Service_Sheets_DimensionGroup'

$conditionalFormatsDataType

protected mixed $conditionalFormatsDataType = 'array'

$conditionalFormatsType

protected mixed $conditionalFormatsType = 'Google_Service_Sheets_ConditionalFormatRule'

$dataDataType

protected mixed $dataDataType = 'array'

$dataType

protected mixed $dataType = 'Google_Service_Sheets_GridData'

$developerMetadataDataType

protected mixed $developerMetadataDataType = 'array'

$developerMetadataType

protected mixed $developerMetadataType = 'Google_Service_Sheets_DeveloperMetadata'

$filterViewsDataType

protected mixed $filterViewsDataType = 'array'

$filterViewsType

protected mixed $filterViewsType = 'Google_Service_Sheets_FilterView'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$mergesDataType

protected mixed $mergesDataType = 'array'

$mergesType

protected mixed $mergesType = 'Google_Service_Sheets_GridRange'

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$propertiesDataType

protected mixed $propertiesDataType = ''

$propertiesType

protected mixed $propertiesType = 'Google_Service_Sheets_SheetProperties'

$protectedRangesDataType

protected mixed $protectedRangesDataType = 'array'

$protectedRangesType

protected mixed $protectedRangesType = 'Google_Service_Sheets_ProtectedRange'

$rowGroupsDataType

protected mixed $rowGroupsDataType = 'array'

$rowGroupsType

protected mixed $rowGroupsType = 'Google_Service_Sheets_DimensionGroup'

$slicersDataType

protected mixed $slicersDataType = 'array'

$slicersType

protected mixed $slicersType = 'Google_Service_Sheets_Slicer'

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 —

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 —

setBandedRanges()

public setBandedRanges(mixed $bandedRanges) : mixed
Parameters
$bandedRanges : mixed
Return values
mixed —

setCharts()

public setCharts(mixed $charts) : mixed
Parameters
$charts : mixed
Return values
mixed —

setColumnGroups()

public setColumnGroups(mixed $columnGroups) : mixed
Parameters
$columnGroups : mixed
Return values
mixed —

setConditionalFormats()

public setConditionalFormats(mixed $conditionalFormats) : mixed
Parameters
$conditionalFormats : mixed
Return values
mixed —

setData()

public setData(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed —

setDeveloperMetadata()

public setDeveloperMetadata(mixed $developerMetadata) : mixed
Parameters
$developerMetadata : mixed
Return values
mixed —

setFilterViews()

public setFilterViews(mixed $filterViews) : mixed
Parameters
$filterViews : mixed
Return values
mixed —

setMerges()

public setMerges(mixed $merges) : mixed
Parameters
$merges : mixed
Return values
mixed —

setProtectedRanges()

public setProtectedRanges(mixed $protectedRanges) : mixed
Parameters
$protectedRanges : mixed
Return values
mixed —

setRowGroups()

public setRowGroups(mixed $rowGroups) : mixed
Parameters
$rowGroups : mixed
Return values
mixed —

setSlicers()

public setSlicers(mixed $slicers) : mixed
Parameters
$slicers : 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