Documentation

Google_Service_Docs_Request 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.
$createFooterDataType  : mixed
$createFooterType  : mixed
$createFootnoteDataType  : mixed
$createFootnoteType  : mixed
$createHeaderDataType  : mixed
$createHeaderType  : mixed
$createNamedRangeDataType  : mixed
$createNamedRangeType  : mixed
$createParagraphBulletsDataType  : mixed
$createParagraphBulletsType  : mixed
$deleteContentRangeDataType  : mixed
$deleteContentRangeType  : mixed
$deleteFooterDataType  : mixed
$deleteFooterType  : mixed
$deleteHeaderDataType  : mixed
$deleteHeaderType  : mixed
$deleteNamedRangeDataType  : mixed
$deleteNamedRangeType  : mixed
$deleteParagraphBulletsDataType  : mixed
$deleteParagraphBulletsType  : mixed
$deletePositionedObjectDataType  : mixed
$deletePositionedObjectType  : mixed
$deleteTableColumnDataType  : mixed
$deleteTableColumnType  : mixed
$deleteTableRowDataType  : mixed
$deleteTableRowType  : mixed
$insertInlineImageDataType  : mixed
$insertInlineImageType  : mixed
$insertPageBreakDataType  : mixed
$insertPageBreakType  : mixed
$insertSectionBreakDataType  : mixed
$insertSectionBreakType  : mixed
$insertTableColumnDataType  : mixed
$insertTableColumnType  : mixed
$insertTableDataType  : mixed
$insertTableRowDataType  : mixed
$insertTableRowType  : mixed
$insertTableType  : mixed
$insertTextDataType  : mixed
$insertTextType  : mixed
$internal_gapi_mappings  : mixed
$mergeTableCellsDataType  : mixed
$mergeTableCellsType  : mixed
$modelData  : mixed
$processed  : mixed
$replaceAllTextDataType  : mixed
$replaceAllTextType  : mixed
$replaceImageDataType  : mixed
$replaceImageType  : mixed
$replaceNamedRangeContentDataType  : mixed
$replaceNamedRangeContentType  : mixed
$unmergeTableCellsDataType  : mixed
$unmergeTableCellsType  : mixed
$updateDocumentStyleDataType  : mixed
$updateDocumentStyleType  : mixed
$updateParagraphStyleDataType  : mixed
$updateParagraphStyleType  : mixed
$updateSectionStyleDataType  : mixed
$updateSectionStyleType  : mixed
$updateTableCellStyleDataType  : mixed
$updateTableCellStyleType  : mixed
$updateTableColumnPropertiesDataType  : mixed
$updateTableColumnPropertiesType  : mixed
$updateTableRowStyleDataType  : mixed
$updateTableRowStyleType  : mixed
$updateTextStyleDataType  : mixed
$updateTextStyleType  : 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.
getCreateFooter()  : Google_Service_Docs_CreateFooterRequest
getCreateFootnote()  : Google_Service_Docs_CreateFootnoteRequest
getCreateHeader()  : Google_Service_Docs_CreateHeaderRequest
getCreateNamedRange()  : Google_Service_Docs_CreateNamedRangeRequest
getCreateParagraphBullets()  : Google_Service_Docs_CreateParagraphBulletsRequest
getDeleteContentRange()  : Google_Service_Docs_DeleteContentRangeRequest
getDeleteFooter()  : Google_Service_Docs_DeleteFooterRequest
getDeleteHeader()  : Google_Service_Docs_DeleteHeaderRequest
getDeleteNamedRange()  : Google_Service_Docs_DeleteNamedRangeRequest
getDeleteParagraphBullets()  : Google_Service_Docs_DeleteParagraphBulletsRequest
getDeletePositionedObject()  : Google_Service_Docs_DeletePositionedObjectRequest
getDeleteTableColumn()  : Google_Service_Docs_DeleteTableColumnRequest
getDeleteTableRow()  : Google_Service_Docs_DeleteTableRowRequest
getInsertInlineImage()  : Google_Service_Docs_InsertInlineImageRequest
getInsertPageBreak()  : Google_Service_Docs_InsertPageBreakRequest
getInsertSectionBreak()  : Google_Service_Docs_InsertSectionBreakRequest
getInsertTable()  : Google_Service_Docs_InsertTableRequest
getInsertTableColumn()  : Google_Service_Docs_InsertTableColumnRequest
getInsertTableRow()  : Google_Service_Docs_InsertTableRowRequest
getInsertText()  : Google_Service_Docs_InsertTextRequest
getMergeTableCells()  : Google_Service_Docs_MergeTableCellsRequest
getReplaceAllText()  : Google_Service_Docs_ReplaceAllTextRequest
getReplaceImage()  : Google_Service_Docs_ReplaceImageRequest
getReplaceNamedRangeContent()  : Google_Service_Docs_ReplaceNamedRangeContentRequest
getUnmergeTableCells()  : Google_Service_Docs_UnmergeTableCellsRequest
getUpdateDocumentStyle()  : Google_Service_Docs_UpdateDocumentStyleRequest
getUpdateParagraphStyle()  : Google_Service_Docs_UpdateParagraphStyleRequest
getUpdateSectionStyle()  : Google_Service_Docs_UpdateSectionStyleRequest
getUpdateTableCellStyle()  : Google_Service_Docs_UpdateTableCellStyleRequest
getUpdateTableColumnProperties()  : Google_Service_Docs_UpdateTableColumnPropertiesRequest
getUpdateTableRowStyle()  : Google_Service_Docs_UpdateTableRowStyleRequest
getUpdateTextStyle()  : Google_Service_Docs_UpdateTextStyleRequest
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setCreateFooter()  : mixed
setCreateFootnote()  : mixed
setCreateHeader()  : mixed
setCreateNamedRange()  : mixed
setCreateParagraphBullets()  : mixed
setDeleteContentRange()  : mixed
setDeleteFooter()  : mixed
setDeleteHeader()  : mixed
setDeleteNamedRange()  : mixed
setDeleteParagraphBullets()  : mixed
setDeletePositionedObject()  : mixed
setDeleteTableColumn()  : mixed
setDeleteTableRow()  : mixed
setInsertInlineImage()  : mixed
setInsertPageBreak()  : mixed
setInsertSectionBreak()  : mixed
setInsertTable()  : mixed
setInsertTableColumn()  : mixed
setInsertTableRow()  : mixed
setInsertText()  : mixed
setMergeTableCells()  : mixed
setReplaceAllText()  : mixed
setReplaceImage()  : mixed
setReplaceNamedRangeContent()  : mixed
setUnmergeTableCells()  : mixed
setUpdateDocumentStyle()  : mixed
setUpdateParagraphStyle()  : mixed
setUpdateSectionStyle()  : mixed
setUpdateTableCellStyle()  : mixed
setUpdateTableColumnProperties()  : mixed
setUpdateTableRowStyle()  : mixed
setUpdateTextStyle()  : 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

