Class: Sabre_DAV_File

Source Location: /includes/classes/SabreDAV/lib/Sabre/DAV/File.php

Class Overview [line 15]

Sabre_DAV_Node
   |
   --Sabre_DAV_File

File class

Author(s):

  • Evert Pot (http://www.rooftopsolutions.nl/)

Version:

Copyright:

  • Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.

Variables

Constants

Methods


Child classes:

MyFile
File class
Sabre_CalDAV_CalendarObject
The CalendarObject represents a single VEVENT or VTODO within a Calendar.
Sabre_DAV_FileMock
File class
Sabre_DAV_ServerPreconditionsNode
File class

Implements interfaces

Inherited Variables

Inherited Constants

Inherited Methods

Class: Sabre_DAV_Node

Sabre_DAV_Node::delete()
Deleted the current node
Sabre_DAV_Node::getLastModified()
Returns the last modification time
Sabre_DAV_Node::setName()
Renames the node


Class Details

File class

This is a helper class, that should aid in getting file classes setup. Most of its methods are implemented, and throw permission denied exceptions

Tags:

[ Top ]


Class Variables


Class Methods

get

mixed get( )

[line 38]

Returns the data

This method may either return a string or a readable stream resource

Tags:

  • access - public

Overridden in child classes as:

MyFile::get()
Sabre_CalDAV_CalendarObject::get()
Returns the ICalendar-formatted object


Implementation of:
Sabre_DAV_IFile::get()
Returns the data

Parameters:

[ Top ]

getContentType

void getContentType( )

[line 73]

Returns the mime-type for a file

If null is returned, we'll assume application/octet-stream

Tags:

  • access - public

Overridden in child classes as:

Sabre_CalDAV_CalendarObject::getContentType()
Returns the mime content-type


Implementation of:
Sabre_DAV_IFile::getContentType()
Returns the mime-type for a file

Parameters:

[ Top ]

getETag

void getETag( )

[line 62]

Returns the ETag for a file

An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change.

Return null if the ETag can not effectively be determined

Tags:

  • access - public

Overridden in child classes as:

Sabre_CalDAV_CalendarObject::getETag()
Returns an ETag for this object
Sabre_DAV_ServerPreconditionsNode::getETag()


Implementation of:
Sabre_DAV_IFile::getETag()
Returns the ETag for a file

Parameters:

[ Top ]

getSize

int getSize( )

[line 49]

Returns the size of the file, in bytes.

Tags:

  • access - public

Overridden in child classes as:

MyFile::getSize()
Sabre_CalDAV_CalendarObject::getSize()
Returns the size of this object in bytes


Implementation of:
Sabre_DAV_IFile::getSize()
Returns the size of the node, in bytes

Parameters:

[ Top ]

put

void put( resource $data)

[line 25]

Updates the data

data is a readable stream resource.

Tags:

  • access - public

Overridden in child classes as:

Sabre_CalDAV_CalendarObject::put()
Updates the ICalendar-formatted object


Implementation of:
Sabre_DAV_IFile::put()
Updates the data

Parameters:

  • resource $data -

[ Top ]


Class Constants


Documentation generated on Mon, 31 May 2010 12:53:18 -0400 by phpDocumentor 1.4.3