Documentation

DriveFile extends 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

Constants

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.

Properties

$appProperties  : mixed
$copyRequiresWriterPermission  : mixed
$createdTime  : mixed
$description  : mixed
$driveId  : mixed
$explicitlyTrashed  : mixed
$exportLinks  : mixed
$fileExtension  : mixed
$folderColorRgb  : mixed
$fullFileExtension  : mixed
$hasAugmentedPermissions  : mixed
$hasThumbnail  : mixed
$headRevisionId  : mixed
$iconLink  : mixed
$id  : mixed
$isAppAuthorized  : mixed
$kind  : mixed
$md5Checksum  : mixed
$mimeType  : mixed
$modifiedByMe  : mixed
$modifiedByMeTime  : mixed
$modifiedTime  : mixed
$name  : mixed
$originalFilename  : mixed
$ownedByMe  : mixed
$parents  : mixed
$permissionIds  : mixed
$properties  : mixed
$quotaBytesUsed  : mixed
$resourceKey  : mixed
$shared  : mixed
$sharedWithMeTime  : mixed
$size  : mixed
$spaces  : mixed
$starred  : mixed
$teamDriveId  : mixed
$thumbnailLink  : mixed
$thumbnailVersion  : mixed
$trashed  : mixed
$trashedTime  : mixed
$version  : mixed
$viewedByMe  : mixed
$viewedByMeTime  : mixed
$viewersCanCopyContent  : mixed
$webContentLink  : mixed
$webViewLink  : mixed
$writersCanShare  : mixed
$capabilitiesDataType  : mixed
$capabilitiesType  : mixed
$collection_key  : mixed
$contentHintsDataType  : mixed
$contentHintsType  : mixed
$contentRestrictionsDataType  : mixed
$contentRestrictionsType  : mixed
$imageMediaMetadataDataType  : mixed
$imageMediaMetadataType  : mixed
$internal_gapi_mappings  : mixed
$lastModifyingUserDataType  : mixed
$lastModifyingUserType  : mixed
$linkShareMetadataDataType  : mixed
$linkShareMetadataType  : mixed
$modelData  : mixed
$ownersDataType  : mixed
$ownersType  : mixed
$permissionsDataType  : mixed
$permissionsType  : mixed
$processed  : mixed
$sharingUserDataType  : mixed
$sharingUserType  : mixed
$shortcutDetailsDataType  : mixed
$shortcutDetailsType  : mixed
$trashingUserDataType  : mixed
$trashingUserType  : mixed
$videoMediaMetadataDataType  : mixed
$videoMediaMetadataType  : mixed

Methods

__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
getAppProperties()  : mixed
getCapabilities()  : DriveFileCapabilities
getContentHints()  : DriveFileContentHints
getContentRestrictions()  : array<string|int, ContentRestriction>
getCopyRequiresWriterPermission()  : mixed
getCreatedTime()  : mixed
getDescription()  : mixed
getDriveId()  : mixed
getExplicitlyTrashed()  : mixed
getExportLinks()  : mixed
getFileExtension()  : mixed
getFolderColorRgb()  : mixed
getFullFileExtension()  : mixed
getHasAugmentedPermissions()  : mixed
getHasThumbnail()  : mixed
getHeadRevisionId()  : mixed
getIconLink()  : mixed
getId()  : mixed
getImageMediaMetadata()  : DriveFileImageMediaMetadata
getIsAppAuthorized()  : mixed
getKind()  : mixed
getLastModifyingUser()  : User
getLinkShareMetadata()  : DriveFileLinkShareMetadata
getMd5Checksum()  : mixed
getMimeType()  : mixed
getModifiedByMe()  : mixed
getModifiedByMeTime()  : mixed
getModifiedTime()  : mixed
getName()  : mixed
getOriginalFilename()  : mixed
getOwnedByMe()  : mixed
getOwners()  : array<string|int, User>
getParents()  : mixed
getPermissionIds()  : mixed
getPermissions()  : array<string|int, Permission>
getProperties()  : mixed
getQuotaBytesUsed()  : mixed
getResourceKey()  : mixed
getShared()  : mixed
getSharedWithMeTime()  : mixed
getSharingUser()  : User
getShortcutDetails()  : DriveFileShortcutDetails
getSize()  : mixed
getSpaces()  : mixed
getStarred()  : mixed
getTeamDriveId()  : mixed
getThumbnailLink()  : mixed
getThumbnailVersion()  : mixed
getTrashed()  : mixed
getTrashedTime()  : mixed
getTrashingUser()  : User
getVersion()  : mixed
getVideoMediaMetadata()  : DriveFileVideoMediaMetadata
getViewedByMe()  : mixed
getViewedByMeTime()  : mixed
getViewersCanCopyContent()  : mixed
getWebContentLink()  : mixed
getWebViewLink()  : mixed
getWritersCanShare()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAppProperties()  : mixed
setCapabilities()  : mixed
setContentHints()  : mixed
setContentRestrictions()  : mixed
setCopyRequiresWriterPermission()  : mixed
setCreatedTime()  : mixed
setDescription()  : mixed
setDriveId()  : mixed
setExplicitlyTrashed()  : mixed
setExportLinks()  : mixed
setFileExtension()  : mixed
setFolderColorRgb()  : mixed
setFullFileExtension()  : mixed
setHasAugmentedPermissions()  : mixed
setHasThumbnail()  : mixed
setHeadRevisionId()  : mixed
setIconLink()  : mixed
setId()  : mixed
setImageMediaMetadata()  : mixed
setIsAppAuthorized()  : mixed
setKind()  : mixed
setLastModifyingUser()  : mixed
setLinkShareMetadata()  : mixed
setMd5Checksum()  : mixed
setMimeType()  : mixed
setModifiedByMe()  : mixed
setModifiedByMeTime()  : mixed
setModifiedTime()  : mixed
setName()  : mixed
setOriginalFilename()  : mixed
setOwnedByMe()  : mixed
setOwners()  : mixed
setParents()  : mixed
setPermissionIds()  : mixed
setPermissions()  : mixed
setProperties()  : mixed
setQuotaBytesUsed()  : mixed
setResourceKey()  : mixed
setShared()  : mixed
setSharedWithMeTime()  : mixed
setSharingUser()  : mixed
setShortcutDetails()  : mixed
setSize()  : mixed
setSpaces()  : mixed
setStarred()  : mixed
setTeamDriveId()  : mixed
setThumbnailLink()  : mixed
setThumbnailVersion()  : mixed
setTrashed()  : mixed
setTrashedTime()  : mixed
setTrashingUser()  : mixed
setVersion()  : mixed
setVideoMediaMetadata()  : mixed
setViewedByMe()  : mixed
setViewedByMeTime()  : mixed
setViewersCanCopyContent()  : mixed
setWebContentLink()  : mixed
setWebViewLink()  : mixed
setWritersCanShare()  : 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

