Bitsmist Frameworks
Docs » URLUtil

URLUtil

概要

URLに関する処理を行う、ユーティリティークラスです。

メソッド

buildQuery(options)

型:String Static

引数で与えられたオブジェクトから、URLのクエリー部を生成します。各キーと値はURLEncodeされます。値が配列の場合、それぞれの要素はカンマで連結されます。

パラメータ

パラメータ型説明
options
必須
ObjectURLのクエリーパラメータのオブジェクトです。

戻り値

URLのクエリー文字列を返します。クエリー文字列が空文字列ではない場合、先頭に?を付加します。


buildURL(routeInfo, options)

型:String Static

指定されたルート情報オブジェクトを元に、URLを生成します。

ルート情報に“URL“が含まれる場合それを使用し、含まれない場合は、”protocol”、“host”、“pathname”を繋ぎ合わせてURLを生成します。指定がないパラメータは、現在のURLの内容が使用されます。

クエリー部はルート情報に“query”が含まれる場合、それがそのまま使用されます。“queryParameters”が含まれる場合、そのオブジェクトを元にクエリー部が生成され、URLに付加されます。

パラメータ

パラメータ型説明
routeInfo
必須
ObjectURLを組み立てるためのルート情報です。以下のキーがあります。
“URL“Stringクエリー部以外のURLを指定します。
“protocol”StringURLのプロトコル部です。
“host”StringURLのホスト部です。
“pathname”StringURLのパス名部です。
“query”StringURLのクエリー部です。
“queryParameters”Objectクエリーのパラメータ部のオブジェクトです。
optionsObjectオプションを指定します。以下のキーがあります。
“mergeParameters”StringTrueの場合、現在のURLのクエリーにルート情報のクエリーパラメータをマージします。

戻り値

生成したURLを返します。


loadParameters(url)

型:Object Static

指定されたURLのクエリー部分を、オブジェクトに変換して返します。

パラメータ

パラメータ型説明
urlString対象となるURLを指定します。指定がない場合、現在のURLが使用されます。

戻り値

クエリー部のオブジェクトを返します。


parseURL(url)

型:Object Static

引数で与えられたURLを分解し、格納したオブジェクトを返します。オブジェクトは以下の情報を持ちます。

キー型説明
protocolStringURLのプロトコル部です。
usernameStringURLのユーザー名部です。
passwordStringURLのパスワード部です。
hostStringURLのホスト部です。ポートが指定されている場合は、ポートも含みます。
hostnameStringURLのホスト部です。
portStringURLのポート部です。
pathnameStringURLのパス部です。
pathStringURLのパス部からファイル名部を取り除いたものです。
searchStringURLのクエリー部です。
queryStringURLのクエリー部です。
hashStringURLのハッシュ部です。
filenameStringURLのファイル名部です。
filenameWithoutExtensionStringURLの拡張子なしのファイル名部です。
extensionStringURLのファイル名の拡張子部です。
queryParametersObjectURLのクエリー部をオブジェクトに変換したものです。

パラメータ

パラメータ型説明
urlString対象となるURLです。指定がない場合は、現在のURLが対象となります。

戻り値

URL情報のオブジェクトです。

Previous Next

© 2019-2023 Masaki Yasutake

Bitsmist Frameworks

Table of Contents

Table of Contents

  • URLUtil
    • 概要
    • メソッド
      • buildQuery(options)
      • buildURL(routeInfo, options)
      • loadParameters(url)
      • parseURL(url)

紹介

  • 概要
  • インストール
  • サンプルユニットを作る

ユニットの解説

  • 概要
  • プロパティとメソッド
  • 設定
  • ロード
  • イベント
  • HTML
  • CSS
  • パークによる拡張

リファレンス - ユニット

  • Unit

リファレンス - パーク

  • Perk(ベースクラス)
  • BasicPerk
  • EventPerk
  • PerkPerk
  • SettingPerk
  • SkinPerk
  • StatusPerk
  • StylePerk
  • UnitPerk

リファレンス - ストア

  • Store
  • ChainableStore

リファレンス - ユーティリティ

  • AjaxUtil
  • ClassUtil
  • URLUtil
  • Util