marcelog/PAGI

View on GitHub
doc/PAGI-Client-Result-IResult.md

Summary

Maintainability
Test Coverage
PAGI\Client\Result\IResult
===============

This is an interface so we can decorate it later.

PHP Version 5


* Interface name: IResult
* Namespace: PAGI\Client\Result
* This is an **interface**






Methods
-------


### getOriginalLine

    string PAGI\Client\Result\IResult::getOriginalLine()

Returns original line.



* Visibility: **public**




### getCode

    integer PAGI\Client\Result\IResult::getCode()

Returns the integer value of the code returned by agi.



* Visibility: **public**




### getResult

    integer PAGI\Client\Result\IResult::getResult()

Returns result (result=xxx) from the result.



* Visibility: **public**




### isResult

    boolean PAGI\Client\Result\IResult::isResult(string $value)

Compares result to a given value.



* Visibility: **public**


#### 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**




### getData

    string PAGI\Client\Result\IResult::getData()

Returns data, if any. False if none.



* Visibility: **public**