Добавлены новые методы. Изменены некоторые методы

Обновлены описания классов, свойств и методов для документации
Добавлена документация
Добавлены примеры использования SDK
This commit is contained in:
Антон Н. Николаев
2021-04-21 11:24:28 +03:00
parent 25c35bb316
commit bd2a5b95fd
399 changed files with 93734 additions and 577 deletions
+20 -24
View File
@@ -31,44 +31,35 @@ use YooKassa\Common\AbstractObject;
use YooKassa\Model\NotificationEventType;
/**
* Class Webhook
* Класс Webhook содержит информацию о подписке на одно событие
*
* @property string $id Идентификатор webhook
* @property string $event Событие, о котором уведомляет ЮKassa
* @property string $url URL, на который ЮKassa будет отправлять уведомления
*
* @package YooKassa
*/
class Webhook extends AbstractObject
{
/**
* Идентификатор webhook
* @var string
*/
private $id;
/**
* Событие, о котором уведомляет ЮKassa
* @see NotificationEventType
* @var string
* @see NotificationEventType
*/
private $event;
/**
* URL, на который ЮKassa будет отправлять уведомления
* @var string
*/
private $url;
/**
* Webhook constructor.
*
* @param $initData
*/
public function __construct($initData = null)
{
if(!empty($initData)) {
$this->fromArray($initData);
}
}
/**
* @return mixed
* Возвращает идентификатор webhook
* @return string Идентификатор webhook
*/
public function getId()
{
@@ -76,7 +67,8 @@ class Webhook extends AbstractObject
}
/**
* @param mixed $id
* Устанавливает идентификатор webhook
* @param mixed $id Идентификатор webhook
*/
public function setId($id)
{
@@ -84,7 +76,8 @@ class Webhook extends AbstractObject
}
/**
* @return mixed
* Возвращает событие, о котором уведомляет ЮKassa
* @return string Событие, о котором уведомляет ЮKassa
*/
public function getEvent()
{
@@ -92,7 +85,8 @@ class Webhook extends AbstractObject
}
/**
* @param mixed $event
* Устанавливает событие, о котором уведомляет ЮKassa
* @param string $event Событие, о котором уведомляет ЮKassa
*/
public function setEvent($event)
{
@@ -100,7 +94,8 @@ class Webhook extends AbstractObject
}
/**
* @return mixed
* Возвращает URL, на который ЮKassa будет отправлять уведомления
* @return string URL, на который ЮKassa будет отправлять уведомления
*/
public function getUrl()
{
@@ -108,7 +103,8 @@ class Webhook extends AbstractObject
}
/**
* @param mixed $url
* Устанавливает URL, на который ЮKassa будет отправлять уведомления
* @param string $url URL, на который ЮKassa будет отправлять уведомления
*/
public function setUrl($url)
{