v3.24現在、globalfunctions.php内には、68個のファンクションが存在します。
一応、全ファンクションの土台を作りました。間違い、補足など、お気付きの点がありましたら、積極的に編集してください。プラグイン作りに必要な情報を、Wikiに集結できたら良いなと思っています。
int getNucleusVersion()
int intPostVar(string name)
HTTP POSTを通して渡された値をinteger型に変換して返す
int intGetVar(string name)
HTTP GETを通して渡された値をinteger型に変換して返す
int intRequestVar(string name)
リクエスト変数$_REQUESTは、$_GET, $_POST, $_COOKIE, $_FILES の内容を格納した連想配列です。($_REQUESTの詳細についてはPHPマニュアルを参照) 未対応サーバでは、自動的に、$_POST、$_GETから値を得るようになっています。
int intCookieVar(string name)
string sql_table(string name)
省略したテーブル名("blog"など)から、正式なテーブル名を返す
void sendContentType(string contenttype, string pagetype, string charset)
PreSendContentTypeイベントを発生させます。
void startUpError(string msg, string title)
resource sql_query(string query)
エラーの場合queryをprintします。
string highlight(string text, mixed expression, string highlight)
文字列内の特定キーワードを、テンプレートで置き換えた結果を返す
配列で複数キーワードを指定する事も可能です。 v3.23現在、バグがあります。詳細は、Nucleus(JP)フォーラム :: grobalfunctions.phpのhighlightファンクションに不具合参照
mixed parseHighlight(string query)
半角2文字以下のキーワードは無効となります。
int isValidMailAddress(string address)
string getBlogIDFromName(string name)
string getBlogIDFromItemID(int itemid)
string getBlogIDFromCommentID(int commentid)
string getBlogIDFromCatID(int catid)
string getCatIDFromName(string name)
string quickQuery(string q)
例えば、
//ブログテーブルの指定ブログidのブログ名を摘出 $bname = quickQuery('SELECT bname as result FROM '.sql_table('blog').' WHERE bnumber='.intval($id));
void doError(string msg, object skin)
int isValidShortName(string name)
int isValidDisplayName(string name)
メンバー名(表示される名前)として有効な文字列かどうか確認する
int isValidCategoryName(string name)
実際には、常に1を返している
int isValidTemplateName(string name)
string addBreaks(string var)
文字列に含まれるすべての改行文字の前に'<br />'を挿入して返す nl2brをかけているだけです。
string removeBreaks(string var)
文字列の行末に含まれるすべての'<br />'を削除して返す nl2brの逆の効果です。
string shorten(string text, int maxlength, string toadd)
文字列textを最大文字数maxlengthで丸めた文字列を返す 文字列text内の特殊文字をHTMLエンティティに変換したのち、指定文字数maxlengthで丸めます。丸めた場合、指定文字列toaddを末尾に添加します。
string mysqldate(int timestamp)
UNIXタイムスタンプをMySQL DATETIME形式に変換して、ダブルクォーテーションで囲んだ文字列を返す
void selectBlog(string shortname)
ブログショートネームから、グローバル変数$blogidと、$archivelistを設定する
void selectCategory(mixed cat)
パラメータcatが数値として評価できる場合、パラメータcatをそのままカテゴリidとします。
void parseFile(string filename)
(スキンタイプに、’fileparser’というのは見当たりません。詳細不明)
void addToLog(int level, string msg)
void help(string id)
Nucleusポップアップ・ヘルプを開くリンクアイコンを表示
echo helpHtml($id);
としているだけ
string helpHtml(string id)
Nucleusポップアップ・ヘルプを開くリンクアイコン表示用HTML文字列を返す
string helplink(string id)
Nucleusポップアップ・ヘルプを開くリンク文字列の一部を返す
bool checkLanguage(string lang)
bool checkPlugin(string plug)
指定プラグインのプラグインファイルが存在するかどうか確認する
string createItemLink(int itemid, mixed extra)
アイテムid、URLモードなどから、アイテムページのURLを生成し返す
string createMemberLink(int memberid, mixed extra)
メンバーid、URLモードなどから、メンバーページのURLを生成し返す
string createCategoryLink(int catid, mixed extra)
カテゴリid、URLモードなどから、カテゴリ指定したインデックスページのURLを生成し返す
string createArchiveListLink(int blogid, mixed extra)
ブログid、URLモードなどから、アーカイブリストページのURLを生成し返す
string createArchiveLink(int blogid, string archive, mixed extra)
ブログid、日付文字列、URLモードなどから、アーカイブページのURLを生成し返す
string createBlogidLink(int blogid, mixed params)
ブログid、URLモードなどから、指定ブログのURLを生成し返す
string createLink(string type, array params)
パラメータ、URLモードなどから、指定タイプページのURLを生成し返す
GenerateURLイベントを発生させます。(プラグインでURLを独自に変更することが可能)
string createBlogLink(string url, array params)
指定URLlに、指定パラメータparamsを加えたURL文字列を返す
return addLinkParams($url . '?', $params);
としているだけ
string addLinkParams(string link, array params)
URLモードに合った形式で、指定URLlに、指定パラメータparamsを加えたURL文字列を返す
string alterQueryStr(string querystr, string param, string value)
指定パラメータが存在しない場合、パラメータと値を追加します。
//e.g. echo alterQueryStr('foo=1&bar=2&x=y', 'bar', '5'); //結果 : foo=1&bar=5&x=y echo alterQueryStr('foo=1&bar=2&x=y', 'abc', 'def'); //結果 : foo=1&bar=2&x=y&abc=def
void passVar(string key, string value)
指定の名前key、指定の値valueで、<input type="hidden">タグを生成
string formatDate(string format, int timestamp, string defaultFormat, string blog)
string stringStripTags(string string)
HTMLタグ、及び、<del>、<script>、<style>タグの内部の文字列を削除した文字列を返す
string stringToAttribute(string string)
詳細不明
string stringToXML(string string)
詳細不明