a-blog cms PHP API Reference

function.php

Classes

Timer

Constants

ACMS_AT_SIGN_TARGET = '/@(section|endsection|extend|extends|include|parent|verbatim|endverbatim)/'
ACMS_AT_SIGN_TOKEN = 'acms-at-sign-' . \md5(\uniqid(\rand(), \true))
ACMS_LOGIN_SESSION_ORGINAL_UID = 'acms-login-uid-original'
ACMS_LOGIN_SESSION_UID = 'acms-login-uid'
CACHE_TPL_ENTRY = '1'
IS_UNREGISTERED_DOMAIN = true
ONLY_BUILD_LAYOUT = 'acms_only_build_layout'
REGEX_EXCEPTION_UA = '@(publish\_ablogcms|acms-include|ablogcms|' . \ONLY_BUILD_LAYOUT . ')@'
REGEX_INVALID_TAG_NAME = '/^[^#,\/]*$/u'
REGEX_SEPARATER = '@(,|\s|　|/)+@u'
REGEX_VALID_ID = '@^[a-zA-Z0-9_-]+$@'
REGEX_VALID_IPV4_ADDR = '@^(([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$@'
REGEX_VALID_MAIL = '/^(?:[^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff]+(?![^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff])|"[^\\\\\\x80-\xff\n\015"]*(?:\\\\[^\x80-\xff][^\\\\\\x80-\xff\n\015"]*)*")(?:\.(?:[^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff]+(?![^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff])|"[^\\\\\\x80-\xff\n\015"]*(?:\\\\[^\x80-\xff][^\\\\\\x80-\xff\n\015"]*)*"))*@(?:[^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff]+(?![^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff])|\[(?:[^\\\\\\x80-\xff\n\015\[\]]|\\\\[^\x80-\xff])*\])(?:\.(?:[^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff]+(?![^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff])|\[(?:[^\\\\\\x80-\xff\n\015\[\]]|\\\\[^\x80-\xff])*\]))*$/'
REGEX_VALID_PASSWD = '@^[!-~]+$@'
REGEX_VALID_URL = '@^(https?|ftp)(:\/\/[-_.!~*\'()a-zA-Z0-9;\/?:\@&=+\$,%#]+)$@u'
REGEXP_SEPARATER = \REGEX_SEPARATER
REGEXP_VALID_DATE = '@^\d{4}-(1[0-2]|0[1-9])-([12][0-9]|3[01]|0[1-9])$@'
REGEXP_VALID_DATETIME = '@^\d{4}-(1[0-2]|0[1-9])-([12][0-9]|3[01]|0[1-9]) (2[0-3]|[0-1]\d):([0-5]\d):([0-5]\d)$@'
REGEXP_VALID_TIME = '@^(2[0-3]|[0-1]\d):([0-5]\d):([0-5]\d)$@'
TAG_SEPARATER = '@(,|/|\n)@'

Functions

