Stud.IP  3.1 Revision 48552
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions
FileStorage Class Reference
Inheritance diagram for FileStorage:
Inheritance graph
Collaboration diagram for FileStorage:
Collaboration graph

Public Member Functions

 delete ()
 exists ()
 getCreationTime ()
 getId ()
 getMimeType ()
 getModificationTime ()
 getSize ()
 isReadable ()
 isWritable ()
 open ($mode)

Static Public Member Functions

static removeFile ($doc_list)

Detailed Description

File.php

Common interface for all backends to store files. At the moment, there is only one backend: DiskFileStorage.

Copyright (c) 2013 Elmar Ludwig

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.

Member Function Documentation

delete ( )

Delete this file from disk.

Reimplemented in DiskFileStorage.

exists ( )

Check whether the file exists on disk.

Returns
boolean TRUE or FALSE

Reimplemented in DiskFileStorage.

getCreationTime ( )

Return the file creation time.

Returns
int timestamp

Reimplemented in DiskFileStorage.

getId ( )

Return the backend id of this file.

Returns
string backend id

Reimplemented in DiskFileStorage.

getMimeType ( )

Return the file's mime type, if known.

Returns
string mime type (NULL if unknown)

Reimplemented in DiskFileStorage.

getModificationTime ( )

Return the file modification time.

Returns
int timestamp

Reimplemented in DiskFileStorage.

getSize ( )

Return the file's size in bytes.

Returns
int file size

Reimplemented in DiskFileStorage.

isReadable ( )

Check if this backend allows reading of files.

Returns
boolean TRUE

Reimplemented in DiskFileStorage.

isWritable ( )

Check if this backend allows writing of files.

Returns
boolean TRUE

Reimplemented in DiskFileStorage.

open (   $mode)

Open a PHP stream resource for this file. Access mode parameter works just like fopen.

Parameters
string$modeaccess mode (see fopen)
Returns
resource file handle

Reimplemented in DiskFileStorage.

static removeFile (   $doc_list)
static

Here is the caller graph for this function:

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