Documentation

Google_Service_Classroom_Course extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

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.
$alternateLink  : mixed
$calendarId  : mixed
$courseGroupEmail  : mixed
$courseState  : mixed
$creationTime  : mixed
$description  : mixed
$descriptionHeading  : mixed
$enrollmentCode  : mixed
$guardiansEnabled  : mixed
$id  : mixed
$name  : mixed
$ownerId  : mixed
$room  : mixed
$section  : mixed
$teacherGroupEmail  : mixed
$updateTime  : mixed
$collection_key  : mixed
$courseMaterialSetsDataType  : mixed
$courseMaterialSetsType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed
$teacherFolderDataType  : mixed
$teacherFolderType  : 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.
count()  : mixed
current()  : mixed
getAlternateLink()  : mixed
getCalendarId()  : mixed
getCourseGroupEmail()  : mixed
getCourseMaterialSets()  : Google_Service_Classroom_CourseMaterialSet
getCourseState()  : mixed
getCreationTime()  : mixed
getDescription()  : mixed
getDescriptionHeading()  : mixed
getEnrollmentCode()  : mixed
getGuardiansEnabled()  : mixed
getId()  : mixed
getName()  : mixed
getOwnerId()  : mixed
getRoom()  : mixed
getSection()  : mixed
getTeacherFolder()  : Google_Service_Classroom_DriveFolder
getTeacherGroupEmail()  : mixed
getUpdateTime()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAlternateLink()  : mixed
setCalendarId()  : mixed
setCourseGroupEmail()  : mixed
setCourseMaterialSets()  : mixed
setCourseState()  : mixed
setCreationTime()  : mixed
setDescription()  : mixed
setDescriptionHeading()  : mixed
setEnrollmentCode()  : mixed
setGuardiansEnabled()  : mixed
setId()  : mixed
setName()  : mixed
setOwnerId()  : mixed
setRoom()  : mixed
setSection()  : mixed
setTeacherFolder()  : mixed
setTeacherGroupEmail()  : mixed
setUpdateTime()  : 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.
valid()  : mixed
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
coerceType()  : mixed
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

$alternateLink

public mixed $alternateLink

$calendarId

public mixed $calendarId

$courseGroupEmail

public mixed $courseGroupEmail

$courseState

public mixed $courseState

$creationTime

public mixed $creationTime

$description

public mixed $description

$descriptionHeading

public mixed $descriptionHeading

$enrollmentCode

public mixed $enrollmentCode

$guardiansEnabled

public mixed $guardiansEnabled

$teacherGroupEmail

public mixed $teacherGroupEmail

$updateTime

public mixed $updateTime

$collection_key

protected mixed $collection_key = 'courseMaterialSets'

$courseMaterialSetsDataType

protected mixed $courseMaterialSetsDataType = 'array'

$courseMaterialSetsType

protected mixed $courseMaterialSetsType = 'Google_Service_Classroom_CourseMaterialSet'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$teacherFolderDataType

protected mixed $teacherFolderDataType = ''

$teacherFolderType

protected mixed $teacherFolderType = 'Google_Service_Classroom_DriveFolder'

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 —

count()

public count() : mixed
Return values
mixed —

current()

public current() : mixed
Return values
mixed —

getAlternateLink()

public getAlternateLink() : mixed
Return values
mixed —

getCalendarId()

public getCalendarId() : mixed
Return values
mixed —

getCourseGroupEmail()

public getCourseGroupEmail() : mixed
Return values
mixed —

getCourseState()

public getCourseState() : mixed
Return values
mixed —

getCreationTime()

public getCreationTime() : mixed
Return values
mixed —

getDescription()

public getDescription() : mixed
Return values
mixed —

getDescriptionHeading()

public getDescriptionHeading() : mixed
Return values
mixed —

getEnrollmentCode()

public getEnrollmentCode() : mixed
Return values
mixed —

getGuardiansEnabled()

public getGuardiansEnabled() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getOwnerId()

public getOwnerId() : mixed
Return values
mixed —

getRoom()

public getRoom() : mixed
Return values
mixed —

getSection()

public getSection() : mixed
Return values
mixed —

getTeacherGroupEmail()

public getTeacherGroupEmail() : mixed
Return values
mixed —

getUpdateTime()

public getUpdateTime() : mixed
Return values
mixed —

key()

public key() : mixed
Return values
mixed —

next()

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

rewind()

public rewind() : mixed
Return values
mixed —

setAlternateLink()

public setAlternateLink(mixed $alternateLink) : mixed
Parameters
$alternateLink : mixed
Return values
mixed —

setCalendarId()

public setCalendarId(mixed $calendarId) : mixed
Parameters
$calendarId : mixed
Return values
mixed —

setCourseGroupEmail()

public setCourseGroupEmail(mixed $courseGroupEmail) : mixed
Parameters
$courseGroupEmail : mixed
Return values
mixed —

setCourseMaterialSets()

public setCourseMaterialSets(mixed $courseMaterialSets) : mixed
Parameters
$courseMaterialSets : mixed
Return values
mixed —

setCourseState()

public setCourseState(mixed $courseState) : mixed
Parameters
$courseState : mixed
Return values
mixed —

setCreationTime()

public setCreationTime(mixed $creationTime) : mixed
Parameters
$creationTime : mixed
Return values
mixed —

setDescription()

public setDescription(mixed $description) : mixed
Parameters
$description : mixed
Return values
mixed —

setDescriptionHeading()

public setDescriptionHeading(mixed $descriptionHeading) : mixed
Parameters
$descriptionHeading : mixed
Return values
mixed —

setEnrollmentCode()

public setEnrollmentCode(mixed $enrollmentCode) : mixed
Parameters
$enrollmentCode : mixed
Return values
mixed —

setGuardiansEnabled()

public setGuardiansEnabled(mixed $guardiansEnabled) : mixed
Parameters
$guardiansEnabled : mixed
Return values
mixed —

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed —

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

setOwnerId()

public setOwnerId(mixed $ownerId) : mixed
Parameters
$ownerId : mixed
Return values
mixed —

setRoom()

public setRoom(mixed $room) : mixed
Parameters
$room : mixed
Return values
mixed —

setSection()

public setSection(mixed $section) : mixed
Parameters
$section : mixed
Return values
mixed —

setTeacherGroupEmail()

public setTeacherGroupEmail(mixed $teacherGroupEmail) : mixed
Parameters
$teacherGroupEmail : mixed
Return values
mixed —

setUpdateTime()

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

valid()

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

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

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