Added some documentation to the MibewAPI class

This commit is contained in:
Dmitriy Simushev 2012-08-03 11:23:09 +00:00
parent 31b6d96fc9
commit 460d2d96c2

View File

@ -40,6 +40,13 @@ Class MibewAPI {
*/
protected $interaction = NULL;
/**
* Returns MibewAPI object
*
* @param string $interaction_type A name of the interaction type
* @return MibeAPI object
* @throws MibewAPIException
*/
public static function getAPI($interaction_type) {
$class_name = "MibewAPI". ucfirst($interaction_type) . "Interaction";
if (! class_exists($class_name)) {
@ -54,6 +61,11 @@ Class MibewAPI {
return self::$interactions[$interaction_type];
}
/**
* Class constructor
*
* @param MibewAPIInteraction $interaction_type Interaction type object
*/
protected function __construct(MibewAPIInteraction $interaction_type) {
$this->interaction = $interaction_type;
}