FileSystem Class Reference

Inheritance diagram for FileSystem:

Collaboration diagram for FileSystem:

Public Member Functions
	getFileRef ($file_ref_id)
	getFileRefData ($file_ref_id)
	updateFileData ($file_ref_id)
	editFileRef ($file_ref_id)
	copyFileRef ($file_ref_id, $destination_folder_id)
	moveFileRef ($file_ref_id, $destination_folder_id)
	deleteFileRef ($file_ref_id)
	uploadFile ($folder_id)
	getDefinedFolderTypes ()
	getFolder ($folder_id)
	createNewFolder ($parent_folder_id)
	getFileRefsOfFolder ($folder_id)
	getSubfoldersOfFolder ($folder_id)
	getFolderPermissions ($folder_id)
	editFolder ($folder_id)
	copyFolder ($folder_id, $destination_folder_id)
	moveFolder ($folder_id, $destination_folder_id)
	deleteFolder ($folder_id)
	getContentTermsOfUseList ()
Public Member Functions inherited from RouteMap
	__construct ()
	init ($router, $route)
	paginated ($data, $total, $uri_params=[], $query_params=[])
	paginate ($uri_format, $total, $offset=null, $limit=null)
	collect ($data)
	status ($status)
	headers ($headers=[])
	body ($body)
	contentType ($mime_type, $params=[])
	error ($status, $body=null)
	etag ($value, $strong_etag=true, $new_resource=null)
	expires ($amount, $cache_control=[])
	cacheControl ($values)
	halt ()
	lastModified ($time)
	notFound ($body=null)
	redirect ($url, $args=null)
	sendFile ($_path, $opts=[])
	url ($addr, $url_params=null)
	urlf ($addr_f, $format_params, $url_params=null)
	getRoutes ($http_method=null)

Additional Inherited Members
Protected Member Functions inherited from RouteMap
	extractConditions ($docblock, $conditions=[])
Protected Attributes inherited from RouteMap
	$pagination = false
	$offset
	$limit

Member Function Documentation

copyFileRef()

copyFileRef	(		$file_ref_id,
			$destination_folder_id
	)

Copies a file reference.

Postcondition

/file/:file_ref_id/copy/:destination_folder_id

Here is the call graph for this function:

copyFolder()

copyFolder	(		$folder_id,
			$destination_folder_id
	)

Copies a folder into another folder.

Postcondition

/folder/:folder_id/copy/:destination_folder_id

Here is the call graph for this function:

createNewFolder()

createNewFolder

(

$parent_folder_id

)

Creates a new folder inside of another folder and returns the new object on success.

Postcondition

/folder/:parent_folder_id/new_folder

Here is the call graph for this function:

deleteFileRef()

deleteFileRef

(

$file_ref_id

)

Deletes a file reference.

@delete /file/:file_ref_id

Here is the call graph for this function:

deleteFolder()

deleteFolder

(

$folder_id

)

Deletes a folder.

@delete /folder/:folder_id

Here is the call graph for this function:

editFileRef()

editFileRef

(

$file_ref_id

)

Edit a file reference.

@put /file/:file_ref_id

Here is the call graph for this function:

editFolder()

editFolder

(

$folder_id

)

Allows editing the name or the description (or both) of a folder.

@put /folder/:folder_id

Here is the call graph for this function:

getContentTermsOfUseList()

getContentTermsOfUseList

(

)

Get a collection of all ContentTermsOfUse objects

@get /studip/content_terms_of_use_list

Here is the call graph for this function:

getDefinedFolderTypes()

getDefinedFolderTypes

(

)

Returns a list of defined folder types, separated by range type. @get /studip/file_system/folder_types

getFileRef()

getFileRef

(

$file_ref_id

)

Get a file reference object (metadata) @get /file/:file_ref_id

Here is the call graph for this function:

getFileRefData()

getFileRefData

(

$file_ref_id

)

Get the data of a file by the ID of an associated FileRef object

@get /file/:file_ref_id/download

Here is the call graph for this function:

getFileRefsOfFolder()

getFileRefsOfFolder

(

$folder_id

)

Get a list with all FileRef objects of a folder. @get /folder/:folder_id/files

Here is the call graph for this function:

getFolder()

getFolder

(

$folder_id

)

Get a folder object with its file references, subdirectories and the permissions for the user who has made the API call. @get /folder/:folder_id

getFolderPermissions()

getFolderPermissions

(

$folder_id

)

Get a list with permissions the current user has for a folder. @get /folder/:folder_id/permissions

getSubfoldersOfFolder()

getSubfoldersOfFolder

(

$folder_id

)

Get a list with all FileRef objects of a folder. @get /folder/:folder_id/subfolders

Here is the call graph for this function:

moveFileRef()

moveFileRef	(		$file_ref_id,
			$destination_folder_id
	)

Moves a file reference.

Postcondition

/file/:file_ref_id/move/:destination_folder_id

Here is the call graph for this function:

moveFolder()

moveFolder	(		$folder_id,
			$destination_folder_id
	)

Move a folder into another folder.

Postcondition

/folder/:folder_id/move/:destination_folder_id

Here is the call graph for this function:

updateFileData()

updateFileData

(

$file_ref_id

)

Update file data using a FileReference to it.

Postcondition

/file/:file_ref_id/update

Here is the call graph for this function:

uploadFile()

uploadFile

(

$folder_id

)

Upload file to given folder. file data has to be attached as multipart/form-data

Postcondition

/file/:folder_id

Here is the call graph for this function:

---

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

• app/routes/FileSystem.php