صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
mrkad
/
php-phantomjs
mirrorاز https://github.com/jonnnnyw/php-phantomjs.git
1
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
شاخه: gh-pages
شاخه‌ها تگ‌ها
php-phantomjs
/
_site
/
3.0
/
4-advanced
/
index.html

index.html 32 KB
لینک دائمی تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572 
  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<title>Advanced Usage</title>
    6. 

  6. 	
    7. 

  7. 	<meta name="author" content="Jonny W">
    8. 

  8. 

  9. 	<!-- Enable responsive viewport -->
    10. 

  10. 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
    11. 

  11. 

  12. 	<!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
    13. 

  13. 	<!--[if lt IE 9]>
    14. 

  14. 	<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
    15. 

  15. 	<![endif]-->
    16. 

  16. 

  17. 	<!-- Le styles -->
    18. 

  18. 	<link href="http://jonnnnyw.github.io/php-phantomjs/assets/resources/bootstrap/css/bootstrap.min.css" rel="stylesheet">
    19. 

  19. 	<link href="http://jonnnnyw.github.io/php-phantomjs/assets/resources/font-awesome/css/font-awesome.min.css" rel="stylesheet">
    20. 

  20. 	<link href="http://jonnnnyw.github.io/php-phantomjs/assets/resources/syntax/syntax.css" rel="stylesheet">
    21. 

  21. 	<link href="http://jonnnnyw.github.io/php-phantomjs/assets/css/style.css" rel="stylesheet">
    22. 

  22. 

  23. 	<!-- Le fav and touch icons -->
    24. 

  24. 	<!-- Update these with your own images
    25. 

  25. 	<link rel="shortcut icon" href="images/favicon.ico">
    26. 

  26. 	<link rel="apple-touch-icon" href="images/apple-touch-icon.png">
    27. 

  27. 	<link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
    28. 

  28. 	<link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
    29. 

  29. 	-->
    30. 

  30. 

  31. 	<link rel="alternate" type="application/rss+xml" title="" href="http://jonnnnyw.github.io/php-phantomjs/feed.xml">
    32. 

  32. 

  33.    <script>
    34. 

  34.         (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
    35. 

  35.         (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
    36. 

  36.         m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    37. 

  37.         })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
    38. 

  38.         
    39. 

  39.         ga('create', 'UA-53289013-1', 'auto');
    40. 

  40.         ga('send', 'pageview');
    41. 

  41.     </script>
    42. 

  42. 

  43. </head>
    44. 

  44. 

  45. <body>
    46. 

  46.     
    47. 

  47.      
    48. 

  48. 

  49. 	<nav class="navbar navbar-default visible-xs" role="navigation" id="global-nav">
    50. 

  50. 		<!-- Brand and toggle get grouped for better mobile display -->
    51. 

  51. 		<div class="navbar-header">
    52. 

  52. 			<button type="button" class="navbar-toggle" data-parent="#global-nav" data-toggle="collapse" data-target="#navbar-collapse-main">
    53. 

  53. 				<span class="sr-only">Toggle navigation</span>
    54. 

  54. 				<span class="icon-bar"></span>
    55. 

  55. 				<span class="icon-bar"></span>
    56. 

  56. 				<span class="icon-bar"></span>
    57. 

  57. 			</button>
    58. 

  58. 			
    59. 

  59. 			<button type="button" class="navbar-toggle version-toggle" data-parent="#global-nav" data-toggle="collapse" data-target="#navbar-collapse-version">
    60. 

  60. 				<span class="sr-only">Toggle navigation</span>
    61. 

  61. 				<span class="fa fa-terminal"><b>3.0</b> version</</span>
    62. 

  62. 			</button>
    63. 

  63.     		
    64. 

  64. 			<a class="navbar-brand" href="http://jonnnnyw.github.io/php-phantomjs/">
    65. 

  65. 				<img src="http://jonnnnyw.github.io/php-phantomjs/assets/media/phantomjs-small.png" class="img-circle" />
    66. 

  66. 				PHP PhantomJs
    67. 

  67. 			</a>
    68. 

  68. 		</div>
    69. 

  69.         
    70. 

  70.         <div class="panel">
    71. 

  71.             <!-- Collect the nav links, forms, and other content for toggling -->
    72. 

  72.     		<div class="collapse navbar-collapse" id="navbar-collapse-version">
    73. 

  73.     			<ul class="nav navbar-nav">
    74. 

  74.     				<li><a href="http://jonnnnyw.github.io/php-phantomjs/4.0/" title="Version 4.0" class="active"><b>4.0</b> version</a></li>
    75. 

  75.                     <li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/" title="Version 3.0"><b>3.0</b> version</a></li>
    76. 

  76.     			</ul>
    77. 

  77.     		</div><!-- /.navbar-collapse -->
    78. 

  78.         </div>
    79. 

  79.         
    80. 

  80.         <div class="panel">
    81. 

  81.     		<!-- Collect the nav links, forms, and other content for toggling -->
    82. 

  82.     		<div class="collapse navbar-collapse" id="navbar-collapse-main">
    83. 

  83.     			<ul class="nav navbar-nav">
    84. 

  84.         			
    85. 

  85.                     <li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/">Introduction</a></li>
    86. 

  86.                     
    87. 

  87.                     <li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/2-installation/">Installation</a></li>
    88. 

  88.                     
    89. 

  89.                     <li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/3-usage/">Usage</a></li>
    90. 

  90.                     
    91. 

  91.                     <li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/4-advanced/">Advanced Usage</a></li>
    92. 

  92.                     
    93. 

  93.                     <li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/5-troubleshooting/">Troubleshooting</a></li>
    94. 

  94.                     
    95. 

  95.     			</ul>
    96. 

  96.     		</div><!-- /.navbar-collapse -->
    97. 

  97.         </div>
    98. 

  98.         
    99. 

  99. 	</nav>
    100. 

  100.     
    101. 

  101. 	<!-- version-menu-dropdown -->
    102. 

  102. 	<div class="btn-group hidden-xs" id="nav-version">
    103. 

  103. 		<button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
    104. 

  104. 			<i class="fa fa-terminal"><b>3.0</b> version</i>
    105. 

  105. 		</button>
    106. 

  106. 		<ul class="dropdown-menu" role="menu">
    107. 

  107. 		    <li><a href="http://jonnnnyw.github.io/php-phantomjs/4.0/" title="4.0 version" class="active"><b>4.0</b> version</a></li>
    108. 

  108. 			<li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/" title="3.0 version"><b>3.0</b> version</a></li>
    109. 

  109. 			<li class="divider"></li>
    110. 

  110. 		</ul>
    111. 

  111. 	</div>
    112. 

  112.     
    113. 

  113. 	<!-- nav-menu-dropdown -->
    114. 

  114. 	<div class="btn-group hidden-xs" id="nav-menu">
    115. 

  115. 		<button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
    116. 

  116. 			<i class="fa fa-bars"></i>
    117. 

  117. 		</button>
    118. 

  118. 		<ul class="dropdown-menu" role="menu">
    119. 

  119. 		    
    120. 

  120. 			<li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/"><i class="fa fa-folder"></i>Introduction</a></li>
    121. 

  121. 			
    122. 

  122. 			<li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/2-installation/"><i class="fa fa-folder"></i>Installation</a></li>
    123. 

  123. 			
    124. 

  124. 			<li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/3-usage/"><i class="fa fa-folder"></i>Usage</a></li>
    125. 

  125. 			
    126. 

  126. 			<li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/4-advanced/"><i class="fa fa-folder"></i>Advanced Usage</a></li>
    127. 

  127. 			
    128. 

  128. 			<li><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/5-troubleshooting/"><i class="fa fa-folder"></i>Troubleshooting</a></li>
    129. 

  129. 			
    130. 

  130. 			<li class="divider"></li>
    131. 

  131. 			<li><a href="#"><i class="fa fa-arrow-up"></i>Top of Page</a></li>
    132. 

  132. 		</ul>
    133. 

  133. 	</div>
    134. 

  134. 

  135. 

  136. 	<div class="col-sm-3 sidebar hidden-xs">
    137. 

  137. 		<! -- sidebar.html -->
    138. 

  138. <header class="sidebar-header" role="banner">
    139. 

  139. 	<a href="http://jonnnnyw.github.io/php-phantomjs/">
    140. 

  140. 		<img src="http://jonnnnyw.github.io/php-phantomjs/assets/media/phantomjs.png" class="img-circle" />
    141. 

  141. 	</a>
    142. 

  142. 	<h3 class="title">
    143. 

  143.         <a href="http://jonnnnyw.github.io/php-phantomjs/">PHP PhantomJs</a>
    144. 

  144.     </h3>
    145. 

  145. </header>
    146. 

  146. 

  147. 

  148. <div id="bio" class="text-center">
    149. 

  149. 	Run PhantomJS scripts through PHP
    150. 

  150. </div>
    151. 

  151. 

  152. 

  153. <div id="contact-list" class="text-center">
    154. 

  154. 

  155. 	<ul class="list-unstyled list-inline">
    156. 

  156. 		
    157. 

  157. 		<li>
    158. 

  158.             <iframe src="http://ghbtns.com/github-btn.html?user=jonnnnyw&repo=php-phantomjs&type=watch&count=true"
    159. 

  159.                 allowtransparency="true" frameborder="0" scrolling="0" width="85" height="20"></iframe>
    160. 

  160. 		</li>
    161. 

  161. 		
    162. 

  162. 		
    163. 

  163. 		<li>
    164. 

  164. 			<iframe src="http://ghbtns.com/github-btn.html?user=jonnnnyw&repo=php-phantomjs&type=fork&count=true"
    165. 

  165.                 allowtransparency="true" frameborder="0" scrolling="0" width="83" height="20"></iframe>
    166. 

  166. 		</li>
    167. 

  167. 		
    168. 

  168. 	</ul>
    169. 

  169. 

  170. </div>
    171. 

  171. <! -- sidebar.html end -->
    172. 

  172. 

  173. 	</div>
    174. 

  174. 

  175.     <p id="version-notice">You are currently viewing version <span>3.0</span> documentation.</p>
    176. 

  176. 

  177. 	<div class="col-sm-9 col-sm-offset-3">
    178. 

  178. 

  179. 		<div class="page-header">
    180. 

  180.   <h1>Advanced Usage </h1>
    181. 

  181. </div>
    182. 

  182. 	
    183. 

  183. <article>
    184. 

  184.     
    185. 

  185. 	<div class="col-sm-10">
    186. 

  186.       
    187. 

  187. 	  <div class="article_body">
    188. 

  188. 	  <ul>
    189. 

  189.   <li><a href="#phantomjs-command-line-options">PhantomJS command line options</a></li>
    190. 

  190.   <li><a href="#custom-phantomjs-scripts">Custom PhantomJS scripts</a></li>
    191. 

  191.   <li><a href="#writing-a-custom-script">Writing a custom script</a></li>
    192. 

  192.   <li><a href="#using-custom-request-parameters-in-your-script">Using custom request parameters in your script</a></li>
    193. 

  193.   <li><a href="#loading-your-script">Loading your script</a></li>
    194. 

  194. </ul>
    195. 

  195. 

  196. <hr />
    197. 

  197. 

  198. <h2 id="phantomjs-command-line-options">PhantomJS command line options</h2>
    199. 

  199. 

  200. <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>
    201. 

  201. 

  202. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="x">    </span><span class="cp">&lt;?php</span>
    203. 

  203. 

  204.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
    205. 

  205.     
    206. 

  206.     <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>
    207. 

  207.     <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>
    208. 

  208.     <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>
    209. 

  209.     
    210. 

  210.     <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>
    211. 

  211.     <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>
    212. 

  212. 

  213.     <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></figure>
    214. 

  214. 

  215. <p>You can also set a path to a JSON configuration file that contains multiple PhantomJS options:</p>
    216. 

  216. 

  217. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="x">    </span><span class="cp">&lt;?php</span>
    218. 

  218. 

  219.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
    220. 

  220.     
    221. 

  221.     <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>
    222. 

  222.     <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>
    223. 

  223.     
    224. 

  224.     <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>
    225. 

  225.     <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>
    226. 

  226. 

  227.     <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></figure>
    228. 

  228. 

  229. <p>See the <a href="http://phantomjs.org/api/command-line.html">PhantomJS Documentation</a> for a full list of command line options.</p>
    230. 

  230. 

  231. <h2 id="custom-phantomjs-scripts">Custom PhantomJS scripts</h2>
    232. 

  232. 

  233. <p>In most instances you shouldn’t need to worry about the javascript files that run the PHP PhantomJS library but there may be times when you want to execute your own custom PhantomJS scripts through the client. This can be easily achieved by using the built in script loader.</p>
    234. 

  234. 

  235. <p>Script files or ‘procedures’ as they are referred to in the application are closely mapped to requests. When you create a default request instance, you are essentially running the default javascript procedure that comes bundled with the application. When you create a capture request you are running the capture procedure.</p>
    236. 

  236. 

  237. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="x">    </span><span class="cp">&lt;?php</span>
    238. 

  238. 

  239.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
    240. 

  240.     
    241. 

  241.     <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="c1">// ~/Resources/procedures/default.proc</span>
    242. 

  242.     <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="c1">// ~/Resources/procedures/capture.proc</span></code></pre></figure>
    243. 

  243. 

  244. <h3 id="writing-a-custom-script">Writing a custom script</h3>
    245. 

  245. 

  246. <p>The first step in creating your script is to create a procedure file somewhere. For the purpose of this guide we will refer to it as <code>my_procedure.proc</code> but in reality it can be called anything you like. The only requirement is that the file extension must be <code>.proc</code>.</p>
    247. 

  247. 

  248. <p>Create the file somewhere and make sure it can be read by your application. Make a note of the path to the directory where your file is created as you will need this when loading your script which is explained later in this guide.</p>
    249. 

  249. 

  250. <figure class="highlight"><pre><code class="language-bash" data-lang="bash">    
    251. 

  251.     <span class="c">#bash</span>
    252. 

  252.     
    253. 

  253.     <span class="nv">$ </span>touch my_procedure.proc
    254. 

  254.     <span class="nv">$ </span>chmod <span class="m">755</span> my_procedure.proc
    255. 

  255.     </code></pre></figure>
    256. 

  256. 

  257. <p>Next open your procedure file in your text editor and write your PhantomJS script. The <a href="http://phantomjs.org/quick-start.html">PhantomJS documentation</a> has more detailed information on writing custom scripts.</p>
    258. 

  258. 

  259. <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript">    
    260. 

  260.     
    261. 

  261.     
    262. 

  262.     <span class="c1">// my_procedure.proc</span>
    263. 

  263. 

  264.     <span class="kd">var</span> <span class="nx">page</span>  <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;webpage&#39;</span><span class="p">).</span><span class="nx">create</span><span class="p">();</span>
    265. 

  265.     
    266. 

  266.     <span class="nx">page</span><span class="p">.</span><span class="nx">open</span> <span class="p">(</span><span class="s1">&#39;{{ request.getUrl() }}&#39;</span><span class="p">,</span> <span class="s1">&#39;{{ request.getMethod() }}&#39;</span><span class="p">,</span> <span class="s1">&#39;{{ request.getBody() }}&#39;</span><span class="p">,</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">status</span><span class="p">)</span> <span class="p">{</span>
    267. 

  267.          
    268. 

  268.         <span class="c1">// It is important that you exit PhantomJS</span>
    269. 

  269.         <span class="c1">// when your script has run or when you</span>
    270. 

  270.         <span class="c1">// encounter an error</span>
    271. 

  271.         <span class="nx">phantom</span><span class="p">.</span><span class="nx">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
    272. 

  272.     <span class="p">});</span>
    273. 

  273.     
    274. 

  274.     <span class="p">...</span>
    275. 

  275.     
    276. 

  276.     
    277. 

  277.     </code></pre></figure>
    278. 

  278. 

  279. <blockquote>
    280. 

  280.   <h4 id="important">Important</h4>
    281. 

  281.   <p>Make sure that <code>phantom.exit(1);</code> is always called after your script has run or if you encounter an error. This requires you to take care when handling PhantomJS errors to ensure that you exit the PhantomJS script, whether the script was successfully executed or not. If you do not call <code>phantom.exit(1);</code> then PhantomJS will continue to run until your PHP script times out. If you find that your custom script is hanging then this is most likely the cause.</p>
    282. 

  282. </blockquote>
    283. 

  283. 

  284. <p>It is a good practice to create a global error handler in your script that exits PhantomJS:</p>
    285. 

  285. 

  286. <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript">    
    287. 

  287.     
    288. 

  288.     
    289. 

  289.     <span class="c1">// my_procedure.proc</span>
    290. 

  290. 

  291.     <span class="nx">phantom</span><span class="p">.</span><span class="nx">onError</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">msg</span><span class="p">,</span> <span class="nx">trace</span><span class="p">)</span> <span class="p">{</span>
    292. 

  292.   
    293. 

  293.         <span class="nx">phantom</span><span class="p">.</span><span class="nx">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
    294. 

  294.     <span class="p">};</span>
    295. 

  295.     
    296. 

  296.     <span class="p">...</span>
    297. 

  297.     
    298. 

  298.     
    299. 

  299.     </code></pre></figure>
    300. 

  300. 

  301. <h3 id="using-custom-request-parameters-in-your-script">Using custom request parameters in your script</h3>
    302. 

  302. 

  303. <p>Before a procedure is executed by the application it is parsed through a template parser. The PHP PhantomJS library uses the popular <a href="https://github.com/fabpot/Twig">Twig templating engine</a>. This gives you access to all the <a href="http://twig.sensiolabs.org/doc/templates.html">Twig niceness</a> which you can use in your custom scripts.</p>
    304. 

  304. 

  305. <p>You may have noticed in the example above that we have used some Twig template tags referencing a request object e.g. <code>{{ request.getUrl() }}</code>. This is in fact the PHP request instance that you created and passed to the client when sending your request, which is injected into the Twig template parser. As a result you gain full access to all the data contained within the request instance, via the data accessor methods.</p>
    306. 

  306. 

  307. <p>A default request instance contains the following accessors:</p>
    308. 

  308. 

  309. <table>
    310. 

  310.   <thead>
    311. 

  311.     <tr>
    312. 

  312.       <th style="text-align: center">Accessor</th>
    313. 

  313.       <th>Description</th>
    314. 

  314.       <th style="text-align: center">Twig example</th>
    315. 

  315.     </tr>
    316. 

  316.   </thead>
    317. 

  317.   <tbody>
    318. 

  318.     <tr>
    319. 

  319.       <td style="text-align: center">getMethod()</td>
    320. 

  320.       <td>The request method e.g. GET.</td>
    321. 

  321.       <td style="text-align: center">{{ request.getMethod() }}</td>
    322. 

  322.     </tr>
    323. 

  323.     <tr>
    324. 

  324.       <td style="text-align: center">getTimeout()</td>
    325. 

  325.       <td>The request timeout period in milliseconds.</td>
    326. 

  326.       <td style="text-align: center">{{ request.getTimeout() }}</td>
    327. 

  327.     </tr>
    328. 

  328.     <tr>
    329. 

  329.       <td style="text-align: center">getDelay()</td>
    330. 

  330.       <td>The page render delay in seconds.</td>
    331. 

  331.       <td style="text-align: center">{{ request.getDelay() }}</td>
    332. 

  332.     </tr>
    333. 

  333.     <tr>
    334. 

  334.       <td style="text-align: center">getViewportWidth()</td>
    335. 

  335.       <td>The viewport width.</td>
    336. 

  336.       <td style="text-align: center">{{ request.getViewportWidth() }}</td>
    337. 

  337.     </tr>
    338. 

  338.     <tr>
    339. 

  339.       <td style="text-align: center">getViewportHeight()</td>
    340. 

  340.       <td>The viewport height.</td>
    341. 

  341.       <td style="text-align: center">{{ request.getViewportHeight() }}</td>
    342. 

  342.     </tr>
    343. 

  343.     <tr>
    344. 

  344.       <td style="text-align: center">getUrl()</td>
    345. 

  345.       <td>The request URL.</td>
    346. 

  346.       <td style="text-align: center">{{ request.getUrl() }}</td>
    347. 

  347.     </tr>
    348. 

  348.     <tr>
    349. 

  349.       <td style="text-align: center">getBody()</td>
    350. 

  350.       <td>The request body (POST, PUT).</td>
    351. 

  351.       <td style="text-align: center">{{ request.getBody() }}</td>
    352. 

  352.     </tr>
    353. 

  353.     <tr>
    354. 

  354.       <td style="text-align: center">getHeaders(<em>format</em>)</td>
    355. 

  355.       <td>The request headers.</td>
    356. 

  356.       <td style="text-align: center">{{ request.getHeaders(‘json’) }}</td>
    357. 

  357.     </tr>
    358. 

  358.   </tbody>
    359. 

  359. </table>
    360. 

  360. 

  361. <p>A capture request contains a few additional ones:</p>
    362. 

  362. 

  363. <table>
    364. 

  364.   <thead>
    365. 

  365.     <tr>
    366. 

  366.       <th style="text-align: center">Accessor</th>
    367. 

  367.       <th>Description</th>
    368. 

  368.       <th style="text-align: center">Twig example</th>
    369. 

  369.     </tr>
    370. 

  370.   </thead>
    371. 

  371.   <tbody>
    372. 

  372.     <tr>
    373. 

  373.       <td style="text-align: center">getRectTop()</td>
    374. 

  374.       <td>The x coordinate of the capture region.</td>
    375. 

  375.       <td style="text-align: center">{{ request.getRectTop() }}</td>
    376. 

  376.     </tr>
    377. 

  377.     <tr>
    378. 

  378.       <td style="text-align: center">getRectLeft()</td>
    379. 

  379.       <td>The y coordinate of the capture region.</td>
    380. 

  380.       <td style="text-align: center">{{ request.getRectLeft() }}</td>
    381. 

  381.     </tr>
    382. 

  382.     <tr>
    383. 

  383.       <td style="text-align: center">getRectWidth()</td>
    384. 

  384.       <td>The width of the capture region.</td>
    385. 

  385.       <td style="text-align: center">{{ request.getRectWidth() }}</td>
    386. 

  386.     </tr>
    387. 

  387.     <tr>
    388. 

  388.       <td style="text-align: center">getRectHeight()</td>
    389. 

  389.       <td>The height of the capture region.</td>
    390. 

  390.       <td style="text-align: center">{{ request.getRectHeight() }}</td>
    391. 

  391.     </tr>
    392. 

  392.     <tr>
    393. 

  393.       <td style="text-align: center">getCaptureFile()</td>
    394. 

  394.       <td>The file to save the capture to.</td>
    395. 

  395.       <td style="text-align: center">{{ request.getCaptureFile() }}</td>
    396. 

  396.     </tr>
    397. 

  397.   </tbody>
    398. 

  398. </table>
    399. 

  399. 

  400. <p>If you would like to inject additional data into your script through custom accessors, simply extend the request class with your own:</p>
    401. 

  401. 

  402. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="x">    </span><span class="cp">&lt;?php</span>
    403. 

  403. 

  404.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Message\Request</span><span class="p">;</span>
    405. 

  405.     
    406. 

  406.     <span class="k">class</span> <span class="nc">CustomRequest</span> <span class="k">extends</span> <span class="nx">Request</span>
    407. 

  407.     <span class="p">{</span>
    408. 

  408.     
    409. 

  409.         <span class="k">public</span> <span class="k">function</span> <span class="nf">getSomething</span><span class="p">()</span>
    410. 

  410.         <span class="p">{</span>
    411. 

  411.             <span class="k">return</span> <span class="s1">&#39;Something!&#39;</span><span class="p">;</span>
    412. 

  412.         <span class="p">}</span>
    413. 

  413.     <span class="p">}</span></code></pre></figure>
    414. 

  414. 

  415. <p>Now you will be able to access the data in your custom script when using your custom request:</p>
    416. 

  416. 

  417. <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript">    
    418. 

  418.     
    419. 

  419.     
    420. 

  420.     <span class="c1">// my_procedure.proc</span>
    421. 

  421. 

  422.     <span class="kd">var</span> <span class="nx">something</span> <span class="o">=</span> <span class="s1">&#39;{{ request.getSomething() }}&#39;</span><span class="p">;</span> <span class="c1">// Get something</span>
    423. 

  423.     
    424. 

  424.     <span class="p">...</span>
    425. 

  425.     
    426. 

  426.     
    427. 

  427.     </code></pre></figure>
    428. 

  428. 

  429. <p>And to use your custom request simply create a new instance of it and pass it to the client:</p>
    430. 

  430. 

  431. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="x">    </span><span class="cp">&lt;?php</span>
    432. 

  432. 

  433.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
    434. 

  434.     
    435. 

  435.     <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>
    436. 

  436.     
    437. 

  437.     <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>
    438. 

  438.     
    439. 

  439.     <span class="nv">$request</span>  <span class="o">=</span> <span class="k">new</span> <span class="nx">CustomRequest</span><span class="p">();</span>
    440. 

  440.     <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>
    441. 

  441.     <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setUrl</span><span class="p">(</span><span class="s1">&#39;http://www.google.com&#39;</span><span class="p">);</span>
    442. 

  442.     
    443. 

  443.     <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></figure>
    444. 

  444. 

  445. <h3 id="loading-your-script">Loading your script</h3>
    446. 

  446. 

  447. <p>Now that you have your custom script and you’ve added your custom request parameters, you may be wondering how to tell the client to actually load your script. This is done by creating a procedure loader and telling it where to find your script files.</p>
    448. 

  448. 

  449. <p>The service container has a factory that makes creating a new procedure loader easy:</p>
    450. 

  450. 

  451. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="x">    </span><span class="cp">&lt;?php</span>
    452. 

  452.     
    453. 

  453.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
    454. 

  454.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\DependencyInjection\ServiceContainer</span><span class="p">;</span>
    455. 

  455.     
    456. 

  456.     <span class="nv">$location</span> <span class="o">=</span> <span class="s1">&#39;/path/to/your/procedure/directory&#39;</span><span class="p">;</span>
    457. 

  457.     
    458. 

  458.     <span class="nv">$serviceContainer</span> <span class="o">=</span> <span class="nx">ServiceContainer</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
    459. 

  459.     
    460. 

  460.     <span class="nv">$procedureLoader</span> <span class="o">=</span> <span class="nv">$serviceContainer</span><span class="o">-&gt;</span><span class="na">get</span><span class="p">(</span><span class="s1">&#39;procedure_loader_factory&#39;</span><span class="p">)</span>
    461. 

  461.         <span class="o">-&gt;</span><span class="na">createProcedureLoader</span><span class="p">(</span><span class="nv">$location</span><span class="p">);</span>
    462. 

  462.         
    463. 

  463.     <span class="o">...</span></code></pre></figure>
    464. 

  464. 

  465. <p>The client contains a chain procedure loader which lets you set multiple loaders at the same time. Ultimately this means that you can load your custom scripts while still maintaining the ability to load the default scripts if you choose. </p>
    466. 

  466. 

  467. <p>Now add your procedure loader to the chain loader:</p>
    468. 

  468. 

  469. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="x">    </span><span class="cp">&lt;?php</span>
    470. 

  470. 

  471.     <span class="o">...</span>
    472. 

  472.     
    473. 

  473.     <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>
    474. 

  474.     <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getProcedureLoader</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">addLoader</span><span class="p">(</span><span class="nv">$procedureLoader</span><span class="p">);</span>
    475. 

  475.     
    476. 

  476.     <span class="o">...</span></code></pre></figure>
    477. 

  477. 

  478. <p>The last thing you need to do is to tell the request which script you want to load for that request. This is done by setting the request type to the name of your procedure file, minus the extension:</p>
    479. 

  479. 

  480. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="x">    </span><span class="cp">&lt;?php</span>
    481. 

  481. 

  482.     <span class="o">...</span>
    483. 

  483.     
    484. 

  484.    <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>
    485. 

  485.    <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setType</span><span class="p">(</span><span class="s1">&#39;my_procedure&#39;</span><span class="p">);</span>
    486. 

  486.     
    487. 

  487.     <span class="o">...</span></code></pre></figure>
    488. 

  488. 

  489. <p>Or if you are using a custom request as outlined in the <a href="#using-custom-request-parameters-in-your-script">custom request parameters</a> section, you can implement a <code>getType()</code> method which returns the name of your procedure, eliminating the need to set the request type for each request:</p>
    490. 

  490. 

  491. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="cp">&lt;?php</span>
    492. 

  492. 

  493.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Message\Request</span><span class="p">;</span>
    494. 

  494.     
    495. 

  495.     <span class="k">class</span> <span class="nc">CustomRequest</span> <span class="k">extends</span> <span class="nx">Request</span>
    496. 

  496.     <span class="p">{</span>
    497. 

  497.     
    498. 

  498.         <span class="k">public</span> <span class="k">function</span> <span class="nf">getType</span><span class="p">()</span>
    499. 

  499.         <span class="p">{</span>
    500. 

  500.             <span class="k">return</span> <span class="s1">&#39;my_procedure&#39;</span><span class="p">;</span>
    501. 

  501.         <span class="p">}</span>
    502. 

  502.     <span class="p">}</span></code></pre></figure>
    503. 

  503. 

  504. <p>Below is a full example for clarity:</p>
    505. 

  505. 

  506. <figure class="highlight"><pre><code class="language-php" data-lang="php"><span class="x">    </span><span class="cp">&lt;?php</span>
    507. 

  507.     
    508. 

  508.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\Client</span><span class="p">;</span>
    509. 

  509.     <span class="k">use</span> <span class="nx">JonnyW\PhantomJs\DependencyInjection\ServiceContainer</span><span class="p">;</span>
    510. 

  510.     
    511. 

  511.     <span class="nv">$location</span> <span class="o">=</span> <span class="s1">&#39;/path/to/your/procedure/directory&#39;</span><span class="p">;</span>
    512. 

  512.     
    513. 

  513.     <span class="nv">$serviceContainer</span> <span class="o">=</span> <span class="nx">ServiceContainer</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
    514. 

  514.     
    515. 

  515.     <span class="nv">$procedureLoader</span> <span class="o">=</span> <span class="nv">$serviceContainer</span><span class="o">-&gt;</span><span class="na">get</span><span class="p">(</span><span class="s1">&#39;procedure_loader_factory&#39;</span><span class="p">)</span>
    516. 

  516.         <span class="o">-&gt;</span><span class="na">createProcedureLoader</span><span class="p">(</span><span class="nv">$location</span><span class="p">);</span>
    517. 

  517.         
    518. 

  518.     <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>
    519. 

  519.     <span class="nv">$client</span><span class="o">-&gt;</span><span class="na">getProcedureLoader</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">addLoader</span><span class="p">(</span><span class="nv">$procedureLoader</span><span class="p">);</span>
    520. 

  520.     
    521. 

  521.     <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>
    522. 

  522.     <span class="nv">$request</span><span class="o">-&gt;</span><span class="na">setType</span><span class="p">(</span><span class="s1">&#39;my_procedure&#39;</span><span class="p">);</span>
    523. 

  523.     
    524. 

  524.     <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>
    525. 

  525.     
    526. 

  526.     <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></figure>
    527. 

  527. 

  528. <blockquote>
    529. 

  529.   <h4 id="troubleshooting">Troubleshooting</h4>
    530. 

  530.   <p>If you find that your script isn’t running or that you are receiving a status of ‘0’ back in the response, chances are you have a syntax error in you script. It pays to turn debugging on in the client <code>$client-&gt;debug(true)</code> which will then give you access to some log information through <code>$client-&gt;getLog()</code>.</p>
    531. 

  531. </blockquote>
    532. 

  532. 

  533. <p>See more detailed information about <a href="http://jonnnnyw.github.io/php-phantomjs/troubleshooting.html">troubleshooting</a>.</p>
    534. 

  534. 

  535. 	  </div>
    536. 

  536. 

  537.     </div>
    538. 

  538. 

  539.     <div class="clearfix"></div>
    540. 

  540.     
    541. 

  541.     <hr>
    542. 

  542.     <ul class="pager">
    543. 

  543.         
    544. 

  544.         <li class="previous"><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/5-troubleshooting/" title="Troubleshooting">&larr; Troubleshooting</a></li>
    545. 

  545.         
    546. 

  546.         
    547. 

  547.         <li class="next"><a href="http://jonnnnyw.github.io/php-phantomjs/3.0/3-usage/" title="Usage">Usage &rarr;</a></li>
    548. 

  548.         
    549. 

  549.     </ul>
    550. 

  550. 

  551. 	
    552. 

  552.     
    553. 

  553. </article>
    554. 

  554. 

  555. 

  556. 

  557. 

  558. 		<footer>
    559. 

  559. 			<hr/>
    560. 

  560. 			<p>
    561. 

  561. 				&copy; 2016 PHP PhantomJs
    562. 

  562. 			</p>
    563. 

  563. 		</footer>
    564. 

  564. 	</div>
    565. 

  565. 

  566. 	<script type="text/javascript" src="http://jonnnnyw.github.io/php-phantomjs/assets/resources/jquery/jquery.min.js"></script>
    567. 

  567. 	<script type="text/javascript" src="http://jonnnnyw.github.io/php-phantomjs/assets/resources/bootstrap/js/bootstrap.min.js"></script>
    568. 

  568. 	<script type="text/javascript" src="http://jonnnnyw.github.io/php-phantomjs/assets/js/app.js"></script>
    569. 

  569. 	
    570. 

  570. </body>
    571. 

  571. </html>
    572. 

  572.