| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479 |
- <!DOCTYPE html>
- <html>
- <head>
- <meta charset="utf-8">
- <title>Usage</title>
-
- <meta name="author" content="Jonny W">
- <!-- Enable responsive viewport -->
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
- <!--[if lt IE 9]>
- <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <!-- Le styles -->
- <link href="http://jonnnnyw.github.io/php-phantomjs/assets/resources/bootstrap/css/bootstrap.min.css" rel="stylesheet">
- <link href="http://jonnnnyw.github.io/php-phantomjs/assets/resources/font-awesome/css/font-awesome.min.css" rel="stylesheet">
- <link href="http://jonnnnyw.github.io/php-phantomjs/assets/resources/syntax/syntax.css" rel="stylesheet">
- <link href="http://jonnnnyw.github.io/php-phantomjs/assets/css/style.css" rel="stylesheet">
- <!-- Le fav and touch icons -->
- <!-- Update these with your own images
- <link rel="shortcut icon" href="images/favicon.ico">
- <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
- <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
- <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
- -->
- <link rel="alternate" type="application/rss+xml" title="" href="http://jonnnnyw.github.io/php-phantomjs/feed.xml">
- <script>
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
- ga('create', 'UA-53289013-1', 'auto');
- ga('send', 'pageview');
- </script>
- </head>
- <body>
- <nav class="navbar navbar-default visible-xs" role="navigation">
- <!-- Brand and toggle get grouped for better mobile display -->
- <div class="navbar-header">
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
-
- <iframe src="http://ghbtns.com/github-btn.html?user=jonnnnyw&repo=php-phantomjs&type=fork&count=true"
- allowtransparency="true" frameborder="0" scrolling="0" width="85" height="20" class="nav-link last"></iframe>
-
-
-
- <iframe src="http://ghbtns.com/github-btn.html?user=jonnnnyw&repo=php-phantomjs&type=watch&count=true"
- allowtransparency="true" frameborder="0" scrolling="0" width="85" height="20" class="nav-link"></iframe>
-
-
- <a class="navbar-brand" href="http://jonnnnyw.github.io/php-phantomjs/">
- <img src="http://jonnnnyw.github.io/php-phantomjs/assets/media/phantomjs-small.png" class="img-circle" />
- PHP PhantomJs
- </a>
- </div>
- <!-- Collect the nav links, forms, and other content for toggling -->
- <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
- <ul class="nav navbar-nav">
- <li class="active"><a href="http://jonnnnyw.github.io/php-phantomjs/">Home</a></li>
- <li><a href="http://jonnnnyw.github.io/php-phantomjs/installation.html">Installation</a></li>
- <li><a href="http://jonnnnyw.github.io/php-phantomjs/usage.html">Usage</a></li>
- <li><a href="http://jonnnnyw.github.io/php-phantomjs/advanced.html">Advanced</a></li>
- <li><a href="http://jonnnnyw.github.io/php-phantomjs/troubleshooting.html">Troubleshooting</a></li>
- </ul>
- </div><!-- /.navbar-collapse -->
- </nav>
- <!-- nav-menu-dropdown -->
- <div class="btn-group hidden-xs" id="nav-menu">
- <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
- <i class="fa fa-bars"></i>
- </button>
- <ul class="dropdown-menu" role="menu">
- <li><a href="http://jonnnnyw.github.io/php-phantomjs/"><i class="fa fa-home"></i>Home</a></li>
- <li><a href="http://jonnnnyw.github.io/php-phantomjs/installation.html"><i class="fa fa-folder"></i>Installation</a></li>
- <li><a href="http://jonnnnyw.github.io/php-phantomjs/usage.html"><i class="fa fa-folder"></i>Usage</a></li>
- <li><a href="http://jonnnnyw.github.io/php-phantomjs/advanced.html"><i class="fa fa-folder"></i>Advanced</a></li>
- <li><a href="http://jonnnnyw.github.io/php-phantomjs/troubleshooting.html"><i class="fa fa-folder"></i>Troubleshooting</a></li>
- <li class="divider"></li>
- <li><a href="#"><i class="fa fa-arrow-up"></i>Top of Page</a></li>
- </ul>
- </div>
- <div class="col-sm-3 sidebar hidden-xs">
- <! -- sidebar.html -->
- <header class="sidebar-header" role="banner">
- <a href="http://jonnnnyw.github.io/php-phantomjs/">
- <img src="http://jonnnnyw.github.io/php-phantomjs/assets/media/phantomjs.png" class="img-circle" />
- </a>
- <h3 class="title">
- <a href="http://jonnnnyw.github.io/php-phantomjs/">PHP PhantomJs</a>
- </h3>
- </header>
- <div id="bio" class="text-center">
- Run PhantomJS scripts through PHP
- </div>
- <div id="contact-list" class="text-center">
- <ul class="list-unstyled list-inline">
-
- <li>
- <iframe src="http://ghbtns.com/github-btn.html?user=jonnnnyw&repo=php-phantomjs&type=watch&count=true"
- allowtransparency="true" frameborder="0" scrolling="0" width="83" height="20"></iframe>
- </li>
-
-
- <li>
- <iframe src="http://ghbtns.com/github-btn.html?user=jonnnnyw&repo=php-phantomjs&type=fork&count=true"
- allowtransparency="true" frameborder="0" scrolling="0" width="83" height="20"></iframe>
- </li>
-
- </ul>
- </div>
- <! -- sidebar.html end -->
- </div>
- <div class="col-sm-9 col-sm-offset-3">
- <div class="page-header">
- <h1>Usage </h1>
- </div>
-
- <article>
- <div class="col-sm-10">
-
- <div class="article_body">
- <p>This page contains some common examples of how to use the PHP PhantomJS library.</p>
- <ul>
- <li><a href="#basic-request">Basic Request</a></li>
- <li><a href="#post-request">POST Request</a></li>
- <li><a href="#other-request-methods">Other Request Methods</a></li>
- <li><a href="#response-data">Response Data</a></li>
- <li><a href="#screen-captures">Screen Captures</a></li>
- <li><a href="#custom-timeout">Custom Timeout</a></li>
- <li><a href="#delay-page-render">Delay Page Render</a></li>
- <li><a href="#custom-run-options">Custom Run Options</a></li>
- </ul>
- <p>For more advanced customization or to load your own PhantomJS scripts, see the <a href="http://jonnnnyw.github.io/php-phantomjs/advanced.html">advanced</a> documentation.</p>
- <h2 id="basic-request">Basic Request</h2>
- <p>A basic GET request:</p>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
-
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createRequest</span><span class="p">();</span>
- <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createResponse</span><span class="p">();</span>
-
- <span class="nv">$request</span><span class="o">-></span><span class="na">setMethod</span><span class="p">(</span><span class="s1">'GET'</span><span class="p">);</span>
- <span class="nv">$request</span><span class="o">-></span><span class="na">setUrl</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">);</span>
-
- <span class="nv">$client</span><span class="o">-></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>
-
- <span class="k">if</span><span class="p">(</span><span class="nv">$response</span><span class="o">-></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>
- <span class="k">echo</span> <span class="nv">$response</span><span class="o">-></span><span class="na">getContent</span><span class="p">();</span>
- <span class="p">}</span></code></pre></div>
- <p>You can also set the URL, request method and timeout period when creating a new request instance through the message factory:</p>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
-
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createRequest</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">,</span> <span class="s1">'GET'</span><span class="p">,</span> <span class="mi">5000</span><span class="p">);</span>
- <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createResponse</span><span class="p">();</span>
-
- <span class="nv">$client</span><span class="o">-></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>
-
- <span class="k">if</span><span class="p">(</span><span class="nv">$response</span><span class="o">-></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>
- <span class="k">echo</span> <span class="nv">$response</span><span class="o">-></span><span class="na">getContent</span><span class="p">();</span>
- <span class="p">}</span></code></pre></div>
- <h2 id="post-request">POST Request</h2>
- <p>A basic POST request:</p>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
-
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createRequest</span><span class="p">();</span>
- <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createResponse</span><span class="p">();</span>
-
- <span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
- <span class="s1">'param1'</span> <span class="o">=></span> <span class="s1">'Param 1'</span><span class="p">,</span>
- <span class="s1">'param2'</span> <span class="o">=></span> <span class="s1">'Param 2'</span>
- <span class="p">);</span>
-
- <span class="nv">$request</span><span class="o">-></span><span class="na">setMethod</span><span class="p">(</span><span class="s1">'POST'</span><span class="p">);</span>
- <span class="nv">$request</span><span class="o">-></span><span class="na">setUrl</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">);</span>
- <span class="nv">$request</span><span class="o">-></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>
-
- <span class="nv">$client</span><span class="o">-></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>
- <h2 id="other-request-methods">Other Request Methods</h2>
- <p>The PHP PhantomJS library supports the following request methods:</p>
- <ul>
- <li>OPTIONS</li>
- <li>GET</li>
- <li>HEAD</li>
- <li>POST</li>
- <li>PUT</li>
- <li>DELETE</li>
- <li>PATCH</li>
- </ul>
- <p>The request method can be set when creating a new request instance through the message factory:</p>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createRequest</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">,</span> <span class="s1">'PUT'</span><span class="p">);</span></code></pre></div>
- <p>Or on the request instance itself:</p>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createRequest</span><span class="p">();</span>
- <span class="nv">$request</span><span class="o">-></span><span class="na">setMethod</span><span class="p">(</span><span class="s1">'PATCH'</span><span class="p">);</span></code></pre></div>
- <h2 id="response-data">Response Data</h2>
- <p>A standard response gives you access to the following interface:</p>
- <table>
- <thead>
- <tr>
- <th style="text-align: center">Accessor</th>
- <th>Description</th>
- <th style="text-align: center">Return Type</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: center">getHeaders()</td>
- <td>Returns an array of all response headers.</td>
- <td style="text-align: center">Array</td>
- </tr>
- <tr>
- <td style="text-align: center">getHeader(<em>header</em>)</td>
- <td>Returns the value for a specific response header e.g. Content-Type.</td>
- <td style="text-align: center">Mixed</td>
- </tr>
- <tr>
- <td style="text-align: center">getStatus()</td>
- <td>The response status code e.g. 200.</td>
- <td style="text-align: center">Int</td>
- </tr>
- <tr>
- <td style="text-align: center">getContent()</td>
- <td>The raw page content of the requested page.</td>
- <td style="text-align: center">String</td>
- </tr>
- <tr>
- <td style="text-align: center">getContentType()</td>
- <td>The content type of the requested page.</td>
- <td style="text-align: center">String</td>
- </tr>
- <tr>
- <td style="text-align: center">getUrl()</td>
- <td>The URL of the requested page.</td>
- <td style="text-align: center">String</td>
- </tr>
- <tr>
- <td style="text-align: center">getRedirectUrl()</td>
- <td>If the response was a redirect, this will return the redirect URL.</td>
- <td style="text-align: center">String</td>
- </tr>
- <tr>
- <td style="text-align: center">isRedirect()</td>
- <td>Will return true if the response was a redirect or false otherwise.</td>
- <td style="text-align: center">Boolean</td>
- </tr>
- <tr>
- <td style="text-align: center">getConsole()</td>
- <td>Returns an array of any javascript errors on the requested page along with a stack trace.</td>
- <td style="text-align: center">Array</td>
- </tr>
- </tbody>
- </table>
- <p>If the response contains a status code of 0, chances are the request failed. Check the request <a href="http://jonnnnyw.github.io/php-phantomjs/troubleshooting.html#debugging">debug log</a> for more detailed information about what may have gone wrong.</p>
- <h2 id="screen-captures">Screen Captures</h2>
- <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>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createCaptureRequest</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">);</span>
- <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createResponse</span><span class="p">();</span>
-
- <span class="nv">$file</span> <span class="o">=</span> <span class="s1">'/path/to/save/your/screen/capture/file.jpg'</span><span class="p">;</span>
-
- <span class="nv">$request</span><span class="o">-></span><span class="na">setCaptureFile</span><span class="p">(</span><span class="nv">$file</span><span class="p">);</span>
-
- <span class="nv">$client</span><span class="o">-></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>
- <p>You will need to make sure the directory that you are saving the file to exists and is writable by your application.</p>
- <p>You can also set the width, height, x and y axis for your screen capture:</p>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createCaptureRequest</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">);</span>
- <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createResponse</span><span class="p">();</span>
-
- <span class="nv">$file</span> <span class="o">=</span> <span class="s1">'/path/to/save/your/screen/capture/file.jpg'</span><span class="p">;</span>
-
- <span class="nv">$top</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
- <span class="nv">$left</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
- <span class="nv">$width</span> <span class="o">=</span> <span class="mi">200</span><span class="p">;</span>
- <span class="nv">$height</span> <span class="o">=</span> <span class="mi">400</span><span class="p">;</span>
-
- <span class="nv">$request</span><span class="o">-></span><span class="na">setCaptureFile</span><span class="p">(</span><span class="nv">$file</span><span class="p">);</span>
- <span class="nv">$request</span><span class="o">-></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>
-
- <span class="nv">$client</span><span class="o">-></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>
- <h2 id="custom-timeout">Custom Timeout</h2>
- <p>By default, each request will timeout after 5 seconds. You can set a custom timeout period (in milliseconds) for each request:</p>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createRequest</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">);</span>
- <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createResponse</span><span class="p">();</span>
-
- <span class="nv">$timeout</span> <span class="o">=</span> <span class="mi">10000</span><span class="p">;</span> <span class="c1">// 10 seconds</span>
-
- <span class="nv">$request</span><span class="o">-></span><span class="na">setTimeout</span><span class="p">(</span><span class="nv">$timeout</span><span class="p">);</span>
-
- <span class="nv">$client</span><span class="o">-></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>
- <h2 id="delay-page-render">Delay Page Render</h2>
- <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>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createCaptureRequest</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">);</span>
- <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createResponse</span><span class="p">();</span>
-
- <span class="nv">$delay</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> <span class="c1">// 5 seconds</span>
-
- <span class="nv">$request</span><span class="o">-></span><span class="na">setDelay</span><span class="p">(</span><span class="nv">$delay</span><span class="p">);</span>
-
- <span class="nv">$client</span><span class="o">-></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>
- <p>You can set a page render delay for standard requests also.</p>
- <h2 id="custom-run-options">Custom Run Options</h2>
- <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>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
- <span class="nv">$client</span><span class="o">-></span><span class="na">addOption</span><span class="p">(</span><span class="s1">'--load-images=true'</span><span class="p">);</span>
- <span class="nv">$client</span><span class="o">-></span><span class="na">addOption</span><span class="p">(</span><span class="s1">'--ignore-ssl-errors=true'</span><span class="p">);</span>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createRequest</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">);</span>
- <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createResponse</span><span class="p">();</span>
- <span class="nv">$client</span><span class="o">-></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>
- <p>You can also set a path to a JSON configuration file that contains multiple PhantomJS options:</p>
- <div class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp"><?php</span>
- <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
-
- <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>
- <span class="nv">$client</span><span class="o">-></span><span class="na">addOption</span><span class="p">(</span><span class="s1">'--config=/path/to/config.json'</span><span class="p">);</span>
-
- <span class="nv">$request</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createRequest</span><span class="p">(</span><span class="s1">'http://google.com'</span><span class="p">);</span>
- <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">getMessageFactory</span><span class="p">()</span><span class="o">-></span><span class="na">createResponse</span><span class="p">();</span>
- <span class="nv">$client</span><span class="o">-></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>
- <p>See the <a href="http://phantomjs.org/api/command-line.html">PhantomJS Documentation</a> for a full list of command line options.</p>
- </div>
- </div>
- <div class="clearfix"></div>
-
- <hr>
- <ul class="pager">
-
- <li class="previous"><a href="http://jonnnnyw.github.io/php-phantomjs/installation.html" title="Installation">← Installation</a></li>
-
-
- <li class="next"><a href="http://jonnnnyw.github.io/php-phantomjs/advanced.html" title="Advanced Usage">Advanced Usage →</a></li>
-
- </ul>
-
-
- </article>
- <footer>
- <hr/>
- <p>
- © 2014 PHP PhantomJs. Theme: Modified <a href="https://github.com/dbtek/dbyll">dbyll</a> by dbtek.
- </p>
- </footer>
- </div>
- <script type="text/javascript" src="http://jonnnnyw.github.io/php-phantomjs/assets/resources/jquery/jquery.min.js"></script>
- <script type="text/javascript" src="http://jonnnnyw.github.io/php-phantomjs/assets/resources/bootstrap/js/bootstrap.min.js"></script>
- <script type="text/javascript" src="http://jonnnnyw.github.io/php-phantomjs/assets/js/app.js"></script>
-
- </body>
- </html>
|