Google_Service_Sheets_CellFormat
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.
- $horizontalAlignment : mixed
- $hyperlinkDisplayType : mixed
- $textDirection : mixed
- $verticalAlignment : mixed
- $wrapStrategy : mixed
- $backgroundColorDataType : mixed
- $backgroundColorStyleDataType : mixed
- $backgroundColorStyleType : mixed
- $backgroundColorType : mixed
- $bordersDataType : mixed
- $bordersType : mixed
- $internal_gapi_mappings : mixed
- $modelData : mixed
- $numberFormatDataType : mixed
- $numberFormatType : mixed
- $paddingDataType : mixed
- $paddingType : mixed
- $processed : mixed
- $textFormatDataType : mixed
- $textFormatType : mixed
- $textRotationDataType : mixed
- $textRotationType : 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.
- getBackgroundColor() : Google_Service_Sheets_Color
- getBackgroundColorStyle() : Google_Service_Sheets_ColorStyle
- getBorders() : Google_Service_Sheets_Borders
- getHorizontalAlignment() : mixed
- getHyperlinkDisplayType() : mixed
- getNumberFormat() : Google_Service_Sheets_NumberFormat
- getPadding() : Google_Service_Sheets_Padding
- getTextDirection() : mixed
- getTextFormat() : Google_Service_Sheets_TextFormat
- getTextRotation() : Google_Service_Sheets_TextRotation
- getVerticalAlignment() : mixed
- getWrapStrategy() : mixed
- offsetExists() : mixed
- offsetGet() : mixed
- offsetSet() : mixed
- offsetUnset() : mixed
- setBackgroundColor() : mixed
- setBackgroundColorStyle() : mixed
- setBorders() : mixed
- setHorizontalAlignment() : mixed
- setHyperlinkDisplayType() : mixed
- setNumberFormat() : mixed
- setPadding() : mixed
- setTextDirection() : mixed
- setTextFormat() : mixed
- setTextRotation() : mixed
- setVerticalAlignment() : mixed
- setWrapStrategy() : 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
$horizontalAlignment
public
mixed
$horizontalAlignment
$hyperlinkDisplayType
public
mixed
$hyperlinkDisplayType
$textDirection
public
mixed
$textDirection
$verticalAlignment
public
mixed
$verticalAlignment
$wrapStrategy
public
mixed
$wrapStrategy
$backgroundColorDataType
protected
mixed
$backgroundColorDataType
= ''
$backgroundColorStyleDataType
protected
mixed
$backgroundColorStyleDataType
= ''
$backgroundColorStyleType
protected
mixed
$backgroundColorStyleType
= 'Google_Service_Sheets_ColorStyle'
$backgroundColorType
protected
mixed
$backgroundColorType
= 'Google_Service_Sheets_Color'
$bordersDataType
protected
mixed
$bordersDataType
= ''
$bordersType
protected
mixed
$bordersType
= 'Google_Service_Sheets_Borders'
$internal_gapi_mappings
protected
mixed
$internal_gapi_mappings
= array()
$modelData
protected
mixed
$modelData
= array()
$numberFormatDataType
protected
mixed
$numberFormatDataType
= ''
$numberFormatType
protected
mixed
$numberFormatType
= 'Google_Service_Sheets_NumberFormat'
$paddingDataType
protected
mixed
$paddingDataType
= ''
$paddingType
protected
mixed
$paddingType
= 'Google_Service_Sheets_Padding'
$processed
protected
mixed
$processed
= array()
$textFormatDataType
protected
mixed
$textFormatDataType
= ''
$textFormatType
protected
mixed
$textFormatType
= 'Google_Service_Sheets_TextFormat'
$textRotationDataType
protected
mixed
$textRotationDataType
= ''
$textRotationType
protected
mixed
$textRotationType
= 'Google_Service_Sheets_TextRotation'
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
Return values
mixed —getBackgroundColor()
public
getBackgroundColor() : Google_Service_Sheets_Color
Return values
Google_Service_Sheets_Color —getBackgroundColorStyle()
public
getBackgroundColorStyle() : Google_Service_Sheets_ColorStyle
Return values
Google_Service_Sheets_ColorStyle —getBorders()
public
getBorders() : Google_Service_Sheets_Borders
Return values
Google_Service_Sheets_Borders —getHorizontalAlignment()
public
getHorizontalAlignment() : mixed
Return values
mixed —getHyperlinkDisplayType()
public
getHyperlinkDisplayType() : mixed
Return values
mixed —getNumberFormat()
public
getNumberFormat() : Google_Service_Sheets_NumberFormat
Return values
Google_Service_Sheets_NumberFormat —getPadding()
public
getPadding() : Google_Service_Sheets_Padding
Return values
Google_Service_Sheets_Padding —getTextDirection()
public
getTextDirection() : mixed
Return values
mixed —getTextFormat()
public
getTextFormat() : Google_Service_Sheets_TextFormat
Return values
Google_Service_Sheets_TextFormat —getTextRotation()
public
getTextRotation() : Google_Service_Sheets_TextRotation
Return values
Google_Service_Sheets_TextRotation —getVerticalAlignment()
public
getVerticalAlignment() : mixed
Return values
mixed —getWrapStrategy()
public
getWrapStrategy() : 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 —setBackgroundColor()
public
setBackgroundColor(Google_Service_Sheets_Color $backgroundColor) : mixed
Parameters
- $backgroundColor : Google_Service_Sheets_Color
Return values
mixed —setBackgroundColorStyle()
public
setBackgroundColorStyle(Google_Service_Sheets_ColorStyle $backgroundColorStyle) : mixed
Parameters
- $backgroundColorStyle : Google_Service_Sheets_ColorStyle
Return values
mixed —setBorders()
public
setBorders(Google_Service_Sheets_Borders $borders) : mixed
Parameters
- $borders : Google_Service_Sheets_Borders
Return values
mixed —setHorizontalAlignment()
public
setHorizontalAlignment(mixed $horizontalAlignment) : mixed
Parameters
- $horizontalAlignment : mixed
Return values
mixed —setHyperlinkDisplayType()
public
setHyperlinkDisplayType(mixed $hyperlinkDisplayType) : mixed
Parameters
- $hyperlinkDisplayType : mixed
Return values
mixed —setNumberFormat()
public
setNumberFormat(Google_Service_Sheets_NumberFormat $numberFormat) : mixed
Parameters
- $numberFormat : Google_Service_Sheets_NumberFormat
Return values
mixed —setPadding()
public
setPadding(Google_Service_Sheets_Padding $padding) : mixed
Parameters
- $padding : Google_Service_Sheets_Padding
Return values
mixed —setTextDirection()
public
setTextDirection(mixed $textDirection) : mixed
Parameters
- $textDirection : mixed
Return values
mixed —setTextFormat()
public
setTextFormat(Google_Service_Sheets_TextFormat $textFormat) : mixed
Parameters
- $textFormat : Google_Service_Sheets_TextFormat
Return values
mixed —setTextRotation()
public
setTextRotation(Google_Service_Sheets_TextRotation $textRotation) : mixed
Parameters
- $textRotation : Google_Service_Sheets_TextRotation
Return values
mixed —setVerticalAlignment()
public
setVerticalAlignment(mixed $verticalAlignment) : mixed
Parameters
- $verticalAlignment : mixed
Return values
mixed —setWrapStrategy()
public
setWrapStrategy(mixed $wrapStrategy) : mixed
Parameters
- $wrapStrategy : 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