plugindev:globalfunctions

Nucleusグローバルファンクション リファレンス

v3.24現在、globalfunctions.php内には、68個のファンクションが存在します。

一応、全ファンクションの土台を作りました。間違い、補足など、お気付きの点がありましたら、積極的に編集してください。プラグイン作りに必要な情報を、Wikiに集結できたら良いなと思っています。

概要一覧

リファレンス

getNucleusVersion

int getNucleusVersion()

Nucleusのバージョンを返す

  • 戻り値
    • Nucleusのバージョンを表す数値(100 = 1.00, 101 = 1.01, etc…)
  • パラメータ
    • なし

intPostVar

int intPostVar(string name)

HTTP POSTを通して渡された値をinteger型に変換して返す

  • 戻り値
    • intval()で整数に変換したpostVar(string name)
  • パラメータ
    • string name : POST配列のキー

intGetVar

int intGetVar(string name)

HTTP GETを通して渡された値をinteger型に変換して返す

  • 戻り値
    • intval()で整数に変換したgetVar(string name)
  • パラメータ
    • string name : GET配列のキー

intRequestVar

int intRequestVar(string name)

リクエスト変数に渡された値をinteger型に変換して返す

リクエスト変数$_REQUESTは、$_GET, $_POST, $_COOKIE, $_FILES の内容を格納した連想配列です。($_REQUESTの詳細についてはPHPマニュアルを参照) 未対応サーバでは、自動的に、$_POST、$_GETから値を得るようになっています。

  • 戻り値
    • intval()で整数に変換したrequestVar(string name)
  • パラメータ
    • string name : REQUEST配列のキー

intCookieVar

int intCookieVar(string name)

HTTP クッキーの情報をinteger型に変換して返す

  • 戻り値
    • intval()で整数に変換したcookieVar(string name)
  • パラメータ
    • string name : COOKIE配列のキー

sql_connect

resource sql_connect()

MySQL サーバへの接続をオープンする

  • 戻り値
    • 成功した場合に MySQL リンク ID(mysql_connect()の戻り値)
  • パラメータ
    • なし

sql_table

string sql_table(string name)

省略したテーブル名("blog"など)から、正式なテーブル名を返す

  • 戻り値
    • テーブル接頭辞なども考慮した、データベース内の正式なテーブル名
  • パラメータ
    • string name : 省略テーブル名

sendContentType

void sendContentType(string contenttype, string pagetype, string charset)

HTTPヘッダーにコンテントタイプをセット

PreSendContentTypeイベントを発生させます。

  • 戻り値
    • なし
  • パラメータ
    • string contenttype : コンテントタイプ(application/xhtml+xmlなど)
    • string pagetype : 表示するページの種類を示す文字列:skin (スキンタイプ), media (メディアライブラリ), admin-action (管理エリア), bookmarklet-action (ブックマークレット)
    • string charset : キャラクターセット

startUpError

void startUpError(string msg, string title)

エラーメッセージを表示して終了させる

  • 戻り値
    • なし
  • パラメータ
    • string msg : ページタイトル
    • string title : メッセージ内容

sql_disconnect

void sql_disconnect()

MySQL接続を閉じる

(mysql_closeを行うのみ)

  • 戻り値
    • なし
  • パラメータ
    • なし

sql_query

resource sql_query(string query)

アクティブなデータベースへMySQLクエリを送信する

エラーの場合queryをprintします。

  • 戻り値
    • mysql_query関数の戻り値を返す
  • パラメータ
    • string query : SQLクエリ

highlight

string highlight(string text, mixed expression, string highlight)

文字列内の特定キーワードを、テンプレートで置き換えた結果を返す

配列で複数キーワードを指定する事も可能です。 v3.23現在、バグがあります。詳細は、Nucleus(JP)フォーラム :: grobalfunctions.phpのhighlightファンクションに不具合参照

  • 戻り値
    • 変換した結果の文字列
  • パラメータ
    • string text : 置換え対象文字列
    • mixed expression : キーワード(配列で複数キーワードを指定する事も可能)
    • string highlight : 置換えテンプレート e.g.<span class='highlight'>\0</span>

parseHighlight

mixed parseHighlight(string query)

文字列から半角スペースで区切れたキーワードを摘出し、返す

半角2文字以下のキーワードは無効となります。

  • 戻り値
    • 摘出したキーワード(複数存在する場合配列で、1つだけの場合スカラー型で返します。)
  • パラメータ
    • string query : 対象文字列

isValidMailAddress

int isValidMailAddress(string address)

メールアドレスとして有効な文字列かどうか確認する

  • 戻り値
    • 1:真、0:偽
  • パラメータ
    • string address : 確認する文字列

