Added updated Marcelog and new logic implementation call transfer

@@ -313,7 +313,7 @@ class DialerController extends Controller {
 						if($sipid&&$sipid->user==Auth::user()->id&&$sipid->status==1)
 						{
 							
-							$dialline=Dialline::where("status","=","Free")->where("enabled","=","1");
+							$dialline=Dialline::where('server', '=', env('app_ip'))->where("status","=","Free")->where("enabled","=","1");
 							if($dspan!="")$dialline=$dialline->where('dspan','=',$dspan);
 							$dialline=$dialline->orderBy('updated_at','ASC')->first();
 							
@@ -456,8 +456,8 @@ if($action=="addconfcall")
 				
 				
 					//start actual calls
-				$newqueue=new Kqueue();
-				$newqueue->userToConf($sipid);
+				// $newqueue=new Kqueue();
+				// $newqueue->userToConf($sipid);
 				$newqueue=new Kqueue();
 				$newqueue->custToConf($sipid,$callnumber,$callerid,$crmcall,$dialline);
 				
@@ -481,6 +481,90 @@ if($action=="addconfcall")
 	return Response::make($retstr);
 }
 
+if($action=="transfercall")
+{
+	$retstr="";
+	$callnumber=Input::get("confnumber");
+	$callerid="";
+
+			//see if user is online on this sipid
+	$sipid=Sipid::find($kstychDialer['phone']);
+	if($sipid&&$sipid->user==Auth::user()->id&&$sipid->status==1)
+	{
+		$oldcrmcall=CRMCall::find($kstychCall['callid']);
+		if($oldcrmcall)
+		{
+			$olddialline=Dialline::find($oldcrmcall->dialline_id);
+			$dspan="1";if($olddialline)$dspan=$olddialline->dspan;
+			
+			$dialline=Dialline::where("status","=","Free")->where("enabled","=","1");
+			if($dspan!="")$dialline=$dialline->where('dspan','=',$dspan);
+			$dialline=$dialline->orderBy('updated_at','ASC')->first();
+			
+			if($dialline)
+			{
+
+				$callerid=$oldcrmcall->did;
+				
+				$dialline->status="transfer";
+				$dialline->channel=$olddialline->channel;
+				$dialline->save();
+				
+				$nowts=microtime(true)*1000;
+				
+					//start the call log
+				$crmcall=new CRMCall();
+				$crmcall->number=$callnumber;
+				$crmcall->user_id=Auth::user()->id;
+				$crmcall->sipid_id=$sipid->id;
+				$crmcall->crm_id=$oldcrmcall->crm_id;
+				$crmcall->client=$oldcrmcall->client;
+				$crmcall->department=$oldcrmcall->department;
+				$crmcall->state='New';
+				$crmcall->userstatus='Conference';
+				$crmcall->usersubstatus='Conference';
+				$crmcall->type='Conference';
+				$crmcall->dialline_id=$dialline->id;
+				
+				$crmcall->setTs('ts_Wait',$nowts);
+				$crmcall->setTs('ts_Call',$nowts);
+				
+				$crmcall->did=$callerid;
+				
+				$tdata=array();
+				$crmcall->data=json_encode($tdata);
+				$crmcall->save();
+				
+				
+				$newqueue=new Kqueue();
+				$newqueue->transferCall($sipid,$callnumber,$callerid,$crmcall,$dialline);
+
+					//start actual calls
+				// $newqueue=new Kqueue();
+				// $newqueue->userToConf($sipid);
+				// $newqueue=new Kqueue();
+				// $newqueue->custToConf($sipid,$callnumber,$callerid,$crmcall,$dialline);
+				
+				$retstr=$crmcall->id;
+			}
+			else 
+			{
+				$retstr="Error : No Lines Free to Dial!";
+			}
+		}
+		else
+		{
+			$retstr="Error : No calls to conference found!";
+		}
+	}
+	else
+	{
+		$retstr="Error : You Are Not Connected!";
+	}
+	
+	return Response::make($retstr);
+}
+
 if($action=="hangupall")
 {
 	$res=0;

@@ -17,6 +17,7 @@ use Request;
 use Cache;
 use File;
 use Route;
+use Log;
 
 use App\Models\Group;
 use App\Models\Sipid;
@@ -103,9 +104,7 @@ class HomeController extends Controller {
 		$cliarr['keepconf']=Config::get("app.kDialer_keeplocalconf");
     //get a free sip id
     $server=explode(":",$user->exten);
-    $sipid=Sipid::where("status","=","0")->where('updated_at','<=',date("Y-m-d H:i:s",time()-600))->orderBy('updated_at','asc')->where('server','!=','');
-    if(isset($server[2]))$sipid=$sipid->where('server','=',$server[2]);
-    $sipid=$sipid->first(); 
+    $sipid=Sipid::where("status","=","0")->where('updated_at','<=',date("Y-m-d H:i:s",time()-600))->orderBy('updated_at','asc')->where('server','=',env('app_ip'))->first();
     if(!$sipid)return Response::make("Error : Cant Allocate Data Channel. Giving Up.");
     $sipid->clients=json_encode($cliarr);
     $sipid->user=$user->id;

 <?php namespace App\Models;
 use Illuminate\Database\Eloquent\Model;
-
+use Log;
 
 class Kqueue extends Model{
 
@@ -69,6 +69,33 @@ class Kqueue extends Model{
 		}
 		
 	}
+	public function transferCall($sipid,$callnumber,$callerid,$crmcall,$dialline)
+	{
+		$dialstr = $dialline->dialstr;
+		$server = $dialline->server;
+		$channel = $dialline->channel;
+Log::info($channel);
+		if($server != '')
+		{
+		$odata=array();$odata['VARS']=array();
+		$odata['fromext']="Local/1000".$sipid->id."@kstychDialer";
+		$odata['context']="initiateTransfer";
+		$odata['callerid']=$channel;
+		$odata['toext']="1003".$callnumber;
+		$odata['account']='m|t|'.$crmcall->id;
+		$odata['VARS']['dialstr']=$dialstr;
+		$odata['VARS']['chnl']=$channel;
+		$odata['VARS']['callnumber']=$callnumber;
+
+		//originate conf
+		$this->type="SIP_".$server;
+		$this->key="originate";
+		$this->status="New";
+		$this->data=json_encode($odata);
+		$this->save();
+		}
+		
+	}
 	public function sipOriginate($sipid,$to,$context)
 	{
 		$odata=array();$odata['VARS']=array();

+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - php
+  fixme:
+    enabled: false
+  phpcodesniffer:
+    enabled: true
+  phpmd:
+    enabled: true
+
+ratings:
+  paths:
+  - "**.php"
+
+exclude_paths:
+- test/**/*
\ No newline at end of file

+vendor
+.buildpath
+.settings
+.project
+build
+resources/php.ini
+composer.lock
+nbproject

+language: php
+php:
+  - '5.4'
+  - '5.5'
+  - '5.6'
+  - '7.0'
+
+before_script:
+  - phpenv config-add test/resources/php.ini
+
+install:
+  - composer install
+
+script:
+  - vendor/bin/phing build
+
+after_script:
+  - travis_retry php vendor/bin/coveralls -v
+  - vendor/bin/test-reporter
+
+addons:
+  code_climate:
+    repo_token: 568675e210a5bfc69593877127f7297bab3150dc4d26692bd19bc49c75bd2c14
\ No newline at end of file

+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+

+[![License](https://poser.pugx.org/marcelog/PAGI/license)](https://packagist.org/packages/marcelog/PAGI)
+[![Latest Stable Version](https://poser.pugx.org/marcelog/PAGI/v/stable)](https://packagist.org/packages/marcelog/PAGI)
+[![Documentation Status](https://readthedocs.org/projects/pami/badge/?version=latest)](http://pami.readthedocs.org/en/latest/?badge=latest)
+
+[![Build Status](https://travis-ci.org/marcelog/PAGI.svg)](https://travis-ci.org/marcelog/PAGI)
+[![Coverage Status](https://coveralls.io/repos/marcelog/PAGI/badge.svg?branch=master&service=github)](https://coveralls.io/github/marcelog/PAGI?branch=master)
+[![Code Climate](https://codeclimate.com/github/marcelog/PAGI/badges/gpa.svg)](https://codeclimate.com/github/marcelog/PAGI)
+[![Issue Count](https://codeclimate.com/github/marcelog/PAGI/badges/issue_count.svg)](https://codeclimate.com/github/marcelog/PAGI)
+
+# Introduction
+
+This framework is intended to simply making ivr applications using Asterisk's
+AGI, providing a nice level of abstraction over what an IVR should look like
+from a developers' perspective.
+
+Resources:
+
+ * [Main Site](http://marcelog.github.com/PAGI)
+ * [API](https://github.com/marcelog/PAGI/blob/master/doc/ApiIndex.md)
+ * [Complete PAGI/PAMI talk for the PHP Conference Argentina 2013](http://www.slideshare.net/mgornstein/phpconf-2013). Check the slide notes for the complete text :)
+ * [In-depth tutorial](http://marcelog.github.com/articles/pagi_tutorial_create_voip_telephony_application_for_asterisk_with_agi_and_php.html)
+ * [An example IVR application that includes unit tests is available here](https://github.com/marcelog/Pagi-App-And-Test-Example)
+ * [Professional Telephony Applications at hand](http://sdjournal.org/a-practical-introduction-to-functional-programming-with-php-sdj-issue-released/) The march edition of [Software Developer Journal](http://sdjournal.org/) features a complete article about writing telephony applications with PAMI and PAGI.
+
+# Installing
+Add this library to your [Composer](https://packagist.org/) configuration. In
+composer.json:
+```json
+  "require": {
+    "marcelog/pagi": "2.*"
+  }
+```
+
+# Using it
+
+First, make sure you include the [autoloader shipped with composer](https://getcomposer.org/doc/01-basic-usage.md#autoloading):
+
+```php
+require __DIR__ . '/vendor/autoload.php';
+```
+
+# Quickstart
+
+You can start by *docs/examples/quickstart* for a very basic example. You'll need something like this in your dialplan:
+
+    [default]
+    exten => 1,1,AGI(/path/to/PAGI/docs/examples/quickstart/run.sh,a,b,c,d)
+    exten => 1,n,Hangup
+
+# Testing IVR applications
+
+A mocked pagi client is included to easily test your ivr applications. See
+**docs/examples/mock** to see an example of how to use it.
+
+# Features
+
+## Nodes
+
+For a tutorial about nodes, see [this article](http://marcelog.github.com/articles/pagi_node_call_flow_easy_telephony_application_for_asterisk_php.html)
+
+Simple Call Flow Nodes are available (see **docs/examples/node/example.php**). Using
+nodes will let you simplify how you build and test your ivr applications. Nodes
+are an abstraction layer above the pagi client, and support:
+
+ * Prompts mixing sound files, playing numbers/digits/datetime's.
+ * Cancel and End Of Input digits.
+ * Validator callbacks for inputs, can optionally specify 1 or more sound files
+ to play when the validation fails.
+ * Callbacks for invalid and valid inputs.
+ * Optional sound when no input.
+ * Maximum valid input attempts.
+ * Optional sound when maximum attempts has been reached.
+ * Expecting at least/at most/exactly N digits per input.
+ * Timeout between digits in more-than-1 digit inputs.
+ * Timeout per input attempt.
+ * Retry Attempts for valid inputs.
+ * And much more!
+
+The NodeController will let you control the call flow of your application, by
+registering nodes and actions based on node results. Thus, you can jump from
+one node to the other on cancel or complete inputs, hangup the call, execute a
+callback, etc. For an example, see docs/examples/nodecontroller/example.php
+
+An article about the node controller is available [here](http://marcelog.github.com/articles/making_your_ivr_nodes_call_flow_with_pagi_and_php_asterisk.html)
+
+## AutoDial
+
+CallFiles are supported. You can also schedule a call in the future.
+
+## Fax
+
+Sending and receiving faxes is supported using spandsp (applications SendFax
+and ReceiveFax).
+
+## Available Facades
+
+ * PAGI\Client\CDR: Provided to access cdr variables.
+ * PAGI\Client\ChannelVariables: Provided to access channel variables and asterisk
+environment variables.
+ * PAGI\Client\CallerID: Provided to access caller id variables.
+ * PAGI\Client\Result: Provided to wrap up the result for agi commands.
+ * PAGI\CallSpool\CallFile: Call file facade.
+ * PAGI\CallSpool\CallSpool: Call spool facade.
+ * PAGI\Logger\Asterisk: Provides access to asterisk logger (see logger.conf in
+your asterisk installation).
+
+## Results
+
+For every operation, a Result is provided. Some operations decorate this
+Result to add functionality, like PlayResult, ReadResult, etc. For example,
+a stream file will return a PlayResult, which decorates a ReadResult which
+in turn, decorated a Result.
+
+  * PAGI\Client\DialResult
+  * PAGI\Client\ExecResult
+  * PAGI\Client\ReadResult
+  * PAGI\Client\PlayResult
+  * PAGI\Client\FaxResult
+
+## Debugging, logging
+
+You can optionally set a [PSR-3](http://www.php-fig.org/psr/psr-3/) compatible logger:
+```php
+$pagi->setLogger($logger);
+```
+
+By default, the client will use the [NullLogger](http://www.php-fig.org/psr/psr-3/#1-4-helper-classes-and-interfaces).
+
+# Developers
+This project uses [phing](https://www.phing.info/). Current tasks include:
+ * test: Runs [PHPUnit](https://phpunit.de/).
+ * cs: Runs [CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
+ * doc: Runs [PhpDocumentor](http://www.phpdoc.org/).
+ * md: runs [PHPMD](http://phpmd.org/).
+ * build: This is the default task, and will run all the other tasks.
+
+## Running a phing task
+To run a task, just do:
+
+```sh
+vendor/bin/phing build
+```
+
+## Contributing
+To contribute:
+ * Make sure you open a **concise** and **short** pull request.
+ * Throw in any needed unit tests to accomodate the new code or the
+ changes involved.
+ * Run `phing` and make sure everything is ok before submitting the pull
+ request (make phpmd and CodeSniffer happy, also make sure that phpDocumentor
+ does not throw any warnings, since all our documentation is automatically
+ generated).
+ * Your code must comply with [PSR-2](http://www.php-fig.org/psr/psr-2/),
+ CodeSniffer should take care of that.
+
+LICENSE
+=======
+Copyright 2011 Marcelo Gornstein <[email protected]>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

+<?xml version="1.0"?>
+<project
+  name="php-sdk"
+  default="build"
+  basedir="."
+  description="PAGI Asterisk Gateway Interface (AGI) client for PHP">
+
+  <target name="install">
+    <exec command="./composer.phar install" checkreturn="true" passthru="true"/>
+    <exec command="./composer.phar update" checkreturn="true" passthru="true"/>
+  </target>
+
+  <target name="clean">
+    <delete dir="build"/>
+  </target>
+
+  <target name="prepare">
+    <mkdir dir="build" mode="0755"/>
+    <mkdir dir="build/doc" mode="0755"/>
+    <mkdir dir="build/doc/xml" mode="0755"/>
+    <mkdir dir="build/doc/html" mode="0755"/>
+    <mkdir dir="build/doc/md" mode="0755"/>
+    <mkdir dir="build/logs" mode="0755"/>
+    <mkdir dir="build/coverage-html" mode="0755"/>
+  </target>
+
+  <target name="cpd">
+    <exec command="vendor/bin/phpcpd --fuzzy src"
+      checkreturn="true"
+      passthru="true"/>
+  </target>
+
+  <target name="md">
+    <exec command="vendor/bin/phpmd ./src text cleancode,codesize,controversial,design,naming,unusedcode"
+      checkreturn="false"
+      passthru="true"/>
+  </target>
+
+  <target name="cs">
+    <exec command="vendor/bin/phpcs --standard=PSR2 src/*"
+      checkreturn="true"
+      passthru="true"/>
+  </target>
+
+  <target name="docxml">
+    <exec command="vendor/bin/phpdoc --template=xml -t build/doc/xml -d src --validate --sourcecode --force --log"
+      checkreturn="true"
+      passthru="true"/>
+  </target>
+
+  <target name="dochtml">
+    <exec command="vendor/bin/phpdoc -t build/doc/html -d src --validate --sourcecode --force --log"
+      checkreturn="true"
+      passthru="true"/>
+  </target>
+
+  <target name="docmd">
+    <exec dir="build/doc/md" command="../../../vendor/bin/phpdocmd ../xml/structure.xml"
+      checkreturn="true"
+      passthru="true"/>
+    <copy todir="doc" overwrite="true">
+      <fileset dir="build/doc/md">
+        <include name="*.md" />
+      </fileset>
+    </copy>
+  </target>
+
+  <target name="test">
+    <exec command="vendor/bin/phpunit -v --debug -c test/resources/phpunit.xml"
+      checkreturn="true"
+      passthru="true"/>
+  </target>
+
+  <target name="build" depends="clean, prepare, cpd, cs, md, doc, test"/>
+  <target name="doc" depends="docxml, dochtml, docmd"/>
+
+</project>
\ No newline at end of file

+{
+  "name": "marcelog/pagi",
+  "type": "library",
+  "description": "Asterisk Gateway Interface (AGI) client for PHP, suitable to make telephony applications using call flow nodes",
+  "keywords": ["asterisk","agi","client","call","flow","node","ivr","telephony","voip"],
+  "homepage": "http://marcelog.github.com/PAGI",
+  "license": "Apache-2.0",
+  "authors": [
+    {
+      "name": "Marcelo Gornstein",
+      "email": "[email protected]",
+      "homepage": "http://marcelog.github.com/",
+      "role": "Developer"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "PAGI\\": "src/PAGI"
+    }
+  },
+  "require": {
+    "php": ">=5.3.3",
+    "psr/log": ">= 1.0.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "4.*",
+    "monolog/monolog": "1.*",
+    "squizlabs/php_codesniffer": "2.*",
+    "phpdocumentor/phpdocumentor": "2.*",
+    "phing/phing": "2.*",
+    "phpmd/phpmd": "2.*",
+    "satooshi/php-coveralls": "0.*",
+    "evert/phpdoc-md" : "~0.1.1",
+    "codeclimate/php-test-reporter": "dev-master",
+    "sebastian/phpcpd": "*"
+  }
+}

+API Index
+=========
+
+* PAGI
+    * PAGI\Application
+        * [PAGIApplication](PAGI-Application-PAGIApplication.md)
+    * PAGI\CallerId
+        * [ICallerId](PAGI-CallerId-ICallerId.md)
+        * PAGI\CallerId\Impl
+            * [CallerIdFacade](PAGI-CallerId-Impl-CallerIdFacade.md)
+    * PAGI\CallSpool
+        * [CallFile](PAGI-CallSpool-CallFile.md)
+        * PAGI\CallSpool\Exception
+            * [CallSpoolException](PAGI-CallSpool-Exception-CallSpoolException.md)
+        * [ICallSpool](PAGI-CallSpool-ICallSpool.md)
+        * PAGI\CallSpool\Impl
+            * [CallSpoolImpl](PAGI-CallSpool-Impl-CallSpoolImpl.md)
+    * PAGI\CDR
+        * [ICDR](PAGI-CDR-ICDR.md)
+        * PAGI\CDR\Impl
+            * [CDRFacade](PAGI-CDR-Impl-CDRFacade.md)
+    * PAGI\ChannelVariables
+        * [IChannelVariables](PAGI-ChannelVariables-IChannelVariables.md)
+        * PAGI\ChannelVariables\Impl
+            * [ChannelVariablesFacade](PAGI-ChannelVariables-Impl-ChannelVariablesFacade.md)
+    * PAGI\Client
+        * [AbstractClient](PAGI-Client-AbstractClient.md)
+        * [ChannelStatus](PAGI-Client-ChannelStatus.md)
+        * [IClient](PAGI-Client-IClient.md)
+        * PAGI\Client\Impl
+            * [ClientImpl](PAGI-Client-Impl-ClientImpl.md)
+            * [MockedClientImpl](PAGI-Client-Impl-MockedClientImpl.md)
+        * PAGI\Client\Result
+            * [AmdResult](PAGI-Client-Result-AmdResult.md)
+            * [DataReadResult](PAGI-Client-Result-DataReadResult.md)
+            * [DialResult](PAGI-Client-Result-DialResult.md)
+            * [DigitReadResult](PAGI-Client-Result-DigitReadResult.md)
+            * [ExecResult](PAGI-Client-Result-ExecResult.md)
+            * [FaxResult](PAGI-Client-Result-FaxResult.md)
+            * [IReadResult](PAGI-Client-Result-IReadResult.md)
+            * [IResult](PAGI-Client-Result-IResult.md)
+            * [PlayResult](PAGI-Client-Result-PlayResult.md)
+            * [ReadResultDecorator](PAGI-Client-Result-ReadResultDecorator.md)
+            * [RecordResult](PAGI-Client-Result-RecordResult.md)
+            * [Result](PAGI-Client-Result-Result.md)
+            * [ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+    * PAGI\DialDescriptor
+        * [DAHDIDialDescriptor](PAGI-DialDescriptor-DAHDIDialDescriptor.md)
+        * [DialDescriptor](PAGI-DialDescriptor-DialDescriptor.md)
+        * [LocalDialDescriptor](PAGI-DialDescriptor-LocalDialDescriptor.md)
+        * [SIPDialDescriptor](PAGI-DialDescriptor-SIPDialDescriptor.md)
+    * PAGI\Exception
+        * [ChannelDownException](PAGI-Exception-ChannelDownException.md)
+        * [DatabaseInvalidEntryException](PAGI-Exception-DatabaseInvalidEntryException.md)
+        * [ExecuteCommandException](PAGI-Exception-ExecuteCommandException.md)
+        * [InvalidCommandException](PAGI-Exception-InvalidCommandException.md)
+        * [MockedException](PAGI-Exception-MockedException.md)
+        * [PAGIException](PAGI-Exception-PAGIException.md)
+        * [RecordException](PAGI-Exception-RecordException.md)
+        * [SoundFileException](PAGI-Exception-SoundFileException.md)
+    * PAGI\Logger
+        * PAGI\Logger\Asterisk
+            * [IAsteriskLogger](PAGI-Logger-Asterisk-IAsteriskLogger.md)
+            * PAGI\Logger\Asterisk\Impl
+                * [AsteriskLoggerImpl](PAGI-Logger-Asterisk-Impl-AsteriskLoggerImpl.md)
+                * [MockedAsteriskLoggerImpl](PAGI-Logger-Asterisk-Impl-MockedAsteriskLoggerImpl.md)
+    * PAGI\Node
+        * PAGI\Node\Exception
+            * [NodeException](PAGI-Node-Exception-NodeException.md)
+        * [MockedNode](PAGI-Node-MockedNode.md)
+        * [Node](PAGI-Node-Node.md)
+        * [NodeActionCommand](PAGI-Node-NodeActionCommand.md)
+        * [NodeController](PAGI-Node-NodeController.md)
+

+PAGI\Application\PAGIApplication
+===============
+
+Parent class for all PAGIApplications.
+
+PHP Version 5
+
+
+* Class name: PAGIApplication
+* Namespace: PAGI\Application
+* This is an **abstract** class
+
+
+
+
+
+Properties
+----------
+
+
+### $logger
+
+    protected \PAGI\Application\Logger $logger
+
+PSR-3 logger.
+
+
+
+* Visibility: **protected**
+
+
+### $agiClient
+
+    private \PAGI\Client\IClient $agiClient
+
+AGI Client.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### init
+
+    void PAGI\Application\PAGIApplication::init()
+
+Called to initialize the application
+
+
+
+* Visibility: **public**
+* This method is **abstract**.
+
+
+
+
+### shutdown
+
+    void PAGI\Application\PAGIApplication::shutdown()
+
+Called when PHPvm is shutting down.
+
+
+
+* Visibility: **public**
+* This method is **abstract**.
+
+
+
+
+### run
+
+    void PAGI\Application\PAGIApplication::run()
+
+Called to run the application, after calling init().
+
+
+
+* Visibility: **public**
+* This method is **abstract**.
+
+
+
+
+### errorHandler
+
+    boolean PAGI\Application\PAGIApplication::errorHandler(integer $type, string $message, string $file, integer $line)
+
+Your error handler. Be careful when implementing this one.
+
+
+
+* Visibility: **public**
+* This method is **abstract**.
+
+
+#### Arguments
+* $type **integer** - <p>PHP Error type constant.</p>
+* $message **string** - <p>Human readable error message string.</p>
+* $file **string** - <p>File that triggered the error.</p>
+* $line **integer** - <p>Line that triggered the error.</p>
+
+
+
+### signalHandler
+
+    void PAGI\Application\PAGIApplication::signalHandler(integer $signal)
+
+Your signal handler. Be careful when implementing this one.
+
+
+
+* Visibility: **public**
+* This method is **abstract**.
+
+
+#### Arguments
+* $signal **integer** - <p>Signal catched.</p>
+
+
+
+### getAgi
+
+    \PAGI\Client\IClient PAGI\Application\PAGIApplication::getAgi()
+
+Returns AGI Client.
+
+
+
+* Visibility: **protected**
+
+
+
+
+### setLogger
+
+    void PAGI\Application\PAGIApplication::setLogger(\PAGI\Application\Psr\Log\LoggerInterface $logger)
+
+Sets the logger implementation.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $logger **PAGI\Application\Psr\Log\LoggerInterface** - <p>The PSR3-Logger</p>
+
+
+
+### __construct
+
+    void PAGI\Application\PAGIApplication::__construct(array $properties)
+
+Constructor. Will call set_error_handler() and pcntl_signal() to setup
+your errorHandler() and signalHandler(). Also will call
+register_shutdown_function() to register your shutdown() function.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $properties **array** - <p>Optional additional properties.</p>
+
+

+PAGI\CDR\ICDR
+===============
+
+CDR facade. Use this to access cdr variables.
+
+PHP Version 5
+
+
+* Interface name: ICDR
+* Namespace: PAGI\CDR
+* This is an **interface**
+
+
+
+
+
+
+Methods
+-------
+
+
+### setUserfield
+
+    void PAGI\CDR\ICDR::setUserfield(string $value)
+
+Set userfileds for cdr. CDR(userfield).
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>New userfields to use.</p>
+
+
+
+### getUserfield
+
+    string PAGI\CDR\ICDR::getUserfield()
+
+The channels uses specified field (read-write). CDR(userfield).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getUniqueId
+
+    string PAGI\CDR\ICDR::getUniqueId()
+
+The channel uniqueid. CDR(uniqueid).
+
+
+
+* Visibility: **public**
+
+
+
+
+### setAccountCode
+
+    void PAGI\CDR\ICDR::setAccountCode(string $value)
+
+Sets account code. CDR(accountcode).
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>New account code.</p>
+
+
+
+### getAccountCode
+
+    string PAGI\CDR\ICDR::getAccountCode()
+
+The channel account code. CDR(accountcode).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getAMAFlags
+
+    string PAGI\CDR\ICDR::getAMAFlags()
+
+DOCUMENTATION, BILL, IGNORE etc. CDR(amaflags).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getStatus
+
+    string PAGI\CDR\ICDR::getStatus()
+
+Call result. CDR(disposition).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getAnswerLength
+
+    string PAGI\CDR\ICDR::getAnswerLength()
+
+Total answered time for the call in seconds. CDR(billsec).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getTotalLength
+
+    string PAGI\CDR\ICDR::getTotalLength()
+
+Total length of the call in seconds. CDR(duration).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getEndTime
+
+    string PAGI\CDR\ICDR::getEndTime()
+
+Time the call ended. CDR(end).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getAnswerTime
+
+    string PAGI\CDR\ICDR::getAnswerTime()
+
+Time the call was answered. CDR(answer).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getStartTime
+
+    string PAGI\CDR\ICDR::getStartTime()
+
+Time the call started. CDR(start).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getLastAppData
+
+    string PAGI\CDR\ICDR::getLastAppData()
+
+Returns Last application data. CDR(lastdata).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getLastApp
+
+    string PAGI\CDR\ICDR::getLastApp()
+
+Returns Last application. CDR(lastapp).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getChannel
+
+    string PAGI\CDR\ICDR::getChannel()
+
+Returns origin channel. CDR(channel).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getDestinationChannel
+
+    string PAGI\CDR\ICDR::getDestinationChannel()
+
+Returns destination channel. CDR(dstchannel).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getCallerId
+
+    string PAGI\CDR\ICDR::getCallerId()
+
+Returns caller id. CDR(clid).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getSource
+
+    string PAGI\CDR\ICDR::getSource()
+
+Returns origin. CDR(src).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getDestination
+
+    string PAGI\CDR\ICDR::getDestination()
+
+Returns destination. CDR(dst).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getDestinationContext
+
+    string PAGI\CDR\ICDR::getDestinationContext()
+
+Returns destination context. CDR(dcontext).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getCustom
+
+    string PAGI\CDR\ICDR::getCustom(string $name)
+
+Returns a custom field in the cdr. CDR(name)
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $name **string** - <p>Field name.</p>
+
+
+
+### setCustom
+
+    void PAGI\CDR\ICDR::setCustom(string $name, string $value)
+
+Sets a custom field in the cdr. CDR(name).
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $name **string** - <p>Field name.</p>
+* $value **string** - <p>Field value.</p>
+
+

+PAGI\CDR\Impl\CDRFacade
+===============
+
+CDR Facade.
+
+If the channel has a cdr, that cdr record has it's own set of variables which
+can be accessed just like channel variables. The following builtin variables
+are available and, unless specified, read-only.
+
+${CDR(clid)}  Caller ID
+${CDR(src)}   Source
+${CDR(dst)}   Destination
+${CDR(dcontext)}  Destination context
+${CDR(channel)}   Channel name
+${CDR(dstchannel)}    Destination channel
+${CDR(lastapp)}   Last app executed
+${CDR(lastdata)}  Last app's arguments
+${CDR(start)}     Time the call started.
+${CDR(answer)}    Time the call was answered.
+${CDR(end)}   Time the call ended.
+${CDR(duration)}  Duration of the call.
+${CDR(billsec)}   Duration of the call once it was answered.
+${CDR(disposition)}   ANSWERED, NO ANSWER, BUSY
+${CDR(amaflags)}  DOCUMENTATION, BILL, IGNORE etc
+${CDR(accountcode)}   The channel's account code (read-write).
+${CDR(uniqueid)}  The channel's unique id.
+${CDR(userfield)}     The channels uses specified field (read-write).
+
+
+In addition, you can set your own extra variables with a traditional
+Set(CDR(var)=val) to anything you want.
+
+NOTE Some CDR values (eg: duration & billsec) can't be accessed until the call
+has terminated. As of 91617, those values will be calculated on-demand if
+requested. Until that makes it into a stable release, you can set
+endbeforehexten=yes in cdr.conf, and then use the "hangup" context to wrap
+up your call.
+
+PHP Version 5
+
+
+* Class name: CDRFacade
+* Namespace: PAGI\CDR\Impl
+* This class implements: [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+Properties
+----------
+
+
+### $client
+
+    private \PAGI\Client\IClient $client
+
+AGI Client, needed to access cdr data.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### setUserfield
+
+    void PAGI\CDR\ICDR::setUserfield(string $value)
+
+Set userfileds for cdr. CDR(userfield).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+#### Arguments
+* $value **string** - <p>New userfields to use.</p>
+
+
+
+### getUserfield
+
+    string PAGI\CDR\ICDR::getUserfield()
+
+The channels uses specified field (read-write). CDR(userfield).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getUniqueId
+
+    string PAGI\CDR\ICDR::getUniqueId()
+
+The channel uniqueid. CDR(uniqueid).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### setAccountCode
+
+    void PAGI\CDR\ICDR::setAccountCode(string $value)
+
+Sets account code. CDR(accountcode).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+#### Arguments
+* $value **string** - <p>New account code.</p>
+
+
+
+### getAccountCode
+
+    string PAGI\CDR\ICDR::getAccountCode()
+
+The channel account code. CDR(accountcode).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getAMAFlags
+
+    string PAGI\CDR\ICDR::getAMAFlags()
+
+DOCUMENTATION, BILL, IGNORE etc. CDR(amaflags).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getStatus
+
+    string PAGI\CDR\ICDR::getStatus()
+
+Call result. CDR(disposition).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getAnswerLength
+
+    string PAGI\CDR\ICDR::getAnswerLength()
+
+Total answered time for the call in seconds. CDR(billsec).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getTotalLength
+
+    string PAGI\CDR\ICDR::getTotalLength()
+
+Total length of the call in seconds. CDR(duration).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getEndTime
+
+    string PAGI\CDR\ICDR::getEndTime()
+
+Time the call ended. CDR(end).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getAnswerTime
+
+    string PAGI\CDR\ICDR::getAnswerTime()
+
+Time the call was answered. CDR(answer).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getStartTime
+
+    string PAGI\CDR\ICDR::getStartTime()
+
+Time the call started. CDR(start).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getLastAppData
+
+    string PAGI\CDR\ICDR::getLastAppData()
+
+Returns Last application data. CDR(lastdata).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getLastApp
+
+    string PAGI\CDR\ICDR::getLastApp()
+
+Returns Last application. CDR(lastapp).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getChannel
+
+    string PAGI\CDR\ICDR::getChannel()
+
+Returns origin channel. CDR(channel).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getDestinationChannel
+
+    string PAGI\CDR\ICDR::getDestinationChannel()
+
+Returns destination channel. CDR(dstchannel).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getCallerId
+
+    string PAGI\CDR\ICDR::getCallerId()
+
+Returns caller id. CDR(clid).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getSource
+
+    string PAGI\CDR\ICDR::getSource()
+
+Returns origin. CDR(src).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getDestination
+
+    string PAGI\CDR\ICDR::getDestination()
+
+Returns destination. CDR(dst).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getDestinationContext
+
+    string PAGI\CDR\ICDR::getDestinationContext()
+
+Returns destination context. CDR(dcontext).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+
+
+### getCustom
+
+    string PAGI\CDR\ICDR::getCustom(string $name)
+
+Returns a custom field in the cdr. CDR(name)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+#### Arguments
+* $name **string** - <p>Field name.</p>
+
+
+
+### setCustom
+
+    void PAGI\CDR\ICDR::setCustom(string $name, string $value)
+
+Sets a custom field in the cdr. CDR(name).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CDR\ICDR](PAGI-CDR-ICDR.md)
+
+
+#### Arguments
+* $name **string** - <p>Field name.</p>
+* $value **string** - <p>Field value.</p>
+
+
+
+### getCDRVariable
+
+    string PAGI\CDR\Impl\CDRFacade::getCDRVariable(string $name)
+
+Access AGI client to get the variables.
+
+
+
+* Visibility: **protected**
+
+
+#### Arguments
+* $name **string** - <p>Variable name.</p>
+
+
+
+### setCDRVariable
+
+    void PAGI\CDR\Impl\CDRFacade::setCDRVariable(string $name, string $value)
+
+Access AGI client to set the variable.
+
+
+
+* Visibility: **protected**
+
+
+#### Arguments
+* $name **string** - <p>Variable name.</p>
+* $value **string** - <p>Value.</p>
+
+
+
+### __construct
+
+    void PAGI\CDR\Impl\CDRFacade::__construct(\PAGI\Client\IClient $client)
+
+Constructor.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $client **[PAGI\Client\IClient](PAGI-Client-IClient.md)** - <p>AGI Client.</p>
+
+

+PAGI\CallSpool\CallFile
+===============
+
+A call file facade.
+
+PHP Version 5
+
+
+* Class name: CallFile
+* Namespace: PAGI\CallSpool
+
+
+
+
+
+Properties
+----------
+
+
+### $parameters
+
+    private array<mixed,string> $parameters
+
+Parameters.
+
+
+
+* Visibility: **private**
+
+
+### $variables
+
+    private array<mixed,string> $variables
+
+Variables.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### getParameter
+
+    string PAGI\CallSpool\CallFile::getParameter(string $key)
+
+Returns the value for the given parameter.
+
+
+
+* Visibility: **protected**
+
+
+#### Arguments
+* $key **string** - &lt;p&gt;Parameter name.&lt;/p&gt;
+
+
+
+### setParameter
+
+    void PAGI\CallSpool\CallFile::setParameter(string $key, string $value)
+
+Sets a given parameter with the given value.
+
+
+
+* Visibility: **protected**
+
+
+#### Arguments
+* $key **string** - &lt;p&gt;Parameter name.&lt;/p&gt;
+* $value **string** - &lt;p&gt;Value.&lt;/p&gt;
+
+
+
+### getVariable
+
+    string PAGI\CallSpool\CallFile::getVariable(string $key)
+
+Returns the value for the given variable.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $key **string** - &lt;p&gt;Variable name.&lt;/p&gt;
+
+
+
+### setVariable
+
+    void PAGI\CallSpool\CallFile::setVariable(string $key, string $value)
+
+Sets a given variable with the given value.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $key **string** - &lt;p&gt;Variable name.&lt;/p&gt;
+* $value **string** - &lt;p&gt;Value.&lt;/p&gt;
+
+
+
+### getChannel
+
+    string PAGI\CallSpool\CallFile::getChannel()
+
+Returns channel to use for the call.
+
+
+
+* Visibility: **public**
+
+
+
+
+### getCallerId
+
+    string PAGI\CallSpool\CallFile::getCallerId()
+
+Returns Caller ID, Please note: It may not work if you do not respect
+the format: CallerID: "Some Name" <1234>
+
+
+
+* Visibility: **public**
+
+
+
+
+### setCallerId
+
+    void PAGI\CallSpool\CallFile::setCallerId(string $value)
+
+Sets the Caller ID, Please note: It may not work if you do not respect
+the format: CallerID: "Some Name" <1234>
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getWaitTime
+
+    integer PAGI\CallSpool\CallFile::getWaitTime()
+
+Returns seconds to wait for an answer. Default is 45.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setWaitTime
+
+    void PAGI\CallSpool\CallFile::setWaitTime(integer $value)
+
+Sets seconds to wait for an answer. Default is 45.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **integer** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getMaxRetries
+
+    integer PAGI\CallSpool\CallFile::getMaxRetries()
+
+Returns number of retries before failing (not including the initial
+attempt, e.g. 0 = total of 1 attempt to make the call). Default is 0.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setMaxRetries
+
+    void PAGI\CallSpool\CallFile::setMaxRetries(integer $value)
+
+Sets number of retries before failing (not including the initial
+attempt, e.g. 0 = total of 1 attempt to make the call). Default is 0.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **integer** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getRetryTime
+
+    integer PAGI\CallSpool\CallFile::getRetryTime()
+
+Returns seconds between retries, Don't hammer an unavailable phone.
+
+Default is 300 (5 min).
+
+* Visibility: **public**
+
+
+
+
+### setRetryTime
+
+    void PAGI\CallSpool\CallFile::setRetryTime(integer $value)
+
+Sets seconds between retries, Don't hammer an unavailable phone.
+
+Default is 300 (5 min).
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **integer** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getAccount
+
+    string PAGI\CallSpool\CallFile::getAccount()
+
+Returns account code to use for this call.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setAccount
+
+    void PAGI\CallSpool\CallFile::setAccount(string $value)
+
+Sets account code to use for this call.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getContext
+
+    string PAGI\CallSpool\CallFile::getContext()
+
+Returns context to use for this call when answered.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setContext
+
+    void PAGI\CallSpool\CallFile::setContext(string $value)
+
+Sets context to use for this call when answered.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getPriority
+
+    string PAGI\CallSpool\CallFile::getPriority()
+
+Returns priority to use for this call when answered.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setPriority
+
+    void PAGI\CallSpool\CallFile::setPriority(string $value)
+
+Sets priority to use for this call when answered.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getExtension
+
+    string PAGI\CallSpool\CallFile::getExtension()
+
+Returns extension to use for this call when answered.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setExtension
+
+    void PAGI\CallSpool\CallFile::setExtension(string $value)
+
+Sets extension to use for this call when answered.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getApplication
+
+    string PAGI\CallSpool\CallFile::getApplication()
+
+Returns Asterisk Application to run (use instead of specifiying context,
+extension and priority)
+
+
+
+* Visibility: **public**
+
+
+
+
+### setApplication
+
+    void PAGI\CallSpool\CallFile::setApplication(string $value)
+
+Sets Asterisk Application to run (use instead of specifiying context,
+extension and priority)
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getApplicationData
+
+    string PAGI\CallSpool\CallFile::getApplicationData()
+
+Returns the options to be passed to application.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setApplicationData
+
+    void PAGI\CallSpool\CallFile::setApplicationData(array $options)
+
+Sets the options to be passed to application.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $options **array**
+
+
+
+### getAlwaysDelete
+
+    boolean PAGI\CallSpool\CallFile::getAlwaysDelete()
+
+If the file's modification time is in the future, the call file will not
+be deleted
+
+
+
+* Visibility: **public**
+
+
+
+
+### setAlwaysDelete
+
+    void PAGI\CallSpool\CallFile::setAlwaysDelete(boolean $value)
+
+If the file's modification time is in the future, the call file will not
+be deleted
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **boolean** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### getArchive
+
+    boolean PAGI\CallSpool\CallFile::getArchive()
+
+Sets if should move to subdir "outgoing_done" with "Status: value",
+where value can be Completed, Expired or Failed.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setArchive
+
+    void PAGI\CallSpool\CallFile::setArchive(boolean $value)
+
+Sets if should move to subdir "outgoing_done" with "Status: value",
+where value can be Completed, Expired or Failed.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **boolean** - &lt;p&gt;Value to set.&lt;/p&gt;
+
+
+
+### serialize
+
+    string PAGI\CallSpool\CallFile::serialize()
+
+Returns the text describing this call file, ready to be spooled.
+
+
+
+* Visibility: **public**
+
+
+
+
+### unserialize
+
+    void PAGI\CallSpool\CallFile::unserialize(string $text)
+
+Deconstructs a call file from the given text.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $text **string** - &lt;p&gt;A call file (intended to be pre-loaded, with
+file_get_contents() or similar).&lt;/p&gt;
+
+
+
+### __construct
+
+    void PAGI\CallSpool\CallFile::__construct(\PAGI\DialDescriptor\DialDescriptor $dialDescriptor)
+
+Constructor.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $dialDescriptor **[PAGI\DialDescriptor\DialDescriptor](PAGI-DialDescriptor-DialDescriptor.md)**
+
+

+PAGI\CallSpool\Exception\CallSpoolException
+===============
+
+This exception indicates an error related to the call spool.
+
+PHP Version 5
+
+
+* Class name: CallSpoolException
+* Namespace: PAGI\CallSpool\Exception
+* Parent class: [PAGI\Exception\PAGIException](PAGI-Exception-PAGIException.md)
+
+
+
+
+
+
+
+

+PAGI\CallSpool\ICallSpool
+===============
+
+An interface to access asterisk call spool.
+
+PHP Version 5
+
+
+* Interface name: ICallSpool
+* Namespace: PAGI\CallSpool
+* This is an **interface**
+
+
+
+
+
+
+Methods
+-------
+
+
+### spool
+
+    void PAGI\CallSpool\ICallSpool::spool(\PAGI\CallSpool\CallFile $call, integer $schedule)
+
+Spools the given call.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $call **[PAGI\CallSpool\CallFile](PAGI-CallSpool-CallFile.md)** - <p>Call to spool.</p>
+* $schedule **integer** - <p>Optional unix timestamp to schedule the call.</p>
+
+

+PAGI\CallSpool\Impl\CallSpoolImpl
+===============
+
+An implementation for asterisk call spool.
+
+PHP Version 5
+
+
+* Class name: CallSpoolImpl
+* Namespace: PAGI\CallSpool\Impl
+* This class implements: [PAGI\CallSpool\ICallSpool](PAGI-CallSpool-ICallSpool.md)
+
+
+
+
+Properties
+----------
+
+
+### $tmpDir
+
+    private string $tmpDir = '/tmp'
+
+Where to temporary generate call files.
+
+
+
+* Visibility: **private**
+
+
+### $spoolDir
+
+    private string $spoolDir = '/var/spool/asterisk'
+
+Asterisk spool directory.
+
+
+
+* Visibility: **private**
+
+
+### $instance
+
+    private \PAGI\CallSpool\Impl\CallSpoolImpl $instance = false
+
+Current instance.
+
+
+
+* Visibility: **private**
+* This property is **static**.
+
+
+Methods
+-------
+
+
+### getInstance
+
+    \PAGI\CallSpool\Impl\CallSpoolImpl PAGI\CallSpool\Impl\CallSpoolImpl::getInstance(array<mixed,string> $options)
+
+Returns an instance for this spool/
+
+
+
+* Visibility: **public**
+* This method is **static**.
+
+
+#### Arguments
+* $options **array&lt;mixed,string&gt;** - &lt;p&gt;Configuration options.&lt;/p&gt;
+
+
+
+### spool
+
+    void PAGI\CallSpool\ICallSpool::spool(\PAGI\CallSpool\CallFile $call, integer $schedule)
+
+Spools the given call.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallSpool\ICallSpool](PAGI-CallSpool-ICallSpool.md)
+
+
+#### Arguments
+* $call **[PAGI\CallSpool\CallFile](PAGI-CallSpool-CallFile.md)** - &lt;p&gt;Call to spool.&lt;/p&gt;
+* $schedule **integer** - &lt;p&gt;Optional unix timestamp to schedule the call.&lt;/p&gt;
+
+
+
+### __construct
+
+    void PAGI\CallSpool\Impl\CallSpoolImpl::__construct(array<mixed,string> $options)
+
+Constructor.
+
+
+
+* Visibility: **private**
+
+
+#### Arguments
+* $options **array&lt;mixed,string&gt;** - &lt;p&gt;Options for this spool.&lt;/p&gt;
+
+

+PAGI\CallerId\ICallerId
+===============
+
+AGI Caller id facade.
+
+PHP Version 5
+
+
+* Interface name: ICallerId
+* Namespace: PAGI\CallerId
+* This is an **interface**
+
+
+
+
+
+
+Methods
+-------
+
+
+### setANI
+
+    void PAGI\CallerId\ICallerId::setANI(string $value)
+
+Sets caller id ani. CALLERID(ani).
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>ANI.</p>
+
+
+
+### getANI
+
+    string PAGI\CallerId\ICallerId::getANI()
+
+Returns caller id ani. CALLERID(ani)
+
+
+
+* Visibility: **public**
+
+
+
+
+### setDNID
+
+    void PAGI\CallerId\ICallerId::setDNID(string $value)
+
+Sets caller id dnid. CALLERID(dnid)
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>DNID.</p>
+
+
+
+### getDNID
+
+    string PAGI\CallerId\ICallerId::getDNID()
+
+Returns caller id dnid. CALLERID(dnid)
+
+
+
+* Visibility: **public**
+
+
+
+
+### setRDNIS
+
+    void PAGI\CallerId\ICallerId::setRDNIS(string $value)
+
+Sets caller id rdnis. CALLERID(rdnis)
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>RDNIS.</p>
+
+
+
+### getRDNIS
+
+    string PAGI\CallerId\ICallerId::getRDNIS()
+
+Returns caller id rdnis. CALLERID(rdnis)
+
+
+
+* Visibility: **public**
+
+
+
+
+### setName
+
+    void PAGI\CallerId\ICallerId::setName(string $value)
+
+Sets caller id name. CALLERID(name)
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>Name.</p>
+
+
+
+### getName
+
+    string PAGI\CallerId\ICallerId::getName()
+
+Returns caller id name. CALLERID(name)
+
+
+
+* Visibility: **public**
+
+
+
+
+### getNumber
+
+    string PAGI\CallerId\ICallerId::getNumber()
+
+Returns caller id number. CALLERID(num)
+
+
+
+* Visibility: **public**
+
+
+
+
+### setNumber
+
+    void PAGI\CallerId\ICallerId::setNumber(string $value)
+
+Sets caller id number. CALLERID(num)
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>Number.</p>
+
+
+
+### setCallerPres
+
+    void PAGI\CallerId\ICallerId::setCallerPres(string $presentationMode)
+
+Changes the caller id presentation mode.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $presentationMode **string** - <p>Can be one of:
+allowed_not_screened - Presentation Allowed, Not Screened.
+allowed_passed_screen - Presentation Allowed, Passed Screen.
+allowed_failed_screen - Presentation Allowed, Failed Screen.
+allowed - Presentation Allowed, Network Number.
+prohib_not_screened - Presentation Prohibited, Not Screened.
+prohib_passed_screen - Presentation Prohibited, Passed Screen.
+prohib_failed_screen - Presentation Prohibited, Failed Screen.
+prohib - Presentation Prohibited, Network Number.
+unavailable - Number Unavailable.</p>
+
+

+PAGI\CallerId\Impl\CallerIdFacade
+===============
+
+AGI Caller id facade.
+
+PHP Version 5
+
+
+* Class name: CallerIdFacade
+* Namespace: PAGI\CallerId\Impl
+* This class implements: [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+
+
+Properties
+----------
+
+
+### $client
+
+    private \PAGI\Client\IClient $client
+
+Instance of client to access caller id variables.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### setANI
+
+    void PAGI\CallerId\ICallerId::setANI(string $value)
+
+Sets caller id ani. CALLERID(ani).
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+#### Arguments
+* $value **string** - <p>ANI.</p>
+
+
+
+### getANI
+
+    string PAGI\CallerId\ICallerId::getANI()
+
+Returns caller id ani. CALLERID(ani)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+
+
+### setDNID
+
+    void PAGI\CallerId\ICallerId::setDNID(string $value)
+
+Sets caller id dnid. CALLERID(dnid)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+#### Arguments
+* $value **string** - <p>DNID.</p>
+
+
+
+### getDNID
+
+    string PAGI\CallerId\ICallerId::getDNID()
+
+Returns caller id dnid. CALLERID(dnid)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+
+
+### setRDNIS
+
+    void PAGI\CallerId\ICallerId::setRDNIS(string $value)
+
+Sets caller id rdnis. CALLERID(rdnis)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+#### Arguments
+* $value **string** - <p>RDNIS.</p>
+
+
+
+### getRDNIS
+
+    string PAGI\CallerId\ICallerId::getRDNIS()
+
+Returns caller id rdnis. CALLERID(rdnis)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+
+
+### setName
+
+    void PAGI\CallerId\ICallerId::setName(string $value)
+
+Sets caller id name. CALLERID(name)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+#### Arguments
+* $value **string** - <p>Name.</p>
+
+
+
+### getName
+
+    string PAGI\CallerId\ICallerId::getName()
+
+Returns caller id name. CALLERID(name)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+
+
+### getNumber
+
+    string PAGI\CallerId\ICallerId::getNumber()
+
+Returns caller id number. CALLERID(num)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+
+
+### setNumber
+
+    void PAGI\CallerId\ICallerId::setNumber(string $value)
+
+Sets caller id number. CALLERID(num)
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+#### Arguments
+* $value **string** - <p>Number.</p>
+
+
+
+### getCallerIdVariable
+
+    string PAGI\CallerId\Impl\CallerIdFacade::getCallerIdVariable(string $name)
+
+Access AGI client to get the variables.
+
+
+
+* Visibility: **protected**
+
+
+#### Arguments
+* $name **string** - <p>Variable name.</p>
+
+
+
+### setCallerIdVariable
+
+    void PAGI\CallerId\Impl\CallerIdFacade::setCallerIdVariable(string $name, string $value)
+
+Access AGI client to set the variable.
+
+
+
+* Visibility: **protected**
+
+
+#### Arguments
+* $name **string** - <p>Variable name.</p>
+* $value **string** - <p>Value.</p>
+
+
+
+### setCallerPres
+
+    void PAGI\CallerId\ICallerId::setCallerPres(string $presentationMode)
+
+Changes the caller id presentation mode.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\CallerId\ICallerId](PAGI-CallerId-ICallerId.md)
+
+
+#### Arguments
+* $presentationMode **string** - <p>Can be one of:
+allowed_not_screened - Presentation Allowed, Not Screened.
+allowed_passed_screen - Presentation Allowed, Passed Screen.
+allowed_failed_screen - Presentation Allowed, Failed Screen.
+allowed - Presentation Allowed, Network Number.
+prohib_not_screened - Presentation Prohibited, Not Screened.
+prohib_passed_screen - Presentation Prohibited, Passed Screen.
+prohib_failed_screen - Presentation Prohibited, Failed Screen.
+prohib - Presentation Prohibited, Network Number.
+unavailable - Number Unavailable.</p>
+
+
+
+### __toString
+
+    string PAGI\CallerId\Impl\CallerIdFacade::__toString()
+
+Standard procedure.
+
+
+
+* Visibility: **public**
+
+
+
+
+### __construct
+
+    void PAGI\CallerId\Impl\CallerIdFacade::__construct(\PAGI\Client\IClient $client)
+
+Constructor.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $client **[PAGI\Client\IClient](PAGI-Client-IClient.md)** - <p>AGI Client to use.</p>
+
+

+PAGI\ChannelVariables\IChannelVariables
+===============
+
+ChannelVariables facade. Use this to access channel variables.
+
+PHP Version 5
+
+
+* Interface name: IChannelVariables
+* Namespace: PAGI\ChannelVariables
+* This is an **interface**
+
+
+
+
+
+
+Methods
+-------
+
+
+### getChannel
+
+    string PAGI\ChannelVariables\IChannelVariables::getChannel()
+
+Returns channel (agi_channel).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getLanguage
+
+    string PAGI\ChannelVariables\IChannelVariables::getLanguage()
+
+Returns language (agi_language).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getType
+
+    string PAGI\ChannelVariables\IChannelVariables::getType()
+
+Returns channel type (agi_type).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getUniqueId
+
+    string PAGI\ChannelVariables\IChannelVariables::getUniqueId()
+
+Returns channel uniqueid (agi_uniqueid).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getVersion
+
+    string PAGI\ChannelVariables\IChannelVariables::getVersion()
+
+Returns asterisk version (agi_version).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getCallerId
+
+    string PAGI\ChannelVariables\IChannelVariables::getCallerId()
+
+Returns caller id number (agi_callerid).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getCallerIdName
+
+    string PAGI\ChannelVariables\IChannelVariables::getCallerIdName()
+
+Returns caller id name (agi_calleridname).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getCallingPres
+
+    string PAGI\ChannelVariables\IChannelVariables::getCallingPres()
+
+Returns CallingPres (agi_callingpres).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getCallingAni2
+
+    string PAGI\ChannelVariables\IChannelVariables::getCallingAni2()
+
+Returns CallingAni (agi_callingani2).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getCallingTon
+
+    string PAGI\ChannelVariables\IChannelVariables::getCallingTon()
+
+Returns CallingTon (agi_callington).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getCallingTns
+
+    string PAGI\ChannelVariables\IChannelVariables::getCallingTns()
+
+Returns CallingTns (agi_callingtns).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getDNID
+
+    string PAGI\ChannelVariables\IChannelVariables::getDNID()
+
+Returns DNID (agi_dnid).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getContext
+
+    string PAGI\ChannelVariables\IChannelVariables::getContext()
+
+Returns context (agi_context).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getRDNIS
+
+    string PAGI\ChannelVariables\IChannelVariables::getRDNIS()
+
+Returns RDNIS (agi_rdnis).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getRequest
+
+    string PAGI\ChannelVariables\IChannelVariables::getRequest()
+
+Returns agi requested (agi_request).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getDNIS
+
+    string PAGI\ChannelVariables\IChannelVariables::getDNIS()
+
+Returns extension dialed (dnis) (agi_extension).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getThreadId
+
+    string PAGI\ChannelVariables\IChannelVariables::getThreadId()
+
+Returns thread id (agi_threadid).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getAccountCode
+
+    string PAGI\ChannelVariables\IChannelVariables::getAccountCode()
+
+Returns account code (agi_accountcode).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getEnhanced
+
+    string PAGI\ChannelVariables\IChannelVariables::getEnhanced()
+
+Returns if using enhanced (agi_enhanced).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getPriority
+
+    string PAGI\ChannelVariables\IChannelVariables::getPriority()
+
+Returns context priority (agi_priority).
+
+
+
+* Visibility: **public**
+
+
+
+
+### getTotalArguments
+
+    integer PAGI\ChannelVariables\IChannelVariables::getTotalArguments()
+
+Returns total number of agi arguments.
+
+
+
+* Visibility: **public**
+
+
+
+
+### getArgument
+
+    string PAGI\ChannelVariables\IChannelVariables::getArgument(integer $index)
+
+Returns the given agi argument. (agi_arg_N).
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $index **integer** - <p>Argument number, starting with 0.</p>
+
+
+
+### getArguments
+
+    array<mixed,string> PAGI\ChannelVariables\IChannelVariables::getArguments()
+
+Returns all arguments as an array.
+
+
+
+* Visibility: **public**
+
+
+
+
+### getDirectoryConfig
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectoryConfig()
+
+Returns the config directory for this running version of asterisk.
+
+Uses environment variable AST_CONFIG_DIR.
+
+* Visibility: **public**
+
+
+
+
+### getConfigFile
+
+    string PAGI\ChannelVariables\IChannelVariables::getConfigFile()
+
+Returns the config file for this running version of asterisk.
+
+Uses environment variable AST_CONFIG_FILE.
+
+* Visibility: **public**
+
+
+
+
+### getDirectoryModules
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectoryModules()
+
+Returns the modules directory for this running version of asterisk.
+
+Uses environment variable AST_MODULE_DIR.
+
+* Visibility: **public**
+
+
+
+
+### getDirectorySpool
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectorySpool()
+
+Returns the spool directory for this running version of asterisk.
+
+Uses environment variable AST_SPOOL_DIR.
+
+* Visibility: **public**
+
+
+
+
+### getDirectoryMonitor
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectoryMonitor()
+
+Returns the monitor directory for this running version of asterisk.
+
+Uses environment variable AST_MONITOR_DIR.
+
+* Visibility: **public**
+
+
+
+
+### getDirectoryVar
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectoryVar()
+
+Returns the var directory for this running version of asterisk.
+
+Uses environment variable AST_VAR_DIR.
+
+* Visibility: **public**
+
+
+
+
+### getDirectoryData
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectoryData()
+
+Returns the data directory for this running version of asterisk.
+
+Uses environment variable AST_DATA_DIR.
+
+* Visibility: **public**
+
+
+
+
+### getDirectoryLog
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectoryLog()
+
+Returns the log directory for this running version of asterisk.
+
+Uses environment variable AST_LOG_DIR.
+
+* Visibility: **public**
+
+
+
+
+### getDirectoryAgi
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectoryAgi()
+
+Returns the agi directory for this running version of asterisk.
+
+Uses environment variable AST_AGI_DIR.
+
+* Visibility: **public**
+
+
+
+
+### getDirectoryKey
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectoryKey()
+
+Returns the key directory for this running version of asterisk.
+
+Uses environment variable AST_KEY_DIR.
+
+* Visibility: **public**
+
+
+
+
+### getDirectoryRun
+
+    string PAGI\ChannelVariables\IChannelVariables::getDirectoryRun()
+
+Returns the run directory for this running version of asterisk.
+
+Uses environment variable AST_RUN_DIR.
+
+* Visibility: **public**
+
+
+

+PAGI\Client\ChannelStatus
+===============
+
+ChannelStatus 'Helper'. See: http://www.voip-info.org/wiki/view/channel+status
+
+PHP Version 5
+
+
+* Class name: ChannelStatus
+* Namespace: PAGI\Client
+
+
+
+Constants
+----------
+
+
+### DOWN_AVAILABLE
+
+    const DOWN_AVAILABLE = 0
+
+
+
+
+
+### DOWN_RESERVED
+
+    const DOWN_RESERVED = 1
+
+
+
+
+
+### OFF_HOOK
+
+    const OFF_HOOK = 2
+
+
+
+
+
+### DIGITS_DIALED
+
+    const DIGITS_DIALED = 3
+
+
+
+
+
+### LINE_RINGING
+
+    const LINE_RINGING = 4
+
+
+
+
+
+### REMOTE_RINGING
+
+    const REMOTE_RINGING = 5
+
+
+
+
+
+### LINE_UP
+
+    const LINE_UP = 6
+
+
+
+
+
+### LINE_BUSY
+
+    const LINE_BUSY = 7
+
+
+
+
+
+
+
+Methods
+-------
+
+
+### toString
+
+    string PAGI\Client\ChannelStatus::toString(integer $status)
+
+This will return the human readable description for the given channel
+status. See class constants. (False if the status is invalid).
+
+
+
+* Visibility: **public**
+* This method is **static**.
+
+
+#### Arguments
+* $status **integer** - <p>Channel status.</p>
+
+

+PAGI\Client\Result\AmdResult
+===============
+
+This decorated result adds the functionality to check for an AMD result.
+
+PHP Version 5
+
+
+* Class name: AmdResult
+* Namespace: PAGI\Client\Result
+* Parent class: [PAGI\Client\Result\ExecResult](PAGI-Client-Result-ExecResult.md)
+
+
+
+
+
+Properties
+----------
+
+
+### $status
+
+    private string $status
+
+Cause
+
+
+
+* Visibility: **private**
+
+
+### $cause
+
+    private string $cause
+
+Cause
+
+
+
+* Visibility: **private**
+
+
+### $result
+
+    private \PAGI\Client\Result\IResult $result
+
+Our decorated result.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### getCause
+
+    string PAGI\Client\Result\AmdResult::getCause()
+
+Returns the cause string.
+
+
+
+* Visibility: **public**
+
+
+
+
+### getStatus
+
+    string PAGI\Client\Result\AmdResult::getStatus()
+
+Returns the status string.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setCause
+
+    void PAGI\Client\Result\AmdResult::setCause(string $cause)
+
+Sets the cause string
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $cause **string**
+
+
+
+### setStatus
+
+    void PAGI\Client\Result\AmdResult::setStatus($status)
+
+Sets the cause string
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $status **mixed**
+
+
+
+### isStatus
+
+    boolean PAGI\Client\Result\AmdResult::isStatus(string $string)
+
+True if the status equals the given string
+
+
+
+* Visibility: **private**
+
+
+#### Arguments
+* $string **string**
+
+
+
+### isCause
+
+    boolean PAGI\Client\Result\AmdResult::isCause(string $string)
+
+True if the cause equals the given string
+
+
+
+* Visibility: **private**
+
+
+#### Arguments
+* $string **string**
+
+
+
+### isMachine
+
+    boolean PAGI\Client\Result\AmdResult::isMachine()
+
+True if AMD detected an answering machine.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isHangup
+
+    boolean PAGI\Client\Result\AmdResult::isHangup()
+
+True if AMD detected a hangup.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isHuman
+
+    boolean PAGI\Client\Result\AmdResult::isHuman()
+
+True if AMD detected a human.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isNotSure
+
+    boolean PAGI\Client\Result\AmdResult::isNotSure()
+
+True if AMD failed detecting an answering machine or human.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isCauseTooLong
+
+    boolean PAGI\Client\Result\AmdResult::isCauseTooLong()
+
+True if AMD status is due to a timeout when detecting.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isCauseInitialSilence
+
+    boolean PAGI\Client\Result\AmdResult::isCauseInitialSilence()
+
+True if AMD status is due to a silence duration.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isCauseHuman
+
+    boolean PAGI\Client\Result\AmdResult::isCauseHuman()
+
+True if AMD status is due to a silence after a greeting.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isCauseGreeting
+
+    boolean PAGI\Client\Result\AmdResult::isCauseGreeting()
+
+True if AMD status is due to a long greeting detected.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isCauseWordLength
+
+    boolean PAGI\Client\Result\AmdResult::isCauseWordLength()
+
+True if AMD status is due to a maximum number of words reached.
+
+
+
+* Visibility: **public**
+
+
+
+
+### __toString
+
+    string PAGI\Client\Result\ResultDecorator::__toString()
+
+Standard procedure.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+
+
+### __construct
+
+    void PAGI\Client\Result\ResultDecorator::__construct(\PAGI\Client\Result\IResult $result)
+
+Constructor.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+#### Arguments
+* $result **[PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)** - <p>Result to decorate.</p>
+
+
+
+### getOriginalLine
+
+    string PAGI\Client\Result\IResult::getOriginalLine()
+
+Returns original line.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getCode
+
+    integer PAGI\Client\Result\IResult::getCode()
+
+Returns the integer value of the code returned by agi.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getResult
+
+    integer PAGI\Client\Result\IResult::getResult()
+
+Returns result (result=xxx) from the result.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### isResult
+
+    boolean PAGI\Client\Result\IResult::isResult(string $value)
+
+Compares result to a given value.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+#### Arguments
+* $value **string** - <p>Value to match against.</p>
+
+
+
+### hasData
+
+    boolean PAGI\Client\Result\IResult::hasData()
+
+Returns true if this command returned any data.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getData
+
+    string PAGI\Client\Result\IResult::getData()
+
+Returns data, if any. False if none.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+

+PAGI\Client\Result\DataReadResult
+===============
+
+This decorated result adds the functionality to check for user input (more
+than one digit).
+
+PHP Version 5
+
+
+* Class name: DataReadResult
+* Namespace: PAGI\Client\Result
+* Parent class: [PAGI\Client\Result\DigitReadResult](PAGI-Client-Result-DigitReadResult.md)
+
+
+
+
+
+Properties
+----------
+
+
+### $digits
+
+    protected string $digits
+
+Digits read (if any).
+
+
+
+* Visibility: **protected**
+
+
+### $timeout
+
+    protected boolean $timeout
+
+Timeout?
+
+
+
+* Visibility: **protected**
+
+
+### $result
+
+    private \PAGI\Client\Result\IResult $result
+
+Our decorated result.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### __construct
+
+    void PAGI\Client\Result\ResultDecorator::__construct(\PAGI\Client\Result\IResult $result)
+
+Constructor.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+#### Arguments
+* $result **[PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)** - <p>Result to decorate.</p>
+
+
+
+### isTimeout
+
+    boolean PAGI\Client\Result\IReadResult::isTimeout()
+
+True if the operation completed and no input was received from the user.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IReadResult](PAGI-Client-Result-IReadResult.md)
+
+
+
+
+### getDigits
+
+    string PAGI\Client\Result\IReadResult::getDigits()
+
+Returns digits read. False if none.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IReadResult](PAGI-Client-Result-IReadResult.md)
+
+
+
+
+### getDigitsCount
+
+    integer PAGI\Client\Result\IReadResult::getDigitsCount()
+
+Returns the number of digits read.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IReadResult](PAGI-Client-Result-IReadResult.md)
+
+
+
+
+### getOriginalLine
+
+    string PAGI\Client\Result\IResult::getOriginalLine()
+
+Returns original line.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getCode
+
+    integer PAGI\Client\Result\IResult::getCode()
+
+Returns the integer value of the code returned by agi.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getResult
+
+    integer PAGI\Client\Result\IResult::getResult()
+
+Returns result (result=xxx) from the result.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### isResult
+
+    boolean PAGI\Client\Result\IResult::isResult(string $value)
+
+Compares result to a given value.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+#### Arguments
+* $value **string** - <p>Value to match against.</p>
+
+
+
+### hasData
+
+    boolean PAGI\Client\Result\IResult::hasData()
+
+Returns true if this command returned any data.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getData
+
+    string PAGI\Client\Result\IResult::getData()
+
+Returns data, if any. False if none.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### __toString
+
+    string PAGI\Client\Result\ResultDecorator::__toString()
+
+Standard procedure.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+

+PAGI\Client\Result\DialResult
+===============
+
+This decorated result adds the functionality to check for a dial result.
+
+PHP Version 5
+
+
+* Class name: DialResult
+* Namespace: PAGI\Client\Result
+* Parent class: [PAGI\Client\Result\ExecResult](PAGI-Client-Result-ExecResult.md)
+
+
+
+
+
+Properties
+----------
+
+
+### $dialedPeerNumber
+
+    private string $dialedPeerNumber
+
+Dialed peer number.
+
+
+
+* Visibility: **private**
+
+
+### $dialedPeerName
+
+    private string $dialedPeerName
+
+Dialed peer name.
+
+
+
+* Visibility: **private**
+
+
+### $dialedTime
+
+    private integer $dialedTime
+
+Total call length in seconds.
+
+
+
+* Visibility: **private**
+
+
+### $answeredTime
+
+    private integer $answeredTime
+
+Total answered length in seconds.
+
+
+
+* Visibility: **private**
+
+
+### $dialStatus
+
+    private string $dialStatus
+
+Dial status.
+
+
+
+* Visibility: **private**
+
+
+### $dynamicFeatures
+
+    private string $dynamicFeatures
+
+Features available for the call.
+
+
+
+* Visibility: **private**
+
+
+### $result
+
+    private \PAGI\Client\Result\IResult $result
+
+Our decorated result.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### getPeerNumber
+
+    string PAGI\Client\Result\DialResult::getPeerNumber()
+
+Returns Peer number.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setPeerNumber
+
+    void PAGI\Client\Result\DialResult::setPeerNumber(string $number)
+
+Set peer number.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $number **string** - <p>Peer number.</p>
+
+
+
+### getPeerName
+
+    string PAGI\Client\Result\DialResult::getPeerName()
+
+Returns Peer name.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setPeerName
+
+    void PAGI\Client\Result\DialResult::setPeerName(string $name)
+
+Set peer name.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $name **string** - <p>Peer name.</p>
+
+
+
+### getDialedTime
+
+    integer PAGI\Client\Result\DialResult::getDialedTime()
+
+Returns total time for the call in seconds.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setDialedTime
+
+    void PAGI\Client\Result\DialResult::setDialedTime(integer $time)
+
+Set dialed time.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $time **integer** - <p>Dialed time.</p>
+
+
+
+### getAnsweredTime
+
+    integer PAGI\Client\Result\DialResult::getAnsweredTime()
+
+Returns answered time.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setAnsweredTime
+
+    void PAGI\Client\Result\DialResult::setAnsweredTime(integer $time)
+
+Set answered time.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $time **integer** - <p>Answered time.</p>
+
+
+
+### getDialStatus
+
+    string PAGI\Client\Result\DialResult::getDialStatus()
+
+Returns dial status.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isBusy
+
+    boolean PAGI\Client\Result\DialResult::isBusy()
+
+Returns true if the result was BUSY.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isCongestion
+
+    boolean PAGI\Client\Result\DialResult::isCongestion()
+
+Returns true if the result was CONGESTION.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isCancel
+
+    boolean PAGI\Client\Result\DialResult::isCancel()
+
+Returns true if the result was CANCEL.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isAnswer
+
+    boolean PAGI\Client\Result\DialResult::isAnswer()
+
+Returns true if the result was ANSWER.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isNoAnswer
+
+    boolean PAGI\Client\Result\DialResult::isNoAnswer()
+
+Returns true if the result was NOANSWER.
+
+
+
+* Visibility: **public**
+
+
+
+
+### isChanUnavailable
+
+    boolean PAGI\Client\Result\DialResult::isChanUnavailable()
+
+Returns true if the result was CHANUNAVAIL.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setDialStatus
+
+    void PAGI\Client\Result\DialResult::setDialStatus(string $status)
+
+Set dial status.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $status **string** - <p>Dial status.</p>
+
+
+
+### getDynamicFeatures
+
+    string PAGI\Client\Result\DialResult::getDynamicFeatures()
+
+Returns features available for the call.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setDynamicFeatures
+
+    void PAGI\Client\Result\DialResult::setDynamicFeatures(string $features)
+
+Set features.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $features **string** - <p>Features.</p>
+
+
+
+### __toString
+
+    string PAGI\Client\Result\ResultDecorator::__toString()
+
+Standard procedure.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+
+
+### __construct
+
+    void PAGI\Client\Result\ResultDecorator::__construct(\PAGI\Client\Result\IResult $result)
+
+Constructor.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+#### Arguments
+* $result **[PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)** - <p>Result to decorate.</p>
+
+
+
+### getOriginalLine
+
+    string PAGI\Client\Result\IResult::getOriginalLine()
+
+Returns original line.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getCode
+
+    integer PAGI\Client\Result\IResult::getCode()
+
+Returns the integer value of the code returned by agi.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getResult
+
+    integer PAGI\Client\Result\IResult::getResult()
+
+Returns result (result=xxx) from the result.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### isResult
+
+    boolean PAGI\Client\Result\IResult::isResult(string $value)
+
+Compares result to a given value.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+#### Arguments
+* $value **string** - <p>Value to match against.</p>
+
+
+
+### hasData
+
+    boolean PAGI\Client\Result\IResult::hasData()
+
+Returns true if this command returned any data.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getData
+
+    string PAGI\Client\Result\IResult::getData()
+
+Returns data, if any. False if none.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+

+PAGI\Client\Result\DigitReadResult
+===============
+
+This decorated result adds the functionality to check for user input. We
+need a distinction between a single digit read (this class) and a data read
+(DataReadResult) because asterisk sends the ascii number for the character
+read (the first case) and the literal string in the latter.
+
+PHP Version 5
+
+
+* Class name: DigitReadResult
+* Namespace: PAGI\Client\Result
+* Parent class: [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+* This class implements: [PAGI\Client\Result\IReadResult](PAGI-Client-Result-IReadResult.md)
+
+
+
+
+Properties
+----------
+
+
+### $digits
+
+    protected string $digits
+
+Digits read (if any).
+
+
+
+* Visibility: **protected**
+
+
+### $timeout
+
+    protected boolean $timeout
+
+Timeout?
+
+
+
+* Visibility: **protected**
+
+
+### $result
+
+    private \PAGI\Client\Result\IResult $result
+
+Our decorated result.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### isTimeout
+
+    boolean PAGI\Client\Result\IReadResult::isTimeout()
+
+True if the operation completed and no input was received from the user.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IReadResult](PAGI-Client-Result-IReadResult.md)
+
+
+
+
+### getDigits
+
+    string PAGI\Client\Result\IReadResult::getDigits()
+
+Returns digits read. False if none.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IReadResult](PAGI-Client-Result-IReadResult.md)
+
+
+
+
+### getDigitsCount
+
+    integer PAGI\Client\Result\IReadResult::getDigitsCount()
+
+Returns the number of digits read.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IReadResult](PAGI-Client-Result-IReadResult.md)
+
+
+
+
+### __construct
+
+    void PAGI\Client\Result\ResultDecorator::__construct(\PAGI\Client\Result\IResult $result)
+
+Constructor.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+#### Arguments
+* $result **[PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)** - <p>Result to decorate.</p>
+
+
+
+### getOriginalLine
+
+    string PAGI\Client\Result\IResult::getOriginalLine()
+
+Returns original line.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getCode
+
+    integer PAGI\Client\Result\IResult::getCode()
+
+Returns the integer value of the code returned by agi.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getResult
+
+    integer PAGI\Client\Result\IResult::getResult()
+
+Returns result (result=xxx) from the result.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### isResult
+
+    boolean PAGI\Client\Result\IResult::isResult(string $value)
+
+Compares result to a given value.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+#### Arguments
+* $value **string** - <p>Value to match against.</p>
+
+
+
+### hasData
+
+    boolean PAGI\Client\Result\IResult::hasData()
+
+Returns true if this command returned any data.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getData
+
+    string PAGI\Client\Result\IResult::getData()
+
+Returns data, if any. False if none.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### __toString
+
+    string PAGI\Client\Result\ResultDecorator::__toString()
+
+Standard procedure.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+

+PAGI\Client\Result\ExecResult
+===============
+
+This decorated result adds the functionality to check for an exec result.
+
+PHP Version 5
+
+
+* Class name: ExecResult
+* Namespace: PAGI\Client\Result
+* Parent class: [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+
+
+
+Properties
+----------
+
+
+### $result
+
+    private \PAGI\Client\Result\IResult $result
+
+Our decorated result.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### __construct
+
+    void PAGI\Client\Result\ResultDecorator::__construct(\PAGI\Client\Result\IResult $result)
+
+Constructor.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+#### Arguments
+* $result **[PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)** - <p>Result to decorate.</p>
+
+
+
+### getOriginalLine
+
+    string PAGI\Client\Result\IResult::getOriginalLine()
+
+Returns original line.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getCode
+
+    integer PAGI\Client\Result\IResult::getCode()
+
+Returns the integer value of the code returned by agi.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getResult
+
+    integer PAGI\Client\Result\IResult::getResult()
+
+Returns result (result=xxx) from the result.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### isResult
+
+    boolean PAGI\Client\Result\IResult::isResult(string $value)
+
+Compares result to a given value.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+#### Arguments
+* $value **string** - <p>Value to match against.</p>
+
+
+
+### hasData
+
+    boolean PAGI\Client\Result\IResult::hasData()
+
+Returns true if this command returned any data.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getData
+
+    string PAGI\Client\Result\IResult::getData()
+
+Returns data, if any. False if none.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### __toString
+
+    string PAGI\Client\Result\ResultDecorator::__toString()
+
+Standard procedure.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+

+PAGI\Client\Result\FaxResult
+===============
+
+This decorated result adds the functionality to check for a fax result.
+
+PHP Version 5
+
+
+* Class name: FaxResult
+* Namespace: PAGI\Client\Result
+* Parent class: [PAGI\Client\Result\ExecResult](PAGI-Client-Result-ExecResult.md)
+
+
+
+
+
+Properties
+----------
+
+
+### $localId
+
+    private string $localId
+
+Local station ID.
+
+
+
+* Visibility: **private**
+
+
+### $localHeader
+
+    private string $localHeader
+
+Local header.
+
+
+
+* Visibility: **private**
+
+
+### $remoteId
+
+    private string $remoteId
+
+Remote station ID.
+
+
+
+* Visibility: **private**
+
+
+### $result
+
+    private \PAGI\Client\Result\IResult $result
+
+Our decorated result.
+
+
+
+* Visibility: **private**
+
+
+### $error
+
+    private string $error
+
+Error detail (if $result === false)
+
+
+
+* Visibility: **private**
+
+
+### $bitrate
+
+    private integer $bitrate
+
+Bitrate for the operation.
+
+
+
+* Visibility: **private**
+
+
+### $pages
+
+    private integer $pages
+
+Total pages for the operation.
+
+
+
+* Visibility: **private**
+
+
+### $resolution
+
+    private string $resolution
+
+Resolution for the operation.
+
+
+
+* Visibility: **private**
+
+
+Methods
+-------
+
+
+### getLocalStationId
+
+    string PAGI\Client\Result\FaxResult::getLocalStationId()
+
+Returns local station id.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setLocalStationId
+
+    void PAGI\Client\Result\FaxResult::setLocalStationId(string $value)
+
+Sets local station id.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>Value to set.</p>
+
+
+
+### getLocalHeaderInfo
+
+    string PAGI\Client\Result\FaxResult::getLocalHeaderInfo()
+
+Returns local header.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setLocalHeaderInfo
+
+    void PAGI\Client\Result\FaxResult::setLocalHeaderInfo(string $value)
+
+Sets local header.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>Value to set.</p>
+
+
+
+### isSuccess
+
+    boolean PAGI\Client\Result\FaxResult::isSuccess()
+
+True if the operation was successfull.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setResult
+
+    void PAGI\Client\Result\FaxResult::setResult(string $value)
+
+Sets operation result (if failed).
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>Value to set.</p>
+
+
+
+### getError
+
+    string PAGI\Client\Result\FaxResult::getError()
+
+Returns error description (if failed).
+
+
+
+* Visibility: **public**
+
+
+
+
+### setError
+
+    void PAGI\Client\Result\FaxResult::setError(string $value)
+
+Sets error detail.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>Value to set.</p>
+
+
+
+### getRemoteStationId
+
+    string PAGI\Client\Result\FaxResult::getRemoteStationId()
+
+Returns remote station id.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setRemoteStationId
+
+    void PAGI\Client\Result\FaxResult::setRemoteStationId(string $value)
+
+Sets remote station id.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>Value to set.</p>
+
+
+
+### getPages
+
+    integer PAGI\Client\Result\FaxResult::getPages()
+
+Returns number of pages.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setPages
+
+    void PAGI\Client\Result\FaxResult::setPages(integer $value)
+
+Sets number of pages.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **integer** - <p>Value to set.</p>
+
+
+
+### getBitrate
+
+    integer PAGI\Client\Result\FaxResult::getBitrate()
+
+Returns bitrate.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setBitrate
+
+    void PAGI\Client\Result\FaxResult::setBitrate(integer $value)
+
+Sets bitrate.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **integer** - <p>Value to set.</p>
+
+
+
+### getResolution
+
+    string PAGI\Client\Result\FaxResult::getResolution()
+
+Returns resolution for the operation.
+
+
+
+* Visibility: **public**
+
+
+
+
+### setResolution
+
+    void PAGI\Client\Result\FaxResult::setResolution(string $value)
+
+Sets resolution.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $value **string** - <p>Value to set.</p>
+
+
+
+### __toString
+
+    string PAGI\Client\Result\ResultDecorator::__toString()
+
+Standard procedure.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+
+
+### __construct
+
+    void PAGI\Client\Result\ResultDecorator::__construct(\PAGI\Client\Result\IResult $result)
+
+Constructor.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\ResultDecorator](PAGI-Client-Result-ResultDecorator.md)
+
+
+#### Arguments
+* $result **[PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)** - <p>Result to decorate.</p>
+
+
+
+### getOriginalLine
+
+    string PAGI\Client\Result\IResult::getOriginalLine()
+
+Returns original line.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getCode
+
+    integer PAGI\Client\Result\IResult::getCode()
+
+Returns the integer value of the code returned by agi.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getResult
+
+    integer PAGI\Client\Result\IResult::getResult()
+
+Returns result (result=xxx) from the result.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### isResult
+
+    boolean PAGI\Client\Result\IResult::isResult(string $value)
+
+Compares result to a given value.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+#### Arguments
+* $value **string** - <p>Value to match against.</p>
+
+
+
+### hasData
+
+    boolean PAGI\Client\Result\IResult::hasData()
+
+Returns true if this command returned any data.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+
+
+### getData
+
+    string PAGI\Client\Result\IResult::getData()
+
+Returns data, if any. False if none.
+
+
+
+* Visibility: **public**
+* This method is defined by [PAGI\Client\Result\IResult](PAGI-Client-Result-IResult.md)
+
+
+