getRFC2068Time() : string: タイムスタンプをRFC2068形式にフォーマットした文字列を取得
requestTime() : int: リクエスト日時を取得タイムマシンモードの場合はタイムマシンモードを考慮した日時を返す
timemachineAuth() : bool: タイムマシーンモードを利用可能な権限をもつユーザーかどうかを判定
timemachineMode() : bool: タイムマシンモードかどうかを取得第2引数がtrueの場合はタイムマシンモードを有効化する
redirect() : never: リダイレクト
multiBytePregMatch() : bool: マルチバイト対応のpreg_match
array_in_array() : bool: 配列の中に指定した値が含まれているかどうかを判定
mailConfig() : mixed: メール設定の取得
detectEncode() : string|false: 文字エンコーディングを検出する
in_ipband() : bool|null: 指定したIPアドレスがCIDR 表記法を使用したサブネット（例: 192.168.100.0/24）に含まれるかどうかを判定する
is_private_ip() : bool: プライベートIPアドレスかどうかを判定する
convert_bytes() : mixed
return_bytes() : mixed
isBufferable() : mixed
die500() : mixed: 503エラーをページに出力
die503() : mixed: 503エラーをページに出力
die400() : never: 403エラーをページに出力
die403() : never: 403エラーをページに出力
page404() : never: 404エラーを出力する
arrayPath() : mixed: 未使用のため非推奨
ite() : int|string: ite
idval() : int: 文字列を0以上の整数に変換古い関数のため、新しいコードでは使わないことを推奨
acmsSerialize() : string: セキュリティ的に安全なシリアライズ
unserializeAllowedClasses() : mixed: 安全なクラスのみ許可したデシリアライズ
acmsUnserialize() : mixed: セキュリティ的に安全なデシリアライズ
acmsDangerUnserialize() : mixed: セキュリティ的に危険なデシリアライズ互換性のためあるだけで非推奨です。新しいコードでは使わないことを推奨
acmsHash() : string: セキュリティ的に安全なハッシュ
stripExternalLink() : string
copyFile() : bool: ファイルをコピー
deleteFile() : bool: ファイルを削除
deleteDirectory() : void: 未使用のため非推奨
strcount() : mixed: 未使用のため非推奨
camelize() : string: 文字列をキャメルケースに変換
decamelize() : string
virtualImageSize() : mixed: 未使用のため非推奨
maskImageSize() : mixed: 未使用のため非推奨
ngram() : array<string|int, string>
roleAvailableUser() : bool: ロールによる権限チェックを使用するかチェック
_roleAvailableUser() : bool: ロールによる権限チェックを使用するかチェック
approvalAvailableUser() : bool: 承認フローに所属するユーザかチェック
roleEntryAuthorization() : bool: ロールによるエントリー権限チェック
roleEntryUpdateAuthorization() : bool: ロールを含んだエントリーの編集権限チェック
roleAuthorization() : bool: 各ロールの権限があるかチェック
editionWithStandard() : bool: ライセンスがスタンダード以上か
editionWithProfessional() : bool: ライセンスがプロフェッショナル以上か
editionIsStandard() : bool: ライセンスがスタンダードか
editionIsProfessional() : bool: ライセンスがプロフェッショナルか
editionIsEnterprise() : bool: ライセンスがエンタープライズか
enableRevision() : bool: 対象のブログでバージョン管理が有効か調べる
enableApproval() : bool: 対象のブログで承認機能が有効か調べる
enableParallelApproval() : bool: 対象のブログで並列承認機能が有効か調べる
isSessionSubscriber() : bool: アクセス中のユーザーが読者かをチェックする
isSessionContributor() : bool: アクセス中のユーザーが投稿者かをチェックする
isSessionEditor() : bool: アクセス中のユーザーが編集者かをチェックする
isSessionAdministrator() : bool: アクセス中のユーザーが管理者かをチェックする
sessionWithSubscription() : bool: アクセス中のユーザーが，指定されたブログにおいて読者以上の権限をもっているかをチェックする
sessionWithContribution() : bool: アクセス中のユーザーが，指定されたブログにおいて投稿者以上の権限をもっているかをチェックする
sessionWithCompilation() : bool: アクセス中のユーザーが，指定されたブログにおいて編集者以上の権限をもっているかをチェックする
sessionWithAdministration() : bool: アクセス中のユーザーが，指定されたブログにおいて管理者以上の権限をもっているかをチェックする
sessionWithEnterpriseAdministration() : bool: アクセス中のユーザーが，ルートブログにおいてエンタープライズ管理操作の権限をもっているかをチェックする
sessionWithProfessionalAdministration() : bool: アクセス中のユーザーが，ルートブログにおいてプロフェッショナル管理操作の権限をもっているかをチェックする
sessionWithFormAdministration() : bool: アクセス中のユーザーが，指定されたブログにおいて、フォームの管理権限があるかチェックする
sessionWithScheduleAdministration() : bool: アクセス中のユーザーが，指定されたブログにおいて、スケジュールの管理権限があるかチェックする
approvalUserPoint() : int: アクセス中のユーザーの承認ポイントを返す
approvalRevisionPublicPoint() : int: リビジョンの現在承認ポイントを返す
approvalRevisionRejectPoint() : int: リビジョンの現在承認却下ポイントを返す
approvalWorkflowPublicPoint() : int: 承認フローの最終承認ポイントを返す
approvalWorkflowRejectPoint() : int: 承認フローの最終承認却下ポイントを返す
getUserGroupIds() : array<string|int, int>: ユーザーが所属するユーザーグループを取得
sessionWithApprovalPreview() : bool: アクセス中のユーザーが対象のリビジョンにおいて承認プレビューができるか
sessionWithApprovalRequest() : bool: アクセス中のユーザーが対象のリビジョンにおいて承認依頼が出来るか
sessionWithApprovalRejectRequest() : bool: アクセス中のユーザーが対象のリビジョンにおいて承認却下依頼が出来るか
sessionWithApprovalReject() : bool: アクセス中のユーザーが対象のリビジョンにおいて取り下げ（リジェクト）が出来るか
sessionWithApprovalPublic() : bool: アクセス中のユーザーが対象のリビジョンにおいて最終承認が出来るか
sessionWithApprovalAdministrator() : bool: アクセス中のユーザーが対象のブログにおいて最終承認が出来るか、またはルートの管理者か
snsLoginAuth() : bool: 指定されたユーザーが対象のブログにおいてSNSログイン権限があるか
is404() : bool: 未使用のため非推奨
httpStatusCode() : string: HTTPステータスコードを取得または設定する
isErrorHttpStatus() : bool: 現在のHTTPステータスコードがエラーかどうかを判定する
userErrorLog() : void: エラーログを出力する AcmsLogger::error() のエイリアス
tplConfig() : string: テーマのtemplate.yamlを考慮したのコンフィグを取得する
config() : T is string ? string : false): 現在のコンテキストにおける，指定されたキーのコンフィグを返すモジュール内で使用した場合は，モジュールIDで設定されたコンフィグを返す
configArray() : array<string|int, mixed>: 現在のコンテキストにおける，指定されたキーのコンフィグを配列で返すモジュール内で使用した場合は，モジュールIDで設定されたコンフィグを返す
setConfig() : mixed: 現在のコンテキストにおける，指定されたキーのコンフィグを一時的に書き換える
parseCsv() : array<string|int, array<string|int, string>>: CSVをパースして配列に変換する
dsn() : Dsn: データベースのDSNを取得する
getRoutingSegments() : array<string, string>: ルーティングに使用するセグメントを取得する
isReserved() : bool: 予約語と衝突していないかを検査する
isValidCode() : bool: 文字列が正しいか検査する
jsModule() : T is null ? array : mixed) : bool): JSモジュールでフロントエンドに渡す変数を設定または取得する引数なしで呼び出すと全ての変数を連想配列で取得する
pathIcon() : string: ファイルの拡張子からアイコンのパスを取得する
otherSizeImagePath() : string: サイズ違いの画像パスを取得する
normalSizeImagePath() : string: 画像のパスから正規サイズの画像パスを取得する
altrim() : string
findTemplate() : string|false: テーマを考慮したテンプレートファイルを検索する
allowViewTemplate() : bool: 表示可能なテンプレートかどうかを判定する
array_last() : mixed: 未使用のため非推奨
getTplContents() : mixed: 未使用のため非推奨
getMimetype() : string: 拡張子からMIMEタイプを取得する
parseDatetime() : mixed: 未使用のため非推奨
addPrefixEntryTitle() : string: エントリータイトルにプレフィックスを追加する
loadDefaultConfig() : array<string|int, mixed>: config.sytem.yamlに記録されているデフォルトのコンフィグを連想配列で返す
loadConfig() : Field: ブログID, ルールID, モジュールIDによって指定されたコンテキストのコンフィグをFieldで返す
loadBlogConfig() : Field: 指定されたidに該当するブログのコンフィグをFieldで返す
loadRuleConfig() : Field: 指定されたidに該当するルールのコンフィグをFieldで返す
loadModuleConfig() : Field: 指定されたidに該当するモジュールIDのコンフィグをFieldで返す
isExistsRuleModuleConfig() : bool: ルールのモジュールコンフィグが存在するかチェック
loadField() : Field: ブログID, カテゴリーID, エントリーID，ユーザーIDのいずれか指定されたカスタムフィールドをFieldオブジェクトで返す
loadBlogField() : Field: 指定されたidに該当するブログのカスタムフィールドをFieldオブジェクトで返す
loadUserField() : Field: 指定されたidに該当するユーザーのカスタムフィールドをFieldオブジェクトで返す
loadCategoryField() : Field: 指定されたidに該当するカテゴリーのカスタムフィールドをFieldオブジェクトで返す
loadModuleField() : Field: 指定されたidに該当するモジュールIDのカスタムフィールドをFieldオブジェクトで返す
loadEntryField() : Field: 指定されたidに該当するエントリーのカスタムフィールドをFieldオブジェクトで返す
loadUnitField() : Field: 指定されたidに該当するユニットのカスタムフィールドをFieldオブジェクトで返す
eagerLoadEntry() : array<int, array<string|int, mixed>>: ToDo: deplicated mehod Ver. 3.2
eagerLoadField() : Field>): ToDo: deplicated mehod Ver. 3.2
eagerLoadSubCategories() : array<string|int, array<int, array<string, mixed>>>: ToDo: deplicated mehod Ver. 3.2
loadGeometry() : Field: 指定されたidに該当するGeometryをFieldオブジェクトで返す
loadColumn() : array<string|int, array<string, mixed>>: エントリーIDに紐づくカラムを取得する ToDo: レガシーな方法なため非推奨。互換性のため残している。
loadFormUnit() : array<string|int, array{id: string, type: "text"|"textarea"|"radio"|"select"|"checkbox", align: string, sort: int, group: string, attr: string, size: string, label: string, caption: string, validatorSet: string, values?: string}>: フォームユニットをデータベースから取得する
fulltextUnitData() : string: フルテキスト用のユニットデータを整形する
loadSubCategories() : array{id: int[], label: string[]}
loadSubCategoriesAll() : array<string|int, array<string, mixed>>
loadRelatedEntries() : array<string|int, int>
loadBlog() : Field_Validation: 指定されたidに該当するブログのレコードをFieldオブジェクトで返す
loadAlias() : Field_Validation: 指定されたidに該当するブログのレコードをFieldオブジェクトで返す
loadConfigSet() : Field_Validation: 指定したコンフィグセットIDに該当するコンフィグセットのレコードをFieldオブジェクトで返す
loadUser() : Field_Validation: 指定されたidに該当するユーザーのレコードをFieldオブジェクトで返す
isRoleAvailableUser() : bool: ロールによる権限チェッックを行うユーザーか
getAuthConsideringRole() : false|string: 指定したユーザーのロールを考慮した権限を取得
loadUserIcon() : string|false: 指定されたidに該当するユーザーの画像パスを取得する
loadUserLargeIcon() : string|false: 指定されたidに該当するユーザーの拡大画像パスを取得する
loadUserOriginalIcon() : string|false: 指定されたidに該当するユーザーの画像パスを取得する
categoryExists() : bool: 指定されたbidにカテゴリーが存在するか調べる
categoryLevel() : int: 指定されたcidの階層を調べる
loadCategory() : Field_Validation: 指定されたidに該当するカテゴリーのレコードをFieldオブジェクトで返す
loadRule() : Field_Validation: 指定されたidに該当するルールのレコードをFieldオブジェクトで返す
loadModule() : Field_Validation: 指定されたidに該当するモジュールIDのレコードをFieldオブジェクトで返す
loadWebhook() : Field_Validation: 指定されたidに該当するWebhookのレコードをFieldオブジェクトで返す
loadRole() : Field_Validation: 指定されたidに該当するロールのレコードをFieldオブジェクトで返す
loadUsergroup() : Field_Validation: 指定されたidに該当するユーザグループのレコードをFieldオブジェクトで返す
loadWorkflow() : Field_Validation: 指定されたブログに該当するワークフローのレコードをFieldオブジェクトで返す
deleteWorkflow() : mixed: 指定されたワークフローを削除する
loadMedia() : Field_Validation: 指定されたidに該当するメディアのレコードをFieldオブジェクトで返す
cacheBusting() : string: css, jsの読み込みをCache Busting対応
repairFlatJson() : string: JSONの文字列を修正するための正規表現例: "key": "value" -> "key": "value" エスケープされたダブルクォートを考慮して、非エスケープのダブルクォートを検出するただし、JSONの形式に従っていることが前提
getLangAndRegion() : string: i18n : ユーザーロケールを決定 config.server.phpでGETTEXT_TYPEが"auto"の場合有効 return : language_REGION (ja_JP, en_US)
i18n() : string|false: i18n : テンプレートの国際化 おはよう おはよう
xi18n() : bool: xi18n : テンプレートの国際化をするための元となるテンプレートこのファイルから各言語用poファイル生成する おはよう おはよう
fileFilter() : bool
gettextFile() : bool
getFileList() : array<string|int, string>: ディレクトリ内のファイルリストを取得
build() : string: テンプレート文字列の解決
mainBuild() : string: テンプレート文字列のGETモジュールを解決
verbatim() : string: verbatim ブロックを解決
setBlockVars() : string: 変数ブロックの変数をグローバル変数（$template_vars）に保存する
buildVarBlocks() : string: 変数ブロックを解決
buildIF() : string: IFブロックを解決
reversePolishNotationBool() : bool|string: 逆ポーランド記法での論理式の計算
resolveFormula() : bool: IFブロックの式を解決
boot() : string: GETモジュールを解決
checkModuleEntry() : bool: モジュールIDがアクセス可能なIDか判定
loadAncestorCategory() : string|int|false
loadAncestorBlog() : string|int|false
isTemplateCacheEnabled() : bool
getTemplateCacheKey() : string: テンプレートキャッシュキーを取得
setGlobalVarsForInclude() : string: インクルード文の中だけ、一部のグローバル変数を解決して返す
recursiveJoin() : string: 配列を文字列に再帰的に結合
globalVarsList() : array<string, mixed>: グローバル変数の連想配列
setGlobalVars() : string: 与えられた文字列中の，グローバル変数(%{GLOBAL_VAR})を解決して返す
previewUrlFormat() : string: プレビューURLのフォーマット
parseAcmsPath() : Field: acmsパスを解析したFieldオブジェクトを返す
parseQuery() : array<string, string|array<string|int, string>>: クエリ文字列を解析して返す
inheritAcmsQuery() : true: 現在のURLコンテキストを継承する
blogDomain() : string: 指定されたブログ、エイリアスのドメインを割り出して返す
acmsLink() : false|string: 連想配列で指定されたURLコンテキストからURLを割り出して返す
acmsLink_page() : bool|string: acmsLink()でpageを出すようにする
acmsPath() : string: 連想配列で指定されたURLコンテキストからパスを割り出して返す
isBlogGlobal() : bool: ブログが子ブログを持っているかどうか
isBlogAncestor() : bool: 指定したブログが指定した親ブログの子ブログ可どうか判定
checkDevelopment() : string|false: 開発モードの場合、アラートを表示するためのJavaScriptを返す開発モードでない場合はfalseを返す
isDebugMode() : bool: デバックモードかどうか判定
isProductionModeForLogger() : bool: 監査ログの出力モードが本番モードかどうか判定
isBenchMarkMode() : bool: ベンチマークモードかどうか判定
acmsBenchmarkSnapshot() : array{modules: array, slow_queries: array, global_vars: array, templates: array, memory: array{limit: string, usage: int, peak: int}, query_count: int, totals: array{boot: float, build: float, rewrite: float, module_total: float, process_total: string}}: ベンチマークデータをスナップショット化する
acmsBenchmarkBuildServerTiming() : string: Server-Timing ヘッダー値を構築する（サマリのみ）
acmsBenchmarkEmitHeaders() : void: Server-Timing ヘッダーを付与する
isHtmlTemplate() : bool: テンプレートがHTMLかどうか判定
acmsSetCookie() : void: クッキーを送信する
setUnregisteredDomain() : void: 登録されていないドメインのアクセスの場合、フラグを設定
isUnregisteredDomain() : bool: 登録されていないドメインのアクセスか判定
isOldLicense() : bool: 旧ライセンスかどうか判定
isTrial() : bool: トライアルモードかどうか判定
setTrial() : void: トライアルモードを設定
isClawler() : bool: クローラーによるアクセスか判定
printContents() : void: コンテンツを出力する
shutdown() : true: シャットダウン処理
detectUnitTypeSpecifier() : string: 特定指定子を除外した、一般名のユニット種別
fixEncodingAssoc() : true
removeComments() : string: HTML内のコメントを削除する
removeBlank() : string: HTML内の空白を削除する
useArchivesServer() : string: アーカイブ画像パスのドメインを書き換える
acmsUserPasswordHash() : string: acmsUserPasswordHash ユーザーパスワードのハッシュを生成
acmsUserPasswordVerify() : bool: パスワードの照合
passwordHashGeneration1() : string: ハッシュ化されたパスワードを生成セキュリティ的に危険なため非推奨（互換性のために残してあります）
passwordHashGeneration2() : string: ハッシュ化されたパスワードを生成セキュリティ的に危険なため非推奨（互換性のために残してあります）
passwordHashGeneration3() : string|false: ハッシュ化されたパスワードを生成
getPasswordGeneration() : int: パスワード生成の方法を取得
uniqueString() : string: uniqueString 指定した文字数のランダム文字列生成
uuidv4() : non-empty-string: uuidv4
setCookieDelFlag() : true: set cookie ( localstorage delete flag )
DB() : DB: DB DBインスタンスの省力化
dbTableExists() : bool: DB テーブルの存在確認
dbCreateTables() : void: DB テーブルの作成
dbDropTables() : void: DB テーブルの削除
appStatus() : bool: AAPP 拡張アプリが有効かどうか
array_clean() : array<string|int, mixed>: array_clean http://d.hatena.ne.jp/H6K/20090601/p1
array_flatten() : array<string|int, mixed>: すべてのサブ配列の要素を指定した深さで再帰的に結合した新しい配列を生成する
is_hash() : bool: is_hash http://d.hatena.ne.jp/fbis/20091112/1258002754
is_ajax() : bool: is_ajax
byteConvert() : string: byteConvert
stripWhitespace() : string: stripWhitespace
acmsDump() : mixed: acmsDump
authorityRestriction() : void|never: 権限ごとのIPチェック
logout() : void: ログアウト
isCSRF() : bool: isCSRF
roleUserLoginAuth() : bool: roleUserLoginCheck
getCookieHost() : string|false: get cookie host.
generateSession() : string: generateSession
getSessionIdFromDB() : string: DBに保存されているセッションIDを取得同時ログイン禁止のために使用
loginRoleCheck() : bool: ロール権限でログインできる権限をもつか判定
arrayColumn() : mixed: 未使用のため非推奨
isStreamLike() : bool: isStreamLike 指定された値がストリームのようなものかどうかを判定
getExceptionTraceAsString() : string: 例外のスタックトレースを文字列で取得
contrastColor() : string: 指定色（Hex指定例: #FFFFFF）に載せる文字色として、コントラストが高くなるように、黒系、白系のカラーを返す
canSwitchUser() : bool: ユーザー切り替えが可能なユーザーかどうか判定
getApprovalFrom() : string: 承認メール送信元のアドレスを取得
isApiBuild() : bool: APIビルドかどうか判定
isApiBuildOrV2Module() : mixed: APIビルドか、V2モジュールである場合はtrueを返す
acmsFputcsv() : int|false: PHP8.1との互換性を持たせるためのfputcsv関数
limitedJsonEncode() : string|false: 連想配列を制限をかけたJSON文字列に変換

