COM functions
出典: GeeklogJpWiki
Geeklog共通ライブラリ⇒ COM_functions |DB_functions |plugin_functions |CUSTOM_functions |ADMIN_functions |CMT_functions |SEC_functions |USER_functions |MBYTE_functions |PNB_functions |SESS_functions |STORY_functions |SYND_functions |TRB_functions |WS_functions
[編集]
lib-common.php
「はじめに」
lib-common.phpは，index.phpなど，Geeklogのプログラムから常に読み込まれているファイルであり， Geeklogのすべて（静的ページPHP、Geeklogプラグイン、Geeklogアプリケーションなど）で使える、Geeklog共通ライブラリを提供しています。
[編集]
関数
|
関数名 |
引数 |
機能 |
|---|---|---|
| COM_siteHeader | $what = 'menu', $pagetitle = '', $headercode = '' | 編集されたサイトヘッダを返す。 |
| COM_siteFooter | $rightblock = -1, $custom = '' | 編集されたサイトフッタを返す。 |
| COM_startBlock | $title='', $helpfile='', $template='blockheader.thtml' | 標準ブロックヘッダをprintoutする。 |
| COM_endBlock | $template='blockfooter.thtml' | COM_startBlockを終了する |
| COM_optionList | $table, $selection, $selected='', $sortcol=1, $where='' | 与えられた引数からformに使うプルダウンメニュをデータベースから生成。 |
| COM_topicList | $selection, $selected = '', $sortcol = 1, $ignorelang = false | 話題選択プルダウンメニュオプションを返す |
| COM_checkList | $table, $selection, $where='', $selected='' | データベースリストからformで使う<input>チェックリストをつくる。 |
| COM_debug | $A | デバッギング用に連想配列を表示する。デバッグの連想配列の中身をリスト形式のHTMLにして返す |
| COM_rdfUpToDateCheck | $updated_type = '', $updated_topic = '', $updated_id = '' | RDFファイルがアップデート必要かチェックし、必要ならアップデートする。 |
| COM_featuredCheck | 全ての記事の'注目記事'状況を確認する。 | |
| COM_errorLog | $logentry, $actionid = '' | error.logまたはWebPageにエラーログを記録する、 |
| COM_accessLog | $logentry | アクセスログを記録する |
| COM_showTopics | $topic='' | 表示可能なすべての話題を表示。 |
| COM_userMenu | $help='', $title='' , $position = ''
$position は、1.5.0で追加| | ユーザーにメニューオプションを表示する。 |
| COM_adminMenu | $help = '', $title = '' , $position = ''
$position は、1.5.0で追加 | 管理者専用メニューを表示する。 |
| COM_refresh | $url | 与えられたURLにリダイレクトする。 |
| COM_userComments | $sid, $title, $type='article', $order='', $mode='', $pid = 0, $page = 1, $cid = false, $delete_option = false ) | 廃止。 |
| COM_checkWords | $Message | bad wordsを適当なものに置き換える |
| COM_killJS | $Message | JavaScriptイベントのon*=をin*=に置き換える。 |
| COM_handleCode | $str | [code] ... [/code] で囲まれた部分を処理する。 |
| COM_checkHTML | $str, $permissions = 'story.edit' | HTMLタグをチェックする。 |
| COM_undoSpecialChars | $string | htmlspecialchars()のUNDO関数。 |
| COM_makesid | 記事ID (Story ID, sid) を生成して返す。 | |
| COM_isEmail | 有効なEmailアドレスであるかチェックする | |
| COM_emailEscape | $string | 文字列をメールヘッダーで使える形式にして返す |
| COM_formatEmailAddress | $name, $address | 名前とアドレスから、整えられたメールアドレスを返す |
| COM_mail | $to, $subject, $message, $from = '', $html = false, $priority = 0, $cc = '' | メールを送信する。 |
| COM_olderStuff | blocksテーブルに記録されてる内容を設定どおりに更新する。 | |
| COM_showBlock | $name, $help='', $title='' | 一つのgeeklogブロックを表示する。 |
| COM_showBlocks | $side, $topic='', $name='all' | Geeklogブロック(複数)を表示する。 |
| COM_formatBlock | $A, $noboxes = false | geeklogブロックを作成する。 |
| COM_rdfCheck | $bid, $rdfurl, $date, $maxheadlines = 0 | RDF/RSSブロックからデータを取り込むタイミングをチェック。 |
| COM_rdfImport | $bid, $rdfurl, $maxheadlines = 0 | フィード取り込み関数。 |
| COM_allowedHTML | $permissions = 'story.edit', $list_only = false | コンテンツに許可されているhtmlを返す。 |
| COM_getPassword | $loginname | ユーザ名($loginname)からパスワードを返す |
| COM_getDisplayName | $uid = '', $username='', $fullname='', $remoteusername='', $remoteservice='' | ユーザの名前を返す |
| COM_hit | システムへのヒット数を加算。 | |
| COM_emailUserTopics | 記事をemailで投稿する | |
| COM_whatsNewBlock | $help = '', $title = '' | ブロックに新着情報を表示する。 |
| COM_formatTimeString | $time_string, $time, $type = '', $amount = 0 | 時間を示す文字列をつくる。 |
| COM_showMessage | $msg, $plugin='' | システムからのメッセージを表示する |
| COM_printPageNavigation | $base_url, $curpage, $num_pages, | Google(tm)ライクなページナビゲーションを表示。 |
| COM_getUserDateTimeFormat | $date='' | ユーザー設定による日付時間フォーマットを返す |
| COM_getUserCookieTimeout | ユーザー設定cookieのタイムアウトを返す。 | |
| COM_getMonthFormOptions | $selected = '' | 月選択プルダウンメニュオプションを返す |
| COM_getDayFormOptions | $selected = '' | 日選択プルダウンメニュオプションを返す |
| COM_getYearFormOptions | $selected = '' | ５年間の年選択プルダウンメニュオプションを返す。 |
| COM_getHourFormOptions | $selected = '', $mode = 12 | 時刻（時）選択プルダウンメニュオプションを返す |
| COM_getMinuteFormOptions | $selected = '', $step = 1 | 時刻（分）選択プルダウンメニュオプションを返す |
| COM_getMinuteOptions | $selected = '', $step = 1 | 後方互換性のためのみに残されている。 |
| COM_getAmPmFormSelection | $name, $selected = '' | 時刻（AM PM）選択プルダウンメニュオプションを返す |
| COM_makeList | $listofitems, $classname = '' | 与えられた列に対して<li>タグを生成する。 |
| COM_checkSpeedlimit | $type = 'submit', $max = 1 | 間隔制限（SpeedLimit)を適用するかチェックする。 |
| COM_updateSpeedlimit | $type = 'submit' | 間隔制限(speedlimit)の投稿情報を保存する |
| COM_clearSpeedlimit | $speedlimit = 60, $type = '' | 無効になった間隔制限（Speedlimit）を解除する。 |
| COM_buildURL | $url | URL classのラッパー関数。 |
| COM_setArgNames | $names | URLラッパー関数。URLにある引数をセットする。 |
| COM_getArgument | $name | URL classのラッパー関数、特定のargumentの値を返す。 |
| COM_getRate | $occurrences, $timespan | 発生頻度と時間。 |
| COM_getPermSQL | $type = 'WHERE', $u_id = 0, $access = 2, $table = '' | パーミッションチェックのためのSQL表現を返す。 |
| COM_getTopicSQL | $type = 'WHERE', $u_id = 0, $table = '' | 許可された話題をチェックしてSQL表現を返す。 |
| COM_stripslashes | $text | magic_quotes_gpc = onの場合のみ文字列からスラッシュを取り去る。 |
| COM_applyFilter | $parameter, $isnumeric = false | GET (URL) か POSTでフィルターされたパラメータ。 |
| COM_sanitizeUrl | $url, $allowed_protocols = '', $default_protocol = '' | URLをサニタイズする。 |
| COM_makeClickableLinks | $text | プレーンアスキーテキストを検知し、クリッカブルリンクに代える。 |
| COM_undoClickableLinks | $text | URLのクリッカブルリンク生成をUNDOする。 |
| COM_highlightQuery | $text, $query | 検索クエリーで検索された言葉をハイライトする。
|
| COM_dateDiff | $interval, $date1, $date2 | 2つの日付の差を決める。入力値はUNIXタイムスタンプでも英語表記の日付でも可。自動的にdate diffを行う。入力の順番は問われない。 |
| COM_getCurrentURL | すべてのパラメータを含むカレントURLを返す。 | |
| COM_onFrontpage | 閲覧者がGeeklogのindexページにいるのか否かをチェックする。 | |
| COM_isFrontpage | Geeklogのindexページにいるか否かをチェックする。[非推奨] | |
| COM_sanitizeID | $id, $new_id = true | IDをサニタイズ。 |
| COM_numberFormat | $number | 数値をカンマ編集（1000単位）して返す。 |
| COM_convertDate2Timestamp | $date, $time = '' | テキストベースのYYYY-MM-DDをUNIXタイムスタンプインテグラ値に置換え |
| COM_getImgSizeAttributes | $file | 高さ・幅の情報つきの画像HTMLを取得する。 |
| COM_displayMessageAndAbort | $msg, $plugin = '', $http_status = 200, $http_text = 'OK' | メッセージを表示して中止する |
| COM_getTopicImageUrl | $imageurl | 話題アイコンのフルURLを返す。 |
| COM_getLanguageFromBrowser | ユーザーが使っている言語をブラウザ判断する。 | |
| COM_getLanguage | 現状使われている言語を取得する。 | |
| COM_getLanguageId | $language = '' | 現状使われている言語のIDを決定する。 |
| COM_getLangSQL | $field, $type = 'WHERE', $table = '' | リクエストした言語のコンテンツからSQL表現を返す。 |
| COM_switchLocaleSettings | ロケールを各言語用の設定でオーバーライドする。 | |
| COM_truncate | $text, $maxlen, $filler = '' | テキスト($text)を指定文字数($maxlen)に切り詰める。 |
| COM_handleError | $errno, $errstr, $errfile='', $errline=0, $errcontext='' | エラーを処理する。 |
[編集]
1.5.0で追加された関数
|
関数名 |
引数 |
機能 |
|---|---|---|
| COM_topicArray | $selection, $sortcol = 0, $ignorelang = false | 話題のリストを配列で返す。 |
| COM_applyBasicFilter | $parameter, $isnumeric = false | パラメータをフィルターする。 |
| COM_sanitizeFilename | $filename, $allow_dots = false | ファイル名をサニタイズ |
| COM_createLink | $content, $url, $attr = array() | HTMLのlinkを作成 |
| COM_createImage | $url, $alt = "", $attr = array() | HTMLのimgを作成 |
| COM_getCharset | 現在のキャラクターセットを取得する。 | |
| COM_isAnonUser | $uid = '' | ログインしていないユーザーの有無をチェックする。 |
| COM_getBlockTemplate | ブロックテンプレートで使うファイルを返す。 | |
| COM_getThemes | インストール済みの全てのテーマを取得。 | |
| COM_renderMenu | メニューを生成。 | |
| COM_resetSpeedlimit | 間隔制限(speedlimit)をリセット | |
| COM_rootDebugClean | rootdebug用。 | |
| phpblock_switch_language | 言語変更のためのドロップダウンメニューを提供する | |
| phpblock_whosonline | オンラインユーザーを表示 |
