Inheritance diagram for RootDirectory:

Collaboration diagram for RootDirectory:

Public Member Functions
	__construct ($id=null)

	delete ()

	checkAccess ($user_id=null, $throw_exception=true)

Public Member Functions inherited from StudipDirectory
	createFile ($name, $description='')

	copy (File $source, $name, $description='')

	getEntry ($name)

	getPermissions ()

	countFiles ($count_deep=false, $count_folders=true)

	isEmpty ()

	isRootDirectory ()

	link (File $file, $name, $description='')

	ensureUniqueFilename ($name, File $file=null)

	listFiles ($offset=0, $limit=0)

	listDirectories ()

	mkdir ($name, $description='')

	delete ()

	isReadable ()

	isWritable ()

	open ($mode)

	search ($text)

	setPermissions ($permissions)

	unlink ($name)

	update ()

Public Member Functions inherited from File
	delete ()

	getLinks ()

	getStoragePath ()

	getStorageObject ()

	isReadable ()

	isWritable ()

	open ($mode)

	setContentFromFile ($file)

	update ()

	checkAccess ($user_id=null, $throw_exception=true)

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)

	setValue ($field, $value)

	__get ($field)

	__set ($field, $value)

	__isset ($field)

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	getIterator ()

	count ()

	isField ($field)

	isAdditionalField ($field)

	isAliasField ($field)

	setData ($data, $reset=false)

	haveData ()

	isNew ()

	isDeleted ()

	setNew ($is_new)

	getWhereQuery ()

	restore ()

	store ()

	triggerChdate ()

	delete ()

	isDirty ()

	isFieldDirty ($field)

	revertValue ($field)

	getPristineValue ($field)

	initRelation ($relation)

	resetRelation ($relation)

Static Public Member Functions
static	find ($context_id)

Static Public Member Functions inherited from StudipDirectory
static	getRootDirectory ($context_id)

Static Public Member Functions inherited from File
static	get ($id)

Static Public Member Functions inherited from SimpleORMap
static	expireTableScheme ()

static	find ($id)

static	exists ($id)

static	countBySql ($sql=1, $params=array())

static	create ($data)

static	build ($data, $is_new=true)

static	buildExisting ($data)

static	import ($data)

static	findBySQL ($sql, $params=array())

static	findByObject (SimpleORMap $object)

static	findOneBySQL ($where, $params=array())

static	findThru ($foreign_key_value, $options)

static	findEachBySQL ($callable, $sql, $params=array())

static	findMany ($pks=array(), $order='', $order_params=array())

static	findEachMany ($callable, $pks=array(), $order='', $order_params=array())

static	findAndMapBySQL ($callable, $where, $params=array())

static	findAndMapMany ($callable, $pks=array(), $order='', $order_params=array())

static	deleteBySQL ($where, $params=array())

static	toObject ($id_or_object)

static	__callStatic ($name, $arguments)

Additional Inherited Members
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)

	getTableScheme ()

	storeRelations ($only_these=null)

	deleteRelations ()

	initializeContent ()

	applyCallbacks ($type)

	registerCallback ($types, $cb)

	unregisterCallback ($types, $cb)

	cbAutoIncrementColumn ($type)

	cbAutoKeyCreation ()

	cbNotificationMapper ($cb_type)

	setSerializedValue ($field, $value)

Static Protected Member Functions inherited from StudipDirectory
static	configure ($config=array())

static	configure ($config=array())

Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=array())

static	tableScheme ($db_table)

Protected Attributes inherited from File
	$storage_object

Protected Attributes inherited from SimpleORMap
	$content = array()

	$content_db = array()

	$is_new = true

	$is_deleted = false

	$db_table = ''

	$db_fields = null

	$pk = null

	$default_values = array()

	$serialized_fields = array()

	$alias_fields = array()

	$additional_fields = array()

	$relations = array()

	$has_many = array()

	$has_one = array()

	$belongs_to = array()

	$has_and_belongs_to_many = array()

	$registered_callbacks

	$known_slots = array()

	$reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')

	$notification_map = array()

	$additional_data = array()

Static Protected Attributes inherited from File
static	$object_cache = array()

Static Protected Attributes inherited from SimpleORMap
static	$schemes = null

static	$config = array()

Detailed Description

File.php

Class to represent (virtual) root directory. Root directories are not represented in the database.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $id = null )

Initialize a new root directory object for the given id.

Parameters

string $id context id

Returns: RootDirectory directory object

Reimplemented from SimpleORMap.

Member Function Documentation

◆ checkAccess()

checkAccess	(	$user_id = `null`,
		$throw_exception = `true`
	)

Checks whether a user has access to the current root directory.

Parameters

mixed	$user_id	Id of the user or null for current user (default)
bool	$throw_exception	Throw an AccessDeniedException instead of returning false

Returns: bool indicating whether the user may access this root directory

Exceptions

AccessDeniedException if $throw_exception is true and the user may not access the root directory

Reimplemented from File.

◆ delete()

delete ( )

Delete the contents of this directory (recursively). The root directory itself cannot (and need not) be deleted.

Reimplemented from StudipDirectory.

Here is the call graph for this function:

◆ find()

static find ( $context_id )

static

Wrapper "find" method in compliance with the other SimpleORMap methods. Since the root directory is abstract and does not have a corresponding db entry, find would always return null otherwise.

Parameters

String $context_id

Returns: RootDirectory

Reimplemented from SimpleORMap.

Here is the caller graph for this function:

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

lib/files/RootDirectory.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkAccess()

◆ delete()

◆ find()