getBlogIDFromName

string getBlogIDFromName(string name)

ブログショートネームから、ブログidを返す

  • 戻り値
    • ブログid(string型として返ってきますが、PHPが自動的に型変換を行いますので、数値として扱って問題ありません。)
  • パラメータ
    • string name : ブログショートネーム

getBlogNameFromID

string getBlogNameFromID(int id)

ブログidから、ブログ名を返す

  • 戻り値
    • ブログ名
  • パラメータ
    • int id : ブログid

getBlogIDFromItemID

string getBlogIDFromItemID(int itemid)

アイテムidから、所属するブログのブログidを返す

  • 戻り値
    • ブログid(string型として返ってきますが、PHPが自動的に型変換を行いますので、数値として扱って問題ありません。)
  • パラメータ
    • int itemid : アイテムid

getBlogIDFromCommentID

string getBlogIDFromCommentID(int commentid)

コメントidから、所属するブログのブログidを返す

  • 戻り値
    • ブログid(string型として返ってきますが、PHPが自動的に型変換を行いますので、数値として扱って問題ありません。)
  • パラメータ
    • int commentid : コメントid

getBlogIDFromCatID

string getBlogIDFromCatID(int catid)

カテゴリidから、所属するブログのブログidを返す

  • 戻り値
    • ブログid(string型として返ってきますが、PHPが自動的に型変換を行いますので、数値として扱って問題ありません。)
  • パラメータ
    • int catid : カテゴリid

getCatIDFromName

string getCatIDFromName(string name)

カテゴリ名から、カテゴリidを返す

  • 戻り値
    • カテゴリid(string型として返ってきますが、PHPが自動的に型変換を行いますので、数値として扱って問題ありません。)
  • パラメータ
    • string name : カテゴリ名

quickQuery

string quickQuery(string q)

データベース内の指定条件、指定カラムの値を返す

例えば、

//ブログテーブルの指定ブログidのブログ名を摘出
$bname = quickQuery('SELECT bname as result FROM '.sql_table('blog').' WHERE bnumber='.intval($id));
  • 戻り値
    • MySQLからの結果値
  • パラメータ
    • string q : 結果を得たいカラムをresultと名付けたクエリ文字列

getPluginNameFromPid

string getPluginNameFromPid(int pid)

プラグインidから、プラグイン名を返す

  • 戻り値
    • プラグイン名
  • パラメータ
    • int pid : プラグインid

selector

void selector()

Action実行、スキンタイプごとの設定、スキンパースなどの処理

  • 戻り値
    • なし
  • パラメータ
    • なし

doError

void doError(string msg, object skin)

エラーメッセージを、エラースキンでパース

  • 戻り値
    • なし
  • パラメータ
    • string msg : エラーメッセージ
    • object skin : スキンインスタンス(指定しない場合、デフォルトスキン)

getConfig

void getConfig()

$CONFの初期化

  • 戻り値
    • なし
  • パラメータ
    • なし

isValidShortName

int isValidShortName(string name)

ブログショートネームとして有効な文字列かどうか確認する

  • 戻り値
    • マッチした文字列の長さ
  • パラメータ
    • string name : ブログショートネーム

isValidDisplayName

int isValidDisplayName(string name)

メンバー名(表示される名前)として有効な文字列かどうか確認する

  • 戻り値
    • マッチした文字列の長さ
  • パラメータ
    • string name : メンバー名

isValidCategoryName

int isValidCategoryName(string name)

カテゴリ名として有効な文字列かどうか確認する

実際には、常に1を返している

  • 戻り値
    • 常に1
  • パラメータ
    • string name : カテゴリ名

isValidTemplateName

int isValidTemplateName(string name)

テンプレート名として有効な文字列かどうか確認する

  • 戻り値
    • マッチした文字列の長さ
  • パラメータ
    • string name : テンプレート名

isValidSkinName

int isValidSkinName(string name)

スキン名として有効な文字列かどうか確認する

  • 戻り値
    • マッチした文字列の長さ
  • パラメータ
    • string name : スキン名

addBreaks

string addBreaks(string var)

文字列に含まれるすべての改行文字の前に'<br />'を挿入して返す nl2brをかけているだけです。

  • 戻り値
    • 変換後の文字列
  • パラメータ
    • string var : 変換対象文字列

removeBreaks

string removeBreaks(string var)

文字列の行末に含まれるすべての'<br />'を削除して返す nl2brの逆の効果です。

  • 戻り値
    • 変換後の文字列
  • パラメータ
    • string var : 変換対象文字列

shorten

string shorten(string text, int maxlength, string toadd)

