introduction.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Introduction</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>Introduction </h1>
  111. </div>
  112. <article>
  113. <div class="col-sm-10">
  114. <div class="article_body">
  115. <p>PHP PhantomJS is a flexible PHP library to load pages through the PhantomJS headless browser and return the page response. It is handy for testing websites that demand javascript support and also supports screen captures.</p>
  116. <h2 id="feature-list">Feature List</h2>
  117. <ul>
  118. <li>Load webpages through the PhantomJS headless browser</li>
  119. <li>View detailed response data including page content, headers, status<br />
  120. code etc.</li>
  121. <li>Handle redirects</li>
  122. <li>View javascript console errors</li>
  123. <li>View detailed PhantomJS debuged information</li>
  124. <li>Save screen captures to local disk</li>
  125. <li>Define screen capture x, y, width and height parameters</li>
  126. <li>Delay page rendering for a specified time</li>
  127. <li>Execute PhantomJS with command line options</li>
  128. <li>Easily build and run custom PhantomJS scripts</li>
  129. </ul>
  130. <h2 id="prerequisites">Prerequisites</h2>
  131. <p>PHP PhantomJS requires PHP <strong>5.3.0</strong> or greater to run.</p>
  132. <h2 id="installation">Installation</h2>
  133. <p>It is recommended that you use Composer to install PHP PhantomJS. First, add the following to your project’s <code>composer.json</code> file:</p>
  134. <div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="s">&quot;scripts&quot;</span><span class="p-Indicator">:</span> <span class="p-Indicator">{</span>
  135. <span class="s">&quot;post-install-cmd&quot;</span><span class="p-Indicator">:</span> <span class="p-Indicator">[</span>
  136. <span class="s">&quot;PhantomInstaller\\Installer::installPhantomJS&quot;</span>
  137. <span class="p-Indicator">],</span>
  138. <span class="s">&quot;post-update-cmd&quot;</span><span class="p-Indicator">:</span> <span class="p-Indicator">[</span>
  139. <span class="s">&quot;PhantomInstaller\\Installer::installPhantomJS&quot;</span>
  140. <span class="p-Indicator">]</span>
  141. <span class="p-Indicator">}</span></code></pre></div>
  142. <p>This will ensure the latest version of PhantomJS is installed for your system, in your bin folder. If you haven’t defined your bin folder in your composer.json, add the path:</p>
  143. <div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="s">&quot;config&quot;</span><span class="p-Indicator">:</span> <span class="p-Indicator">{</span>
  144. <span class="s">&quot;bin-dir&quot;</span><span class="p-Indicator">:</span> <span class="s">&quot;bin&quot;</span>
  145. <span class="p-Indicator">}</span></code></pre></div>
  146. <p>Finally, install PHP PhantomJS from the root of your project:</p>
  147. <div class="highlight"><pre><code class="language-bash" data-lang="bash">composer require <span class="s2">&quot;jonnyw/php-phantomjs:3.*&quot;</span></code></pre></div>
  148. <p>If you would like to use another installation method or would like to see more detailed installation instructions, see the <a href="/installation.html">installation</a> documentation.</p>
  149. <h2 id="basic-usage">Basic Usage</h2>
  150. <p>The following illustrates how to make a basic GET request and output the page content:</p>
  151. <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
  152. <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
  153. <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>
  154. <span class="sd">/** </span>
  155. <span class="sd"> * @see JonnyW\PhantomJs\Message\Request </span>
  156. <span class="sd"> **/</span>
  157. <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>
  158. <span class="sd">/** </span>
  159. <span class="sd"> * @see JonnyW\PhantomJs\Message\Response </span>
  160. <span class="sd"> **/</span>
  161. <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>
  162. <span class="c1">// Send the request</span>
  163. <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>
  164. <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>
  165. <span class="c1">// Dump the requested page content</span>
  166. <span class="k">echo</span> <span class="nv">$response</span><span class="o">-&gt;</span><span class="na">getContent</span><span class="p">();</span>
  167. <span class="p">}</span></code></pre></div>
  168. <p>And if you would like to save a screen capture to local disk:</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="sd">/** </span>
  173. <span class="sd"> * @see JonnyW\PhantomJs\Message\CaptureRequest</span>
  174. <span class="sd"> **/</span>
  175. <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> <span class="s1">&#39;GET&#39;</span><span class="p">);</span>
  176. <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setCaptureFile</span><span class="p">(</span><span class="s1">&#39;/path/to/save/capture/file.jpg&#39;</span><span class="p">);</span>
  177. <span class="sd">/** </span>
  178. <span class="sd"> * @see JonnyW\PhantomJs\Message\Response </span>
  179. <span class="sd"> **/</span>
  180. <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>
  181. <span class="c1">// Send the request</span>
  182. <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>
  183. <p>For more detailed examples see the <a href="/usage.html">usage</a> section, or to create your own custom scripts check out the <a href="/advanced.html">advanced</a> documentation.</p>
  184. </div>
  185. </div>
  186. <div class="clearfix"></div>
  187. <ul class="pager">
  188. <li class="previous"><a href="/installation.html" title="Installation">&larr; Installation</a></li>
  189. </ul>
  190. <hr>
  191. </div>
  192. <div class="col-sm-2 sidebar-2">
  193. </div>
  194. </article>
  195. <div class="clearfix"></div>
  196. <footer>
  197. <hr/>
  198. <p>
  199. &copy; 2014 PHP PhantomJs. Theme: Modified <a href="https://github.com/dbtek/dbyll">dbyll</a> by dbtek.
  200. </p>
  201. </footer>
  202. </div>
  203. <script type="text/javascript" src="/assets/resources/jquery/jquery.min.js"></script>
  204. <script type="text/javascript" src="/assets/resources/bootstrap/js/bootstrap.min.js"></script>
  205. <script type="text/javascript" src="/assets/js/app.js"></script>
  206. </body>
  207. </html>