ACMS_AT_SIGN_TARGET


    public
        mixed
    ACMS_AT_SIGN_TARGET
    = '/@(section|endsection|extend|extends|include|parent|verbatim|endverbatim)/'

ACMS_AT_SIGN_TOKEN


    public
        mixed
    ACMS_AT_SIGN_TOKEN
    = 'acms-at-sign-' . \md5(\uniqid(\rand(), \true))

ACMS_LOGIN_SESSION_ORGINAL_UID


    public
        mixed
    ACMS_LOGIN_SESSION_ORGINAL_UID
    = 'acms-login-uid-original'

ACMS_LOGIN_SESSION_UID


    public
        mixed
    ACMS_LOGIN_SESSION_UID
    = 'acms-login-uid'

CACHE_TPL_ENTRY


    public
        mixed
    CACHE_TPL_ENTRY
    = '1'

IS_UNREGISTERED_DOMAIN


    public
        mixed
    IS_UNREGISTERED_DOMAIN
    = true

ONLY_BUILD_LAYOUT


    public
        mixed
    ONLY_BUILD_LAYOUT
    = 'acms_only_build_layout'

REGEX_EXCEPTION_UA


    public
        mixed
    REGEX_EXCEPTION_UA
    = '@(publish\_ablogcms|acms-include|ablogcms|' . \ONLY_BUILD_LAYOUT . ')@'

REGEX_INVALID_TAG_NAME


    public
        mixed
    REGEX_INVALID_TAG_NAME
    = '/^[^#,\/]*$/u'

REGEX_SEPARATER


    public
        mixed
    REGEX_SEPARATER
    = '@(,|\s|　|/)+@u'

REGEX_VALID_ID


    public
        mixed
    REGEX_VALID_ID
    = '@^[a-zA-Z0-9_-]+$@'

REGEX_VALID_IPV4_ADDR


    public
        mixed
    REGEX_VALID_IPV4_ADDR
    = '@^(([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$@'

REGEX_VALID_MAIL


    public
        mixed
    REGEX_VALID_MAIL
    = '/^(?:[^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff]+(?![^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff])|"[^\\\\\\x80-\xff\n\015"]*(?:\\\\[^\x80-\xff][^\\\\\\x80-\xff\n\015"]*)*")(?:\.(?:[^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff]+(?![^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff])|"[^\\\\\\x80-\xff\n\015"]*(?:\\\\[^\x80-\xff][^\\\\\\x80-\xff\n\015"]*)*"))*@(?:[^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff]+(?![^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff])|\[(?:[^\\\\\\x80-\xff\n\015\[\]]|\\\\[^\x80-\xff])*\])(?:\.(?:[^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff]+(?![^(\040)<>@,;:".\\\\\\[\]\000-\037\x80-\xff])|\[(?:[^\\\\\\x80-\xff\n\015\[\]]|\\\\[^\x80-\xff])*\]))*$/'

REGEX_VALID_PASSWD


    public
        mixed
    REGEX_VALID_PASSWD
    = '@^[!-~]+$@'

REGEX_VALID_URL


    public
        mixed
    REGEX_VALID_URL
    = '@^(https?|ftp)(:\/\/[-_.!~*\'()a-zA-Z0-9;\/?:\@&=+\$,%#]+)$@u'

REGEXP_SEPARATER


    public
        mixed
    REGEXP_SEPARATER
    = \REGEX_SEPARATER

REGEXP_VALID_DATE


    public
        mixed
    REGEXP_VALID_DATE
    = '@^\d{4}-(1[0-2]|0[1-9])-([12][0-9]|3[01]|0[1-9])$@'

REGEXP_VALID_DATETIME


    public
        mixed
    REGEXP_VALID_DATETIME
    = '@^\d{4}-(1[0-2]|0[1-9])-([12][0-9]|3[01]|0[1-9]) (2[0-3]|[0-1]\d):([0-5]\d):([0-5]\d)$@'

REGEXP_VALID_TIME


    public
        mixed
    REGEXP_VALID_TIME
    = '@^(2[0-3]|[0-1]\d):([0-5]\d):([0-5]\d)$@'

TAG_SEPARATER


    public
        mixed
    TAG_SEPARATER
    = '@(,|/|\n)@'

getRFC2068Time()

タイムスタンプをRFC2068形式にフォーマットした文字列を取得


    
                    getRFC2068Time(int $timestamp) : string

Parameters

$timestamp : int

Return values

string

requestTime()

リクエスト日時を取得タイムマシンモードの場合はタイムマシンモードを考慮した日時を返す


    
                    requestTime() : int

Return values

int

timemachineAuth()

タイムマシーンモードを利用可能な権限をもつユーザーかどうかを判定


    
                    timemachineAuth() : bool

Return values

bool

timemachineMode()

タイムマシンモードかどうかを取得第2引数がtrueの場合はタイムマシンモードを有効化する


    
                    timemachineMode([bool $set = false ]) : bool

Parameters

$set : bool = false

Return values

bool

redirect()

リダイレクト


    
                    redirect(string $url[, bool $is301 = false ]) : never

Parameters

$url : string
$is301 : bool = false

Return values

never

multiBytePregMatch()

マルチバイト対応のpreg_match


    
                    multiBytePregMatch(string $pattern, string $subject) : bool

Parameters

$pattern : string
$subject : string

Return values

bool

array_in_array()

配列の中に指定した値が含まれているかどうかを判定


    
                    array_in_array(array<string|int, mixed> $needles, array<string|int, mixed> $haystack) : bool

Parameters

$needles : array<string|int, mixed>
$haystack : array<string|int, mixed>

Return values

bool

mailConfig()

メール設定の取得

未使用のため非推奨


    
                    mailConfig() : mixed

detectEncode()

文字エンコーディングを検出する


    
                    detectEncode(string $str) : string|false

Parameters

$str : string

Return values

string|false

in_ipband()

指定したIPアドレスがCIDR 表記法を使用したサブネット（例: 192.168.100.0/24）に含まれるかどうかを判定する


    
                    in_ipband(string $ip, string $ipband) : bool|null

Parameters

$ip : string: IPアドレス
$ipband : string: CIDR 表記法を使用したサブネット

Return values

bool|null

is_private_ip()

プライベートIPアドレスかどうかを判定する


    
                    is_private_ip([string $ip = '' ]) : bool

Parameters

$ip : string = ''

Return values

bool

convert_bytes()


    
                    convert_bytes(mixed $val, mixed $unit[, mixed $pos = 2 ]) : mixed

Parameters

$val : mixed
$unit : mixed
$pos : mixed = 2

return_bytes()


    
                    return_bytes(mixed $val) : mixed

Parameters

$val : mixed

isBufferable()

未使用のため非推奨


    
                    isBufferable(mixed $bytes) : mixed

Parameters

$bytes : mixed

die500()

503エラーをページに出力


    
                    die500([string $message = '' ]) : mixed

Parameters

$message : string = ''

die503()

503エラーをページに出力


    
                    die503([string $message = '' ]) : mixed

Parameters

$message : string = ''

die400()

403エラーをページに出力


    
                    die400([string $message = '' ]) : never

Parameters

$message : string = ''

Return values

never

die403()

403エラーをページに出力


    
                    die403([string $message = '' ]) : never

Parameters

$message : string = ''

Return values

never

page404()

404エラーを出力する


    
                    page404() : never

Return values

never

arrayPath()

未使用のため非推奨


    
                    arrayPath(mixed $ary, mixed $path[, mixed $key = null ][, mixed $isObject = false ]) : mixed

Parameters

$ary : mixed
$path : mixed
$key : mixed = null
$isObject : mixed = false

ite()

ite


    
                    ite([array<string|int, mixed> $ary = [] ][, string|int|null $key = null ][, string $defaultValue = '' ][, bool $exist = false ][, string $opt = '' ]) : int|string

Parameters

$ary : array<string|int, mixed> = []
$key : string|int|null = null
$defaultValue : string = ''
$exist : bool = false
$opt : string = ''

Return values

int|string

idval()

文字列を0以上の整数に変換古い関数のため、新しいコードでは使わないことを推奨


    
                    idval(string $id) : int

Parameters

$id : string

Return values

int

acmsSerialize()

セキュリティ的に安全なシリアライズ


    
                    acmsSerialize(mixed $Obj) : string

Parameters

$Obj : mixed

Return values

string

unserializeAllowedClasses()

安全なクラスのみ許可したデシリアライズ


    
                    unserializeAllowedClasses(string $data) : mixed

Parameters

$data : string

acmsUnserialize()

セキュリティ的に安全なデシリアライズ


    
                    acmsUnserialize(string $signedData) : mixed

Parameters

$signedData : string

acmsDangerUnserialize()

セキュリティ的に危険なデシリアライズ互換性のためあるだけで非推奨です。新しいコードでは使わないことを推奨


    
                    acmsDangerUnserialize(string $signedData) : mixed

Parameters

$signedData : string

acmsHash()

