ResourceLabel Class Reference

Inheritance diagram for ResourceLabel:

Public Member Functions
	getFolder ($create_if_missing=true)
	setFolder (ResourceFolder $folder)
	createFolder ()
	createSimpleBooking (User $user, DateTime $begin, DateTime $end, $preparation_time=0, $description='', $internal_comment='', $booking_type=ResourceBooking::TYPE_NORMAL)
	createBookingFromRequest (User $user, ResourceRequest $request, $preparation_time=0, $description='', $internal_comment='', $booking_type=ResourceBooking::TYPE_NORMAL, $prepend_preparation_time=false, $notify_lecturers=false)
	createBooking (User $user, $range_id=null, $time_ranges=[], $repetition_interval=null, $repetition_amount=0, $repetition_end_date=null, $preparation_time=0, $description='', $internal_comment='', $booking_type=ResourceBooking::TYPE_NORMAL, $force_booking=false)
	createSimpleRequest (User $user, DateTime $begin, DateTime $end, $comment='', $preparation_time=0)
	createRequest (User $user, $date_range_ids=null, $comment='', $properties=[], $preparation_time=0)
	createLock (User $user, DateTime $begin, DateTime $end, $internal_comment='')
	propertyExists ($name='')
	getPropertyObject (string $name)
	getProperty (string $name)
	getPropertyRelatedObject (string $name)
	setProperty (string $name, $state='', $user_id=null)
	isPropertyEditable (string $name, User $user)
	setPropertyByDefinitionId ( $property_definition_id=null, $state=null)
	setPropertyRelatedObject (string $name, SimpleORMap $object)
	getIcon ($role=Icon::ROLE_INFO)
	getPropertyArray ($only_requestable_properties=false)
	isAssigned (DateTime $begin, DateTime $end, $excluded_booking_ids=[])
	isReserved (DateTime $begin, DateTime $end, $excluded_reservation_ids=[])
	isLocked (DateTime $begin, DateTime $end, $excluded_lock_ids=[])
	isAvailable (DateTime $begin, DateTime $end, $excluded_booking_ids=[])
	isAvailableForRequest (ResourceRequest $request)
	getFullName ()
	getOpenResourceRequests (DateTime $begin, DateTime $end)
	getResourceBookings (DateTime $begin, DateTime $end, array $booking_types=[ResourceBooking::TYPE_NORMAL])
	getResourceLocks (DateTime $begin, DateTime $end)
	hasFiles ()
	checkHierarchy ()
	getItemAvatarURL ()
