Documentation

Google_Service_Docs_DocumentStyleSuggestionState 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.
$defaultFooterIdSuggested  : mixed
$defaultHeaderIdSuggested  : mixed
$evenPageFooterIdSuggested  : mixed
$evenPageHeaderIdSuggested  : mixed
$firstPageFooterIdSuggested  : mixed
$firstPageHeaderIdSuggested  : mixed
$marginBottomSuggested  : mixed
$marginFooterSuggested  : mixed
$marginHeaderSuggested  : mixed
$marginLeftSuggested  : mixed
$marginRightSuggested  : mixed
$marginTopSuggested  : mixed
$pageNumberStartSuggested  : mixed
$useCustomHeaderFooterMarginsSuggested  : mixed
$useEvenPageHeaderFooterSuggested  : mixed
$useFirstPageHeaderFooterSuggested  : mixed
$backgroundSuggestionStateDataType  : mixed
$backgroundSuggestionStateType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$pageSizeSuggestionStateDataType  : mixed
$pageSizeSuggestionStateType  : mixed
$processed  : 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.
getBackgroundSuggestionState()  : Google_Service_Docs_BackgroundSuggestionState
getDefaultFooterIdSuggested()  : mixed
getDefaultHeaderIdSuggested()  : mixed
getEvenPageFooterIdSuggested()  : mixed
getEvenPageHeaderIdSuggested()  : mixed
getFirstPageFooterIdSuggested()  : mixed
getFirstPageHeaderIdSuggested()  : mixed
getMarginBottomSuggested()  : mixed
getMarginFooterSuggested()  : mixed
getMarginHeaderSuggested()  : mixed
getMarginLeftSuggested()  : mixed
getMarginRightSuggested()  : mixed
getMarginTopSuggested()  : mixed
getPageNumberStartSuggested()  : mixed
getPageSizeSuggestionState()  : Google_Service_Docs_SizeSuggestionState
getUseCustomHeaderFooterMarginsSuggested()  : mixed
getUseEvenPageHeaderFooterSuggested()  : mixed
getUseFirstPageHeaderFooterSuggested()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setBackgroundSuggestionState()  : mixed
setDefaultFooterIdSuggested()  : mixed
setDefaultHeaderIdSuggested()  : mixed
setEvenPageFooterIdSuggested()  : mixed
setEvenPageHeaderIdSuggested()  : mixed
setFirstPageFooterIdSuggested()  : mixed
setFirstPageHeaderIdSuggested()  : mixed
setMarginBottomSuggested()  : mixed
setMarginFooterSuggested()  : mixed
setMarginHeaderSuggested()  : mixed
setMarginLeftSuggested()  : mixed
setMarginRightSuggested()  : mixed
setMarginTopSuggested()  : mixed
setPageNumberStartSuggested()  : mixed
setPageSizeSuggestionState()  : mixed
setUseCustomHeaderFooterMarginsSuggested()  : mixed
setUseEvenPageHeaderFooterSuggested()  : mixed
setUseFirstPageHeaderFooterSuggested()  : 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

$backgroundSuggestionStateType

protected mixed $backgroundSuggestionStateType = 'Google_Service_Docs_BackgroundSuggestionState'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

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 —

getUseCustomHeaderFooterMarginsSuggested()

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

setDefaultFooterIdSuggested()

public setDefaultFooterIdSuggested(mixed $defaultFooterIdSuggested) : mixed
Parameters
$defaultFooterIdSuggested : mixed
Return values
mixed —

setDefaultHeaderIdSuggested()

public setDefaultHeaderIdSuggested(mixed $defaultHeaderIdSuggested) : mixed
Parameters
$defaultHeaderIdSuggested : mixed
Return values
mixed —

setEvenPageFooterIdSuggested()

public setEvenPageFooterIdSuggested(mixed $evenPageFooterIdSuggested) : mixed
Parameters
$evenPageFooterIdSuggested : mixed
Return values
mixed —

setEvenPageHeaderIdSuggested()

public setEvenPageHeaderIdSuggested(mixed $evenPageHeaderIdSuggested) : mixed
Parameters
$evenPageHeaderIdSuggested : mixed
Return values
mixed —

setFirstPageFooterIdSuggested()

public setFirstPageFooterIdSuggested(mixed $firstPageFooterIdSuggested) : mixed
Parameters
$firstPageFooterIdSuggested : mixed
Return values
mixed —

setFirstPageHeaderIdSuggested()

public setFirstPageHeaderIdSuggested(mixed $firstPageHeaderIdSuggested) : mixed
Parameters
$firstPageHeaderIdSuggested : mixed
Return values
mixed —

setMarginBottomSuggested()

public setMarginBottomSuggested(mixed $marginBottomSuggested) : mixed
Parameters
$marginBottomSuggested : mixed
Return values
mixed —

setMarginFooterSuggested()

public setMarginFooterSuggested(mixed $marginFooterSuggested) : mixed
Parameters
$marginFooterSuggested : mixed
Return values
mixed —

setMarginHeaderSuggested()

public setMarginHeaderSuggested(mixed $marginHeaderSuggested) : mixed
Parameters
$marginHeaderSuggested : mixed
Return values
mixed —

setMarginLeftSuggested()

public setMarginLeftSuggested(mixed $marginLeftSuggested) : mixed
Parameters
$marginLeftSuggested : mixed
Return values
mixed —

setMarginRightSuggested()

public setMarginRightSuggested(mixed $marginRightSuggested) : mixed
Parameters
$marginRightSuggested : mixed
Return values
mixed —

setMarginTopSuggested()

public setMarginTopSuggested(mixed $marginTopSuggested) : mixed
Parameters
$marginTopSuggested : mixed
Return values
mixed —

setPageNumberStartSuggested()

public setPageNumberStartSuggested(mixed $pageNumberStartSuggested) : mixed
Parameters
$pageNumberStartSuggested : mixed
Return values
mixed —

setUseCustomHeaderFooterMarginsSuggested()

public setUseCustomHeaderFooterMarginsSuggested(mixed $useCustomHeaderFooterMarginsSuggested) : mixed
Parameters
$useCustomHeaderFooterMarginsSuggested : mixed
Return values
mixed —

setUseEvenPageHeaderFooterSuggested()

public setUseEvenPageHeaderFooterSuggested(mixed $useEvenPageHeaderFooterSuggested) : mixed
Parameters
$useEvenPageHeaderFooterSuggested : mixed
Return values
mixed —

setUseFirstPageHeaderFooterSuggested()

public setUseFirstPageHeaderFooterSuggested(mixed $useFirstPageHeaderFooterSuggested) : mixed
Parameters
$useFirstPageHeaderFooterSuggested : 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