$createFooterDataType

protected mixed $createFooterDataType = ''

$createFooterType

protected mixed $createFooterType = 'Google_Service_Docs_CreateFooterRequest'

$createFootnoteDataType

protected mixed $createFootnoteDataType = ''

$createFootnoteType

protected mixed $createFootnoteType = 'Google_Service_Docs_CreateFootnoteRequest'

$createHeaderDataType

protected mixed $createHeaderDataType = ''

$createHeaderType

protected mixed $createHeaderType = 'Google_Service_Docs_CreateHeaderRequest'

$createNamedRangeDataType

protected mixed $createNamedRangeDataType = ''

$createNamedRangeType

protected mixed $createNamedRangeType = 'Google_Service_Docs_CreateNamedRangeRequest'

$createParagraphBulletsDataType

protected mixed $createParagraphBulletsDataType = ''

$createParagraphBulletsType

protected mixed $createParagraphBulletsType = 'Google_Service_Docs_CreateParagraphBulletsRequest'

$deleteContentRangeDataType

protected mixed $deleteContentRangeDataType = ''

$deleteContentRangeType

protected mixed $deleteContentRangeType = 'Google_Service_Docs_DeleteContentRangeRequest'

$deleteFooterDataType

protected mixed $deleteFooterDataType = ''

$deleteFooterType

protected mixed $deleteFooterType = 'Google_Service_Docs_DeleteFooterRequest'

$deleteHeaderDataType

protected mixed $deleteHeaderDataType = ''

$deleteHeaderType

protected mixed $deleteHeaderType = 'Google_Service_Docs_DeleteHeaderRequest'

$deleteNamedRangeDataType

protected mixed $deleteNamedRangeDataType = ''

$deleteNamedRangeType

protected mixed $deleteNamedRangeType = 'Google_Service_Docs_DeleteNamedRangeRequest'

$deleteParagraphBulletsDataType

protected mixed $deleteParagraphBulletsDataType = ''

$deleteParagraphBulletsType

protected mixed $deleteParagraphBulletsType = 'Google_Service_Docs_DeleteParagraphBulletsRequest'

$deletePositionedObjectDataType

protected mixed $deletePositionedObjectDataType = ''

$deletePositionedObjectType

