ajaxSend とは
- ここで説明する ajaxSend とは次の語句からなる jQuery のメソッドです。
- ajax
- 読み: エイジャックス
意味: ウェブページの表示技術の一種。サーバーからのデータの取得とブラウザ上での表示を非同期的に処理させるもの。 - send
- 読み: センド
意味: 送信、送る、発信、届ける
ajaxSend メソッドの概要
このメソッドは、ドキュメント内で行われる、各 ajax 通信の送信前イベントにハンドラーをアタッチします。
つまり、このメソッドの実行により、ページ内で発生した ajax 通信は監視され、各通信の送信前に関数を実行することができます。
前述しているとおり、ajax 通信の 送信前 イベントにハンドラーをアタッチするので、 ユーザーに送信の可否を問うことなどが容易になります。 もちろん、それ以外の用途で使用しても構いません。
構文
サンプルを見る前に構文を確認しておきます。
このメソッドはグローバルイベントハンドラーです。 メソッドの呼び出し元は グローバルプロパティ を指定することが一般的 となりますので document や window プロパティを使用してください。
$(document).ajaxSend(handler);
$(document).ajaxSend(callback(eventObject, jqxhr, ajaxSettings));
サンプルコードと実行結果
ここでは、このページのファイルとは別の php-post-response.php というファイルに ajax 通信を使ってデータを送信し、結果をリクエストします。
サンプルでは ajax 通信の送信が開始される前に送信の可否を確認するダイアログを開きます。
サンプルコード: PHP ( php-post-response.php )
<?php
$post = $_POST['sendData'];
if(strlen($post) > 0){
echo('POST メソッドで ' . $post . ' という値を受け取りました。');
}
?>
ここでは、 PHP のコードの説明は割愛させていただきます。
動作内容としては、 この php ファイルに POSTメソッドを使って sendData というキーと 値 をセットで送信すると、その受信した 値 を php の実行により出力するというものです。
サンプルコード: CSS
<style>
div{
margin: 1em 0;
}
button{
cursor: pointer;
}
#idReceive{
display: block;
background-color: ##white;
border: thin solid ##gray;
padding: 0 1em;
}
</style>
サンプルコード: HTML
<head>
<style>...</style>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
</head>
<body>
<div><button id="idPost"> send POST Hello </button></div>
<div><output id="idReceive"> Waiting for send </output></div>
<script>...</script>
</body>
- 06: button id="idPost" (ボタンです。これをクリックすると、 script の 06~08 行目のコードが実行されます。)
- 07: output id="idReceive" (出力要素です。この要素に php ファイルが実行された後の返信結果が出力されます。)
サンプルコード: script
<script>
$(document).ajaxSend(function(eo, jqxhr, settings){
let blnResult = window.confirm(" 送信します。\r\r よろしいですか?");
if(blnResult == false){
jqxhr.abort();
$("#idReceive").text("送信はキャンセルされました。");
}
});
$("#idPost").click(function(){
$.ajax({
type: "POST",
url: "php-post-response.php",
data: {"sendData" : "Hello"}
})
.done(function(receives){
$("#idReceive").html(receives);
});
});
</script>
- 02-08: $(document).ajaxSend(function(){ 関数の処理 }) (このページ内で ajax 通信による送信が開始される前に、関数の処理 の部分が実行されます。 ここでの処理の内容は、確認ダイアログを開いて、その戻り値が false ならリクエストをキャンセルするようにしています。)
- 05: jqxhr.abort() (ajaxSend() のコールバック値である jqxhr オブジェクトから abort() メソッドを実行して通信をキャンセルしています。)
- 09-18: $("#idPost").click(function(){ 関数の処理 }) (id 属性に idPost をもつ要素がクリックされると 関数の処理 の部分が実行されます。 処理内容については $.ajax のページを参照してください。)
送信:
受信: id="idReceive"