wp/wp-includes/class-wp-ajax-response.php
author ymh <ymh.work@gmail.com>
Wed, 06 Nov 2013 03:21:17 +0000
changeset 0 d970ebf37754
child 5 5e2f62d02dcd
permissions -rw-r--r--
first import
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
 * Send XML response back to AJAX request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
 * @package WordPress
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
 * @since 2.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
class WP_Ajax_Response {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
	 * Store XML responses to send.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
	 * @since 2.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
	 * @var array
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
	 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
	var $responses = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
	 * Constructor - Passes args to {@link WP_Ajax_Response::add()}.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
	 * @since 2.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
	 * @see WP_Ajax_Response::add()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
	 * @param string|array $args Optional. Will be passed to add() method.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
	 * @return WP_Ajax_Response
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
	function __construct( $args = '' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
		if ( !empty($args) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
			$this->add($args);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
	 * Append to XML response based on given arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
	 * The arguments that can be passed in the $args parameter are below. It is
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
	 * also possible to pass a WP_Error object in either the 'id' or 'data'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
	 * argument. The parameter isn't actually optional, content should be given
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
	 * in order to send the correct response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
	 * 'what' argument is a string that is the XMLRPC response type.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
	 * 'action' argument is a boolean or string that acts like a nonce.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
	 * 'id' argument can be WP_Error or an integer.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
	 * 'old_id' argument is false by default or an integer of the previous ID.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
	 * 'position' argument is an integer or a string with -1 = top, 1 = bottom,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
	 * html ID = after, -html ID = before.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
	 * 'data' argument is a string with the content or message.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
	 * 'supplemental' argument is an array of strings that will be children of
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
	 * the supplemental element.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
	 * @since 2.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
	 * @param string|array $args Override defaults.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
	 * @return string XML response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
	function add( $args = '' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
		$defaults = array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
			'what' => 'object', 'action' => false,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
			'id' => '0', 'old_id' => false,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
			'position' => 1,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
			'data' => '', 'supplemental' => array()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
		);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
		$r = wp_parse_args( $args, $defaults );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
		extract( $r, EXTR_SKIP );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
		$position = preg_replace( '/[^a-z0-9:_-]/i', '', $position );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
		if ( is_wp_error($id) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
			$data = $id;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
			$id = 0;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
		$response = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
		if ( is_wp_error($data) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
			foreach ( (array) $data->get_error_codes() as $code ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
				$response .= "<wp_error code='$code'><![CDATA[" . $data->get_error_message($code) . "]]></wp_error>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
				if ( !$error_data = $data->get_error_data($code) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
					continue;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
				$class = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
				if ( is_object($error_data) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
					$class = ' class="' . get_class($error_data) . '"';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
					$error_data = get_object_vars($error_data);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
				}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
				$response .= "<wp_error_data code='$code'$class>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
				if ( is_scalar($error_data) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
					$response .= "<![CDATA[$error_data]]>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
				} elseif ( is_array($error_data) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
					foreach ( $error_data as $k => $v )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
						$response .= "<$k><![CDATA[$v]]></$k>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
				}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
				$response .= "</wp_error_data>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
			}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
		} else {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
			$response = "<response_data><![CDATA[$data]]></response_data>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
		$s = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
		if ( is_array($supplemental) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
			foreach ( $supplemental as $k => $v )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
				$s .= "<$k><![CDATA[$v]]></$k>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
			$s = "<supplemental>$s</supplemental>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
		if ( false === $action )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
			$action = $_POST['action'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
		$x = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
		$x .= "<response action='{$action}_$id'>"; // The action attribute in the xml output is formatted like a nonce action
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
		$x .=	"<$what id='$id' " . ( false === $old_id ? '' : "old_id='$old_id' " ) . "position='$position'>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
		$x .=		$response;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   113
		$x .=		$s;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   114
		$x .=	"</$what>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   115
		$x .= "</response>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   116
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   117
		$this->responses[] = $x;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   118
		return $x;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   119
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   120
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   121
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   122
	 * Display XML formatted responses.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   123
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   124
	 * Sets the content type header to text/xml.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   125
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   126
	 * @since 2.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   127
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   128
	function send() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   129
		header( 'Content-Type: text/xml; charset=' . get_option( 'blog_charset' ) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   130
		echo "<?xml version='1.0' encoding='" . get_option( 'blog_charset' ) . "' standalone='yes'?><wp_ajax>";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   131
		foreach ( (array) $this->responses as $response )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   132
			echo $response;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   133
		echo '</wp_ajax>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   134
		if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   135
			wp_die();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   136
		else
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   137
			die();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   138
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   139
}