Documentation

Google_Service_Docs_DocumentStyle 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.
$defaultFooterId  : mixed
$defaultHeaderId  : mixed
$evenPageFooterId  : mixed
$evenPageHeaderId  : mixed
$firstPageFooterId  : mixed
$firstPageHeaderId  : mixed
$pageNumberStart  : mixed
$useCustomHeaderFooterMargins  : mixed
$useEvenPageHeaderFooter  : mixed
$useFirstPageHeaderFooter  : mixed
$backgroundDataType  : mixed
$backgroundType  : mixed
$internal_gapi_mappings  : mixed
$marginBottomDataType  : mixed
$marginBottomType  : mixed
$marginFooterDataType  : mixed
$marginFooterType  : mixed
$marginHeaderDataType  : mixed
$marginHeaderType  : mixed
$marginLeftDataType  : mixed
$marginLeftType  : mixed
$marginRightDataType  : mixed
$marginRightType  : mixed
$marginTopDataType  : mixed
$marginTopType  : mixed
$modelData  : mixed
$pageSizeDataType  : mixed
$pageSizeType  : 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.
getBackground()  : Google_Service_Docs_Background
getDefaultFooterId()  : mixed
getDefaultHeaderId()  : mixed
getEvenPageFooterId()  : mixed
getEvenPageHeaderId()  : mixed
getFirstPageFooterId()  : mixed
getFirstPageHeaderId()  : mixed
getMarginBottom()  : Google_Service_Docs_Dimension
getMarginFooter()  : Google_Service_Docs_Dimension
getMarginHeader()  : Google_Service_Docs_Dimension
getMarginLeft()  : Google_Service_Docs_Dimension
getMarginRight()  : Google_Service_Docs_Dimension
getMarginTop()  : Google_Service_Docs_Dimension
getPageNumberStart()  : mixed
getPageSize()  : Google_Service_Docs_Size
getUseCustomHeaderFooterMargins()  : mixed
getUseEvenPageHeaderFooter()  : mixed
getUseFirstPageHeaderFooter()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setBackground()  : mixed
setDefaultFooterId()  : mixed
setDefaultHeaderId()  : mixed
setEvenPageFooterId()  : mixed
setEvenPageHeaderId()  : mixed
setFirstPageFooterId()  : mixed
setFirstPageHeaderId()  : mixed
setMarginBottom()  : mixed
setMarginFooter()  : mixed
setMarginHeader()  : mixed
setMarginLeft()  : mixed
setMarginRight()  : mixed
setMarginTop()  : mixed
setPageNumberStart()  : mixed
setPageSize()  : mixed
setUseCustomHeaderFooterMargins()  : mixed
setUseEvenPageHeaderFooter()  : mixed
setUseFirstPageHeaderFooter()  : 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

$useCustomHeaderFooterMargins

public mixed $useCustomHeaderFooterMargins

$useEvenPageHeaderFooter

public mixed $useEvenPageHeaderFooter

$useFirstPageHeaderFooter

public mixed $useFirstPageHeaderFooter

$backgroundDataType

protected mixed $backgroundDataType = ''

$backgroundType

protected mixed $backgroundType = 'Google_Service_Docs_Background'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$marginBottomDataType

protected mixed $marginBottomDataType = ''

$marginBottomType

protected mixed $marginBottomType = 'Google_Service_Docs_Dimension'

$marginFooterDataType

protected mixed $marginFooterDataType = ''

$marginFooterType

protected mixed $marginFooterType = 'Google_Service_Docs_Dimension'

$marginHeaderDataType

protected mixed $marginHeaderDataType = ''

$marginHeaderType

protected mixed $marginHeaderType = 'Google_Service_Docs_Dimension'

$marginLeftDataType

protected mixed $marginLeftDataType = ''

$marginLeftType

protected mixed $marginLeftType = 'Google_Service_Docs_Dimension'

$marginRightDataType

protected mixed $marginRightDataType = ''

$marginRightType

protected mixed $marginRightType = 'Google_Service_Docs_Dimension'

$marginTopType

protected mixed $marginTopType = 'Google_Service_Docs_Dimension'

$modelData

protected mixed $modelData = array()

$pageSizeType

protected mixed $pageSizeType = 'Google_Service_Docs_Size'

$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 —

getDefaultFooterId()

public getDefaultFooterId() : mixed
Return values
mixed —

getDefaultHeaderId()

public getDefaultHeaderId() : mixed
Return values
mixed —

getEvenPageFooterId()

public getEvenPageFooterId() : mixed
Return values
mixed —

getEvenPageHeaderId()

public getEvenPageHeaderId() : mixed
Return values
mixed —

getFirstPageFooterId()

public getFirstPageFooterId() : mixed
Return values
mixed —

getFirstPageHeaderId()

public getFirstPageHeaderId() : mixed
Return values
mixed —

getPageNumberStart()

public getPageNumberStart() : mixed
Return values
mixed —

getUseCustomHeaderFooterMargins()

public getUseCustomHeaderFooterMargins() : mixed
Return values
mixed —

getUseEvenPageHeaderFooter()

public getUseEvenPageHeaderFooter() : mixed
Return values
mixed —

getUseFirstPageHeaderFooter()

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

setDefaultFooterId()

public setDefaultFooterId(mixed $defaultFooterId) : mixed
Parameters
$defaultFooterId : mixed
Return values
mixed —

setDefaultHeaderId()

public setDefaultHeaderId(mixed $defaultHeaderId) : mixed
Parameters
$defaultHeaderId : mixed
Return values
mixed —

setEvenPageFooterId()

public setEvenPageFooterId(mixed $evenPageFooterId) : mixed
Parameters
$evenPageFooterId : mixed
Return values
mixed —

setEvenPageHeaderId()

public setEvenPageHeaderId(mixed $evenPageHeaderId) : mixed
Parameters
$evenPageHeaderId : mixed
Return values
mixed —

setFirstPageFooterId()

public setFirstPageFooterId(mixed $firstPageFooterId) : mixed
Parameters
$firstPageFooterId : mixed
Return values
mixed —

setFirstPageHeaderId()

public setFirstPageHeaderId(mixed $firstPageHeaderId) : mixed
Parameters
$firstPageHeaderId : mixed
Return values
mixed —

setPageNumberStart()

public setPageNumberStart(mixed $pageNumberStart) : mixed
Parameters
$pageNumberStart : mixed
Return values
mixed —

setUseCustomHeaderFooterMargins()

public setUseCustomHeaderFooterMargins(mixed $useCustomHeaderFooterMargins) : mixed
Parameters
$useCustomHeaderFooterMargins : mixed
Return values
mixed —

setUseEvenPageHeaderFooter()

public setUseEvenPageHeaderFooter(mixed $useEvenPageHeaderFooter) : mixed
Parameters
$useEvenPageHeaderFooter : mixed
Return values
mixed —

setUseFirstPageHeaderFooter()

public setUseFirstPageHeaderFooter(mixed $useFirstPageHeaderFooter) : mixed
Parameters
$useFirstPageHeaderFooter : 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