Class Horde_Data_imc

Description

Abstract implementation of the Horde_Data:: API for IMC data - vCards and iCalendar data, etc. Provides a number of utility methods that vCard and iCalendar implementation can share and rely on.

$Horde: framework/Data/Data/imc.php,v 1.32.10.12 2009/01/06 15:23:01 jan Exp $

Copyright 1999-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Data/Data/imc.php (line 22)

PEAR
   |
   --Horde_Data
      |
      --Horde_Data_imc
Direct descendents
Class Description
 class Horde_Data_icalendar This is iCalendar (vCalendar).
 class Horde_Data_vcard Implement the Horde_Data:: API for vCard data.
 class Horde_Data_vnote Implement the Horde_Data:: API for vNote data.
 class Horde_Data_vtodo Implement the Horde_Data:: API for vTodo data.
Variable Summary
 mixed $_iCal
Method Summary
 string exportData (array $data, [string $method = 'REQUEST'])
 void exportFile (string $filename, array $data)
 void importData ( $text)
 mixed nextStep (integer $action, [array $param = array()])
Variables
mixed $_iCal = false (line 24)

Inherited Variables

Inherited from Horde_Data

Horde_Data::$_contentType
Horde_Data::$_extension
Horde_Data::$_warnings
Methods
exportData (line 46)

Builds an iCalendar file from a given data structure and returns it as a string.

  • return: The iCalendar data.
string exportData (array $data, [string $method = 'REQUEST'])
  • array $data: An array containing Horde_iCalendar_vevent objects
  • string $method: The iTip method to use.

Redefinition of:
Horde_Data::exportData()
Stub to return exported data.

Redefined in descendants as:
exportFile (line 66)

Builds an iCalendar file from a given data structure and triggers its download. It DOES NOT exit the current script but only outputs the correct headers and data.

void exportFile (string $filename, array $data)
  • string $filename: The name of the file to be downloaded.
  • array $data: An array containing Horde_iCalendar_vevents

Redefinition of:
Horde_Data::exportFile()
Stub to export data to a file.
importData (line 26)
void importData ( $text)
  • $text

Redefinition of:
Horde_Data::importData()
Stub to import passed data.
nextStep (line 83)

Takes all necessary actions for the given import step, parameters and form values and returns the next necessary step.

  • return: Either the next step as an integer constant or imported data set after the final step.
mixed nextStep (integer $action, [array $param = array()])
  • integer $action: The current step. One of the IMPORT_* constants.
  • array $param: An associative array containing needed parameters for the current step.

Redefinition of:
Horde_Data::nextStep()
Takes all necessary actions for the given import step, parameters and form values and returns the next necessary step.

Inherited Methods

Inherited From Horde_Data

 Horde_Data::cleanup()
 Horde_Data::exportData()
 Horde_Data::exportFile()
 Horde_Data::factory()
 Horde_Data::getContentType()
 Horde_Data::getFilename()
 Horde_Data::getNewline()
 Horde_Data::importData()
 Horde_Data::importFile()
 Horde_Data::nextStep()
 Horde_Data::singleton()
 Horde_Data::warnings()

Documentation generated on Sun, 30 Jan 2011 05:18:28 +0000 by phpDocumentor 1.4.3