$copyRequiresWriterPermission

public mixed $copyRequiresWriterPermission

$explicitlyTrashed

public mixed $explicitlyTrashed

$folderColorRgb

public mixed $folderColorRgb

$fullFileExtension

public mixed $fullFileExtension

$hasAugmentedPermissions

public mixed $hasAugmentedPermissions

$headRevisionId

public mixed $headRevisionId

$isAppAuthorized

public mixed $isAppAuthorized

$modifiedByMeTime

public mixed $modifiedByMeTime

$originalFilename

public mixed $originalFilename

$quotaBytesUsed

public mixed $quotaBytesUsed

$sharedWithMeTime

public mixed $sharedWithMeTime

$thumbnailVersion

public mixed $thumbnailVersion

$viewedByMeTime

public mixed $viewedByMeTime

$viewersCanCopyContent

public mixed $viewersCanCopyContent

$webContentLink

public mixed $webContentLink

$writersCanShare

public mixed $writersCanShare

$capabilitiesDataType

protected mixed $capabilitiesDataType = ''

$capabilitiesType

protected mixed $capabilitiesType = \Google\Service\Drive\DriveFileCapabilities::class

$collection_key

protected mixed $collection_key = 'spaces'

$contentHintsDataType

protected mixed $contentHintsDataType = ''

$contentHintsType

protected mixed $contentHintsType = \Google\Service\Drive\DriveFileContentHints::class

$contentRestrictionsDataType

protected mixed $contentRestrictionsDataType = 'array'

$contentRestrictionsType

protected mixed $contentRestrictionsType = \Google\Service\Drive\ContentRestriction::class

$imageMediaMetadataDataType

protected mixed $imageMediaMetadataDataType = ''

$imageMediaMetadataType

protected mixed $imageMediaMetadataType = \Google\Service\Drive\DriveFileImageMediaMetadata::class

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$lastModifyingUserDataType

protected mixed $lastModifyingUserDataType = ''

$lastModifyingUserType

protected mixed $lastModifyingUserType = \Google\Service\Drive\User::class

$linkShareMetadataDataType

protected mixed $linkShareMetadataDataType = ''

$linkShareMetadataType

protected mixed $linkShareMetadataType = \Google\Service\Drive\DriveFileLinkShareMetadata::class

$modelData

protected mixed $modelData = array()

$ownersDataType

protected mixed $ownersDataType = 'array'

$ownersType

protected mixed $ownersType = \Google\Service\Drive\User::class

$permissionsDataType

protected mixed $permissionsDataType = 'array'

$permissionsType

protected mixed $permissionsType = \Google\Service\Drive\Permission::class

$processed

protected mixed $processed = array()

