Contentserv PHP API

CSWidgetMetaData extends CSSystemMetaData
in package

This class describes the CSPlugin or CSModule meta data

Tags

Table of Contents

META_DATA_EXIF  = 8
META_DATA_IPTC  = 32
META_DATA_MODULE  = 2
META_DATA_PLUGIN  = 1
META_DATA_WIDGET  = 4
META_DATA_XML  = 64
META_DATA_XMP  = 16
META_INFO_API_VERSION  = 'apiVersion'
META_INFO_AUTHOR  = 'author'
META_INFO_DESCRIPTION  = 'description'
META_INFO_KEYWORDS  = 'keywords'
META_INFO_TITLE  = 'title'
META_INFO_VERSION  = 'version'
META_INFO_WEBSITE  = 'website'
addData()  : mixed
Adds the metadata.
addMeta()  : void
Adds a Meta data to the plugin
getApiVersion()  : string
Gets the the api Version of the plugin
getAuthor()  : string
Gets the the author of the plugin
getAutoRefresh()  : int
Gets the the website of the widget
getBetaVersion()  : string
Gets the the beta state of the widget
getBrowserSupport()  : CSBrowserSupport
Returns the information of the supported browsers for this widget
getCategory()  : string
Gets the the category of the widget
getClass()  : CSFileMetaData
Returns the current classname of the class.
getData()  : array<string|int, mixed>
Returns the metadata for the provided keys. If passed null, returns all the metadata
getDebugMode()  : bool
Gets the the debug mode of the widget
getDescription()  : string
Gets the the description of the plugin
getFromUWAPath()  : mixed
Loads all meta datas from a UWA Path
getIcon()  : string
Gets the icon of the widget
getInstance()  : static
Get self instance
getKeywords()  : string
Gets the the keywords of the plugin
getMeta()  : string
Returns a Meta data for a given key
getMetas()  : array<string|int, mixed>
Returns all Meta datas as an array
getScreenshot()  : string
Gets the the screenshot of the widget
getSecured()  : bool
Returns whether the widget is secured
getSupportedTypeNames()  : array<string|int, mixed>
Returns suported metadata type names
getSupportedTypes()  : mixed
getThumbnail()  : string
Gets the the thumbnail of the widget
getTitle()  : string
Gets the the default title of the plugin
getType()  : int
Returns the metadata type from defined constants
getVersion()  : string
Gets the the version of the plugin
getWebsite()  : string
Gets the the website of the plugin
isLicensed()  : bool
Checks whether the license is available
isSupportedType()  : int
Checks whether the type is supported or not using bitwise operator
removeData()  : mixed
Removes the metadata
resetData()  : mixed
Resets or deletes the complete metadata
setApiVersion()  : void
Documents the api Version of the plugin
setAuthor()  : void
Documents the author of the plugin
setAutoRefresh()  : void
Tells the portal environment to automatically reload the widget periodically
setBetaVersion()  : void
Documents a beta state of the widget
setBrowserSupport()  : mixed
Sets the information of the supported browsers for this widget
setCategory()  : void
Sets the the category of the widget
setData()  : mixed
Sets the metadata.
setDebugMode()  : void
Tells the portal environment to render the widget in a debug mode
setDescription()  : void
Describes the plugin
setIcon()  : void
Documents the icon of the widget
setKeywords()  : void
Keyword to search for the plugin
setScreenshot()  : void
Url to a screenshot with the widget
setSecured()  : void
Marks the widget as secured and therefore only users with special rights can add it
setThumbnail()  : void
Url to a thumbnail with the widget
setTitle()  : void
Documents the default title of the plugin
setVersion()  : void
Version of the plugin
setWebsite()  : void
Documents the website with more information about the plugin

Constants

META_DATA_EXIF

public mixed META_DATA_EXIF = 8
Tags

META_DATA_IPTC

public mixed META_DATA_IPTC = 32
Tags

META_DATA_MODULE

public mixed META_DATA_MODULE = 2
Tags

META_DATA_PLUGIN

public mixed META_DATA_PLUGIN = 1
Tags

META_DATA_WIDGET

public mixed META_DATA_WIDGET = 4
Tags

META_DATA_XML

public mixed META_DATA_XML = 64
Tags