セキュリティ的に安全なハッシュ


    
                    acmsHash(string $txt[, bool $previous = false ]) : string

Parameters

$txt : string
$previous : bool = false

Return values

string

stripExternalLink()

未使用のため非推奨


    
                    stripExternalLink(string $html) : string

Parameters

$html : string

Return values

string

copyFile()

ファイルをコピー


    
                    copyFile(string $from, string $to, bool $isPublic) : bool

Parameters

$from : string
$to : string
$isPublic : bool

Return values

bool

deleteFile()

ファイルを削除


    
                    deleteFile(string $path, bool $isPublic) : bool

Parameters

$path : string: この値は、ユーザーの入力値など信頼されない値を指定しない
$isPublic : bool

Return values

bool

deleteDirectory()

未使用のため非推奨


    
                    deleteDirectory(string $path) : void

Parameters

$path : string: この値は、ユーザーの入力値など信頼されない値を指定しない

strcount()

未使用のため非推奨


    
                    strcount(mixed $haystack, mixed $needle) : mixed

Parameters

$haystack : mixed
$needle : mixed

camelize()

文字列をキャメルケースに変換


    
                    camelize(string $str[, string $glue = '_' ]) : string

Parameters

$str : string
$glue : string = '_'

Return values

string

decamelize()


    
                    decamelize(string $str[, string $glue = '_' ]) : string

Parameters

$str : string
$glue : string = '_'

Return values

string

virtualImageSize()

未使用のため非推奨


    
                    virtualImageSize(mixed $xy, mixed $max) : mixed

Parameters

$xy : mixed
$max : mixed

maskImageSize()

未使用のため非推奨


    
                    maskImageSize(mixed $xy, mixed $size) : mixed

Parameters

$xy : mixed
$size : mixed

ngram()


    
                    ngram(string $txt, int $n) : array<string|int, string>

Parameters

$txt : string
$n : int: N-gram検索で使用するNの値

Return values

array<string|int, string>

roleAvailableUser()

ロールによる権限チェックを使用するかチェック


    
                    roleAvailableUser([int $suid = SUID ]) : bool

Parameters

$suid : int = SUID

Return values

bool

_roleAvailableUser()

ロールによる権限チェックを使用するかチェック


    
                    _roleAvailableUser(int $suid) : bool

Parameters

$suid : int

Return values

bool

approvalAvailableUser()

承認フローに所属するユーザかチェック


    
                    approvalAvailableUser([int $suid = SUID ]) : bool

Parameters

$suid : int = SUID

Return values

bool

roleEntryAuthorization()

ロールによるエントリー権限チェック


    
                    roleEntryAuthorization([int $bid = BID ][, array{entry_id?: int, entry_user_id?: int, entry_status?: string, entry_start_datetime?: string, entry_end_datetime?: string} $entry = [] ][, bool $status = true ]) : bool

Parameters

$bid : int = BID
$entry : array{entry_id?: int, entry_user_id?: int, entry_status?: string, entry_start_datetime?: string, entry_end_datetime?: string} = []
$status : bool = true: 未使用の引数

Return values

bool

roleEntryUpdateAuthorization()

ロールを含んだエントリーの編集権限チェック


    
                    roleEntryUpdateAuthorization([int|null $bid = BID ][, array{entry_id?: int, entry_user_id?: int} $entry = [] ]) : bool

Parameters

$bid : int|null = BID
$entry : array{entry_id?: int, entry_user_id?: int} = []

Return values

bool

roleAuthorization()

各ロールの権限があるかチェック


    
                    roleAuthorization([string $action = '' ][, int|null $bid = BID ][, int|null $eid = 0 ]) : bool

Parameters

$action : string = ''
$bid : int|null = BID
$eid : int|null = 0

Return values

bool

editionWithStandard()

ライセンスがスタンダード以上か


    
                    editionWithStandard() : bool

Return values

bool

editionWithProfessional()

ライセンスがプロフェッショナル以上か


    
                    editionWithProfessional() : bool

Return values

bool

editionIsStandard()

ライセンスがスタンダードか


    
                    editionIsStandard() : bool

Return values

bool

editionIsProfessional()

ライセンスがプロフェッショナルか


    
                    editionIsProfessional() : bool

Return values

bool

editionIsEnterprise()

ライセンスがエンタープライズか


    
                    editionIsEnterprise() : bool

Return values

bool

enableRevision()

対象のブログでバージョン管理が有効か調べる


    
                    enableRevision() : bool

Return values

bool

enableApproval()

対象のブログで承認機能が有効か調べる


    
                    enableApproval([int $bid = BID ][, int|null $cid = CID ]) : bool

Parameters

$bid : int = BID
$cid : int|null = CID

Return values

bool

enableParallelApproval()

対象のブログで並列承認機能が有効か調べる


    
                    enableParallelApproval([int $bid = BID ][, int|null $cid = CID ]) : bool

Parameters

$bid : int = BID
$cid : int|null = CID

Return values

bool

isSessionSubscriber()

アクセス中のユーザーが読者かをチェックする


    
                    isSessionSubscriber() : bool

Return values

bool

isSessionContributor()

アクセス中のユーザーが投稿者かをチェックする


    
                    isSessionContributor() : bool

Return values

bool

isSessionEditor()

アクセス中のユーザーが編集者かをチェックする


    
                    isSessionEditor() : bool

Return values

bool

isSessionAdministrator()

アクセス中のユーザーが管理者かをチェックする


    
                    isSessionAdministrator() : bool

Return values

bool

sessionWithSubscription()

アクセス中のユーザーが，指定されたブログにおいて読者以上の権限をもっているかをチェックする


    
                    sessionWithSubscription([int $bid = BID ][, bool|array{cache?: bool, considerTimemachineMode?: bool} $options = [] ]) : bool

Parameters

$bid : int = BID
$options : bool|array{cache?: bool, considerTimemachineMode?: bool} = []

Return values

bool

sessionWithContribution()

アクセス中のユーザーが，指定されたブログにおいて投稿者以上の権限をもっているかをチェックする


    
                    sessionWithContribution([int $bid = BID ][, bool|array{cache?: bool, considerTimemachineMode?: bool} $options = [] ]) : bool

Parameters

$bid : int = BID
$options : bool|array{cache?: bool, considerTimemachineMode?: bool} = []

Return values

bool

sessionWithCompilation()

アクセス中のユーザーが，指定されたブログにおいて編集者以上の権限をもっているかをチェックする


    
                    sessionWithCompilation([int $bid = BID ][, bool|array{cache?: bool, considerTimemachineMode?: bool} $options = [] ]) : bool

Parameters

$bid : int = BID
$options : bool|array{cache?: bool, considerTimemachineMode?: bool} = []

Return values

bool

sessionWithAdministration()

アクセス中のユーザーが，指定されたブログにおいて管理者以上の権限をもっているかをチェックする


    
                    sessionWithAdministration([int $bid = BID ][, bool|array{cache?: bool, considerTimemachineMode?: bool} $options = [] ]) : bool

Parameters

$bid : int = BID
$options : bool|array{cache?: bool, considerTimemachineMode?: bool} = []

Return values

bool

sessionWithEnterpriseAdministration()

アクセス中のユーザーが，ルートブログにおいてエンタープライズ管理操作の権限をもっているかをチェックする


    
                    sessionWithEnterpriseAdministration() : bool

Return values

bool

sessionWithProfessionalAdministration()

アクセス中のユーザーが，ルートブログにおいてプロフェッショナル管理操作の権限をもっているかをチェックする


    
                    sessionWithProfessionalAdministration() : bool

Return values

bool

sessionWithFormAdministration()

アクセス中のユーザーが，指定されたブログにおいて、フォームの管理権限があるかチェックする


    
                    sessionWithFormAdministration([int $bid = BID ][, bool|array{cache?: bool, considerTimemachineMode?: bool} $options = [] ]) : bool

Parameters

$bid : int = BID
$options : bool|array{cache?: bool, considerTimemachineMode?: bool} = []

Return values

bool

sessionWithScheduleAdministration()

アクセス中のユーザーが，指定されたブログにおいて、スケジュールの管理権限があるかチェックする


    
                    sessionWithScheduleAdministration([int $bid = BID ][, int|null $scid = null ]) : bool

Parameters

$bid : int = BID
$scid : int|null = null

Return values

bool

approvalUserPoint()

アクセス中のユーザーの承認ポイントを返す


    
                    approvalUserPoint([int $bid = BID ][, int|null $cid = CID ]) : int

Parameters

$bid : int = BID
$cid : int|null = CID

Return values

int

approvalRevisionPublicPoint()

リビジョンの現在承認ポイントを返す


    
                    approvalRevisionPublicPoint([int $eid = EID ][, int $rvid = RVID ][, int $bid = BID ]) : int

Parameters

$eid : int = EID
$rvid : int = RVID
$bid : int = BID

Return values

int

approvalRevisionRejectPoint()

リビジョンの現在承認却下ポイントを返す


    
                    approvalRevisionRejectPoint([int $eid = EID ][, int $rvid = RVID ][, int $bid = BID ]) : int

Parameters

$eid : int = EID
$rvid : int = RVID
$bid : int = BID

Return values

int

approvalWorkflowPublicPoint()

承認フローの最終承認ポイントを返す


    
                    approvalWorkflowPublicPoint([int $bid = BID ][, int|null $cid = CID ]) : int

Parameters

$bid : int = BID
$cid : int|null = CID

Return values

int —

$point

approvalWorkflowRejectPoint()

承認フローの最終承認却下ポイントを返す


    
                    approvalWorkflowRejectPoint([int $bid = BID ][, int $cid = CID ]) : int

Parameters

$bid : int = BID
$cid : int = CID

Return values

int —

$point

getUserGroupIds()

ユーザーが所属するユーザーグループを取得


    
                    getUserGroupIds(int $uid) : array<string|int, int>

Parameters

$uid : int

Return values

array<string|int, int>

sessionWithApprovalPreview()

アクセス中のユーザーが対象のリビジョンにおいて承認プレビューができるか


    
                    sessionWithApprovalPreview(int $bid, int $eid, int|null $cid, int $rvid, int $suid) : bool

Parameters

$bid : int
$eid : int
$cid : int|null
$rvid : int
$suid : int

Return values

bool

sessionWithApprovalRequest()

アクセス中のユーザーが対象のリビジョンにおいて承認依頼が出来るか


    
                    sessionWithApprovalRequest([int $bid = BID ][, int|null $cid = CID ][, int|null $eid = null ][, int|null $rvid = null ]) : bool

Parameters

$bid : int = BID
$cid : int|null = CID
$eid : int|null = null
$rvid : int|null = null

Return values

bool

sessionWithApprovalRejectRequest()

アクセス中のユーザーが対象のリビジョンにおいて承認却下依頼が出来るか


    
                    sessionWithApprovalRejectRequest([int $bid = BID ][, int|null $cid = CID ][, int|null $eid = null ][, int|null $rvid = null ]) : bool

