usage.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479
  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. <a type="button" class="navbar-toggle nav-link" href="mailto:contact@jonnyw.me">
  39. <i class="fa fa-envelope"></i>
  40. </a>
  41. -->
  42. <a class="navbar-brand" href="/">
  43. <img src="/assets/media/phantomjs-small.png" class="img-circle" />
  44. PHP PhantomJs
  45. </a>
  46. </div>
  47. <!-- Collect the nav links, forms, and other content for toggling -->
  48. <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
  49. <ul class="nav navbar-nav">
  50. <li class="active"><a href="/">Home</a></li>
  51. <li><a href="/installation.html">Installation</a></li>
  52. <li><a href="/usage.html">Usage</a></li>
  53. <li><a href="/advanced.html">Advanced</a></li>
  54. <li><a href="/debugging.html">Debugging</a></li>
  55. <li><a href="/troubleshooting.html">Troubleshooting</a></li>
  56. </ul>
  57. </div><!-- /.navbar-collapse -->
  58. </nav>
  59. <!-- nav-menu-dropdown -->
  60. <div class="btn-group hidden-xs" id="nav-menu">
  61. <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
  62. <i class="fa fa-bars"></i>
  63. </button>
  64. <ul class="dropdown-menu" role="menu">
  65. <li><a href="/"><i class="fa fa-home"></i>Home</a></li>
  66. <li><a href="/installation.html"><i class="fa fa-folder"></i>Installation</a></li>
  67. <li><a href="/usage.html"><i class="fa fa-folder"></i>Usage</a></li>
  68. <li><a href="/advanced.html"><i class="fa fa-folder"></i>Advanced</a></li>
  69. <li><a href="/debugging.html"><i class="fa fa-folder"></i>Debugging</a></li>
  70. <li><a href="/troubleshooting.html"><i class="fa fa-folder"></i>Troubleshooting</a></li>
  71. <li class="divider"></li>
  72. <li><a href="#"><i class="fa fa-arrow-up"></i>Top of Page</a></li>
  73. </ul>
  74. </div>
  75. <div class="col-sm-3 sidebar hidden-xs">
  76. <! -- sidebar.html -->
  77. <header class="sidebar-header" role="banner">
  78. <a href="/">
  79. <img src="/assets/media/phantomjs.png" class="img-circle" />
  80. </a>
  81. <h3 class="title">
  82. <a href="/">PHP PhantomJs</a>
  83. </h3>
  84. </header>
  85. <div id="bio" class="text-center">
  86. Run PhantomJS scripts through PHP
  87. </div>
  88. <div id="contact-list" class="text-center">
  89. <!--
  90. <ul class="list-unstyled list-inline">
  91. <li>
  92. <a class="btn btn-default btn-sm" href="mailto:contact@jonnyw.me">
  93. <i class="fa fa-envelope fa-lg"></i>
  94. </a>
  95. </li>
  96. </ul>
  97. <ul id="contact-list-secondary" class="list-unstyled list-inline">
  98. <li>
  99. <a class="btn btn-default btn-sm" href="/feed.xml">
  100. <i class="fa fa-rss fa-lg"></i>
  101. </a>
  102. </li>
  103. </ul>
  104. -->
  105. </div>
  106. <! -- sidebar.html end -->
  107. </div>
  108. <div class="col-sm-9 col-sm-offset-3">
  109. <div class="page-header">
  110. <h1>Usage </h1>
  111. </div>
  112. <article>
  113. <div class="col-sm-10">
  114. <div class="article_body">
  115. <p>This page contains some common examples of how to use the PHP PhantomJS library.</p>
  116. <ul>
  117. <li><a href="#basic-request">Basic Request</a></li>
  118. <li><a href="#post-request">POST Request</a></li>
  119. <li><a href="#other-request-methods">Other Request Methods</a></li>
  120. <li><a href="#response-data">Response Data</a></li>
  121. <li><a href="#screen-captures">Screen Captures</a></li>
  122. <li><a href="#custom-timeout">Custom Timeout</a></li>
  123. <li><a href="#delay-page-render">Delay Page Render</a></li>
  124. <li><a href="#custom-run-options">Custom Run Options</a></li>
  125. </ul>
  126. <p>For more advanced customization or to load your own PhantomJS scripts, see the <a href="/advanced.html">advanced</a> documentation.</p>
  127. <h2 id="basic-request">Basic Request</h2>
  128. <p>A basic GET request:</p>
  129. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  130. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  131. <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>
  132. <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>
  133. <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>
  134. <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>
  135. <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>
  136. <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>
  137. <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>
  138. <span class="k">echo</span> <span class="nv">$response</span><span class="o">-&gt;</span><span class="na">getContent</span><span class="p">();</span>
  139. <span class="p">}</span></code></pre></div>
  140. <p>You can also set the URL, request method and timeout period when creating a new request instance through the message factory:</p>
  141. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  142. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  143. <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>
  144. <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>
  145. <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>
  146. <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>
  147. <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>
  148. <span class="k">echo</span> <span class="nv">$response</span><span class="o">-&gt;</span><span class="na">getContent</span><span class="p">();</span>
  149. <span class="p">}</span></code></pre></div>
  150. <h2 id="post-request">POST Request</h2>
  151. <p>A basic POST request:</p>
  152. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  153. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  154. <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>
  155. <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>
  156. <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>
  157. <span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
  158. <span class="s1">&#39;param1&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;Param 1&#39;</span><span class="p">,</span>
  159. <span class="s1">&#39;param2&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;Param 2&#39;</span>
  160. <span class="p">);</span>
  161. <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>
  162. <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>
  163. <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>
  164. <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>
  165. <h2 id="other-request-methods">Other Request Methods</h2>
  166. <p>The PHP PhantomJS library supports the following request methods:</p>
  167. <ul>
  168. <li>OPTIONS</li>
  169. <li>GET</li>
  170. <li>HEAD</li>
  171. <li>POST</li>
  172. <li>PUT</li>
  173. <li>DELETE</li>
  174. <li>PATCH</li>
  175. </ul>
  176. <p>The request method can be set when creating a new request instance through the message factory:</p>
  177. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  178. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  179. <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>
  180. <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>
  181. <p>Or on the request instance itself:</p>
  182. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  183. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  184. <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>
  185. <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>
  186. <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>
  187. <h2 id="response-data">Response Data</h2>
  188. <p>A standard response gives you access to the following interface:</p>
  189. <table>
  190. <thead>
  191. <tr>
  192. <th style="text-align: center">Accessor</th>
  193. <th>Description</th>
  194. <th style="text-align: center">Return Type</th>
  195. </tr>
  196. </thead>
  197. <tbody>
  198. <tr>
  199. <td style="text-align: center">getHeaders()</td>
  200. <td>Returns an array of all response headers.</td>
  201. <td style="text-align: center">Array</td>
  202. </tr>
  203. <tr>
  204. <td style="text-align: center">getHeader(<em>header</em>)</td>
  205. <td>Returns the value for a specific response header e.g. Content-Type.</td>
  206. <td style="text-align: center">Mixed</td>
  207. </tr>
  208. <tr>
  209. <td style="text-align: center">getStatus()</td>
  210. <td>The response status code e.g. 200.</td>
  211. <td style="text-align: center">Int</td>
  212. </tr>
  213. <tr>
  214. <td style="text-align: center">getContent()</td>
  215. <td>The raw page content of the requested page.</td>
  216. <td style="text-align: center">String</td>
  217. </tr>
  218. <tr>
  219. <td style="text-align: center">getContentType()</td>
  220. <td>The content type of the requested page.</td>
  221. <td style="text-align: center">String</td>
  222. </tr>
  223. <tr>
  224. <td style="text-align: center">getUrl()</td>
  225. <td>The URL of the requested page.</td>
  226. <td style="text-align: center">String</td>
  227. </tr>
  228. <tr>
  229. <td style="text-align: center">getRedirectUrl()</td>
  230. <td>If the response was a redirect, this will return the redirect URL.</td>
  231. <td style="text-align: center">String</td>
  232. </tr>
  233. <tr>
  234. <td style="text-align: center">isRedirect()</td>
  235. <td>Will return true if the response was a redirect or false otherwise.</td>
  236. <td style="text-align: center">Boolean</td>
  237. </tr>
  238. <tr>
  239. <td style="text-align: center">getConsole()</td>
  240. <td>Returns an array of any javascript errors on the requested page along with a stack trace.</td>
  241. <td style="text-align: center">Array</td>
  242. </tr>
  243. </tbody>
  244. </table>
  245. <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>
  246. <h2 id="screen-captures">Screen Captures</h2>
  247. <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>
  248. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  249. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  250. <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>
  251. <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>
  252. <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>
  253. <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>
  254. <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>
  255. <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>
  256. <p>You will need to make sure the directory that you are saving the file to exists and is writable by your application.</p>
  257. <p>You can also set the width, height, x and y axis for your screen capture:</p>
  258. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  259. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  260. <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>
  261. <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>
  262. <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>
  263. <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>
  264. <span class="nv">$top</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
  265. <span class="nv">$left</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
  266. <span class="nv">$width</span> <span class="o">=</span> <span class="mi">200</span><span class="p">;</span>
  267. <span class="nv">$height</span> <span class="o">=</span> <span class="mi">400</span><span class="p">;</span>
  268. <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>
  269. <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>
  270. <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>
  271. <h2 id="custom-timeout">Custom Timeout</h2>
  272. <p>By default, each request will timeout after 5 seconds. You can set a custom timeout period (in milliseconds) for each request:</p>
  273. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  274. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  275. <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>
  276. <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>
  277. <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>
  278. <span class="nv">$timeout</span> <span class="o">=</span> <span class="mi">10000</span><span class="p">;</span> <span class="c1">// 10 seconds</span>
  279. <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>
  280. <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>
  281. <h2 id="delay-page-render">Delay Page Render</h2>
  282. <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>
  283. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  284. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  285. <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>
  286. <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>
  287. <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>
  288. <span class="nv">$delay</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> <span class="c1">// 5 seconds</span>
  289. <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>
  290. <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>
  291. <p>You can set a page render delay for standard requests also.</p>
  292. <h2 id="custom-run-options">Custom Run Options</h2>
  293. <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>
  294. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  295. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  296. <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>
  297. <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>
  298. <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>
  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>You can also set a path to a JSON configuration file that contains multiple PhantomJS options:</p>
  303. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  304. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  305. <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>
  306. <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>
  307. <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>
  308. <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>
  309. <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>
  310. <p>See the <a href="http://phantomjs.org/api/command-line.html">PhantomJS Documentation</a> for a full list of command line options.</p>
  311. </div>
  312. </div>
  313. <div class="clearfix"></div>
  314. <ul class="pager">
  315. <li class="previous"><a href="/advanced.html" title="Advanced Usage">&larr; Advanced Usage</a></li>
  316. <li class="next"><a href="/installation.html" title="Installation">Installation &rarr;</a></li>
  317. </ul>
  318. <hr>
  319. </div>
  320. <div class="col-sm-2 sidebar-2">
  321. </div>
  322. </article>
  323. <div class="clearfix"></div>
  324. <footer>
  325. <hr/>
  326. <p>
  327. &copy; 2014 PHP PhantomJs. Theme: Modified <a href="https://github.com/dbtek/dbyll">dbyll</a> by dbtek.
  328. </p>
  329. </footer>
  330. </div>
  331. <script type="text/javascript" src="/assets/resources/jquery/jquery.min.js"></script>
  332. <script type="text/javascript" src="/assets/resources/bootstrap/js/bootstrap.min.js"></script>
  333. <script type="text/javascript" src="/assets/js/app.js"></script>
  334. </body>
  335. </html>