libical
[ class tree: libical ] [ index: libical ] [ all elements ]

Class: ical_File

Source Location: /ical.php

Class Overview

ical_ComponentManager
   |
   --ical_File

This is the class that everyone should start with to open an existing file or create a new one.


Methods


Inherited Variables

Inherited Methods

Class: ical_ComponentManager

ical_ComponentManager::add()
Add this value if it can have multiple entries, otherwise overwrite the old one.
ical_ComponentManager::add_new()
This is only used for adding additional items.
ical_ComponentManager::cleanup_array()
Prepare iCal array of lines for further processing.
ical_ComponentManager::components_dump()
Dump component values to text format.
ical_ComponentManager::format_line()
Do line folding as defined in the RFC.
ical_ComponentManager::get()
Return an array of ical_Property objects for the component.
ical_ComponentManager::get_all()
Return all component values in native array form.
ical_ComponentManager::ical_dump()
Dump ical data to text.
ical_ComponentManager::load_ical()
Recursive method to add ical objects from their text.
ical_ComponentManager::remove()
Remove all of a given component.
ical_ComponentManager::rfc_verify()
Return 0 when everything checks out, negative code otherwise.
ical_ComponentManager::set()
Set all values for this component type in this array return 0 on success, 1 otherwise.

Class Details

[line 58]
This is the class that everyone should start with to open an existing file or create a new one.



[ Top ]


Class Methods


constructor ical_File [line 69]

ical_File ical_File( [string $filename = ""])

Pass a filename (existing or not) when an instance is created.



Parameters:

string   $filename  

[ Top ]

method download [line 138]

void download( [string $filename = 'myical.ics'])

download method -- outputs the appropriate headers then outputs the results of ical_dump

this method added by C. R. Dick http://wazzuplocal.com




Parameters:

string   $filename  

[ Top ]

method ical_dump [line 91]

string ical_dump( [string $text = ""])

Dump ical data to text string

Slightly modified from parent class because this isn't really an RFC defined object




Overrides ical_ComponentManager::ical_dump() (Dump ical data to text.)

Parameters:

string   $text  

[ Top ]

method write [line 115]

integer write( [string $filename = ""])

Write out calendar(s) in this object to a file

Returns 0 on sucess, -1 on failure




Parameters:

string   $filename  

[ Top ]


Documentation generated on Tue, 14 Aug 2007 19:37:27 -0700 by phpDocumentor 1.4.0