Parameters

$bid : int = BID
$cid : int|null = CID
$eid : int|null = null
$rvid : int|null = null

Return values

bool

sessionWithApprovalReject()

アクセス中のユーザーが対象のリビジョンにおいて取り下げ（リジェクト）が出来るか


    
                    sessionWithApprovalReject([int $bid = BID ][, int|null $cid = CID ]) : bool

Parameters

$bid : int = BID
$cid : int|null = CID

Return values

bool

sessionWithApprovalPublic()

アクセス中のユーザーが対象のリビジョンにおいて最終承認が出来るか


    
                    sessionWithApprovalPublic([int $bid = BID ][, int|null $cid = CID ]) : bool

Parameters

$bid : int = BID
$cid : int|null = CID

Return values

bool

sessionWithApprovalAdministrator()

アクセス中のユーザーが対象のブログにおいて最終承認が出来るか、またはルートの管理者か


    
                    sessionWithApprovalAdministrator([int $bid = BID ][, int|null $cid = CID ]) : bool

Parameters

$bid : int = BID
$cid : int|null = CID

Return values

bool

snsLoginAuth()

指定されたユーザーが対象のブログにおいてSNSログイン権限があるか


    
                    snsLoginAuth([int $uid = SUID ][, int $bid = BID ]) : bool

Parameters

$uid : int = SUID
$bid : int = BID

Return values

bool

is404()

未使用のため非推奨


    
                    is404([bool $bool = true ]) : bool

Parameters

$bool : bool = true

Return values

bool

httpStatusCode()

HTTPステータスコードを取得または設定する


    
                    httpStatusCode([null|string $hsc = null ]) : string

Parameters

$hsc : null|string = null: 指定した場合はHTTPステータスコードを設定する

Return values

string

isErrorHttpStatus()

現在のHTTPステータスコードがエラーかどうかを判定する


    
                    isErrorHttpStatus() : bool

Return values

bool

userErrorLog()

エラーログを出力する AcmsLogger::error() のエイリアス


    
                    userErrorLog(string $mess) : void

Parameters

$mess : string

tplConfig()

テーマのtemplate.yamlを考慮したのコンフィグを取得する


    
                    tplConfig(string $key) : string

Parameters

$key : string: コンフィグのkey

Return values

string

config()

現在のコンテキストにおける，指定されたキーのコンフィグを返すモジュール内で使用した場合は，モジュールIDで設定されたコンフィグを返す


    
                    config(T $key[, string|int|null $default = null ][, int $i = 0 ]) : T is string ? string : false)

Parameters

$key : T
$default : string|int|null = null
$i : int = 0

Return values

T is string ? string : false)

configArray()

現在のコンテキストにおける，指定されたキーのコンフィグを配列で返すモジュール内で使用した場合は，モジュールIDで設定されたコンフィグを返す


    
                    configArray(string $key[, bool $strict = false ]) : array<string|int, mixed>

Parameters

$key : string
$strict : bool = false

Return values

array<string|int, mixed>

setConfig()

現在のコンテキストにおける，指定されたキーのコンフィグを一時的に書き換える


    
                    setConfig(string $key[, null|mixed $val = null ]) : mixed

Parameters

$key : string
$val : null|mixed = null

parseCsv()

CSVをパースして配列に変換する


    
                    parseCsv(string $csv) : array<string|int, array<string|int, string>>

Parameters

$csv : string

Return values

array<string|int, array<string|int, string>>

dsn()

データベースのDSNを取得する


    
                    dsn([array{host?: string, user?: string, pass?: string, name?: string, charset?: string, prefix?: string, type?: string, port?: int|null, debug?: bool} $dsn = [] ]) : Dsn

Parameters

$dsn : array{host?: string, user?: string, pass?: string, name?: string, charset?: string, prefix?: string, type?: string, port?: int|null, debug?: bool} = []

Return values

Dsn

getRoutingSegments()

ルーティングに使用するセグメントを取得する


    
                    getRoutingSegments() : array<string, string>

Return values

array<string, string>

isReserved()

予約語と衝突していないかを検査する


    
                    isReserved(string $word[, bool $extension = true ]) : bool

Parameters

$word : string
$extension : bool = true

Return values

bool

isValidCode()

文字列が正しいか検査する


    
                    isValidCode(string $word) : bool

Parameters

$word : string

Return values

bool

jsModule()

JSモジュールでフロントエンドに渡す変数を設定または取得する引数なしで呼び出すと全ての変数を連想配列で取得する


    
                    jsModule([T $key = null ][, U $value = null ]) : T is null ? array : mixed) : bool)

Parameters

$key : T = null
$value : U = null

Return values

T is null ? array : mixed) : bool)

pathIcon()

ファイルの拡張子からアイコンのパスを取得する


    
                    pathIcon(string $ext) : string

Parameters

$ext : string

Return values

string

otherSizeImagePath()

サイズ違いの画像パスを取得する


    
                    otherSizeImagePath(string $path, "large"|"tiny"|"square" $type) : string

Parameters

$path : string
$type : "large"|"tiny"|"square"

Return values

string

normalSizeImagePath()

画像のパスから正規サイズの画像パスを取得する


    
                    normalSizeImagePath(string $path) : string

Parameters

$path : string

Return values

string

altrim()


    
                    altrim(string $str, string $trim) : string

Parameters

$str : string
$trim : string

Return values

string

findTemplate()

テーマを考慮したテンプレートファイルを検索する


    
                    findTemplate(string $tpl) : string|false

Parameters

$tpl : string: テンプレートファイルのパス

Return values

string|false

allowViewTemplate()

表示可能なテンプレートかどうかを判定する


    
                    allowViewTemplate(string $path) : bool

Parameters

$path : string: テンプレートファイルのパス

Return values

bool

array_last()

未使用のため非推奨


    
                    array_last(array<string|int, mixed> $array) : mixed

Parameters

$array : array<string|int, mixed>

getTplContents()

未使用のため非推奨


    
                    getTplContents(mixed $path) : mixed

Parameters

$path : mixed

getMimetype()

拡張子からMIMEタイプを取得する


    
                    getMimetype([string $ext = '' ]) : string

Parameters

$ext : string = ''

Return values

string

parseDatetime()

未使用のため非推奨


    
                    parseDatetime(mixed $datetime) : mixed

Parameters

$datetime : mixed

addPrefixEntryTitle()

エントリータイトルにプレフィックスを追加する


    
                    addPrefixEntryTitle(string $title, "close"|"draft"|"trash"|"open" $status, string $stime, string $etime[, "none"|"pre_approval" $approval = 'none' ]) : string

Parameters

$title : string
$status : "close"|"draft"|"trash"|"open": 'close' | 'draft' | 'trash'
$stime : string: 開始日時
$etime : string: 終了日時
$approval : "none"|"pre_approval" = 'none': 承認ステータス

Return values

string

loadDefaultConfig()

config.sytem.yamlに記録されているデフォルトのコンフィグを連想配列で返す


    
                    loadDefaultConfig() : array<string|int, mixed>

Return values

array<string|int, mixed>

loadConfig()

ブログID, ルールID, モジュールIDによって指定されたコンテキストのコンフィグをFieldで返す


    
                    loadConfig([null|int $bid = null ][, null|int $rid = null ][, null|int $mid = null ]) : Field

Parameters

$bid : null|int = null
$rid : null|int = null
$mid : null|int = null

Return values

Field

loadBlogConfig()

指定されたidに該当するブログのコンフィグをFieldで返す


    
                    loadBlogConfig(null|int $bid) : Field

Parameters

$bid : null|int

Return values

Field

loadRuleConfig()

指定されたidに該当するルールのコンフィグをFieldで返す


    
                    loadRuleConfig(int $rid[, null|int $setid = null ]) : Field

Parameters

$rid : int
$setid : null|int = null

Return values

Field

loadModuleConfig()

指定されたidに該当するモジュールIDのコンフィグをFieldで返す


    
                    loadModuleConfig(null|int $mid[, mixed $rid = null ]) : Field

Parameters

$mid : null|int
$rid : mixed = null

Return values

Field

isExistsRuleModuleConfig()

ルールのモジュールコンフィグが存在するかチェック


    
                    isExistsRuleModuleConfig() : bool

Return values

bool

loadField()

ブログID, カテゴリーID, エントリーID，ユーザーIDのいずれか指定されたカスタムフィールドをFieldオブジェクトで返す


    
                    loadField([null|int $bid = null ][, null|int $uid = null ][, null|int $cid = null ][, null|int $mid = null ][, null|int $eid = null ][, null|string $unitId = null ][, null|int $rvid = null ][, bool $rewrite = false ]) : Field

Parameters

$bid : null|int = null
$uid : null|int = null
$cid : null|int = null
$mid : null|int = null
$eid : null|int = null
$unitId : null|string = null
$rvid : null|int = null
$rewrite : bool = false

Return values

Field

loadBlogField()

指定されたidに該当するブログのカスタムフィールドをFieldオブジェクトで返す


    
                    loadBlogField(int $bid) : Field

Parameters

$bid : int

Return values

Field

loadUserField()

指定されたidに該当するユーザーのカスタムフィールドをFieldオブジェクトで返す


    
                    loadUserField(int $uid) : Field

Parameters

$uid : int

Return values

Field

loadCategoryField()

指定されたidに該当するカテゴリーのカスタムフィールドをFieldオブジェクトで返す


    
                    loadCategoryField(int $cid) : Field

Parameters

$cid : int

Return values

Field

loadModuleField()

指定されたidに該当するモジュールIDのカスタムフィールドをFieldオブジェクトで返す


    
                    loadModuleField(int $mid) : Field

Parameters

$mid : int

Return values

Field

loadEntryField()

指定されたidに該当するエントリーのカスタムフィールドをFieldオブジェクトで返す


    
                    loadEntryField(int $eid[, mixed $rvid = null ][, mixed $rewrite = false ]) : Field

Parameters

$eid : int
$rvid : mixed = null
$rewrite : mixed = false

Return values

Field

loadUnitField()

指定されたidに該当するユニットのカスタムフィールドをFieldオブジェクトで返す


    
                    loadUnitField(string $unitId[, int|null $rvid = null ][, bool $rewrite = false ]) : Field

Parameters

$unitId : string
$rvid : int|null = null
$rewrite : bool = false

Return values

Field

eagerLoadEntry()

ToDo: deplicated mehod Ver. 3.2


    
                    eagerLoadEntry(array<string|int, int> $ids) : array<int, array<string|int, mixed>>

Parameters

$ids : array<string|int, int>

Return values

array<int, array<string|int, mixed>>

eagerLoadField()

ToDo: deplicated mehod Ver. 3.2


    
                    eagerLoadField(array<string|int, string>|array<string|int, int> $ids, "eid"|"uid"|"bid"|"cid"|"mid"|"unit_id" $type[, int|null $rvid = null ]) : Field>)