META_DATA_XMP

public mixed META_DATA_XMP = 16
Tags

META_INFO_API_VERSION

public mixed META_INFO_API_VERSION = 'apiVersion'
Tags

META_INFO_DESCRIPTION

public mixed META_INFO_DESCRIPTION = 'description'
Tags

Methods

addData()

Adds the metadata.

public final addData(array<string|int, mixed> $aData) : mixed
Parameters
$aData : array<string|int, mixed>

Array of metadata properties with its values

Tags
Return values
mixed —

addMeta()

Adds a Meta data to the plugin

public addMeta(string $sKey, string $sValue) : void
Parameters
$sKey : string

the key of the meta data

$sValue : string

the value of the meta data

Tags
access

public

Return values
void —

getApiVersion()

Gets the the api Version of the plugin

public getApiVersion() : string
Tags
access

public

Return values
string —

api Version

getAuthor()

Gets the the author of the plugin

public getAuthor() : string
Tags
access

public

Return values
string —

name of the author

getAutoRefresh()

Gets the the website of the widget

public getAutoRefresh() : int
Tags
access

public

Return values
int —

minutes of auto refresh

getBetaVersion()

Gets the the beta state of the widget

public getBetaVersion() : string
Tags
access

public

Return values
string —

the description of the beta version, if it is in beta state

getBrowserSupport()

Returns the information of the supported browsers for this widget

public getBrowserSupport() : CSBrowserSupport
Tags
access

public

Return values
CSBrowserSupport —

the supported browsers

getCategory()

Gets the the category of the widget

public getCategory() : string
Tags
access

public

Return values
string —

category of the widget

getData()

Returns the metadata for the provided keys. If passed null, returns all the metadata

public final getData([array<string|int, mixed>|null $aKeys = null ]) : array<string|int, mixed>
Parameters
$aKeys : array<string|int, mixed>|null = null

array of keys

Tags
throws
CSMetaDataException
Return values
array<string|int, mixed> —

of metadata values for provided keys

getDebugMode()

Gets the the debug mode of the widget

public getDebugMode() : bool
Tags
access

public

Return values
bool —

debug mode

getDescription()

Gets the the description of the plugin

public getDescription() : string
Tags
access

public

Return values
string —

description

getFromUWAPath()

Loads all meta datas from a UWA Path

public static getFromUWAPath(string $uwaPath) : mixed
Parameters
$uwaPath : string

the path to the uwa widget

Tags
access

public

throws
CSException
deprecated

Netvibes Widget are no longer supported. Pleaes don't use the method anymore.

Return values
mixed —

getIcon()

Gets the icon of the widget

public getIcon() : string
Tags
access

public

Return values
string —

to the icon

getInstance()

Get self instance

public final static getInstance(int $sMetaDataType) : static
Parameters
$sMetaDataType : int
Tags
Return values
static —

getKeywords()

Gets the the keywords of the plugin

public getKeywords() : string
Tags
access

public

Return values
string —

keywords

getMeta()

Returns a Meta data for a given key

public getMeta(string $sKey) : string
Parameters
$sKey : string

the key of the meta data

Tags
access

public

Return values
string —

the value of the meta data

getMetas()

Returns all Meta datas as an array

public getMetas() : array<string|int, mixed>
Tags
access

public

Return values
array<string|int, mixed> —

the the meta datas

getScreenshot()

Gets the the screenshot of the widget

public getScreenshot() : string
Tags
access

public

Return values
string —

url of the screenshot

getSecured()

Returns whether the widget is secured

public getSecured() : bool
Tags
access

public

Return values
bool —

whether the widget is secured

getSupportedTypeNames()

Returns suported metadata type names

public static getSupportedTypeNames() : array<string|int, mixed>
Tags
inheritdoc
Return values
array<string|int, mixed> —

getSupportedTypes()

public getSupportedTypes() : mixed
Tags
inheritdoc
Return values
mixed —

getThumbnail()

Gets the the thumbnail of the widget

public getThumbnail() : string
Tags
access

public

Return values
string —

url of the thumbnail

getTitle()

Gets the the default title of the plugin

public getTitle() : string
Tags
access

public

Return values
string —

title of the plugin

getType()

Returns the metadata type from defined constants

