documentation/moodle/i_calendar__parameters_8php_source.html

00001 <?php
00002
00016 class iCalendar_parameter {
00017     function multiple_values_allowed($parameter) {
00018         switch($parameter) {
00019             case 'DELEGATED-FROM':
00020             case 'DELEGATED-TO':
00021             case 'MEMBER':
00022                 return true;
00023             default:
00024                 return false;
00025         }
00026     }
00027
00028     function default_value($parameter) {
00029         switch($parameter) {
00030             case 'CUTYPE':   return 'INDIVIDUAL';
00031             case 'FBTYPE':   return 'BUSY';
00032             case 'PARTSTAT': return 'NEEDS-ACTION';
00033             case 'RELATED':  return 'START';
00034             case 'RELTYPE':  return 'PARENT';
00035             case 'ROLE':     return 'REQ-PARTICIPANT';
00036             case 'RSVP':     return 'FALSE';
00037             default:         return NULL;
00038         }
00039     }
00040
00041     function is_valid_value(&$parent_property, $parameter, $value) {
00042         switch($parameter) {
00043             // These must all be a URI
00044             case 'ALTREP':
00045             case 'DIR':
00046                 return rfc2445_is_valid_value($value, RFC2445_TYPE_URI);
00047             break;
00048
00049             // These must be CAL-ADDRESS, which is equivalent to URI
00050             case 'DELEGATED-FROM':
00051             case 'DELEGATED-TO':
00052             case 'MEMBER':
00053             case 'SENT-BY':
00054                 return rfc2445_is_valid_value($value, RFC2445_TYPE_CAL_ADDRESS);
00055             break;
00056
00057             // RFC-2445: can contain quotes.
00058             case 'CN':
00059                 return true;
00060             break;
00061
00062             // These have enumerated legal values
00063             case 'CUTYPE':
00064                 $value = strtoupper($value);
00065                 return ($value == 'INDIVIDUAL' || $value == 'GROUP' || $value == 'RESOURCE' || $value == 'ROOM' || $value == 'UNKNOWN' || rfc2445_is_xname($value));
00066             break;
00067
00068             case 'ENCODING':
00069                 $value = strtoupper($value);
00070                 return ($value == '8BIT' || $value == 'BASE64' || rfc2445_is_xname($value));
00071             break;
00072
00073             case 'FBTYPE':
00074                 $value = strtoupper($value);
00075                 return ($value == 'FREE' || $value == 'BUSY' || $value == 'BUSY-UNAVAILABLE' || $value == 'BUSY-TENTATIVE' || rfc2445_is_xname($value));
00076             break;
00077
00078             case 'FMTTYPE':
00079                 $fmttypes = array(
00080                         'TEXT'        => array('PLAIN', 'RICHTEXT', 'ENRICHED', 'TAB-SEPARATED-VALUES', 'HTML', 'SGML',
00081                                                'VND.LATEX-Z', 'VND.FMI.FLEXSTOR'),
00082                         'MULTIPART'   => array('MIXED', 'ALTERNATIVE', 'DIGEST', 'PARALLEL', 'APPLEDOUBLE', 'HEADER-SET',
00083                                                'FORM-DATA', 'RELATED', 'REPORT', 'VOICE-MESSAGE', 'SIGNED', 'ENCRYPTED',
00084                                                'BYTERANGES'),
00085                         'MESSAGE'     => array('RFC822', 'PARTIAL', 'EXTERNAL-BODY', 'NEWS', 'HTTP'),
00086                         'APPLICATION' => array('OCTET-STREAM', 'POSTSCRIPT', 'ODA', 'ATOMICMAIL', 'ANDREW-INSET', 'SLATE',
00087                                                'WITA', 'DEC-DX', 'DCA-RFT', 'ACTIVEMESSAGE', 'RTF', 'APPLEFILE',
00088                                                'MAC-BINHEX40', 'NEWS-MESSAGE-ID', 'NEWS-TRANSMISSION', 'WORDPERFECT5.1',
00089                                                'PDF', 'ZIP', 'MACWRITEII', 'MSWORD', 'REMOTE-PRINTING', 'MATHEMATICA',
00090                                                'CYBERCASH', 'COMMONGROUND', 'IGES', 'RISCOS', 'ESHOP', 'X400-BP', 'SGML',
00091                                                'CALS-1840', 'PGP-ENCRYPTED', 'PGP-SIGNATURE', 'PGP-KEYS', 'VND.FRAMEMAKER',
00092                                                'VND.MIF', 'VND.MS-EXCEL', 'VND.MS-POWERPOINT', 'VND.MS-PROJECT',
00093                                                'VND.MS-WORKS', 'VND.MS-TNEF', 'VND.SVD', 'VND.MUSIC-NIFF', 'VND.MS-ARTGALRY',
00094                                                'VND.TRUEDOC', 'VND.KOAN', 'VND.STREET-STREAM', 'VND.FDF',
00095                                                'SET-PAYMENT-INITIATION', 'SET-PAYMENT', 'SET-REGISTRATION-INITIATION',
00096                                                'SET-REGISTRATION', 'VND.SEEMAIL', 'VND.BUSINESSOBJECTS',
00097                                                'VND.MERIDIAN-SLINGSHOT', 'VND.XARA', 'SGML-OPEN-CATALOG', 'VND.RAPID',
00098                                                'VND.ENLIVEN', 'VND.JAPANNET-REGISTRATION-WAKEUP',
00099                                                'VND.JAPANNET-VERIFICATION-WAKEUP', 'VND.JAPANNET-PAYMENT-WAKEUP',
00100                                                'VND.JAPANNET-DIRECTORY-SERVICE', 'VND.INTERTRUST.DIGIBOX', 'VND.INTERTRUST.NNCP'),
00101                         'IMAGE'       => array('JPEG', 'GIF', 'IEF', 'G3FAX', 'TIFF', 'CGM', 'NAPLPS', 'VND.DWG', 'VND.SVF',
00102                                                'VND.DXF', 'PNG', 'VND.FPX', 'VND.NET-FPX'),
00103                         'AUDIO'       => array('BASIC', '32KADPCM', 'VND.QCELP'),
00104                         'VIDEO'       => array('MPEG', 'QUICKTIME', 'VND.VIVO', 'VND.MOTOROLA.VIDEO', 'VND.MOTOROLA.VIDEOP')
00105                 );
00106                 $value = strtoupper($value);
00107                 if(rfc2445_is_xname($value)) {
00108                     return true;
00109                 }
00110                 @list($type, $subtype) = explode('/', $value);
00111                 if(empty($type) || empty($subtype)) {
00112                     return false;
00113                 }
00114                 if(!isset($fmttypes[$type]) || !in_array($subtype, $fmttypes[$type])) {
00115                     return false;
00116                 }
00117                 return true;
00118             break;
00119
00120             case 'LANGUAGE':
00121                 $value = strtoupper($value);
00122                 $parts = explode('-', $value);
00123                 foreach($parts as $part) {
00124                     if(empty($part)) {
00125                         return false;
00126                     }
00127                     if(strspn($part, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789') != strlen($part)) {
00128                         return false;
00129                     }
00130                 }
00131                 return true;
00132             break;
00133
00134             case 'PARTSTAT':
00135                 $value = strtoupper($value);
00136                 switch($parent_property->parent_component) {
00137                     case 'VEVENT':
00138                         return ($value == 'NEEDS-ACTION' || $value == 'ACCEPTED' || $value == 'DECLINED' || $value == 'TENTATIVE'
00139                                 || $value == 'DELEGATED' || rfc2445_is_xname($value));
00140                     break;
00141                     case 'VTODO':
00142                         return ($value == 'NEEDS-ACTION' || $value == 'ACCEPTED' || $value == 'DECLINED' || $value == 'TENTATIVE'
00143                                 || $value == 'DELEGATED' || $value == 'COMPLETED' || $value == 'IN-PROCESS' || rfc2445_is_xname($value));
00144                     break;
00145                     case 'VJOURNAL':
00146                         return ($value == 'NEEDS-ACTION' || $value == 'ACCEPTED' || $value == 'DECLINED' || rfc2445_is_xname($value));
00147                     break;
00148                 }
00149                 return false;
00150             break;
00151
00152             case 'RANGE':
00153                 $value = strtoupper($value);
00154                 return ($value == 'THISANDPRIOR' || $value == 'THISANDFUTURE');
00155             break;
00156
00157             case 'RELATED':
00158                 $value = strtoupper($value);
00159                 return ($value == 'START' || $value == 'END');
00160             break;
00161
00162             case 'RELTYPE':
00163                 $value = strtoupper($value);
00164                 return ($value == 'PARENT' || $value == 'CHILD' || $value == 'SIBLING' || rfc2445_is_xname($value));
00165             break;
00166
00167             case 'ROLE':
00168                 $value = strtoupper($value);
00169                 return ($value == 'CHAIR' || $value == 'REQ-PARTICIPANT' || $value == 'OPT-PARTICIPANT' || $value == 'NON-PARTICIPANT' || rfc2445_is_xname($value));
00170             break;
00171
00172             case 'RSVP':
00173                 $value = strtoupper($value);
00174                 return ($value == 'TRUE' || $value == 'FALSE');
00175             break;
00176
00177             case 'TZID':
00178                 if(empty($value)) {
00179                     return false;
00180                 }
00181                 return (strcspn($value, '";:,') == strlen($value));
00182             break;
00183
00184             case 'VALUE':
00185                 $value = strtoupper($value);
00186                 return ($value == 'BINARY'    || $value == 'BOOLEAN'    || $value == 'CAL-ADDRESS' || $value == 'DATE'    ||
00187                         $value == 'DATE-TIME' || $value == 'DURATION'   || $value == 'FLOAT'       || $value == 'INTEGER' ||
00188                         $value == 'PERIOD'    || $value == 'RECUR'      || $value == 'TEXT'        || $value == 'TIME'    ||
00189                         $value == 'URI'       || $value == 'UTC-OFFSET' || rfc2445_is_xname($value));
00190             break;
00191         }
00192     }
00193
00194     function do_value_formatting($parameter, $value) {
00195         switch($parameter) {
00196             // Parameters of type CAL-ADDRESS or URI MUST be double-quoted
00197             case 'ALTREP':
00198             case 'DIR':
00199             case 'DELEGATED-FROM':
00200             case 'DELEGATED-TO':
00201             case 'MEMBER':
00202             case 'SENT-BY':
00203                 return '"'.$value.'"';
00204             break;
00205
00206             // Textual parameter types must be double quoted if they contain COLON, SEMICOLON
00207             // or COMMA. Quoting always sounds easier and standards-conformant though.
00208             case 'CN':
00209                 return '"'.$value.'"';
00210             break;
00211
00212             // Parameters with enumerated legal values, just make them all caps
00213             case 'CUTYPE':
00214             case 'ENCODING':
00215             case 'FBTYPE':
00216             case 'FMTTYPE':
00217             case 'LANGUAGE':
00218             case 'PARTSTAT':
00219             case 'RANGE':
00220             case 'RELATED':
00221             case 'RELTYPE':
00222             case 'ROLE':
00223             case 'RSVP':
00224             case 'VALUE':
00225                 return strtoupper($value);
00226             break;
00227
00228             // Parameters we shouldn't be messing with
00229             case 'TZID':
00230                 return $value;
00231             break;
00232         }
00233     }
00234
00235     function undo_value_formatting($parameter, $value) {
00236     }
00237
00238 }