Parameters

$ids : array<string|int, string>|array<string|int, int>
$type : "eid"|"uid"|"bid"|"cid"|"mid"|"unit_id"
$rvid : int|null = null

Return values

Field>)

eagerLoadSubCategories()

ToDo: deplicated mehod Ver. 3.2


    
                    eagerLoadSubCategories(array<string|int, int> $eidArray) : array<string|int, array<int, array<string, mixed>>>

Parameters

$eidArray : array<string|int, int>

Return values

array<string|int, array<int, array<string, mixed>>>

loadGeometry()

指定されたidに該当するGeometryをFieldオブジェクトで返す


    
                    loadGeometry(string $type, int $id[, int|null $rvid = null ][, int $bid = BID ]) : Field

Parameters

$type : string
$id : int
$rvid : int|null = null
$bid : int = BID

Return values

Field

loadColumn()

エントリーIDに紐づくカラムを取得する ToDo: レガシーな方法なため非推奨。互換性のため残している。


    
                    loadColumn(int $eid[, int|null $range = null ][, int|null $rvid = null ]) : array<string|int, array<string, mixed>>

Parameters

$eid : int
$range : int|null = null
$rvid : int|null = null

Return values

array<string|int, array<string, mixed>>

loadFormUnit()

フォームユニットをデータベースから取得する


    
                    loadFormUnit(int $eid) : array<string|int, array{id: string, type: "text"|"textarea"|"radio"|"select"|"checkbox", align: string, sort: int, group: string, attr: string, size: string, label: string, caption: string, validatorSet: string, values?: string}>

Parameters

$eid : int

Return values

array<string|int, array{id: string, type: "text"|"textarea"|"radio"|"select"|"checkbox", align: string, sort: int, group: string, attr: string, size: string, label: string, caption: string, validatorSet: string, values?: string}>

fulltextUnitData()

フルテキスト用のユニットデータを整形する


    
                    fulltextUnitData(string $text) : string

Parameters

$text : string

Return values

string

loadSubCategories()


    
                    loadSubCategories(int $eid[, int|null $rvid = null ]) : array{id: int[], label: string[]}

Parameters

$eid : int
$rvid : int|null = null

Return values

array{id: int[], label: string[]}

loadSubCategoriesAll()


    
                    loadSubCategoriesAll(int $eid[, int|null $rvid = null ]) : array<string|int, array<string, mixed>>

Parameters

$eid : int
$rvid : int|null = null

Return values

array<string|int, array<string, mixed>>

loadRelatedEntries()


    
                    loadRelatedEntries(int $eid[, int|null $rvid = null ][, string $type = 'default' ]) : array<string|int, int>

Parameters

$eid : int
$rvid : int|null = null
$type : string = 'default'

Return values

array<string|int, int>

loadBlog()

指定されたidに該当するブログのレコードをFieldオブジェクトで返す


    
                    loadBlog(int $bid) : Field_Validation

Parameters

$bid : int

Return values

Field_Validation

loadAlias()

指定されたidに該当するブログのレコードをFieldオブジェクトで返す


    
                    loadAlias(int $aid) : Field_Validation

Parameters

$aid : int

Return values

Field_Validation

loadConfigSet()

指定したコンフィグセットIDに該当するコンフィグセットのレコードをFieldオブジェクトで返す


    
                    loadConfigSet(int $setid) : Field_Validation

Parameters

$setid : int

Return values

Field_Validation

loadUser()

指定されたidに該当するユーザーのレコードをFieldオブジェクトで返す


    
                    loadUser(int $uid[, mixed $deprecated = null ]) : Field_Validation

Parameters

$uid : int
$deprecated : mixed = null: この引数は廃止されました

Return values

Field_Validation

isRoleAvailableUser()

ロールによる権限チェッックを行うユーザーか


    
                    isRoleAvailableUser([int $uid = SUID ]) : bool

Parameters

$uid : int = SUID

Return values

bool

getAuthConsideringRole()

指定したユーザーのロールを考慮した権限を取得


    
                    getAuthConsideringRole([int|null $uid = SUID ]) : false|string

Parameters

$uid : int|null = SUID

Return values

false|string

loadUserIcon()

指定されたidに該当するユーザーの画像パスを取得する


    
                    loadUserIcon(int $uid) : string|false

Parameters

$uid : int

Return values

string|false

loadUserLargeIcon()

指定されたidに該当するユーザーの拡大画像パスを取得する


    
                    loadUserLargeIcon(int $uid) : string|false

Parameters

$uid : int

Return values

string|false

loadUserOriginalIcon()

指定されたidに該当するユーザーの画像パスを取得する


    
                    loadUserOriginalIcon(int $uid) : string|false

Parameters

$uid : int

Return values

string|false

categoryExists()

指定されたbidにカテゴリーが存在するか調べる


    
                    categoryExists([int $bid = BID ]) : bool

Parameters

$bid : int = BID

Return values

bool

categoryLevel()

指定されたcidの階層を調べる


    
                    categoryLevel([int $cid = CID ]) : int

Parameters

$cid : int = CID

Return values

int

loadCategory()

指定されたidに該当するカテゴリーのレコードをFieldオブジェクトで返す


    
                    loadCategory(int $cid) : Field_Validation

Parameters

$cid : int

Return values

Field_Validation

loadRule()

指定されたidに該当するルールのレコードをFieldオブジェクトで返す


    
                    loadRule(int $rid) : Field_Validation

Parameters

$rid : int

Return values

Field_Validation

loadModule()

指定されたidに該当するモジュールIDのレコードをFieldオブジェクトで返す


    
                    loadModule(int $mid) : Field_Validation

Parameters

$mid : int

Return values

Field_Validation

loadWebhook()

指定されたidに該当するWebhookのレコードをFieldオブジェクトで返す


    
                    loadWebhook(int $id) : Field_Validation

Parameters

$id : int

Return values

Field_Validation

loadRole()

指定されたidに該当するロールのレコードをFieldオブジェクトで返す


    
                    loadRole(int $rid) : Field_Validation

Parameters

$rid : int

Return values

Field_Validation

loadUsergroup()

指定されたidに該当するユーザグループのレコードをFieldオブジェクトで返す


    
                    loadUsergroup(int $ugid) : Field_Validation

Parameters

$ugid : int

Return values

Field_Validation

loadWorkflow()

指定されたブログに該当するワークフローのレコードをFieldオブジェクトで返す


    
                    loadWorkflow([int $bid = BID ][, int|null $cid = null ][, bool $status = true ]) : Field_Validation

Parameters

$bid : int = BID
$cid : int|null = null
$status : bool = true

Return values

Field_Validation

deleteWorkflow()

指定されたワークフローを削除する


    
                    deleteWorkflow([int $bid = BID ][, int|null $cid = null ]) : mixed

Parameters

$bid : int = BID
$cid : int|null = null

loadMedia()

指定されたidに該当するメディアのレコードをFieldオブジェクトで返す


    
                    loadMedia(int $mid) : Field_Validation

Parameters

$mid : int

Return values

Field_Validation

cacheBusting()

css, jsの読み込みをCache Busting対応


    
                    cacheBusting(string $path, string $real_path) : string

Parameters

$path : string
$real_path : string

Return values

string

repairFlatJson()

JSONの文字列を修正するための正規表現例: "key": "value" -> "key": "value" エスケープされたダブルクォートを考慮して、非エスケープのダブルクォートを検出するただし、JSONの形式に従っていることが前提


    
                    repairFlatJson(string $json) : string

Parameters

$json : string

Return values

string

getLangAndRegion()

i18n : ユーザーロケールを決定 config.server.phpでGETTEXT_TYPEが"auto"の場合有効 return : language_REGION (ja_JP, en_US)


    
                    getLangAndRegion() : string

Return values

string

i18n()

i18n : テンプレートの国際化 おはよう おはよう


    
                    i18n([string $txt = null ]) : string|false

空文字が渡された場合はfalseを返す

Parameters

$txt : string = null

Return values

string|false

xi18n()

xi18n : テンプレートの国際化をするための元となるテンプレートこのファイルから各言語用poファイル生成する おはよう おはよう


    
                    xi18n([string|null $root = null ][, string $pot = 'lang/message.pot' ]) : bool

Parameters

$root : string|null = null
$pot : string = 'lang/message.pot'

Return values

bool

fileFilter()


    
                    fileFilter(string $file) : bool

Parameters

$file : string

Return values

bool

gettextFile()


    
                    gettextFile(resource $fp[, string|null $file = null ][, array<string|int, mixed> &$exists = [] ]) : bool

Parameters

$fp : resource
$file : string|null = null
$exists : array<string|int, mixed> = []

Return values

bool

getFileList()

ディレクトリ内のファイルリストを取得


    
                    getFileList(string $dir[, array<string|int, string> $extAry = [] ]) : array<string|int, string>

Parameters

$dir : string
$extAry : array<string|int, string> = []

Return values

array<string|int, string>

build()

テンプレート文字列の解決


    
                    build(string $txt, Field_Validation &$Post[, bool $noBuildIF = false ]) : string

Parameters

$txt : string: テンプレート文字列
$Post : Field_Validation
$noBuildIF : bool = false: IFブロックを解決するかどうか

Return values

string —

解決されたテンプレート文字列

mainBuild()

テンプレート文字列のGETモジュールを解決


    
                    mainBuild(string $txt, Field_Validation &$Post) : string

Parameters

$txt : string: テンプレート文字列
$Post : Field_Validation

Return values

string —

解決されたテンプレート文字列

verbatim()

verbatim ブロックを解決


    
                    verbatim(string $txt[, bool $escape = true ]) : string

Parameters

$txt : string
$escape : bool = true

Return values

string

setBlockVars()

変数ブロックの変数をグローバル変数（$template_vars）に保存する


    
                    setBlockVars(["Template"|"Rendered" $block = 'Rendered' ][, string $txt = null ]) : string

Parameters

$block : "Template"|"Rendered" = 'Rendered': テンプレート文字列
$txt : string = null: テンプレート文字列

Return values

string

buildVarBlocks()

変数ブロックを解決


    
                    buildVarBlocks(string $txt[, bool $before = false ]) : string

Parameters

$txt : string: テンプレート文字列
$before : bool = false: trueの場合、SetTemplate, GetTemplateブロックを解決。falseの場合、SetRenderd, GetRenderdブロックを解決

Return values

string

buildIF()

IFブロックを解決


    
                    buildIF(string $txt) : string

Parameters

$txt : string: テンプレート文字列

Return values

string

reversePolishNotationBool()

逆ポーランド記法での論理式の計算


    
                    reversePolishNotationBool(string $string) : bool|string

Parameters

$string : string

Return values

bool|string

resolveFormula()

IFブロックの式を解決


    
                    resolveFormula(array<string|int, string> $formula) : bool

Parameters

$formula : array<string|int, string>