Public Member Functions inherited from Resource
	store ()
	delete ()
	cbValidate ()
	__toString ()
	getFolder ($create_if_missing=true)
	setFolder (ResourceFolder $folder)
	createFolder ()
	getRequiredPropertyNames ()
	createSimpleBooking (User $user, DateTime $begin, DateTime $end, $preparation_time=0, $description='', $internal_comment='', $booking_type=ResourceBooking::TYPE_NORMAL)
	createBookingFromRequest (User $user, ResourceRequest $request, $preparation_time=0, $description='', $internal_comment='', $booking_type=ResourceBooking::TYPE_NORMAL, $prepend_preparation_time=false, $notify_lecturers=false)
	createBooking (User $user, $range_id=null, $time_ranges=[], $repetition_interval=null, $repetition_amount=0, $repetition_end_date=null, $preparation_time=0, $description='', $internal_comment='', $booking_type=ResourceBooking::TYPE_NORMAL, $force_booking=false)
	createSimpleRequest (User $user, DateTime $begin, DateTime $end, $comment='', $preparation_time=0)
	createRequest (User $user, $date_range_ids=null, $comment='', $properties=[], $preparation_time=0)
	createLock (User $user, DateTime $begin, DateTime $end, $internal_comment='')
	getGroupedProperties ($excluded_properties=[])
	propertyExists ($name='')
	getPropertyObject (string $name)
	getInfolabelProperties ()
	getProperty (string $name)
	getPropertyRelatedObject (string $name)
	setProperty (string $name, $state='', $user=null)
	setPropertiesByName (array $properties, User $user)
	setPropertiesById (array $properties, User $user=null)
	isPropertyEditable (string $name, User $user)
	setPropertyByDefinitionId ($property_definition_id=null, $state=null)
	setPropertyRelatedObject (string $name, SimpleORMap $object)
	deleteProperty (string $name, User $user)
	getPictureUrl ()
	getDefaultPictureUrl ()
	getIcon ($role=Icon::ROLE_INFO)
	getPropertyArray ($only_requestable_properties=false)
	isAssigned (DateTime $begin, DateTime $end, $excluded_booking_ids=[])
	isReserved (DateTime $begin, DateTime $end, $excluded_reservation_ids=[])
	isLocked (DateTime $begin, DateTime $end, $excluded_lock_ids=[])
	isAvailable (DateTime $begin, DateTime $end, $excluded_booking_ids=[])
	isAvailableForRequest (ResourceRequest $request)
	getFullName ()
	setUserPermission (User $user, $perm='autor')
	deleteUserPermission (User $user)
	deleteAllPermissions ()
	getUserPermission (User $user, $time_range=[], $permanent_only=false)
	userHasPermission (?User $user, string $permission='user', array $time_range=[])
	userMayCreateChild (User $user)
	userHasRequestRights (User $user)
	userHasBookingRights (User $user, $begin=null, $end=null)
	bookingPlanVisibleForUser (?User $user, $time_range=[])
	findParentByClassName ($class_name='Resource')
	findChildrenByClassName ( $class_name='Resource', $depth=0, $convert_objects=true, $order_by_name=true)
	addChild (Resource $resource)
	getOpenResourceRequests (DateTime $begin, DateTime $end)
	getResourceBookings (DateTime $begin, DateTime $end, array $booking_types=[0])
	getResourceLocks (DateTime $begin, DateTime $end)
	hasFiles ()
	getDerivedClassInstance ()
	checkHierarchy ()
	getActionLink ($action='show', $link_parameters=[])
	getActionURL ($action='show', $url_parameters=[])
	getItemName ($long_format=true)
	getItemURL ()
	getItemAvatarURL ()
	getLink ()
Public Member Functions inherited from SimpleORMap
	__construct ($id=null)
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toRawArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	getDefaultValue ($field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isRelation ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	isI18nField ($field)
	setData ($data, $reset=false)
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	getPristineValue ($field)
	initRelation ($relation)
	resetRelation ($relation)
	cleanup ()

Additional Inherited Members
Static Public Member Functions inherited from Resource
static	findChildren ($resource_id)
static	getTranslatedClassName ($item_count=1)
static	getRootResources ()
static	getRequiredProperties ()
static	getLinkForAction ( $action='show', $id=null, $link_parameters=[])
static	getURLForAction ( $action='show', $id=null, $url_parameters=[])
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	exists ($id)
static	countBySql ($sql='1', $params=[])
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=[])
static	findOneBySQL ($where, $params=[])
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=[])
static	findMany ($pks=[], $order='', $order_params=[])
static	findEachMany ($callable, $pks=[], $order='', $order_params=[])
static	findAndMapBySQL ($callable, $where, $params=[])
static	findAndMapMany ($callable, $pks=[], $order='', $order_params=[])
static	deleteBySQL ($where, $params=[])
static	toObject ($id_or_object)
static	__callStatic (string $name, array $arguments)
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
Protected Member Functions inherited from SimpleORMap
	_getId ($field)
	_setId ($field, $value)
	_getAdditionalValueFromRelation ($field)
	_setAdditionalValueFromRelation ($field, $value)
	_getAdditionalValue ($field)
	_setAdditionalValue ($field, $value)
	parseRelationOptions ($type, $name, $options)
	storeRelations ($only_these=null)
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
Static Protected Member Functions inherited from Resource
static	configure ($config=[])
static	buildPathForAction ($action='show', $id=null)
Static Protected Member Functions inherited from SimpleORMap
static	db_table ()
static	db_fields ()
static	pk ()
static	default_values ()
static	serialized_fields ()
static	alias_fields ()
static	i18n_fields ()
static	additional_fields ()
static	has_many ()
static	has_one ()
static	belongs_to ()
static	has_and_belongs_to_many ()
static	registered_callbacks ()
static	known_slots ()
static	notification_map ()
static	getter_setter_map ()
static	configure ($config=[])
static	config ($key)
static	registerCallback ($types, $cb)
static	unregisterCallback ($types, $cb)
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$relations = []
	$additional_data = []