文字列textを最大文字数maxlengthで丸めた文字列を返す 文字列text内の特殊文字をHTMLエンティティに変換したのち、指定文字数maxlengthで丸めます。丸めた場合、指定文字列toaddを末尾に添加します。

  • 戻り値
    • 変換後の文字列
  • パラメータ
    • string text : 変換対象文字列
    • int maxlength : 最大文字数
    • string $toadd : 丸めた場合、末尾に付ける文字列

mysqldate

string mysqldate(int timestamp)

UNIXタイムスタンプをMySQL DATETIME形式に変換して、ダブルクォーテーションで囲んだ文字列を返す

  • 戻り値
    • MySQL DATETIME形式文字列
  • パラメータ
    • int timestamp : タイムスタンプ

selectBlog

void selectBlog(string shortname)

ブログショートネームから、グローバル変数$blogidと、$archivelistを設定する

  • 戻り値
    • なし
  • パラメータ
    • string shortname : ブログショートネーム

selectSkin

void selectSkin(string skinname)

スキン名から、グローバル変数$skinidを設定する

  • 戻り値
    • なし
  • パラメータ
    • string skinname : スキン名

selectCategory

void selectCategory(mixed cat)

カテゴリ名から、グローバル変数$catidを設定する

パラメータcatが数値として評価できる場合、パラメータcatをそのままカテゴリidとします。

  • 戻り値
    • なし
  • パラメータ
    • mixed cat : カテゴリ名および、カテゴリid

selectItem

void selectItem(int id)

アイテムidから、グローバル変数$itemidを設定する

  • 戻り値
    • なし
  • パラメータ
    • int id : アイテムid

selectLanguage

void selectLanguage(string language)

ランゲージファイルの読み込み

  • 戻り値
    • なし
  • パラメータ
    • string language : 言語文字列

parseFile

void parseFile(string filename)

指定ファイルをfileparserタイプとしてパースする

(スキンタイプに、'fileparser'というのは見当たりません。詳細不明)

  • 戻り値
    • なし
  • パラメータ
    • string filename : ファイル名

debug

void debug(string msg)

デバッグ用メッセージを出力する

echo '<p><b>' . $msg . "</b></p>\n";

としているだけ

  • 戻り値
    • なし
  • パラメータ
    • string msg : メッセージ

addToLog

void addToLog(int level, string msg)

アクションログに、メッセージを追加する

  • 戻り値
    • なし
  • パラメータ
    • int level : レベル($CONF['LogLevel']より小さい場合有効)
    • string msg : メッセージ

ACTIONLOGクラスのaddメソッドへのショートカットです。

help

void help(string id)

Nucleusポップアップ・ヘルプを開くリンクアイコンを表示

echo helpHtml($id);

としているだけ

  • 戻り値
    • なし
  • パラメータ
    • string id : ヘルプページの各アンカー

helpHtml

string helpHtml(string id)

Nucleusポップアップ・ヘルプを開くリンクアイコン表示用HTML文字列を返す

  • 戻り値
    • help()で表示する内容
  • パラメータ
    • string id : ヘルプページの各アンカー

string helplink(string id)

Nucleusポップアップ・ヘルプを開くリンク文字列の一部を返す

  • 戻り値
    • helpHtmlのリンク部分
  • パラメータ
    • string id : ヘルプページの各アンカー

getMailFooter

string getMailFooter()

メールのフッタ文字列を返す

  • 戻り値
    • メールフッタ文字列
  • パラメータ
    • なし

getLanguageName

string getLanguageName()

使用言語名を返す

  • 戻り値
    • 使用言語名
  • パラメータ
    • なし

includephp

mixed includephp(string filename)

指定ファイルが存在するならincludeする

  • 戻り値
    • なし
  • パラメータ
    • string filename : ファイル名

checkLanguage

bool checkLanguage(string lang)

指定言語の言語ファイルが存在するかどうか確認する

  • 戻り値
    • TRUE:真、FALSE:偽
  • パラメータ
    • string lang : Language("japanese-utf8"など)

checkPlugin

bool checkPlugin(string plug)

指定プラグインのプラグインファイルが存在するかどうか確認する

  • 戻り値
    • TRUE:真、FALSE:偽
  • パラメータ
    • string plug : プラグイン名(NP_からはじまるプラグイン名)

string createItemLink(int itemid, mixed extra)

アイテムid、URLモードなどから、アイテムページのURLを生成し返す

  • 戻り値
    • リンクURL
  • パラメータ
    • int itemid : アイテムid
    • mixed extra : その他のパラメータ

string createMemberLink(int memberid, mixed extra)