Return values

bool

boot()

GETモジュールを解決


    
                    boot(string $name, string $inner, string $opt, Field_Validation &$Post[, Field|null $_Config = null ][, array<string|int, mixed>|null $eagerLoadModule = null ]) : string

Parameters

$name : string: モジュール名例) Entry_Summary, Touch_Entry etc...
$inner : string: 解決するテンプレート文字列
$opt : string: オプション例) id="module_id" ctx="bid/1/cid/2" など
$Post : Field_Validation
$_Config : Field|null = null: GETモジュール解決後にグローバルに適用するコンフィグ
$eagerLoadModule : array<string|int, mixed>|null = null

Return values

string

checkModuleEntry()

モジュールIDがアクセス可能なIDか判定


    
                    checkModuleEntry(int $eid[, int|null $bid = null ][, int|null $mbid = null ]) : bool

Parameters

$eid : int
$bid : int|null = null
$mbid : int|null = null

Return values

bool

loadAncestorCategory()


    
                    loadAncestorCategory("parent"|"root" $scope[, string $fd = 'id' ]) : string|int|false

Parameters

$scope : "parent"|"root"
$fd : string = 'id'

Return values

string|int|false

loadAncestorBlog()


    
                    loadAncestorBlog("parent"|"root" $scope[, string $fd = 'id' ]) : string|int|false

Parameters

$scope : "parent"|"root"
$fd : string = 'id'

Return values

string|int|false

isTemplateCacheEnabled()


    
                    isTemplateCacheEnabled() : bool

Return values

bool

getTemplateCacheKey()

テンプレートキャッシュキーを取得


    
                    getTemplateCacheKey(string $path, string $theme[, bool $entry = false ]) : string

Parameters

$path : string
$theme : string
$entry : bool = false

Return values

string

setGlobalVarsForInclude()

インクルード文の中だけ、一部のグローバル変数を解決して返す


    
                    setGlobalVarsForInclude(string $txt) : string

Parameters

$txt : string

Return values

string

recursiveJoin()

配列を文字列に再帰的に結合


    
                    recursiveJoin(mixed $vals[, string $separator = '/' ]) : string

Parameters

$vals : mixed
$separator : string = '/'

Return values

string

globalVarsList()

グローバル変数の連想配列


    
                    globalVarsList() : array<string, mixed>

Return values

array<string, mixed>

setGlobalVars()

与えられた文字列中の，グローバル変数(%{GLOBAL_VAR})を解決して返す


    
                    setGlobalVars(string $txt) : string

Parameters

$txt : string

Return values

string

previewUrlFormat()

プレビューURLのフォーマット


    
                    previewUrlFormat(string $uri) : string

Parameters

$uri : string

Return values

string

parseAcmsPath()

acmsパスを解析したFieldオブジェクトを返す


    
                    parseAcmsPath(string $path) : Field

Parameters

$path : string

Return values

Field

parseQuery()

クエリ文字列を解析して返す


    
                    parseQuery(string $query) : array<string, string|array<string|int, string>>

Parameters

$query : string

Return values

array<string, string|array<string|int, string>>

inheritAcmsQuery()

現在のURLコンテキストを継承する


    
                    inheritAcmsQuery(Field &$Q) : true

Parameters

$Q : Field

Return values

true

blogDomain()

指定されたブログ、エイリアスのドメインを割り出して返す


    
                    blogDomain([int|null $bid = null ][, int|null $aid = null ]) : string

Parameters

$bid : int|null = null
$aid : int|null = null

Return values

string

acmsLink()

連想配列で指定されたURLコンテキストからURLを割り出して返す


    
                    acmsLink([Field|Field} $Q = [] ][, bool|AcmsLinkOptions $inheritOrOptions = true ][, bool $isDeep = false ][, bool $baseId = false ][, bool $explicitTpl = false ]) : false|string

第2引数でオプションを指定できます。

inherit - 現在のURLコンテキストを引き継ぐかどうかを指定します。（デフォルト: true） trueの場合、現在のページの状態(bid,eid等)を維持したままリンクを生成します。

isDeep - 第一引数のFieldオブジェクトのディープコピーを行うかどうかを指定します。（デフォルト: false）

baseId - ID指定によるのパス（bid/1/cid/1/）を生成するかどうかを指定します。（デフォルト: false）

explicitTpl - URLコンテキストのTPLを必ず生成するかどうかを指定します。（デフォルト: false） trueの場合、URLコンテキストのTPLを必ず生成します。 falseの場合、tplが指定されている場合でも、不要な場合は生成しません。

ignoreTplIfAjax - Ajaxリクエスト時にtplパラメータを無視するかどうかを指定します。（デフォルト: true） trueの場合、Ajaxリクエスト時にtplパラメータを無視します。

Parameters

$Q : Field|Field} = []
$inheritOrOptions : bool|AcmsLinkOptions = true
$isDeep : bool = false: 非推奨の引数
$baseId : bool = false: 非推奨の引数
$explicitTpl : bool = false: 非推奨の引数

Return values

false|string

acmsLink_page()

acmsLink()でpageを出すようにする


    
                    acmsLink_page([Field|Field} $Q = [] ][, AcmsLinkOptions $options = [] ]) : bool|string

Parameters

$Q : Field|Field} = []
$options : AcmsLinkOptions = []: オプション

Return values

bool|string

acmsPath()

連想配列で指定されたURLコンテキストからパスを割り出して返す


    
                    acmsPath([Field|array{bid?: int|null, cid?: int|null, eid?: int|null, sid?: int|null, aid?: int|null, uid?: int|null, cmid?: int|null, utid?: string|null, keyword?: string|null, tag?: string|string[]|null, field?: string|null, order?: string|null, tpl?: string|null, page?: int|null, proxy?: string|null, span?: bool, admin?: string|null, api?: string|null, login?: bool, admin-reset-password?: bool, admin-reset-password-auth?: bool, admin-tfa-recovery?: bool, signin?: bool, signup?: bool, reset-password?: bool, reset-password-auth?: bool, tfa-recovery?: bool, update-profile?: bool, update-password?: bool, update-email?: bool, update-tfa?: bool, withdrawal?: bool, limit?: int|null, domain?: string|null, fragment?: string|null, start?: string|null, end?: string|null, date?: string|int[]|string[]|null, protocol?: string|null, port?: int|null} $Q = null ][, bool $isAdmin = false ][, bool $baseId = false ][, bool $explicitTpl = false ]) : string

Parameters

$Q : Field|array{bid?: int|null, cid?: int|null, eid?: int|null, sid?: int|null, aid?: int|null, uid?: int|null, cmid?: int|null, utid?: string|null, keyword?: string|null, tag?: string|string[]|null, field?: string|null, order?: string|null, tpl?: string|null, page?: int|null, proxy?: string|null, span?: bool, admin?: string|null, api?: string|null, login?: bool, admin-reset-password?: bool, admin-reset-password-auth?: bool, admin-tfa-recovery?: bool, signin?: bool, signup?: bool, reset-password?: bool, reset-password-auth?: bool, tfa-recovery?: bool, update-profile?: bool, update-password?: bool, update-email?: bool, update-tfa?: bool, withdrawal?: bool, limit?: int|null, domain?: string|null, fragment?: string|null, start?: string|null, end?: string|null, date?: string|int[]|string[]|null, protocol?: string|null, port?: int|null} = null
$isAdmin : bool = false: 管理画面用のパス（bid/1/cid/1/）を生成するかどうか
$baseId : bool = false: ID指定によるのパス（bid/1/cid/1/）を生成するかどうか
$explicitTpl : bool = false: URLコンテキストのTPLを必ず生成するかどうかを指定します

Return values

string

isBlogGlobal()

ブログが子ブログを持っているかどうか


    
                    isBlogGlobal(int $bid) : bool

Parameters

$bid : int

Return values

bool

isBlogAncestor()

指定したブログが指定した親ブログの子ブログ可どうか判定


    
                    isBlogAncestor(int $bid, int $pid[, bool $self = false ]) : bool

Parameters

$bid : int
$pid : int
$self : bool = false: 自分自身を含めるかどうか

Return values

bool

checkDevelopment()

開発モードの場合、アラートを表示するためのJavaScriptを返す開発モードでない場合はfalseを返す


    
                    checkDevelopment() : string|false

Return values

string|false

isDebugMode()

デバックモードかどうか判定


    
                    isDebugMode() : bool

Return values

bool

isProductionModeForLogger()

監査ログの出力モードが本番モードかどうか判定


    
                    isProductionModeForLogger() : bool

Return values

bool

isBenchMarkMode()

ベンチマークモードかどうか判定


    
                    isBenchMarkMode() : bool

Return values

bool

acmsBenchmarkSnapshot()

ベンチマークデータをスナップショット化する


    
                    acmsBenchmarkSnapshot() : array{modules: array, slow_queries: array, global_vars: array, templates: array, memory: array{limit: string, usage: int, peak: int}, query_count: int, totals: array{boot: float, build: float, rewrite: float, module_total: float, process_total: string}}

Return values

array{modules: array, slow_queries: array, global_vars: array, templates: array, memory: array{limit: string, usage: int, peak: int}, query_count: int, totals: array{boot: float, build: float, rewrite: float, module_total: float, process_total: string}}

acmsBenchmarkBuildServerTiming()

Server-Timing ヘッダー値を構築する（サマリのみ）


    
                    acmsBenchmarkBuildServerTiming(array{modules?: array, slow_queries?: array, memory?: array{limit?: string, usage?: int, peak?: int}, query_count?: int, totals?: array{boot?: float, build?: float, rewrite?: float, module_total?: float, process_total?: string}} $snapshot) : string

Parameters

$snapshot : array{modules?: array, slow_queries?: array, memory?: array{limit?: string, usage?: int, peak?: int}, query_count?: int, totals?: array{boot?: float, build?: float, rewrite?: float, module_total?: float, process_total?: string}}

Return values

string

acmsBenchmarkEmitHeaders()

Server-Timing ヘッダーを付与する


    
                    acmsBenchmarkEmitHeaders() : void

isHtmlTemplate()

テンプレートがHTMLかどうか判定


    
                    isHtmlTemplate() : bool

Return values

bool

acmsSetCookie()

クッキーを送信する


    
                    acmsSetCookie(string $name, string|null $value[, int $expires = 0 ][, string $path = '/' ]) : void

Parameters

$name : string
$value : string|null
$expires : int = 0
$path : string = '/'

setUnregisteredDomain()

登録されていないドメインのアクセスの場合、フラグを設定


    
                    setUnregisteredDomain() : void

isUnregisteredDomain()

登録されていないドメインのアクセスか判定


    
                    isUnregisteredDomain() : bool

Return values

bool

isOldLicense()

旧ライセンスかどうか判定


    
                    isOldLicense() : bool

Return values

bool

isTrial()

トライアルモードかどうか判定


    
                    isTrial() : bool

