usage.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Usage</title>
  6. <meta name="author" content="Jonny W">
  7. <!-- Enable responsive viewport -->
  8. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  9. <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
  10. <!--[if lt IE 9]>
  11. <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
  12. <![endif]-->
  13. <!-- Le styles -->
  14. <link href="/assets/resources/bootstrap/css/bootstrap.min.css" rel="stylesheet">
  15. <link href="/assets/resources/font-awesome/css/font-awesome.min.css" rel="stylesheet">
  16. <link href="/assets/resources/syntax/syntax.css" rel="stylesheet">
  17. <link href="/assets/css/style.css" rel="stylesheet">
  18. <!-- Le fav and touch icons -->
  19. <!-- Update these with your own images
  20. <link rel="shortcut icon" href="images/favicon.ico">
  21. <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
  22. <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
  23. <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
  24. -->
  25. <link rel="alternate" type="application/rss+xml" title="" href="/feed.xml">
  26. </head>
  27. <body>
  28. <nav class="navbar navbar-default visible-xs" role="navigation">
  29. <!-- Brand and toggle get grouped for better mobile display -->
  30. <div class="navbar-header">
  31. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
  32. <span class="sr-only">Toggle navigation</span>
  33. <span class="icon-bar"></span>
  34. <span class="icon-bar"></span>
  35. <span class="icon-bar"></span>
  36. </button>
  37. <!--
  38. -->
  39. <a class="navbar-brand" href="/">
  40. <img src="/assets/media/phantomjs-small.png" class="img-circle" />
  41. PHP PhantomJs
  42. </a>
  43. </div>
  44. <!-- Collect the nav links, forms, and other content for toggling -->
  45. <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
  46. <ul class="nav navbar-nav">
  47. <li class="active"><a href="/">Home</a></li>
  48. <li><a href="/installation.html">Installation</a></li>
  49. <li><a href="/usage.html">Usage</a></li>
  50. <li><a href="/advanced.html">Advanced</a></li>
  51. <li><a href="/debugging.html">Debugging</a></li>
  52. <li><a href="/troubleshooting.html">Troubleshooting</a></li>
  53. </ul>
  54. </div><!-- /.navbar-collapse -->
  55. </nav>
  56. <!-- nav-menu-dropdown -->
  57. <div class="btn-group hidden-xs" id="nav-menu">
  58. <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
  59. <i class="fa fa-bars"></i>
  60. </button>
  61. <ul class="dropdown-menu" role="menu">
  62. <li><a href="/"><i class="fa fa-home"></i>Home</a></li>
  63. <li><a href="/installation.html"><i class="fa fa-folder"></i>Installation</a></li>
  64. <li><a href="/usage.html"><i class="fa fa-folder"></i>Usage</a></li>
  65. <li><a href="/advanced.html"><i class="fa fa-folder"></i>Advanced</a></li>
  66. <li><a href="/debugging.html"><i class="fa fa-folder"></i>Debugging</a></li>
  67. <li><a href="/troubleshooting.html"><i class="fa fa-folder"></i>Troubleshooting</a></li>
  68. <li class="divider"></li>
  69. <li><a href="#"><i class="fa fa-arrow-up"></i>Top of Page</a></li>
  70. </ul>
  71. </div>
  72. <div class="col-sm-3 sidebar hidden-xs">
  73. <! -- sidebar.html -->
  74. <header class="sidebar-header" role="banner">
  75. <a href="/">
  76. <img src="/assets/media/phantomjs.png" class="img-circle" />
  77. </a>
  78. <h3 class="title">
  79. <a href="/">PHP PhantomJs</a>
  80. </h3>
  81. </header>
  82. <div id="bio" class="text-center">
  83. Run PhantomJS scripts through PHP
  84. </div>
  85. <div id="contact-list" class="text-center">
  86. <!--
  87. <ul class="list-unstyled list-inline">
  88. </ul>
  89. <ul id="contact-list-secondary" class="list-unstyled list-inline">
  90. <li>
  91. <a class="btn btn-default btn-sm" href="/feed.xml">
  92. <i class="fa fa-rss fa-lg"></i>
  93. </a>
  94. </li>
  95. </ul>
  96. -->
  97. </div>
  98. <! -- sidebar.html end -->
  99. </div>
  100. <div class="col-sm-9 col-sm-offset-3">
  101. <div class="page-header">
  102. <h1>Usage </h1>
  103. </div>
  104. <article>
  105. <div class="col-sm-10">
  106. <div class="article_body">
  107. <p>This page contains some common examples of how to use the PHP PhantomJS library.</p>
  108. <ul>
  109. <li><a href="#basic-request">Basic Request</a></li>
  110. <li><a href="#post-request">POST Request</a></li>
  111. <li><a href="#other-request-methods">Other Request Methods</a></li>
  112. <li><a href="#response-data">Response Data</a></li>
  113. <li><a href="#screen-captures">Screen Captures</a></li>
  114. <li><a href="#custom-timeout">Custom Timeout</a></li>
  115. <li><a href="#delay-page-render">Delay Page Render</a></li>
  116. <li><a href="#custom-run-options">Custom Run Options</a></li>
  117. </ul>
  118. <p>For more advanced customization or to load your own PhantomJS scripts, see the <a href="/advanced.html">advanced</a> documentation.</p>
  119. <h2 id="basic-request">Basic Request</h2>
  120. <p>A basic GET request:</p>
  121. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  122. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  123. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  124. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createRequest</span><span class="p">();</span>
  125. <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createResponse</span><span class="p">();</span>
  126. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setMethod</span><span class="p">(</span><span class="s1">&#39;GET&#39;</span><span class="p">);</span>
  127. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setUrl</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">);</span>
  128. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">send</span><span class="p">(</span><span class="nv">$request</span><span class="p">,</span> <span class="nv">$response</span><span class="p">);</span>
  129. <span class="k">if</span><span class="p">(</span><span class="nv">$response</span><span class="o">-&gt;</span><span class="na">getStatus</span><span class="p">()</span> <span class="o">===</span> <span class="mi">200</span><span class="p">)</span> <span class="p">{</span>
  130. <span class="k">echo</span> <span class="nv">$response</span><span class="o">-&gt;</span><span class="na">getContent</span><span class="p">();</span>
  131. <span class="p">}</span></code></pre></div>
  132. <p>You can also set the URL, request method and timeout period when creating a new request instance through the message factory:</p>
  133. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  134. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  135. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  136. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createRequest</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">,</span> <span class="s1">&#39;GET&#39;</span><span class="p">,</span> <span class="mi">5000</span><span class="p">);</span>
  137. <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createResponse</span><span class="p">();</span>
  138. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">send</span><span class="p">(</span><span class="nv">$request</span><span class="p">,</span> <span class="nv">$response</span><span class="p">);</span>
  139. <span class="k">if</span><span class="p">(</span><span class="nv">$response</span><span class="o">-&gt;</span><span class="na">getStatus</span><span class="p">()</span> <span class="o">===</span> <span class="mi">200</span><span class="p">)</span> <span class="p">{</span>
  140. <span class="k">echo</span> <span class="nv">$response</span><span class="o">-&gt;</span><span class="na">getContent</span><span class="p">();</span>
  141. <span class="p">}</span></code></pre></div>
  142. <h2 id="post-request">POST Request</h2>
  143. <p>A basic POST request:</p>
  144. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  145. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  146. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  147. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createRequest</span><span class="p">();</span>
  148. <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createResponse</span><span class="p">();</span>
  149. <span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
  150. <span class="s1">&#39;param1&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;Param 1&#39;</span><span class="p">,</span>
  151. <span class="s1">&#39;param2&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;Param 2&#39;</span>
  152. <span class="p">);</span>
  153. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setMethod</span><span class="p">(</span><span class="s1">&#39;POST&#39;</span><span class="p">);</span>
  154. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setUrl</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">);</span>
  155. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setRequestData</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span> <span class="c1">// Set post data</span>
  156. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">send</span><span class="p">(</span><span class="nv">$request</span><span class="p">,</span> <span class="nv">$response</span><span class="p">);</span></code></pre></div>
  157. <h2 id="other-request-methods">Other Request Methods</h2>
  158. <p>The PHP PhantomJS library supports the following request methods:</p>
  159. <ul>
  160. <li>OPTIONS</li>
  161. <li>GET</li>
  162. <li>HEAD</li>
  163. <li>POST</li>
  164. <li>PUT</li>
  165. <li>DELETE</li>
  166. <li>PATCH</li>
  167. </ul>
  168. <p>The request method can be set when creating a new request instance through the message factory:</p>
  169. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  170. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  171. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  172. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createRequest</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">,</span> <span class="s1">&#39;PUT&#39;</span><span class="p">);</span></code></pre></div>
  173. <p>Or on the request instance itself:</p>
  174. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  175. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  176. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  177. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createRequest</span><span class="p">();</span>
  178. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setMethod</span><span class="p">(</span><span class="s1">&#39;PATCH&#39;</span><span class="p">);</span></code></pre></div>
  179. <h2 id="response-data">Response Data</h2>
  180. <p>A standard response gives you access to the following interface:</p>
  181. <table>
  182. <thead>
  183. <tr>
  184. <th style="text-align: center">Accessor</th>
  185. <th>Description</th>
  186. <th style="text-align: center">Return Type</th>
  187. </tr>
  188. </thead>
  189. <tbody>
  190. <tr>
  191. <td style="text-align: center">getHeaders()</td>
  192. <td>Returns an array of all response headers.</td>
  193. <td style="text-align: center">Array</td>
  194. </tr>
  195. <tr>
  196. <td style="text-align: center">getHeader(<em>header</em>)</td>
  197. <td>Returns the value for a specific response header e.g. Content-Type.</td>
  198. <td style="text-align: center">Mixed</td>
  199. </tr>
  200. <tr>
  201. <td style="text-align: center">getStatus()</td>
  202. <td>The response status code e.g. 200.</td>
  203. <td style="text-align: center">Int</td>
  204. </tr>
  205. <tr>
  206. <td style="text-align: center">getContent()</td>
  207. <td>The raw page content of the requested page.</td>
  208. <td style="text-align: center">String</td>
  209. </tr>
  210. <tr>
  211. <td style="text-align: center">getContentType()</td>
  212. <td>The content type of the requested page.</td>
  213. <td style="text-align: center">String</td>
  214. </tr>
  215. <tr>
  216. <td style="text-align: center">getUrl()</td>
  217. <td>The URL of the requested page.</td>
  218. <td style="text-align: center">String</td>
  219. </tr>
  220. <tr>
  221. <td style="text-align: center">getRedirectUrl()</td>
  222. <td>If the response was a redirect, this will return the redirect URL.</td>
  223. <td style="text-align: center">String</td>
  224. </tr>
  225. <tr>
  226. <td style="text-align: center">isRedirect()</td>
  227. <td>Will return true if the response was a redirect or false otherwise.</td>
  228. <td style="text-align: center">Boolean</td>
  229. </tr>
  230. <tr>
  231. <td style="text-align: center">getConsole()</td>
  232. <td>Returns an array of any javascript errors on the requested page along with a stack trace.</td>
  233. <td style="text-align: center">Array</td>
  234. </tr>
  235. </tbody>
  236. </table>
  237. <p>If the response contains a status code of 0, chances are the request failed. Check the request <a href="https://github.com/jonnnnyw/php-phantomjs/blob/master/doc/debugging.rst">debug log</a> for more detailed information about what may have gone wrong.</p>
  238. <h2 id="screen-captures">Screen Captures</h2>
  239. <p>You can save screen captures of a page to your local disk by creating a screen capture request and setting the path you wish to save the file to:</p>
  240. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  241. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  242. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  243. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createCaptureRequest</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">);</span>
  244. <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createResponse</span><span class="p">();</span>
  245. <span class="nv">$file</span> <span class="o">=</span> <span class="s1">&#39;/path/to/save/your/screen/capture/file.jpg&#39;</span><span class="p">;</span>
  246. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setCaptureFile</span><span class="p">(</span><span class="nv">$file</span><span class="p">);</span>
  247. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">send</span><span class="p">(</span><span class="nv">$request</span><span class="p">,</span> <span class="nv">$response</span><span class="p">);</span></code></pre></div>
  248. <p>You will need to make sure the directory that you are saving the file to exists and is writable by your application.</p>
  249. <p>You can also set the width, height, x and y axis for your screen capture:</p>
  250. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  251. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  252. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  253. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createCaptureRequest</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">);</span>
  254. <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createResponse</span><span class="p">();</span>
  255. <span class="nv">$file</span> <span class="o">=</span> <span class="s1">&#39;/path/to/save/your/screen/capture/file.jpg&#39;</span><span class="p">;</span>
  256. <span class="nv">$top</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
  257. <span class="nv">$left</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
  258. <span class="nv">$width</span> <span class="o">=</span> <span class="mi">200</span><span class="p">;</span>
  259. <span class="nv">$height</span> <span class="o">=</span> <span class="mi">400</span><span class="p">;</span>
  260. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setCaptureFile</span><span class="p">(</span><span class="nv">$file</span><span class="p">);</span>
  261. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setCaptureDimensions</span><span class="p">(</span><span class="nv">$width</span><span class="p">,</span> <span class="nv">$height</span><span class="p">,</span> <span class="nv">$top</span><span class="p">,</span> <span class="nv">$left</span><span class="p">);</span>
  262. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">send</span><span class="p">(</span><span class="nv">$request</span><span class="p">,</span> <span class="nv">$response</span><span class="p">);</span></code></pre></div>
  263. <h2 id="custom-timeout">Custom Timeout</h2>
  264. <p>By default, each request will timeout after 5 seconds. You can set a custom timeout period (in milliseconds) for each request:</p>
  265. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  266. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  267. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  268. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createRequest</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">);</span>
  269. <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createResponse</span><span class="p">();</span>
  270. <span class="nv">$timeout</span> <span class="o">=</span> <span class="mi">10000</span><span class="p">;</span> <span class="c1">// 10 seconds</span>
  271. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setTimeout</span><span class="p">(</span><span class="nv">$timeout</span><span class="p">);</span>
  272. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">send</span><span class="p">(</span><span class="nv">$request</span><span class="p">,</span> <span class="nv">$response</span><span class="p">);</span></code></pre></div>
  273. <h2 id="delay-page-render">Delay Page Render</h2>
  274. <p>Sometimes when taking screen captures you may want to wait until the page is completely loaded before saving the capture. In this instance you can set a page render delay (in seconds) for the request:</p>
  275. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  276. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  277. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  278. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createCaptureRequest</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">);</span>
  279. <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createResponse</span><span class="p">();</span>
  280. <span class="nv">$delay</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> <span class="c1">// 5 seconds</span>
  281. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setDelay</span><span class="p">(</span><span class="nv">$delay</span><span class="p">);</span>
  282. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">send</span><span class="p">(</span><span class="nv">$request</span><span class="p">,</span> <span class="nv">$response</span><span class="p">);</span></code></pre></div>
  283. <p>You can set a page render delay for standard requests also.</p>
  284. <h2 id="custom-run-options">Custom Run Options</h2>
  285. <p>The PhantomJS API contains a range of command line options that can be passed when executing the PhantomJS executable. These can also be passed in via the client before a request:</p>
  286. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  287. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  288. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  289. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">addOption</span><span class="p">(</span><span class="s1">&#39;--load-images=true&#39;</span><span class="p">);</span>
  290. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">addOption</span><span class="p">(</span><span class="s1">&#39;--ignore-ssl-errors=true&#39;</span><span class="p">);</span>
  291. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createRequest</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">);</span>
  292. <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createResponse</span><span class="p">();</span>
  293. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">send</span><span class="p">(</span><span class="nv">$request</span><span class="p">,</span> <span class="nv">$response</span><span class="p">);</span></code></pre></div>
  294. <p>You can also set a path to a JSON configuration file that contains multiple PhantomJS options:</p>
  295. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  296. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  297. <span class="nv">$client</span> <span class="o">=</span> <span class="nx">Client</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
  298. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">addOption</span><span class="p">(</span><span class="s1">&#39;--config=/path/to/config.json&#39;</span><span class="p">);</span>
  299. <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createRequest</span><span class="p">(</span><span class="s1">&#39;http://google.com&#39;</span><span class="p">);</span>
  300. <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">createResponse</span><span class="p">();</span>
  301. <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">send</span><span class="p">(</span><span class="nv">$request</span><span class="p">,</span> <span class="nv">$response</span><span class="p">);</span></code></pre></div>
  302. <p>See the <a href="http://phantomjs.org/api/command-line.html">PhantomJS Documentation</a> for a full list of command line options.</p>
  303. </div>
  304. </div>
  305. <div class="clearfix"></div>
  306. <ul class="pager">
  307. <li class="previous"><a href="/advanced.html" title="Advanced Usage">&larr; Advanced Usage</a></li>
  308. <li class="next"><a href="/installation.html" title="Installation">Installation &rarr;</a></li>
  309. </ul>
  310. <hr>
  311. </div>
  312. <div class="col-sm-2 sidebar-2">
  313. </div>
  314. </article>
  315. <div class="clearfix"></div>
  316. <footer>
  317. <hr/>
  318. <p>
  319. &copy; 2014 PHP PhantomJs. Theme: Modified <a href="https://github.com/dbtek/dbyll">dbyll</a> by dbtek.
  320. </p>
  321. </footer>
  322. </div>
  323. <script type="text/javascript" src="/assets/resources/jquery/jquery.min.js"></script>
  324. <script type="text/javascript" src="/assets/resources/bootstrap/js/bootstrap.min.js"></script>
  325. <script type="text/javascript" src="/assets/js/app.js"></script>
  326. </body>
  327. </html>