メンバーid、URLモードなどから、メンバーページのURLを生成し返す

  • 戻り値
    • リンクURL
  • パラメータ
    • int memberid : メンバーid
    • mixed extra : その他のパラメータ

string createCategoryLink(int catid, mixed extra)

カテゴリid、URLモードなどから、カテゴリ指定したインデックスページのURLを生成し返す

  • 戻り値
    • リンクURL
  • パラメータ
    • int catid : カテゴリid
    • mixed extra : その他のパラメータ

string createArchiveListLink(int blogid, mixed extra)

ブログid、URLモードなどから、アーカイブリストページのURLを生成し返す

  • 戻り値
    • リンクURL
  • パラメータ
    • int blogid : ブログid
    • mixed extra : その他のパラメータ

string createArchiveLink(int blogid, string archive, mixed extra)

ブログid、日付文字列、URLモードなどから、アーカイブページのURLを生成し返す

  • 戻り値
    • リンクURL
  • パラメータ
    • int blogid : ブログid
    • string archive : 日付文字列
    • mixed extra : その他のパラメータ

string createBlogidLink(int blogid, mixed params)

ブログid、URLモードなどから、指定ブログのURLを生成し返す

  • 戻り値
    • リンクURL
  • パラメータ
    • int blogid : ブログid
    • mixed params : その他のパラメータ

string createLink(string type, array params)

パラメータ、URLモードなどから、指定タイプページのURLを生成し返す

GenerateURLイベントを発生させます。(プラグインでURLを独自に変更することが可能)

  • 戻り値
    • リンクURL
  • パラメータ
    • string type : 'item'、'member'、'category'、'archivelist'、'archive'、'blog'の何れか
    • array params : 各種パラメータ

string createBlogLink(string url, array params)

指定URLlに、指定パラメータparamsを加えたURL文字列を返す

return addLinkParams($url . '?', $params);

としているだけ

  • 戻り値
    • リンクURL
  • パラメータ
    • string url : URL文字列
    • array params : 各種パラメータ

addLinkParams

string addLinkParams(string link, array params)

URLモードに合った形式で、指定URLlに、指定パラメータparamsを加えたURL文字列を返す

  • 戻り値
    • リンクURL
  • パラメータ
    • string link : URL文字列
    • array params : 各種パラメータ

alterQueryStr

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
  • 戻り値
    • 変換後のクエリ文字列
  • パラメータ
    • string querystr : クエリ文字列
    • string param : パラメータ名
    • string value : 値

passVar

void passVar(string key, string value)

指定の名前key、指定の値valueで、<input type="hidden">タグを生成

  • 戻り値
    • なし
  • パラメータ
    • string key : hiddenの名前
    • string value : hiddenの値

formatDate

string formatDate(string format, int timestamp, string defaultFormat, string blog)

日付・時刻を、指定した日付フォーマットで返す

  • 戻り値
    • 日付を表す文字列
  • パラメータ
    • string format : 日付フォーマット('rfc822'、'rfc822GMT'、'utc'、'iso8601')
    • int timestamp : タイムスタンプ(Unixエポック(1970年1月1日 00:00:00 GMT)からの通算秒で表したもの)
    • string defaultFormat : デフォルトのフォーマット
    • string blog : BLOGインスタンス(サーバ時刻との時差を得るため)

checkVars

void checkVars(array aVars)

各種スーパーグローバル変数のキーに、指定パラメータが存在する場合、強制終了

  • 戻り値
    • なし
  • パラメータ
    • array aVars : パラメータ名

redirect

void redirect(string url)

指定URLにリダイレクトさせる

  • 戻り値
    • なし
  • パラメータ
    • string url : 転送先URL

stringStripTags

string stringStripTags(string string)

HTMLタグ、及び、<del>、<script>、<style>タグの内部の文字列を削除した文字列を返す

  • 戻り値
    • 変換後の文字列
  • パラメータ
    • string string : 変換対象文字列

stringToAttribute

string stringToAttribute(string string)

文字列をタグの属性用に正規化

詳細不明

  • 戻り値
    • 変換後の文字列
  • パラメータ
    • string string : 変換対象文字列

stringToXML

string stringToXML(string string)

HTMLを含む文字列をXML用に正規化

詳細不明

  • 戻り値
    • 変換後の文字列
  • パラメータ
    • string string : 変換対象文字列

getNucleusPatchLevel

int getNucleusPatchLevel()

パワーユーザテスト用パッチレベルを返す

詳細不明

  • 戻り値
    • レベル
  • パラメータ
    • なし
 
plugindev/globalfunctions.txt · 最終更新: 2011/03/23 21:28 (外部編集)