M-Blog

Document Parser

絞り込み:
Document ParserドキュメントパーサーのAPI
$modx->db;DBAPI Objectを配列で取得
$modx->event;SystemEvent Objectを配列で取得
$modx->config;グローバル設定を配列で取得
$modx->pluginEvent;システムイベント別に使用しているプラグインの配列を取得
$modx->rs;
$modx->result;
$modx->sql;
$modx->$table_prefix;
$modx->debug;
$modx->q;
$modx->documentIdentifier;現在のリソースIDを出力
$modx->documentGenerated;リソースの生成に成功したか判定
$modx->documentContent;$modx->documentObject[content]の内容がセットされる
$modx->documentOutput;出力するリソースが代入される
$modx->tstart;
$modx->mstart;PHPに割り当てられたメモリ量を出力
$modx->maxParserPasses;パーサーやループの最大数
$modx->$documentObject;リソース変数とテンプレート変数の配列
$modx->templateObject;
$modx->snippetObjects;
$modx->stopOnNotice;
$modx->executedQueries;実行されたクエリ数
$modx->queryTime;データベースとの通信に要した時間のトータル
$modx->currentSnippet;現在実行しているスニペット名
$modx->aliases;
$modx->entrypage;
$modx->dumpSnippets;
$modx->snipCode;
$modx->chunkCache;チャンクのキャッシュを配列が代入される
$modx->snippetCache;スニペットのキャッシュを配列が代入される
$modx->contentTypes;リソースのコンテントタイプの配列が代入される
$modx->dumpSQL;
$modx->queryCode;
$modx->ph;
$modx->placeholders;
$modx->sjscripts;headタグを閉じる直前に読み込むスクリプトを配列が代入される
$modx->jscripts;bodyタグを閉じる前に読み込むスクリプトを配列で代入される
$modx->loadedjscripts;
$modx->documentMap;リソースの親子関係を配列で代入される
$modx->forwards;
$modx->referenceListing;
$modx->childrenList;
$modx->safeMode;
$modx->qs_hash;
$modx->cacheRefreshTime;キャッシュをクリアする時間
$modx->error_reporting;エラーの通知レベル
$modx->http_status_code;HTTPステータスコード
$modx->decoded_request_uri;リクエストされたURI
$modx->directParse;
$modx->dbConfig;データベースのコンフィグが配列で代入される
$modx->pluginCache;プラグインのキャッシュが配列で代入される
$modx->aliasListing;リソースのエイリアス構成情報が配列で代入される
$modx->SystemAlertMsgQueque;
$modx->functionCache;
$modx->uaType;現在のユーザーエージェントのタイプ
$modx->currentSnippetCall;
$modx->functionLog;
$modx->$aliasCache;
$modx->previewObject;プレビュー用のPOSTデータ
$modx->snipLapCount;
$modx->chunkieCache;
$modx->template_path;テンプレートパス
$modx->loadExtension($extname);manager/includes/extenders ディレクトリのファイルを読み込む
$modx->executeParser();パーサーの実行
$modx->getDocumentIdentifier($request_uri);取得法に応じてエイリアスまたはリソースIDを返す
$modx->setRequestQ($decoded_request_uri);
$modx->sanitizeVars();
$modx->setUaType();ユーザーエージェントのタイプを設定
$modx->genQsHash();
$modx->prepareResponse();ページ出力に必要な情報の取得
$modx->outputContent($noEvent= false);出力されるリソース
$modx->postProcess();リソースの生成
$modx->sanitize_gpc(& $target, $count=0) ;
$modx->getUaType();ユーザーエージェントを取得
$modx->join($delim=',', $array, $prefix='');配列を文字列に変換
$modx->getMicroTime();Unixタイムスタンプをマイクロ秒まで出力
$modx->get_static_pages($filepath);リクエストされた/temp/public_html内のファイルを出力
$modx->getSiteCache();config.siteCache.idx.phpに保存されているグローバル設定を配列で取得
$modx->getSettings();ユーザーの全ての設定を配列で取得
$modx->isLoggedin();管理画面へのログインセッションを判定
$modx->checkSession();管理画面へのログインセッションを判定
$modx->checkPreview();プレビューが可能かどうか判定
$modx->checkSiteStatus();このサイトがメンテナンスモードかどうか判定
$modx->checkCache($id);キャッシュがある場合そのリソースを出力
$modx->getCache($id);キャッシュがある場合そのリソースを出力
$modx->checkPublishStatus();リソースの公開状態を監視
$modx->getTagsFromContent($content,$left='[+',$right='+]');指定した修飾子とその名前を配列で出力
$modx->getUltimateParentId($id,$top=0);最上位のリソースIDを取得
$modx->mergeDocumentContent($content,$convertDate=true);$content内の[*リソース変数*]及び[*テンプレート変数*]を展開
$modx->addLogEntry($fname,$fstart);$modx->functionLogにメッセージを追加
$modx->mergeSettingsContent($content);$content内の[(コンフィグ変数)]を展開
$modx->mergeChunkContent($content);$content内の{{チャンク}}を展開
$modx->mergePlaceholderContent($content);$content内の[+プレースホルダ+]を展開
$modx->mergeCommentedTagsContent($content, $left='<!--@MODX:', $right='-->');リソース出力時にコメント内(@MODX:以下)の文字列を出力
$modx->ignoreCommentedTagsContent($content, $left='<!--@IGNORE:BEGIN-->', $right='<!--@IGNORE:END-->');リソース出力時にコメントタグ(@IGNORE)で挟まれた文字列を無視する
$modx->mergeConditionalTagsContent($content, $left='<!--@IF:', $right='<@ENDIF-->');条件分岐コメントタグを展開
$modx->mergeBenchmarkContent($content);[^ベンチマーク^]を展開
$modx->evalPlugin($pluginCode, $params);プラグインの実行
$modx->evalSnippet($phpcode, $params);スニペットの展開
$modx->evalSnippets($content,$nest=0);$content内のスニペットを展開
$modx->setChunkCache();チャンクのキャッシュを$modx->chunkCacheに代入
$modx->setSnippetCache();スニペットのキャッシュを$modx->snippetCacheに代入
$modx->getPluginCache();プラグインのキャッシュを$modx->pluginCacheに代入
$modx->setdocumentMap()リソースの親子関係の配列を$modx->documentMapに代入
$modx->setAliasListing();$modx->aliasListingにaliasListing.siteCache.idx.phpの中身を代入
$modx->set_aliases();リソースIDとエイリアスの配列を取得
$modx->getDocumentObject($method='id', $identifier='', $mode='direct');リソース情報の取得
$modx->parseDocumentSource($source);$source内の変数、スニペット、チャンクなどをすべて展開して出力
$modx->getParentIds($id='', $height= 10);指定リソースIDの親リソースIDをさかのぼって配列で取得
$modx->set_childrenList();サブリソースのIDリストを配列で取得
$modx->getChildIds($id, $depth= 10, $children= array ());指定リソースの子リソースIDを配列で全て取得
$modx->hasPermission($pm);現在のユーザーが権限を持っていればtrue
$modx->isBackend();管理画面であればtrue
$modx->isFrontend();フロントエンドの場合true
$modx->getDocuments($ids= array(), $published= 1, $deleted= 0, $fields= '*', $where= '', $sort= 'menuindex', $dir= 'ASC', $limit= '');指定した複数のIDの情報を配列で取得
$modx->getDocument($id= 0, $fields= '*', $published= 1, $deleted= 0);指定したIDの情報を配列で取得
$modx->getField($field='content', $docid='');指定IDの変数を出力
$modx->getPageInfo($docid= 0, $activeOnly= 1, $fields= 'id, pagetitle, description, alias');指定リソースのページ情報を配列で取得
$modx->getParent($pid= -1, $activeOnly= 1, $fields= 'id, pagetitle, description, alias, parent');指定リソースIDの親リソースの情報を配列で取得
$modx->makeUrl($id, $alias= '', $args= '', $scheme= 'full', $ignoreReference=false);リソースIDからURLを生成
$modx->rewriteUrls($content);文字列内のリンクタグ([~リソースID~])をURLに変換
$modx->getConfig($name= '', $default='');$modx->configから出力
$modx->getChunk($key);チャンクの内容を出力
$modx->parseChunk($chunkName, $chunkArr, $prefix= '{', $suffix= '}',$mode='chunk');チャンク内のプレースホルダの登録及び展開
$modx->parseText($content='', $ph=array(), $left= '[+', $right= '+]',$cleanup=true);$content内のプレースホルダの登録及び展開
$modx->toDateFormat($timestamp = 0, $mode = '');タイムスタンプをデータフォーマットに変換
$modx->toTimeStamp($str);タイムスタンプに変換
$modx->mb_strftime($format='%Y/%m/%d', $timestamp='');タイムスタンプをデーターフォーマットに変換
$modx->getTemplateVar($idname= '', $fields= '*', $docid= '', $published= 1);指定した変数の情報を配列で取得
$modx->getTemplateVars($idnames='*',$fields='*',$docid='',$published= 1,$sort='rank',$dir='ASC');全てのリソース変数及びテンプレート変数の情報を配列で取得
$modx->getTemplateVarOutput($idnames= '*', $docid= '', $published= 1, $sep='');特定のリソース変数及びテンプレート変数の情報を配列で取得
$modx->getFullTableName($tbl);MySQLのテーブル名を取得
$modx->getPlaceholder($name);プレースホルダの値を出力
$modx->setPlaceholder($name, $value);プレースホルダに値を代入
$modx->toPlaceholders($subject, $prefix= '');配列またはobjectをプレースホルダに設定する
$modx->toPlaceholder($key, $value, $prefix= '');プレースホルダに設定
$modx->getManagerPath();管理画面のパスを出力
$modx->getCachePath();キャッシュフォルダのパスを出力
$modx->getLoginUserID($context= '');現在のユーザーIDを出力
$modx->getUserDocGroups($resolveIds= false);リソースグループを配列で出力
$modx->stripTags($html, $allowed= '');HTMLタグを除外
$modx->removeAllEventListener();プラグインで使用しているシステムイベントの配列($modx->pluginEvent)を空にする
$modx->invokeEvent($evtName, $extParams= array ());システムイベントを発動させる
$modx->getPluginCode($pluginName);プラグインコードを読み込む
$modx->getPluginProperties($pluginName);プラグインの「プラグイン設定」を出力
$modx->setPluginCache($pluginName);プラグインのキャッシュを作成
$modx->parseProperties($propertyString);プラグインの「プラグイン設定」を配列に変換
$modx->tvProcessor($value,$format='',$paramstring='',$name='',$tvtype='',$docid='', $sep='');フォーマットに応じて出力
$modx->dbConnect();データベースへ接続
$modx->dbQuery($sql);SQL文の実行
$modx->recordCount($rs);レコードのカウント
$modx->fetchRow($rs,$mode='assoc');結果を取得するモード
$modx->affectedRows($rs);一番最近の操作で変更された行の数を取得
$modx->insertId($rs);直近のクエリで生成された(INSERTされた)IDを取得
$modx->dbClose();データベースへの接続を終了
$modx->putChunk($chunkName);チャンクの内容を出力
$modx->getDocGroups();リソースグループを配列で出力
$modx->changePassword($o, $n);現在のウェブユーザーのパスワードを変更
$modx->parsePlaceholder($src='', $ph=array(), $left= '[+', $right= '+]',$mode='ph');$src内のプレースホルダの登録及び展開
$modx->phpError($nr, $text, $file, $line);PHPのエラーメッセージを出力
$modx->getRegisteredClientScripts();regClientScriptで設定したスクリプトを出力
$modx->getRegisteredClientStartupScripts();regClientScriptで$startupを「true」に設定したスクリプト
またはregClientStartupScriptで設定したスクリプトを出力
$modx->stripAlias($alias, $browserID='');エイリアスをURLで使用できるようにフォーマット
$modx->nicesize($size);サイズの変換
$modx->getDocumentListing($str);エイリアスからリソースIDを出力
$modx->getIdFromAlias($alias);エイリアスからリソースIDを取得
$modx->setBaseTime($t='');基準時間の設定
$modx->getBaseTime();基準時間の取得
$modx->executeParserDirect($id='')l
$modx->parseTextSimple($tpl='', $ph=array(), $left= '')l

© 2015 - 2019 M-Blog. Powered by MODX.

(URL:https://modx.mblo.info/,E-mail:info@mblo.info)

ブログについて
MODX Evolutionを使ってブログをしています。基本的にはまとめ、チートシートのメモなど、他にも日常のことをぼちぼち書いています。

コンテンツ
ブログ
MODXまとめ
MODXチートシート

動作環境
このブログはで運用しています。
・Apache 2.2.31
・OS Free BSD
・PHP 7.1.28
・MySQL 5.5.38
・MODX 1.0.22J-beta1

ブログ更新通知
RSS | ATOM

まとめ更新通知
RSS | ATOM

フィードバック

お問い合わせ
Twitter