public final getType() : int
Tags
Return values
int —

getVersion()

Gets the the version of the plugin

public getVersion() : string
Tags
access

public

Return values
string —

version

getWebsite()

Gets the the website of the plugin

public getWebsite() : string
Tags
access

public

Return values
string —

website

isLicensed()

Checks whether the license is available

public isLicensed() : bool
Tags
access

public

Return values
bool —

whether the widget is licensed

isSupportedType()

Checks whether the type is supported or not using bitwise operator

public final isSupportedType(int $iType) : int
Parameters
$iType : int

integer for the respective type define above in constants

Tags
Return values
int —

Returns 0 if not supported

removeData()

Removes the metadata

public final removeData(array<string|int, mixed> $aKeys) : mixed
Parameters
$aKeys : array<string|int, mixed>

array of properties that needs to be removed

Tags
Return values
mixed —

resetData()

Resets or deletes the complete metadata

public final resetData() : mixed
Tags
Return values
mixed —

setApiVersion()

Documents the api Version of the plugin

public setApiVersion(mixed $apiVersion) : void
Parameters
$apiVersion : mixed
Tags
access

public

Return values
void —

setAuthor()

Documents the author of the plugin

public setAuthor(mixed $author) : void
Parameters
$author : mixed
Tags
access

public

Return values
void —

setAutoRefresh()

Tells the portal environment to automatically reload the widget periodically

public setAutoRefresh(int $minutes) : void
Parameters
$minutes : int

minutes after which the widget should be reloaded

Tags
access

public

Return values
void —

setBetaVersion()

Documents a beta state of the widget

public setBetaVersion([string $betaDescription = 'Beta' ]) : void
Parameters
$betaDescription : string = 'Beta'

the description of the beta version, e.g. Beta, Alpha, ...

Tags
access

public

Return values
void —

setBrowserSupport()

Sets the information of the supported browsers for this widget

public setBrowserSupport(CSBrowserSupport $browserSupport) : mixed
Parameters
$browserSupport : CSBrowserSupport

the supported browsers

Tags
access

public

Return values
mixed —

setCategory()

Sets the the category of the widget

public setCategory(mixed $category) : void
Parameters
$category : mixed
Tags
access

public

Return values
void —

setData()

Sets the metadata.

public final setData(array<string|int, mixed> $aData) : mixed
Parameters
$aData : array<string|int, mixed>

Array of metadata properties with its values

Tags
Return values
mixed —

setDebugMode()

Tells the portal environment to render the widget in a debug mode

public setDebugMode([bool $debugMode = true ]) : void
Parameters
$debugMode : bool = true

if true the widget should be rendered in a debug mode

Tags
access

public

Return values
void —

setDescription()

Describes the plugin

public setDescription(string $description) : void
Parameters
$description : string

description of the plugin

Tags
access

public

Return values
void —

setIcon()

Documents the icon of the widget

public setIcon(string $path) : void
Parameters
$path : string
Tags
access

public

Return values
void —

setKeywords()

Keyword to search for the plugin

public setKeywords(string $keywords) : void
Parameters
$keywords : string

keywords of the plugin

Tags
access

public

Return values
void —

setScreenshot()

Url to a screenshot with the widget

public setScreenshot(string $url) : void
Parameters
$url : string

url of the screenshot

Tags
access

public

Return values
void —

setSecured()

Marks the widget as secured and therefore only users with special rights can add it

public setSecured([bool $secured = true ]) : void
Parameters
$secured : bool = true

whether the widget is secured

Tags
access

public

Return values
void —

setThumbnail()

Url to a thumbnail with the widget

public setThumbnail(string $url) : void
Parameters
$url : string

url of the thumbnail

Tags
access

public

Return values
void —

setTitle()

Documents the default title of the plugin

public setTitle(string $title) : void
Parameters
$title : string

title of the plugin

Tags
access

public

Return values
void —

setVersion()

Version of the plugin

public setVersion(string $version) : void
Parameters
$version : string

version string of the plugin

Tags
access

public

Return values
void —

setWebsite()

Documents the website with more information about the plugin

public setWebsite(mixed $website) : void
Parameters
$website : mixed
Tags
access

public

Return values
void — 

        

        
    




    

    

                

    

        

            
Search results