$sharingUserDataType

protected mixed $sharingUserDataType = ''

$sharingUserType

protected mixed $sharingUserType = \Google\Service\Drive\User::class

$shortcutDetailsDataType

protected mixed $shortcutDetailsDataType = ''

$shortcutDetailsType

protected mixed $shortcutDetailsType = \Google\Service\Drive\DriveFileShortcutDetails::class

$trashingUserDataType

protected mixed $trashingUserDataType = ''

$trashingUserType

protected mixed $trashingUserType = \Google\Service\Drive\User::class

$videoMediaMetadataDataType

protected mixed $videoMediaMetadataDataType = ''

$videoMediaMetadataType

protected mixed $videoMediaMetadataType = \Google\Service\Drive\DriveFileVideoMediaMetadata::class

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : 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

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : 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
Exception

Thrown if $obj isn't an array.

getAppProperties()

public getAppProperties() : mixed

getCopyRequiresWriterPermission()

public getCopyRequiresWriterPermission() : mixed

getCreatedTime()

public getCreatedTime() : mixed

getDescription()

public getDescription() : mixed

getExplicitlyTrashed()

public getExplicitlyTrashed() : mixed

getExportLinks()

public getExportLinks() : mixed

getFileExtension()

public getFileExtension() : mixed

getFolderColorRgb()

public getFolderColorRgb() : mixed

getFullFileExtension()

public getFullFileExtension() : mixed

getHasAugmentedPermissions()

public getHasAugmentedPermissions() : mixed

getHasThumbnail()

public getHasThumbnail() : mixed

getHeadRevisionId()

public getHeadRevisionId() : mixed

getIsAppAuthorized()

public getIsAppAuthorized() : mixed

getMd5Checksum()

public getMd5Checksum() : mixed

getModifiedByMe()

public getModifiedByMe() : mixed

getModifiedByMeTime()

public getModifiedByMeTime() : mixed

getModifiedTime()

public getModifiedTime() : mixed

getOriginalFilename()

public getOriginalFilename() : mixed

getOwnedByMe()

public getOwnedByMe() : mixed

getOwners()

public getOwners() : array<string|int, User>
Return values
array<string|int, User>

getPermissionIds()

public getPermissionIds() : mixed

getProperties()

public getProperties() : mixed

getQuotaBytesUsed()

public getQuotaBytesUsed() : mixed

getResourceKey()

public getResourceKey() : mixed

getSharedWithMeTime()

public getSharedWithMeTime() : mixed

getTeamDriveId()

public getTeamDriveId() : mixed

getThumbnailLink()

public getThumbnailLink() : mixed

getThumbnailVersion()

public getThumbnailVersion() : mixed

getTrashedTime()

public getTrashedTime() : mixed

getViewedByMe()

public getViewedByMe() : mixed

getViewedByMeTime()

public getViewedByMeTime() : mixed

getViewersCanCopyContent()

public getViewersCanCopyContent() : mixed

getWebContentLink()

public getWebContentLink() : mixed

getWebViewLink()

public getWebViewLink() : mixed

getWritersCanShare()

public getWritersCanShare() : mixed

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed

setAppProperties()

public setAppProperties(mixed $appProperties) : mixed
Parameters
$appProperties : mixed

setContentRestrictions()

public setContentRestrictions(mixed $contentRestrictions) : mixed
Parameters
$contentRestrictions : mixed

setCopyRequiresWriterPermission()

public setCopyRequiresWriterPermission(mixed $copyRequiresWriterPermission) : mixed
Parameters
$copyRequiresWriterPermission : mixed

setCreatedTime()

public setCreatedTime(mixed $createdTime) : mixed
Parameters
$createdTime : mixed

setDescription()

public setDescription(mixed $description) : mixed
Parameters
$description : mixed

setDriveId()

public setDriveId(mixed $driveId) : mixed
Parameters
$driveId : mixed

setExplicitlyTrashed()

public setExplicitlyTrashed(mixed $explicitlyTrashed) : mixed
Parameters
$explicitlyTrashed : mixed

setExportLinks()

public setExportLinks(mixed $exportLinks) : mixed
Parameters
$exportLinks : mixed

setFileExtension()

public setFileExtension(mixed $fileExtension) : mixed
Parameters
$fileExtension : mixed

setFolderColorRgb()

public setFolderColorRgb(mixed $folderColorRgb) : mixed
Parameters
$folderColorRgb : mixed

setFullFileExtension()

public setFullFileExtension(mixed $fullFileExtension) : mixed
Parameters
$fullFileExtension : mixed

setHasAugmentedPermissions()

public setHasAugmentedPermissions(mixed $hasAugmentedPermissions) : mixed
Parameters
$hasAugmentedPermissions : mixed

setHasThumbnail()

public setHasThumbnail(mixed $hasThumbnail) : mixed
Parameters
$hasThumbnail : mixed

setHeadRevisionId()

public setHeadRevisionId(mixed $headRevisionId) : mixed
Parameters
$headRevisionId : mixed

setIconLink()

public setIconLink(mixed $iconLink) : mixed
Parameters
$iconLink : mixed

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed

setIsAppAuthorized()

public setIsAppAuthorized(mixed $isAppAuthorized) : mixed
Parameters
$isAppAuthorized : mixed

setKind()

public setKind(mixed $kind) : mixed
Parameters
$kind : mixed

setLastModifyingUser()

public setLastModifyingUser(User $lastModifyingUser) : mixed
Parameters
$lastModifyingUser : User

setMd5Checksum()

public setMd5Checksum(mixed $md5Checksum) : mixed
Parameters
$md5Checksum : mixed

setMimeType()

public setMimeType(mixed $mimeType) : mixed
Parameters
$mimeType : mixed

setModifiedByMe()

public setModifiedByMe(mixed $modifiedByMe) : mixed
Parameters
$modifiedByMe : mixed

setModifiedByMeTime()

public setModifiedByMeTime(mixed $modifiedByMeTime) : mixed
Parameters
$modifiedByMeTime : mixed

setModifiedTime()

public setModifiedTime(mixed $modifiedTime) : mixed
Parameters
$modifiedTime : mixed

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed

setOriginalFilename()

public setOriginalFilename(mixed $originalFilename) : mixed
Parameters
$originalFilename : mixed

setOwnedByMe()

public setOwnedByMe(mixed $ownedByMe) : mixed
Parameters
$ownedByMe : mixed

setOwners()

public setOwners(mixed $owners) : mixed
Parameters
$owners : mixed

setParents()

public setParents(mixed $parents) : mixed
Parameters
$parents : mixed

setPermissionIds()

public setPermissionIds(mixed $permissionIds) : mixed
Parameters
$permissionIds : mixed

setPermissions()

public setPermissions(mixed $permissions) : mixed
Parameters
$permissions : mixed

setProperties()

public setProperties(mixed $properties) : mixed
Parameters
$properties : mixed

setQuotaBytesUsed()

public setQuotaBytesUsed(mixed $quotaBytesUsed) : mixed
Parameters
$quotaBytesUsed : mixed

setResourceKey()

public setResourceKey(mixed $resourceKey) : mixed
Parameters
$resourceKey : mixed

setShared()

public setShared(mixed $shared) : mixed
Parameters
$shared : mixed

setSharedWithMeTime()

public setSharedWithMeTime(mixed $sharedWithMeTime) : mixed
Parameters
$sharedWithMeTime : mixed

setSharingUser()

public setSharingUser(User $sharingUser) : mixed
Parameters
$sharingUser : User

setSize()

public setSize(mixed $size) : mixed
Parameters
$size : mixed

setSpaces()

public setSpaces(mixed $spaces) : mixed
Parameters
$spaces : mixed

setStarred()

public setStarred(mixed $starred) : mixed
Parameters
$starred : mixed

setTeamDriveId()

public setTeamDriveId(mixed $teamDriveId) : mixed
Parameters
$teamDriveId : mixed

setThumbnailLink()

public setThumbnailLink(mixed $thumbnailLink) : mixed
Parameters
$thumbnailLink : mixed

setThumbnailVersion()

public setThumbnailVersion(mixed $thumbnailVersion) : mixed
Parameters
$thumbnailVersion : mixed

setTrashed()

public setTrashed(mixed $trashed) : mixed
Parameters
$trashed : mixed

setTrashedTime()

public setTrashedTime(mixed $trashedTime) : mixed
Parameters
$trashedTime : mixed

setTrashingUser()

public setTrashingUser(User $trashingUser) : mixed
Parameters
$trashingUser : User

setVersion()

public setVersion(mixed $version) : mixed
Parameters
$version : mixed

setViewedByMe()

public setViewedByMe(mixed $viewedByMe) : mixed
Parameters
$viewedByMe : mixed

setViewedByMeTime()

public setViewedByMeTime(mixed $viewedByMeTime) : mixed
Parameters
$viewedByMeTime : mixed

setViewersCanCopyContent()

public setViewersCanCopyContent(mixed $viewersCanCopyContent) : mixed
Parameters
$viewersCanCopyContent : mixed

setWebContentLink()

public setWebContentLink(mixed $webContentLink) : mixed
Parameters
$webContentLink : mixed

setWebViewLink()

public setWebViewLink(mixed $webViewLink) : mixed
Parameters
$webViewLink : mixed

setWritersCanShare()

public setWritersCanShare(mixed $writersCanShare) : mixed
Parameters
$writersCanShare : 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

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : 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

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

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.

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

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results