LV. MCAL 関数

導入

MCAL は、Modular Calendar Access Library を意味します。

libmcal は、カレンダーアクセス用の C ライブラリです。このライブラ リは、結合性の高いドライバとして書かれています。MCAL は、メールボッ クス用の IMAP モジュールのカレンダー版です。

mcal サポート機能により、カレンダーストリームを IMAP サポート機能 によるメールボックスストリームと全く同様にオープンすることができま す。カレンダーは、ローカルファイルに保存したり、リモートのICAPサー バーとしたり、mcal ライブラリによりサポートされる他のフォーマット とすることができます。

カレンダーイベントは、発生、検索、保存することができます。カレンダー のトリガー(アラーム)および定期的なイベントもサポートされます。

libmcal により、メインのカレンダーサーバーをアクセス、使用することが できます。この場合、特定のデータベースおよびローカルファイルに依存した プログラミングは必要ありません。

多くの関数は、各ストリーム毎に固有の内部イベント構造体を使用します。 これにより、大きなオブジェクトを関数の間で渡すことが容易になります。 イベント構造体の値を設定、初期化、取得する便利な関数があります。

注意: PHPには、ICAP拡張モジュールが以前ありましたが、元のライブラリと このPHP拡張モジュールはもうサポートされていません。推奨される代 替品はMCALです。

注意: この拡張モジュールはWindows環境 では利用できません。

要件

mcalライブラリがインストールされている必要があります。最新版を http://mcal.chek.com/から取得し、コンパイル、 インストールしてください。

インストール手順

mcalライブラリをインストールした後、これらの関数を動作させるには、 PHP を--with-mcal[=DIR] を付けてコ ンパイルする必要があります。

実行用の設定

この拡張モジュールは設定ディレクティブを全く 定義しません。

リソース型

この拡張モジュールはリソース型を全く定義し ません。

定義済みの定数

これらの定数は、この拡張モジュールで定義されており、 この拡張モジュールがPHP内部にコンパイルされているか実行時に動的にロー ドされるかのどちらかの場合のみ使用可能です。

MCAL_SUNDAY (integer)

MCAL_MONDAY (integer)

MCAL_TUESDAY (integer)

MCAL_WEDNESDAY (integer)

MCAL_THURSDAY (integer)

MCAL_FRIDAY (integer)

MCAL_SATURDAY (integer)

MCAL_JANUARY (integer)

MCAL_FEBRUARY (integer)

MCAL_MARCH (integer)

MCAL_APRIL (integer)

MCAL_MAY (integer)

MCAL_JUNE (integer)

MCAL_JULY (integer)

MCAL_AUGUST (integer)

MCAL_SEPTEMBER (integer)

MCAL_OCTOBER (integer)

MCAL_NOVEMBER (integer)

MCAL_DECEMBER (integer)

MCAL_RECUR_NONE (integer)

MCAL_RECUR_DAILY (integer)

MCAL_RECUR_WEEKLY (integer)

MCAL_RECUR_MONTHLY_MDAY (integer)

MCAL_RECUR_MONTHLY_WDAY (integer)

MCAL_RECUR_YEARLY (integer)

MCAL_M_SUNDAY (integer)

MCAL_M_MONDAY (integer)

MCAL_M_TUESDAY (integer)

MCAL_M_WEDNESDAY (integer)

MCAL_M_THURSDAY (integer)

MCAL_M_FRIDAY (integer)

MCAL_M_SATURDAY (integer)

MCAL_M_WEEKDAYS (integer)

MCAL_M_WEEKEND (integer)

MCAL_M_ALLDAYS (integer)

目次
mcal_append_event -- MCALカレンダーに新規イベントを保存する
mcal_close -- MCAL ストリームを閉じる
mcal_create_calendar -- 新規にMCALカレンダを作成する
mcal_date_compare -- 二つの日付を比較する
mcal_date_valid --  指定した年月日が有効な日付である場合に TRUE を返す
mcal_day_of_week --  指定した日の曜日を返す
mcal_day_of_year --  指定した日の年間積算日を返す
mcal_days_in_month --  指定した月の日数を返す
mcal_delete_calendar -- MCALカレンダを削除する
mcal_delete_event -- MCAL カレンダーからイベントを削除する
mcal_event_add_attribute --  グローバルイベント構造体ストリームに属性およびその値を追加する
mcal_event_init --  グローバルイベント構造体のストリームを初期化する
mcal_event_set_alarm --  グローバルイベント構造体ストリームのアラームを設定する
mcal_event_set_category --  グローバルイベント構造体ストリームの«テゴリを設定する
mcal_event_set_class --  グローバルイベント構造体ストリームのクラスを設定する
mcal_event_set_description --  グローバルイベント構造体ストリームの description を設定する
mcal_event_set_end --  グローバルイベント構造体ストリームの終了日を設定する
mcal_event_set_recur_daily --  グローバルイベント構造体ストリームの反復を設定する
mcal_event_set_recur_monthly_mday --  グローバルイベント構造体ストリームの繰り返しを設定する
mcal_event_set_recur_monthly_wday --  グローバルイベント構造体ストリームの繰り返しを設定する
mcal_event_set_recur_none --  グローバルイベント構造体ストリームの反復を設定する
mcal_event_set_recur_weekly --  グローバルイベント構造体ストリームの繰り返しを設定する
mcal_event_set_recur_yearly --  グローバルイベント構造体ストリームの繰り返しを設定する
mcal_event_set_start --  グローバルイベント構造体ストリームの開始日を設定する
mcal_event_set_title --  グローバルイベント構造体ストリームのtitleを設定する
mcal_expunge --  削除マークを付けられた全てのイベントを削除する
mcal_fetch_current_stream_event --  現在のイベント構造体ストリームを有するオブジェクトを返す
mcal_fetch_event --  カレンダーストリームからイベントを取得する
mcal_is_leap_year --  指定した年が閏年であるかどうかを返す
mcal_list_alarms --  指定した datetime までにアラームを発生するイベントのリストを返す
mcal_list_events --  日付または日付の範囲に関してIDのリストを返す
mcal_next_recurrence -- イベントが次に発生する日を返す
mcal_open -- MCAL 接続をオープンする
mcal_popen -- 永続的なMCAL接続をオープンする
mcal_rename_calendar -- MCALカレンダの名前を変更する
mcal_reopen -- MCAL接続を再オープンする
mcal_snooze -- イベントのアラームをオフにする
mcal_store_event -- MCALカレンダーの既存のイベントを修正する
mcal_time_valid --  指定した時間、分、秒が有効な時間である場合に TRUE を返す
mcal_week_of_year --  指定した日付の週番号を返す