Documentation

Google_Service_Docs_Document extends Google_Model
in package

This class defines attributes, valid values, and usage which is generated from a given json schema.

http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5

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.
$documentId  : mixed
$revisionId  : mixed
$suggestionsViewMode  : mixed
$title  : mixed
$bodyDataType  : mixed
$bodyType  : mixed
$documentStyleDataType  : mixed
$documentStyleType  : mixed
$footersDataType  : mixed
$footersType  : mixed
$footnotesDataType  : mixed
$footnotesType  : mixed
$headersDataType  : mixed
$headersType  : mixed
$inlineObjectsDataType  : mixed
$inlineObjectsType  : mixed
$internal_gapi_mappings  : mixed
$listsDataType  : mixed
$listsType  : mixed
$modelData  : mixed
$namedRangesDataType  : mixed
$namedRangesType  : mixed
$namedStylesDataType  : mixed
$namedStylesType  : mixed
$positionedObjectsDataType  : mixed
$positionedObjectsType  : mixed
$processed  : mixed
$suggestedDocumentStyleChangesDataType  : mixed
$suggestedDocumentStyleChangesType  : mixed
$suggestedNamedStylesChangesDataType  : mixed
$suggestedNamedStylesChangesType  : 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.
getBody()  : Google_Service_Docs_Body
getDocumentId()  : mixed
getDocumentStyle()  : Google_Service_Docs_DocumentStyle
getFooters()  : Google_Service_Docs_Footer
getFootnotes()  : Google_Service_Docs_Footnote
getHeaders()  : Google_Service_Docs_Header
getInlineObjects()  : Google_Service_Docs_InlineObject
getLists()  : Google_Service_Docs_DocsList
getNamedRanges()  : Google_Service_Docs_NamedRanges
getNamedStyles()  : Google_Service_Docs_NamedStyles
getPositionedObjects()  : Google_Service_Docs_PositionedObject
getRevisionId()  : mixed
getSuggestedDocumentStyleChanges()  : Google_Service_Docs_SuggestedDocumentStyle
getSuggestedNamedStylesChanges()  : Google_Service_Docs_SuggestedNamedStyles
getSuggestionsViewMode()  : mixed
getTitle()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setBody()  : mixed
setDocumentId()  : mixed
setDocumentStyle()  : mixed
setFooters()  : mixed
setFootnotes()  : mixed
setHeaders()  : mixed
setInlineObjects()  : mixed
setLists()  : mixed
setNamedRanges()  : mixed
setNamedStyles()  : mixed
setPositionedObjects()  : mixed
setRevisionId()  : mixed
setSuggestedDocumentStyleChanges()  : mixed
setSuggestedNamedStylesChanges()  : mixed
setSuggestionsViewMode()  : mixed
setTitle()  : 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.
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
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

$suggestionsViewMode

public mixed $suggestionsViewMode

$bodyDataType

protected mixed $bodyDataType = ''

$bodyType

protected mixed $bodyType = 'Google_Service_Docs_Body'

$documentStyleDataType

protected mixed $documentStyleDataType = ''

$documentStyleType

protected mixed $documentStyleType = 'Google_Service_Docs_DocumentStyle'

$footersDataType

protected mixed $footersDataType = 'map'

$footersType

protected mixed $footersType = 'Google_Service_Docs_Footer'

$footnotesDataType

protected mixed $footnotesDataType = 'map'

$footnotesType

protected mixed $footnotesType = 'Google_Service_Docs_Footnote'

$headersDataType

protected mixed $headersDataType = 'map'

$headersType

protected mixed $headersType = 'Google_Service_Docs_Header'

$inlineObjectsDataType

protected mixed $inlineObjectsDataType = 'map'

$inlineObjectsType

protected mixed $inlineObjectsType = 'Google_Service_Docs_InlineObject'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$listsDataType

protected mixed $listsDataType = 'map'

$listsType

protected mixed $listsType = 'Google_Service_Docs_DocsList'

$modelData

protected mixed $modelData = array()

$namedRangesDataType

protected mixed $namedRangesDataType = 'map'

$namedRangesType

protected mixed $namedRangesType = 'Google_Service_Docs_NamedRanges'

$namedStylesDataType

protected mixed $namedStylesDataType = ''

$namedStylesType

protected mixed $namedStylesType = 'Google_Service_Docs_NamedStyles'

$positionedObjectsDataType

protected mixed $positionedObjectsDataType = 'map'

$positionedObjectsType

protected mixed $positionedObjectsType = 'Google_Service_Docs_PositionedObject'

$processed

protected mixed $processed = array()

$suggestedDocumentStyleChangesDataType

protected mixed $suggestedDocumentStyleChangesDataType = 'map'

$suggestedDocumentStyleChangesType

protected mixed $suggestedDocumentStyleChangesType = 'Google_Service_Docs_SuggestedDocumentStyle'

$suggestedNamedStylesChangesDataType

protected mixed $suggestedNamedStylesChangesDataType = 'map'

$suggestedNamedStylesChangesType

protected mixed $suggestedNamedStylesChangesType = 'Google_Service_Docs_SuggestedNamedStyles'

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 —

getDocumentId()

public getDocumentId() : mixed
Return values
mixed —

getRevisionId()

public getRevisionId() : mixed
Return values
mixed —

getSuggestionsViewMode()

public getSuggestionsViewMode() : mixed
Return values
mixed —

getTitle()

public getTitle() : 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 —

setDocumentId()

public setDocumentId(mixed $documentId) : mixed
Parameters
$documentId : mixed
Return values
mixed —

setFooters()

public setFooters(mixed $footers) : mixed
Parameters
$footers : mixed
Return values
mixed —

setFootnotes()

public setFootnotes(mixed $footnotes) : mixed
Parameters
$footnotes : mixed
Return values
mixed —

setHeaders()

public setHeaders(mixed $headers) : mixed
Parameters
$headers : mixed
Return values
mixed —

setInlineObjects()

public setInlineObjects(mixed $inlineObjects) : mixed
Parameters
$inlineObjects : mixed
Return values
mixed —

setLists()

public setLists(mixed $lists) : mixed
Parameters
$lists : mixed
Return values
mixed —

setNamedRanges()

public setNamedRanges(mixed $namedRanges) : mixed
Parameters
$namedRanges : mixed
Return values
mixed —

setPositionedObjects()

public setPositionedObjects(mixed $positionedObjects) : mixed
Parameters
$positionedObjects : mixed
Return values
mixed —

setRevisionId()

public setRevisionId(mixed $revisionId) : mixed
Parameters
$revisionId : mixed
Return values
mixed —

setSuggestedDocumentStyleChanges()

public setSuggestedDocumentStyleChanges(mixed $suggestedDocumentStyleChanges) : mixed
Parameters
$suggestedDocumentStyleChanges : mixed
Return values
mixed —

setSuggestedNamedStylesChanges()

public setSuggestedNamedStylesChanges(mixed $suggestedNamedStylesChanges) : mixed
Parameters
$suggestedNamedStylesChanges : mixed
Return values
mixed —

setSuggestionsViewMode()

public setSuggestionsViewMode(mixed $suggestionsViewMode) : mixed
Parameters
$suggestionsViewMode : mixed
Return values
mixed —

setTitle()

public setTitle(mixed $title) : mixed
Parameters
$title : 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 —

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 —

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