<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[2273] 2013/rmccue/trunk/lib/class-wp-json-media.php: Add PHPDoc for new attachment methods</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://gsoc.trac.wordpress.org/changeset/2273">2273</a></dd>
<dt>Author</dt> <dd>rmccue</dd>
<dt>Date</dt> <dd>2013-09-11 04:31:31 +0000 (Wed, 11 Sep 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Add PHPDoc for new attachment methods</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#2013rmccuetrunklibclasswpjsonmediaphp">2013/rmccue/trunk/lib/class-wp-json-media.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="2013rmccuetrunklibclasswpjsonmediaphp"></a>
<div class="modfile"><h4>Modified: 2013/rmccue/trunk/lib/class-wp-json-media.php (2272 => 2273)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/rmccue/trunk/lib/class-wp-json-media.php    2013-09-11 04:31:25 UTC (rev 2272)
+++ 2013/rmccue/trunk/lib/class-wp-json-media.php       2013-09-11 04:31:31 UTC (rev 2273)
</span><span class="lines">@@ -103,6 +103,17 @@
</span><span class="cx">          return parent::deletePost( $id, $force );
</span><span class="cx">  }
</span><span class="cx"> 
</span><ins>+       /**
+        * Upload a new attachment
+        *
+        * Creating a new attachment is done in two steps: uploading the data, then
+        * setting the post. This is achieved by first creating an attachment, then
+        * editing the post data for it.
+        *
+        * @param array $_files Data from $_FILES
+        * @param array $_headers HTTP headers from the request
+        * @return array|WP_Error Attachment data or error
+        */
</ins><span class="cx">   public function uploadAttachment( $_files, $_headers ) {
</span><span class="cx">          global $wp_json_server;
</span><span class="cx"> 
</span><span class="lines">@@ -158,6 +169,13 @@
</span><span class="cx">          return $id;
</span><span class="cx">  }
</span><span class="cx"> 
</span><ins>+       /**
+        * Handle an upload via raw POST data
+        *
+        * @param array $_files Data from $_FILES. Unused.
+        * @param array $_headers HTTP headers from the request
+        * @return array|WP_Error Data from {@see wp_handle_sideload()}
+        */
</ins><span class="cx">   protected function uploadFromData( $_files, $_headers ) {
</span><span class="cx">          global $wp_json_server;
</span><span class="cx">          $data = $wp_json_server->get_raw_data();
</span><span class="lines">@@ -233,6 +251,13 @@
</span><span class="cx">          return $sideloaded;
</span><span class="cx">  }
</span><span class="cx"> 
</span><ins>+       /**
+        * Handle an upload via multipart/form-data ($_FILES)
+        *
+        * @param array $_files Data from $_FILES
+        * @param array $_headers HTTP headers from the request
+        * @return array|WP_Error Data from {@see wp_handle_upload()}
+        */
</ins><span class="cx">   protected function uploadFromFile( $_files, $_headers ) {
</span><span class="cx">          if ( empty( $_files['file'] ) )
</span><span class="cx">                  return new WP_Error( 'json_upload_no_data', __( 'No data supplied' ), array( 'status' => 400 ) );
</span></span></pre>
</div>
</div>

</body>
</html>