Inheritance diagram for StudipItem:

Collaboration diagram for StudipItem:

Public Member Functions
	getItemName ($long_format=true)

	getItemURL ()

	getItemAvatarURL ()

Detailed Description

This interface provides methods which allow an unified access to basic properties of Stud.IP objects. It is meant to be an extension for SimpleORMap objects.

Member Function Documentation

◆ getItemAvatarURL()

getItemAvatarURL ( )

Returns the URL to the avatar image or icon of the object, if applicable.

Returns: string|null Either the URL to the object's avatar or icon or null, if the object does not have an avatar.

Implemented in Course, Resource, and ResourceLabel.

◆ getItemName()

getItemName ( $long_format = true )

Returns a human-readable name of the object.

Parameters

bool $long_format If set to true, a long format that has the object type as a prefix (course, room etc.) is returned. Otherwise only the name is returned.

Returns: string A human-readable string of the object's name.

Implemented in Course, and Resource.

◆ getItemURL()

getItemURL ( )

Returns an URL that points to a page describing or displaying the object.

Returns: string|null Either the URL to a descriptive page for the object or null, if the object does not have such an URL.