dolibarr  20.0.0-alpha
Functions
xcal.lib.php File Reference

Function to manage calendar files (vcal/ical/...) More...

Go to the source code of this file.

Functions

 build_calfile ($format, $title, $desc, $events_array, $outputfile)
 Build a file from an array of events All input params and data must be encoded in $conf->charset_output. More...
 
 build_rssfile ($format, $title, $desc, $events_array, $outputfile, $filter='', $url='', $langcode='')
 Build a file from an array of events. More...
 
 format_cal ($format, $string)
 Encode for cal export. More...
 
 calEncode ($line)
 Cut string after 75 chars. More...
 
 quotedPrintEncode ($str, $forcal=0)
 Encode into vcal format. More...
 
 quotedPrintDecode ($str)
 Decode vcal format. More...
 

Detailed Description

Function to manage calendar files (vcal/ical/...)

Definition in file xcal.lib.php.

Function Documentation

◆ build_calfile()

build_calfile (   $format,
  $title,
  $desc,
  $events_array,
  $outputfile 
)

Build a file from an array of events All input params and data must be encoded in $conf->charset_output.

Parameters
string$format"vcal" or "ical"
string$titleTitle of export
string$descDescription of export
array$events_arrayArray of events ("uid","startdate","duration","enddate","title","summary","category","email","url","desc","author")
string$outputfileOutput file
Returns
int Return integer < 0 if KO, Nb of events in file if OK

Definition at line 35 of file xcal.lib.php.

◆ build_rssfile()

build_rssfile (   $format,
  $title,
  $desc,
  $events_array,
  $outputfile,
  $filter = '',
  $url = '',
  $langcode = '' 
)

Build a file from an array of events.

All input data must be encoded in $conf->charset_output

Parameters
string$format"rss"
string$titleTitle of export
string$descDescription of export
array$events_arrayArray of events ("uid","startdate","summary","url","desc","author","category","image") or Array of WebsitePage
string$outputfileOutput file
string$filter(optional) Filter
string$urlUrl (If empty, forge URL for agenda RSS export)
string$langcodeLanguage code to show in header
Returns
int Return integer < 0 if KO, Nb of events in file if OK

Definition at line 325 of file xcal.lib.php.

◆ calEncode()

calEncode (   $line)

Cut string after 75 chars.

Add CRLF+Space. line must be encoded in UTF-8

Parameters
string$lineString to convert
Returns
string String converted

Definition at line 491 of file xcal.lib.php.

◆ format_cal()

format_cal (   $format,
  $string 
)

Encode for cal export.

Parameters
string$format"vcal" or "ical"
string$stringString to encode
Returns
string String encoded

Definition at line 463 of file xcal.lib.php.

◆ quotedPrintDecode()

quotedPrintDecode (   $str)

Decode vcal format.

Parameters
string$strString to convert
Returns
string String converted

Definition at line 592 of file xcal.lib.php.

◆ quotedPrintEncode()

quotedPrintEncode (   $str,
  $forcal = 0 
)

Encode into vcal format.

Parameters
string$strString to convert
int$forcal(optional) 1 = For cal
Returns
string String converted

Definition at line 546 of file xcal.lib.php.