Static Protected Attributes inherited from Resource
static	$permission_cache
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
static	$performs_batch_operation = false

Member Function Documentation

checkHierarchy()

checkHierarchy

(

)

createBooking()

createBooking	(	User	$user,
			$range_id = null,
			$time_ranges = [],
			$repetition_interval = null,
			$repetition_amount = 0,
			$repetition_end_date = null,
			$preparation_time = 0,
			$description = '',
			$internal_comment = '',
			$booking_type = ResourceBooking::TYPE_NORMAL,
			$force_booking = false
	)

createBookingFromRequest()

createBookingFromRequest	(	User	$user,
		ResourceRequest	$request,
			$preparation_time = 0,
			$description = '',
			$internal_comment = '',
			$booking_type = ResourceBooking::TYPE_NORMAL,
			$prepend_preparation_time = false,
			$notify_lecturers = false
	)

createFolder()

createFolder

(

)

createLock()

createLock	(	User	$user,
		DateTime	$begin,
		DateTime	$end,
			$internal_comment = ''
	)

createRequest()

createRequest	(	User	$user,
			$date_range_ids = null,
			$comment = '',
			$properties = [],
			$preparation_time = 0
	)

createSimpleBooking()

createSimpleBooking	(	User	$user,
		DateTime	$begin,
		DateTime	$end,
			$preparation_time = 0,
			$description = '',
			$internal_comment = '',
			$booking_type = ResourceBooking::TYPE_NORMAL
	)

createSimpleRequest()

createSimpleRequest	(	User	$user,
		DateTime	$begin,
		DateTime	$end,
			$comment = '',
			$preparation_time = 0
	)

getFolder()

getFolder

(

$create_if_missing = true

)

getFullName()

getFullName

(

)

getIcon()

getIcon

(

$role = Icon::ROLE_INFO

)

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.

Implements StudipItem.

getOpenResourceRequests()

getOpenResourceRequests	(	DateTime	$begin,
		DateTime	$end
	)

getProperty()

getProperty

(

string

$name

)

getPropertyArray()

getPropertyArray

(

$only_requestable_properties = false

)

getPropertyObject()

getPropertyObject

(

string

$name

)

getPropertyRelatedObject()

getPropertyRelatedObject

(

string

$name

)

getResourceBookings()

getResourceBookings	(	DateTime	$begin,
		DateTime	$end,
		array	$booking_types = [ResourceBooking::TYPE_NORMAL]
	)

getResourceLocks()

getResourceLocks	(	DateTime	$begin,
		DateTime	$end
	)

hasFiles()

hasFiles

(

)

isAssigned()

isAssigned	(	DateTime	$begin,
		DateTime	$end,
			$excluded_booking_ids = []
	)

isAvailable()

isAvailable	(	DateTime	$begin,
		DateTime	$end,
			$excluded_booking_ids = []
	)

isAvailableForRequest()

isAvailableForRequest

(

ResourceRequest

$request

)

isLocked()

isLocked	(	DateTime	$begin,
		DateTime	$end,
			$excluded_lock_ids = []
	)

isPropertyEditable()

isPropertyEditable	(	string	$name,
		User	$user
	)

isReserved()

isReserved	(	DateTime	$begin,
		DateTime	$end,
			$excluded_reservation_ids = []
	)

propertyExists()

propertyExists

(

$name = ''

)

setFolder()

setFolder

(

ResourceFolder

$folder

)

setProperty()

setProperty	(	string	$name,
			$state = '',
			$user_id = null
	)

setPropertyByDefinitionId()

setPropertyByDefinitionId	(		$property_definition_id = null,
			$state = null
	)

setPropertyRelatedObject()

setPropertyRelatedObject	(	string	$name,
		SimpleORMap	$object
	)

---

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

• lib/models/resources/ResourceLabel.class.php