protected mixed $deletePositionedObjectType = 'Google_Service_Docs_DeletePositionedObjectRequest'

$deleteTableColumnDataType

protected mixed $deleteTableColumnDataType = ''

$deleteTableColumnType

protected mixed $deleteTableColumnType = 'Google_Service_Docs_DeleteTableColumnRequest'

$deleteTableRowDataType

protected mixed $deleteTableRowDataType = ''

$deleteTableRowType

protected mixed $deleteTableRowType = 'Google_Service_Docs_DeleteTableRowRequest'

$insertInlineImageDataType

protected mixed $insertInlineImageDataType = ''

$insertInlineImageType

protected mixed $insertInlineImageType = 'Google_Service_Docs_InsertInlineImageRequest'

$insertPageBreakDataType

protected mixed $insertPageBreakDataType = ''

$insertPageBreakType

protected mixed $insertPageBreakType = 'Google_Service_Docs_InsertPageBreakRequest'

$insertSectionBreakDataType

protected mixed $insertSectionBreakDataType = ''

$insertSectionBreakType

protected mixed $insertSectionBreakType = 'Google_Service_Docs_InsertSectionBreakRequest'

$insertTableColumnDataType

protected mixed $insertTableColumnDataType = ''

$insertTableColumnType

protected mixed $insertTableColumnType = 'Google_Service_Docs_InsertTableColumnRequest'

$insertTableDataType

protected mixed $insertTableDataType = ''

$insertTableRowDataType

protected mixed $insertTableRowDataType = ''

$insertTableRowType

protected mixed $insertTableRowType = 'Google_Service_Docs_InsertTableRowRequest'

$insertTableType

protected mixed $insertTableType = 'Google_Service_Docs_InsertTableRequest'

$insertTextDataType

protected mixed $insertTextDataType = ''

$insertTextType

protected mixed $insertTextType = 'Google_Service_Docs_InsertTextRequest'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$mergeTableCellsDataType

protected mixed $mergeTableCellsDataType = ''

$mergeTableCellsType

protected mixed $mergeTableCellsType = 'Google_Service_Docs_MergeTableCellsRequest'

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$replaceAllTextDataType

protected mixed $replaceAllTextDataType = ''

$replaceAllTextType

protected mixed $replaceAllTextType = 'Google_Service_Docs_ReplaceAllTextRequest'

$replaceImageDataType

protected mixed $replaceImageDataType = ''

$replaceImageType

protected mixed $replaceImageType = 'Google_Service_Docs_ReplaceImageRequest'

$replaceNamedRangeContentDataType

protected mixed $replaceNamedRangeContentDataType = ''

$replaceNamedRangeContentType

protected mixed $replaceNamedRangeContentType = 'Google_Service_Docs_ReplaceNamedRangeContentRequest'

$unmergeTableCellsDataType

protected mixed $unmergeTableCellsDataType = ''

$unmergeTableCellsType

protected mixed $unmergeTableCellsType = 'Google_Service_Docs_UnmergeTableCellsRequest'

$updateDocumentStyleDataType

protected mixed $updateDocumentStyleDataType = ''

$updateDocumentStyleType

protected mixed $updateDocumentStyleType = 'Google_Service_Docs_UpdateDocumentStyleRequest'

$updateParagraphStyleDataType

protected mixed $updateParagraphStyleDataType = ''

$updateParagraphStyleType

protected mixed $updateParagraphStyleType = 'Google_Service_Docs_UpdateParagraphStyleRequest'

$updateSectionStyleDataType

protected mixed $updateSectionStyleDataType = ''

$updateSectionStyleType

protected mixed $updateSectionStyleType = 'Google_Service_Docs_UpdateSectionStyleRequest'

$updateTableCellStyleDataType

protected mixed $updateTableCellStyleDataType = ''

$updateTableCellStyleType

protected mixed $updateTableCellStyleType = 'Google_Service_Docs_UpdateTableCellStyleRequest'

$updateTableColumnPropertiesDataType

protected mixed $updateTableColumnPropertiesDataType = ''

$updateTableColumnPropertiesType

protected mixed $updateTableColumnPropertiesType = 'Google_Service_Docs_UpdateTableColumnPropertiesRequest'

$updateTableRowStyleDataType

protected mixed $updateTableRowStyleDataType = ''

$updateTableRowStyleType

protected mixed $updateTableRowStyleType = 'Google_Service_Docs_UpdateTableRowStyleRequest'

$updateTextStyleDataType

protected mixed $updateTextStyleDataType = ''

$updateTextStyleType

protected mixed $updateTextStyleType = 'Google_Service_Docs_UpdateTextStyleRequest'

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 —

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 —

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