Nextcloud PHP API (master)

Reference
in package
implements IReference

Tags
since
25.0.0
psalm-type

OpenGraphObject = array{id: string, name: string, description: ?string, thumb: ?string, link: string}

Table of Contents

Interfaces

IReference

Properties

$accessible  : bool
$contentType  : string|null
$description  : string|null
$imageUrl  : string|null
$reference  : string
$richObject  : array<string|int, mixed>|null
$richObjectType  : string|null
$title  : string|null
$url  : string|null

Methods

__construct()  : mixed
fromCache()  : IReference
getAccessible()  : bool
Accessible flag indicates if the user has access to the provided reference
getDescription()  : string|null
getId()  : string
getImageContentType()  : string|null
getImageUrl()  : string|null
getOpenGraphObject()  : OpenGraphObject
Returns the opengraph rich object representation
getRichObject()  : array<string, mixed>
Returns the reference specific rich object representation
getRichObjectType()  : string
Returns the type of the reference specific rich object
getTitle()  : string
getUrl()  : string
jsonSerialize()  : OpenGraphObject, accessible: bool}
setAccessible()  : void
Accessible flag indicates if the user has access to the provided reference
setDescription()  : void
setImageContentType()  : void
setImageUrl()  : void
setRichObject()  : void
Set the reference specific rich object representation
setTitle()  : void
setUrl()  : void
toCache()  : array<string|int, mixed>

Properties

$accessible

protected bool $accessible = true

$contentType

protected string|null $contentType = null

$description

protected string|null $description = null

$imageUrl

protected string|null $imageUrl = null

$richObject

protected array<string|int, mixed>|null $richObject = null

$richObjectType

protected string|null $richObjectType = null

Methods

__construct()

public __construct(string $reference) : mixed
Parameters
$reference : string
Tags
since
25.0.0

fromCache()

public static fromCache(array<string|int, mixed> $cache) : IReference
Parameters
$cache : array<string|int, mixed>
Tags
since
25.0.0
Return values
IReference

getAccessible()

Accessible flag indicates if the user has access to the provided reference

public getAccessible() : bool
Tags
inheritdoc
since
25.0.0
Return values
bool

getDescription()

public getDescription() : string|null
Tags
inheritdoc
since
25.0.0
Return values
string|null

getId()

public getId() : string
Tags
inheritdoc
since
25.0.0
Return values
string

getImageContentType()

public getImageContentType() : string|null
Tags
inheritdoc
since
25.0.0
Return values
string|null

getImageUrl()

public getImageUrl() : string|null
Tags
inheritdoc
since
25.0.0
Return values
string|null

getOpenGraphObject()

Returns the opengraph rich object representation

public getOpenGraphObject() : OpenGraphObject
Tags
inheritdoc
since
25.0.0
Return values
OpenGraphObject

getRichObject()

Returns the reference specific rich object representation

public getRichObject() : array<string, mixed>
Tags
inheritdoc
since
25.0.0
Return values
array<string, mixed>

getRichObjectType()

Returns the type of the reference specific rich object

public getRichObjectType() : string
Tags
inheritdoc
since
25.0.0
Return values
string

getTitle()

public getTitle() : string
Tags
inheritdoc
since
25.0.0
Return values
string

getUrl()

public getUrl() : string
Tags
inheritdoc
since
25.0.0
Return values
string

jsonSerialize()

public jsonSerialize() : OpenGraphObject, accessible: bool}
Tags
inheritdoc
since
25.0.0
Return values
OpenGraphObject, accessible: bool}

setAccessible()

Accessible flag indicates if the user has access to the provided reference

public setAccessible(bool $accessible) : void
Parameters
$accessible : bool
Tags
inheritdoc
since
25.0.0

setDescription()

public setDescription(string|null $description) : void
Parameters
$description : string|null
Tags
inheritdoc
since
25.0.0

setImageContentType()

public setImageContentType(string|null $contentType) : void
Parameters
$contentType : string|null
Tags
inheritdoc
since
25.0.0

setImageUrl()

public setImageUrl(string|null $imageUrl) : void
Parameters
$imageUrl : string|null
Tags
inheritdoc
since
25.0.0

setRichObject()

Set the reference specific rich object representation

public setRichObject(string $type, array<string|int, mixed>|null $richObject) : void
Parameters
$type : string
$richObject : array<string|int, mixed>|null
Tags
inheritdoc
since
25.0.0

setTitle()

public setTitle(string $title) : void
Parameters
$title : string
Tags
inheritdoc
since
25.0.0

setUrl()

public setUrl(string|null $url) : void
Parameters
$url : string|null
Tags
inheritdoc
since
25.0.0

toCache()

public static toCache(IReference $reference) : array<string|int, mixed>
Parameters
$reference : IReference
Tags
since
25.0.0
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results