Documentation

ContentDetails
in package

Content Details Object

Represents additional details specific to the content associated with a module item. This is a read-only object that is embedded within ModuleItem responses when requested.

Table of Contents

Properties

$dueAt  : string|null
Due date for the content
$lockAt  : string|null
Lock date for the content
$lockContext  : string|null
Lock context (e.g., 'module', 'assignment')
$lockedForUser  : bool|null
Whether the content is locked for the user
$lockExplanation  : string|null
Explanation of why the content is locked
$lockInfo  : array<string|int, mixed>|null
Additional lock information
$pointsPossible  : float|null
Points possible for the content
$unlockAt  : string|null
Unlock date for the content

Methods

__construct()  : mixed
Constructor
getDueAt()  : string|null
Get due date
getLockAt()  : string|null
Get lock date
getLockContext()  : string|null
Get lock context
getLockedForUser()  : bool|null
Get locked for user status
getLockExplanation()  : string|null
Get lock explanation
getLockInfo()  : array<string|int, mixed>|null
Get lock info
getPointsPossible()  : float|null
Get points possible
getUnlockAt()  : string|null
Get unlock date
hasDeadline()  : bool
Check if content has a deadline
hasDueDate()  : bool
Check if content has a due date
isAvailable()  : bool
Check if content is available (based on unlock date)
isExpired()  : bool
Check if content is expired (based on lock date)
isLocked()  : bool
Check if content is locked
setDueAt()  : void
Set due date
setLockAt()  : void
Set lock date
setLockContext()  : void
Set lock context
setLockedForUser()  : void
Set locked for user status
setLockExplanation()  : void
Set lock explanation
setLockInfo()  : void
Set lock info
setPointsPossible()  : void
Set points possible
setUnlockAt()  : void
Set unlock date
toArray()  : array<string|int, mixed>
Convert to array

Properties

$dueAt

Due date for the content

public string|null $dueAt = null

$lockAt

Lock date for the content

public string|null $lockAt = null

$lockContext

Lock context (e.g., 'module', 'assignment')

public string|null $lockContext = null

$lockedForUser

Whether the content is locked for the user

public bool|null $lockedForUser = null

$lockExplanation

Explanation of why the content is locked

public string|null $lockExplanation = null

$lockInfo

Additional lock information

public array<string|int, mixed>|null $lockInfo = null

$pointsPossible

Points possible for the content

public float|null $pointsPossible = null

$unlockAt

Unlock date for the content

public string|null $unlockAt = null

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

getDueAt()

Get due date

public getDueAt() : string|null
Return values
string|null

getLockAt()

Get lock date

public getLockAt() : string|null
Return values
string|null

getLockContext()

Get lock context

public getLockContext() : string|null
Return values
string|null

getLockedForUser()

Get locked for user status

public getLockedForUser() : bool|null
Return values
bool|null

getLockExplanation()

Get lock explanation

public getLockExplanation() : string|null
Return values
string|null

getLockInfo()

Get lock info

public getLockInfo() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getPointsPossible()

Get points possible

public getPointsPossible() : float|null
Return values
float|null

getUnlockAt()

Get unlock date

public getUnlockAt() : string|null
Return values
string|null

hasDeadline()

Check if content has a deadline

public hasDeadline() : bool
Return values
bool

hasDueDate()

Check if content has a due date

public hasDueDate() : bool
Return values
bool

isAvailable()

Check if content is available (based on unlock date)

public isAvailable() : bool
Return values
bool

isExpired()

Check if content is expired (based on lock date)

public isExpired() : bool
Return values
bool

isLocked()

Check if content is locked

public isLocked() : bool
Return values
bool

setDueAt()

Set due date

public setDueAt(string|null $dueAt) : void
Parameters
$dueAt : string|null

setLockAt()

Set lock date

public setLockAt(string|null $lockAt) : void
Parameters
$lockAt : string|null

setLockContext()

Set lock context

public setLockContext(string|null $lockContext) : void
Parameters
$lockContext : string|null

setLockedForUser()

Set locked for user status

public setLockedForUser(bool|null $lockedForUser) : void
Parameters
$lockedForUser : bool|null

setLockExplanation()

Set lock explanation

public setLockExplanation(string|null $lockExplanation) : void
Parameters
$lockExplanation : string|null

setLockInfo()

Set lock info

public setLockInfo(array<string|int, mixed>|null $lockInfo) : void
Parameters
$lockInfo : array<string|int, mixed>|null

setPointsPossible()

Set points possible

public setPointsPossible(float|null $pointsPossible) : void
Parameters
$pointsPossible : float|null

setUnlockAt()

Set unlock date

public setUnlockAt(string|null $unlockAt) : void
Parameters
$unlockAt : string|null

toArray()

Convert to array

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results