Stud.IP  jlu_3.3 Revision
Files Class Reference
Inheritance diagram for Files:
Inheritance graph
Collaboration diagram for Files:
Collaboration graph

Public Member Functions

 before ($router, &$handler, &$parameters)
 
 getFile ($file_id)
 
 getFileContent ($file_id)
 
 addFile ($folder_id)
 
 putFile ($id)
 
 deleteFile ($file_id)
 
 getCourseFiles ($course_id)
 
- Public Member Functions inherited from RouteMap
 __construct ()
 
 init ($router, $route, $request_body=null)
 
 paginated ($data, $total, $uri_params=array(), $query_params=array())
 
 paginate ($uri_format, $total, $offset=null, $limit=null)
 
 collect ($data)
 
 status ($status)
 
 headers ($headers=array())
 
 body ($body)
 
 contentType ($mime_type, $params=array())
 
 error ($status, $body=null)
 
 etag ($value, $strong_etag=true, $new_resource=null)
 
 expires ($amount, $cache_control=array())
 
 cacheControl ($values)
 
 halt ()
 
 lastModified ($time)
 
 notFound ($body=null)
 
 redirect ($url, $args=null)
 
 sendFile ($_path, $opts=array())
 
 url ($addr, $url_params=null)
 
 urlf ($addr_f, $format_params, $url_params=null)
 

Additional Inherited Members

- Protected Attributes inherited from RouteMap
 $pagination = false
 
 $offset
 
 $limit
 

Detailed Description

Author
Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m
mlunz.nosp@m.ena@.nosp@m.uos.d.nosp@m.e @license GPL 2 or later

@condition course_id ^[a-f0-9]{32}$ @condition file_id ^[a-f0-9]{32}$

Member Function Documentation

◆ addFile()

addFile (   $folder_id)

Create file or folder. To create a file just attach a file as multipart request. If no file is attached, this will create a folder.

Postcondition
/file/:folder_id
Parameters
string$file_id: id of the folder to insert the file or folder to.
stringname : if set the document will have this name instead of the filename. For folders this attribute is mandatory.
stringdescription : sets the description of the document or folder.
Here is the call graph for this function:

◆ before()

before (   $router,
$handler,
$parameters 
)

◆ deleteFile()

deleteFile (   $file_id)

Löschen einer Datei bzw. eines Ordners

@delete /file/:file_id

Here is the call graph for this function:

◆ getCourseFiles()

getCourseFiles (   $course_id)

Dateien/Ordner einer Veranstaltung

@get /course/:course_id/files

Here is the call graph for this function:

◆ getFile()

getFile (   $file_id)

(Meta-)Daten einer Datei bzw. eines Ordners

@get /file/:file_id

Here is the call graph for this function:

◆ getFileContent()

getFileContent (   $file_id)

Inhalte einer Datei

@get /file/:file_id/content

See also
public/sendfile.php
Here is the call graph for this function:

◆ putFile()

putFile (   $id)

Update einer Datei bzw. eines Ordners

@put /file/:file_id

Here is the call graph for this function:

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