オブジェクト組み込みオブジェクト
  1. 表紙
  2. 組み込みオブジェクト
  3. オブジェクトHttpコレクション

オブジェクトHttpコレクション

HttpCollection は処理用の一般的なコンテナですhttpメッセージ内のヘッダー、クエリ、フォーム、Cookie データ

HttpCollection の使用法を説明するためにヘッダーを例に挙げます。

HttpCollection は、次の 3 つの形式のデータ追加をサポートしています。

  1. Key-Value データを追加します。データを追加しても、既存の Key-Value データは変更されません。add
1
2
3
4
headers.add({
    'Content-Type': 'text/plain',
    'User-Agent': 'fibjs'
});
  1. キー値を持つデータのセットを追加します。データを追加しても、既存のキー値のデータは変更されません。add
1
2
3
4
headers.add('Set-Cookie', [
    'a=10',
    'b=20'
]);
  1. Key-Value データを追加します。データを追加しても、既存の Key-Value データは変更されません。add
1
headers.add('Accept-Encoding', 'gzip');

HttpCollection データを設定する形式は追加と同じで、方法は ですset。

has指定したキー値を持つデータがコンテナ内に存在するかどうかを確認するために使用できます

1
const contentTypeExists = headers.has('Content-Type');

firstコンテナ内のキーに対応する最初の値を取得するために使用します。

1
const contentType = headers.first('Content-Type');

all指定されたキー値のすべての値をクエリし、配列を返すために使用します。空の文字列引数が渡された場合は、完全な値が返されます。

1
2
const cookieArray = headers.all('Set-Cookie');
const alls = headers.all();

指定されたキー値のすべてのデータを削除し、表現deleteを返すメソッドを使用します。true

相続関係

%0 object object toString() toJSON() HttpCollection HttpCollection operator[String] clear() has() first() get() all() add() set() remove() delete() sort() keys() values() object->HttpCollection

オペレーター

operator[String]

キーと値の添字を使用して値に直接アクセスできるようにします

1
Variant HttpCollection[String];

メンバー関数

clear

コンテナデータのクリア

1
HttpCollection.clear();

has

指定したキー値を持つデータがコンテナ内に存在するか確認する

1
Boolean HttpCollection.has(String name);

呼び出しパラメータ:

  • name: 文字列、チェックするキー値を指定します

返される結果:

  • Boolean、キー値が存在するかどうかを返します。

first

指定されたキー値の最初の値をクエリします

1
Variant HttpCollection.first(String name);

呼び出しパラメータ:

  • name: 文字列、クエリするキー値を指定します

返される結果:

  • Variant、キー値に対応する値を返します。キー値が存在しない場合は、未定義を返します。

get

指定されたキー値の最初の値をクエリします。これは first と同等です。

1
Variant HttpCollection.get(String name);

呼び出しパラメータ:

  • name: 文字列、クエリするキー値を指定します

返される結果:

  • Variant、キー値に対応する値を返します。キー値が存在しない場合は、未定義を返します。

all

指定されたキー値のすべての値をクエリします

1
NObject HttpCollection.all(String name = "");

呼び出しパラメータ:

  • name: 文字列。クエリするキー値を指定します。すべてのキー値の結果を返すには空の文字列を渡します。

返される結果:

  • NObject, キー値に対応するすべての値の配列を返します。データが存在しない場合は null を返します。

add

Key-Value データを追加します。データを追加しても、既存の Key-Value データは変更されません。

1
HttpCollection.add(Object map);

呼び出しパラメータ:

  • map: オブジェクト。追加するキーと値のデータ ディクショナリを指定します。

キー値のデータ セットを追加します。データを追加しても、既存のキー値のデータは変更されません。

1
2
HttpCollection.add(String name,
    Array values);

呼び出しパラメータ:

  • name: 文字列、追加するキー値を指定します
  • values: 配列、追加するデータのセットを指定します

Key-Value データを追加します。データを追加しても、既存の Key-Value データは変更されません。

1
2
HttpCollection.add(String name,
    Variant value);

呼び出しパラメータ:

  • name: 文字列、追加するキー値を指定します
  • value: バリアント、追加するデータを指定します

set

キー値データを設定します。データを設定すると、キー値に対応する最初の値が変更され、同じキー値を持つ残りのデータがクリアされます。

1
HttpCollection.set(Object map);

呼び出しパラメータ:

  • map: オブジェクト。設定するキーと値のデータ ディクショナリを指定します。

キー値に一連のデータを設定します。データを設定すると、キー値に対応する値が変更され、同じキー値を持つ残りのデータがクリアされます。

1
2
HttpCollection.set(String name,
    Array values);

呼び出しパラメータ:

  • name: 文字列、設定するキー値を指定します
  • values: 配列、設定するデータのセットを指定します

キー値データを設定します。データを設定すると、キー値に対応する最初の値が変更され、同じキー値を持つ残りのデータがクリアされます。

1
2
HttpCollection.set(String name,
    Variant value);

呼び出しパラメータ:

  • name: 文字列、設定するキー値を指定します
  • value: バリアント、設定するデータを指定します

remove

指定したキーの値をすべて削除します

1
HttpCollection.remove(String name);

呼び出しパラメータ:

  • name: 文字列、削除するキー値を指定します

delete

指定したキーの値をすべて削除します

1
HttpCollection.delete(String name);

呼び出しパラメータ:

  • name: 文字列、削除するキー値を指定します

sort

コンテナの内容をキー値で並べ替える

1
HttpCollection.sort();

keys

コンテナ内のキー値をクエリします。

1
NArray HttpCollection.keys();

返される結果:

  • NArray、すべてのキー値を含む配列を返します。

values

コンテナ内の値をクエリする

1
NArray HttpCollection.values();

返される結果:

  • NArray、すべての値を含む配列を返します。

toString

オブジェクトの文字列表現を返します。通常、「[Native Object]」が返されます。オブジェクトは、独自の特性に従って再実装できます。

1
String HttpCollection.toString();

返される結果:

  • String、オブジェクトの文字列表現を返します。

toJSON

オブジェクトの JSON 形式表現を返します。通常は、オブジェクトによって定義された読み取り可能なプロパティのコレクションを返します。

1
Value HttpCollection.toJSON(String key = "");

呼び出しパラメータ:

  • key: 文字列、使用されません

返される結果:

  • Value、シリアル化可能な JSON を含む値を返します
© Copyright 2012-2024 fibjs.org |サポートしてください