LTI Integration Library 5.0.0-rc2
PHP class library for building LTI integrations
 
Loading...
Searching...
No Matches
Image Class Reference

Class to represent a content-item image object. More...

Inheritance diagram for Image:
ContentItemImage

Public Member Functions

 __construct ($url, $width=null, $height=null)
 Class constructor.
 
object toJsonldObject ()
 Generate the JSON-LD object representation of the image.
 
object toJsonObject ()
 Generate the JSON object representation of the image.
 

Static Public Member Functions

static Image null fromJsonObject ($item)
 Generate an Image object from its JSON or JSON-LD representation.
 

Detailed Description

Class to represent a content-item image object.

Author
Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com
Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Constructor & Destructor Documentation

◆ __construct()

__construct (   $url,
  $width = null,
  $height = null 
)

Class constructor.

Parameters
string$urlURL of image
int$widthWidth of image in pixels (optional)
int$heightHeight of image in pixels (optional)

Reimplemented in ContentItemImage.

Member Function Documentation

◆ fromJsonObject()

static Image null fromJsonObject (   $item)
static

Generate an Image object from its JSON or JSON-LD representation.

Parameters
object$itemA JSON or JSON-LD object representing a content-item
Returns
Image|null The Image object

◆ toJsonldObject()

object toJsonldObject ( )

Generate the JSON-LD object representation of the image.

Returns
object

◆ toJsonObject()

object toJsonObject ( )

Generate the JSON object representation of the image.

Returns
object

The documentation for this class was generated from the following file: