adding doc dir

build.xml

@@ -32,7 +32,7 @@
 
   <target name="md">
     <exec command="vendor/bin/phpmd ./src text cleancode,codesize,controversial,design,naming,unusedcode"
-      checkreturn="true"
+      checkreturn="false"
       passthru="true"/>
   </target>
 

doc/ApiIndex.md

@@ -0,0 +1,74 @@
+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)
+

doc/PAGI-Application-PAGIApplication.md

@@ -0,0 +1,171 @@
+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>
+
+