Return values

bool

setTrial()

トライアルモードを設定


    
                    setTrial([bool $reset = false ]) : void

Parameters

$reset : bool = false

isClawler()

クローラーによるアクセスか判定


    
                    isClawler() : bool

Return values

bool

printContents()

コンテンツを出力する


    
                    printContents(string $contents) : void

Parameters

$contents : string

shutdown()

シャットダウン処理


    
                    shutdown() : true

Return values

true

detectUnitTypeSpecifier()

特定指定子を除外した、一般名のユニット種別


    
                    detectUnitTypeSpecifier(string $type) : string

Parameters

$type : string

Return values

string

fixEncodingAssoc()

何もしないため非推奨


    
                    fixEncodingAssoc(mixed &$val) : true

Parameters

$val : mixed

Return values

true

removeComments()

HTML内のコメントを削除する


    
                    removeComments(string $html) : string

Parameters

$html : string

Return values

string

removeBlank()

HTML内の空白を削除する


    
                    removeBlank(string $html) : string

Parameters

$html : string

Return values

string

useArchivesServer()

アーカイブ画像パスのドメインを書き換える


    
                    useArchivesServer(string $html) : string

Parameters

$html : string

Return values

string

acmsUserPasswordHash()

acmsUserPasswordHash ユーザーパスワードのハッシュを生成


    
                    acmsUserPasswordHash(string $password) : string

Parameters

$password : string

Return values

string

acmsUserPasswordVerify()

パスワードの照合


    
                    acmsUserPasswordVerify(string $password, string $hash, int $generation) : bool

Parameters

$password : string: ユーザーが入力したパスワード
$hash : string: ハッシュ化されたパスワード
$generation : int

Return values

bool

passwordHashGeneration1()

ハッシュ化されたパスワードを生成セキュリティ的に危険なため非推奨（互換性のために残してあります）


    
                    passwordHashGeneration1(string $password) : string

Parameters

$password : string

Return values

string

passwordHashGeneration2()

ハッシュ化されたパスワードを生成セキュリティ的に危険なため非推奨（互換性のために残してあります）


    
                    passwordHashGeneration2(string $password) : string

Parameters

$password : string

Return values

string

passwordHashGeneration3()

ハッシュ化されたパスワードを生成


    
                    passwordHashGeneration3(string $password) : string|false

Parameters

$password : string

Return values

string|false

getPasswordGeneration()

パスワード生成の方法を取得


    
                    getPasswordGeneration(array{user_pass: string, user_pass_generation: int} $user) : int

Parameters

$user : array{user_pass: string, user_pass_generation: int}

Return values

int

uniqueString()

uniqueString 指定した文字数のランダム文字列生成


    
                    uniqueString([int $length = 32 ]) : string

Parameters

$length : int = 32

Return values

string

uuidv4()

uuidv4


    
                    uuidv4([string|null $data = null ]) : non-empty-string

Parameters

$data : string|null = null

Return values

non-empty-string

setCookieDelFlag()

set cookie ( localstorage delete flag )


    
                    setCookieDelFlag() : true

Return values

true

DB()

DB DBインスタンスの省力化


    
                    DB([callable $func = null ]) : DB

未使用のため非推奨 Dababase Facade を利用してください。

Parameters

$func : callable = null

Return values

dbTableExists()

DB テーブルの存在確認


    
                    dbTableExists(string $tb) : bool

Parameters

$tb : string

Return values

bool

dbCreateTables()

DB テーブルの作成


    
                    dbCreateTables(string $tb, array<string|int, mixed> $data[, array<string|int, mixed>|null $idx = null ]) : void

Parameters

$tb : string
$data : array<string|int, mixed>
$idx : array<string|int, mixed>|null = null

dbDropTables()

DB テーブルの削除


    
                    dbDropTables(array<string|int, mixed> $tbs) : void

Parameters

$tbs : array<string|int, mixed>

appStatus()

AAPP 拡張アプリが有効かどうか


    
                    appStatus(string $app) : bool

未使用のため非推奨

Parameters

$app : string

Return values

bool

array_clean()

array_clean http://d.hatena.ne.jp/H6K/20090601/p1


    
                    array_clean(array<string|int, mixed> $array) : array<string|int, mixed>

Parameters

$array : array<string|int, mixed>

Return values

array<string|int, mixed>

array_flatten()

すべてのサブ配列の要素を指定した深さで再帰的に結合した新しい配列を生成する


    
                    array_flatten(array<string|int, mixed> $array[, int $depth = 1 ]) : array<string|int, mixed>

Parameters

$array : array<string|int, mixed>
$depth : int = 1: フラットにする深さ。デフォルトは1。PHP_INT_MAXで、すべてのレベルをフラットにする

Return values

array<string|int, mixed>

is_hash()

is_hash http://d.hatena.ne.jp/fbis/20091112/1258002754


    
                    is_hash(array<string|int, mixed> &$array) : bool

未使用のため非推奨

Parameters

$array : array<string|int, mixed>

Return values

bool

is_ajax()

is_ajax


    
                    is_ajax() : bool

Return values

bool

byteConvert()

byteConvert


    
                    byteConvert(int $size) : string

Parameters

$size : int

Return values

string

stripWhitespace()

stripWhitespace


    
                    stripWhitespace(string $txt) : string

Parameters

$txt : string

Return values

string

acmsDump()

acmsDump


    
                    acmsDump(mixed $obj[, bool $die = false ]) : mixed

Parameters

$obj : mixed
$die : bool = false

authorityRestriction()

権限ごとのIPチェック


    
                    authorityRestriction([int|null $uid = SUID ][, int|null $bid = BID ]) : void|never

Parameters

$uid : int|null = SUID
$bid : int|null = BID

Return values

void|never

logout()

ログアウト


    
                    logout([int|null $uid = SUID ]) : void

Parameters

$uid : int|null = SUID

isCSRF()

isCSRF


    
                    isCSRF() : bool

Return values

bool

roleUserLoginAuth()

roleUserLoginCheck


    
                    roleUserLoginAuth(array{user_id: int, user_blog_id: int, user_login_anywhere: "on"|"off"} $user) : bool

Parameters

$user : array{user_id: int, user_blog_id: int, user_login_anywhere: "on"|"off"}

Return values

bool

getCookieHost()

get cookie host.


    
                    getCookieHost() : string|false

localhostの場合はfalseを返す

Return values

string|false

generateSession()

generateSession


    
                    generateSession(int $uid[, mixed $persistent = 'on' ]) : string

Parameters

$uid : int
$persistent : mixed = 'on'

Return values

string —

sid

getSessionIdFromDB()

DBに保存されているセッションIDを取得同時ログイン禁止のために使用


    
                    getSessionIdFromDB(int $uid, string $host[, bool $address = false ]) : string

Parameters

$uid : int
$host : string
$address : bool = false

Return values

string

loginRoleCheck()

ロール権限でログインできる権限をもつか判定


    
                    loginRoleCheck(int $uid) : bool

Parameters

$uid : int

Return values

bool

arrayColumn()

未使用のため非推奨


    
                    arrayColumn(mixed $input, mixed $key) : mixed

Parameters

$input : mixed
$key : mixed

isStreamLike()

isStreamLike 指定された値がストリームのようなものかどうかを判定


    
                    isStreamLike(mixed $value) : bool

Parameters

$value : mixed

Return values

bool

getExceptionTraceAsString()

例外のスタックトレースを文字列で取得


    
                    getExceptionTraceAsString(Throwable $exception) : string

Parameters

$exception : Throwable

Return values

string

contrastColor()

指定色（Hex指定例: #FFFFFF）に載せる文字色として、コントラストが高くなるように、黒系、白系のカラーを返す


    
                    contrastColor(string $hex[, string $black = '#000000' ][, string $white = '#ffffff' ]) : string

Parameters

$hex : string
$black : string = '#000000'
$white : string = '#ffffff'

Return values

string

canSwitchUser()

ユーザー切り替えが可能なユーザーかどうか判定


    
                    canSwitchUser(int $uid) : bool

Parameters

$uid : int

Return values

bool

getApprovalFrom()

承認メール送信元のアドレスを取得


    
                    getApprovalFrom(int $uid) : string

Parameters

$uid : int

Return values

string

isApiBuild()

APIビルドかどうか判定


    
                    isApiBuild() : bool

Return values

bool

isApiBuildOrV2Module()

APIビルドか、V2モジュールである場合はtrueを返す


    
                    isApiBuildOrV2Module() : mixed

acmsFputcsv()

PHP8.1との互換性を持たせるためのfputcsv関数


    
                    acmsFputcsv(resource $stream, array<string|int, mixed> $fields[, string $separator = "," ][, string $enclosure = "\"" ][, string $escape = "\\" ][, string $eol = "\n" ]) : int|false

Parameters

$stream : resource
$fields : array<string|int, mixed>
$separator : string = ","
$enclosure : string = "\""
$escape : string = "\\"
$eol : string = "\n"

Return values

int|false

limitedJsonEncode()

連想配列を制限をかけたJSON文字列に変換


    
                    limitedJsonEncode(array<string|int, mixed> $data[, int $length = 100 ][, mixed $strLength = 1024 ][, int $depth = 5 ]) : string|false

Parameters

$data : array<string|int, mixed>
$length : int = 100
$strLength : mixed = 1024
$depth : int = 5

Return values

string|false

function.php

Table of Contents

Classes

Constants

Functions

Constants

ACMS_AT_SIGN_TARGET

ACMS_AT_SIGN_TOKEN

ACMS_LOGIN_SESSION_ORGINAL_UID

ACMS_LOGIN_SESSION_UID

CACHE_TPL_ENTRY

IS_UNREGISTERED_DOMAIN

ONLY_BUILD_LAYOUT

REGEX_EXCEPTION_UA

REGEX_INVALID_TAG_NAME

REGEX_SEPARATER

REGEX_VALID_ID

REGEX_VALID_IPV4_ADDR

REGEX_VALID_MAIL

REGEX_VALID_PASSWD

REGEX_VALID_URL

REGEXP_SEPARATER

REGEXP_VALID_DATE

REGEXP_VALID_DATETIME

REGEXP_VALID_TIME

TAG_SEPARATER

Functions

getRFC2068Time()

Parameters

Return values

requestTime()

Return values

timemachineAuth()

Return values

timemachineMode()

Parameters

Return values

redirect()

Parameters

Return values

multiBytePregMatch()

Parameters

Return values

array_in_array()

Parameters

Return values

mailConfig()

detectEncode()

Parameters

Return values

in_ipband()

Parameters

Return values

is_private_ip()

Parameters

Return values

convert_bytes()

Parameters

return_bytes()

Parameters

isBufferable()

Parameters

die500()

Parameters

die503()

Parameters

die400()

Parameters

Return values

die403()

Parameters

Return values

page404()

Return values

arrayPath()

Parameters

ite()

Parameters

Return values

idval()