RetailCRM-Mirror/mg-bot-api-client-php
1
0
Fork 0
mirror of synced 2024-11-25 13:16:01 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #11 from Neur0toxine/master

Browse Source 
[fix] update phpdoc for getters
This commit is contained in:
Alex Lushpai 2019-10-08 17:06:37 +03:00 committed by GitHub
commit 0534f31c34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
26 changed files with 134 additions and 135 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/Bot/Model/Entity/Bot.php
View File

@ -136,7 +136,7 @@ class Bot implements ModelInterface
private $isSystem;
/**
* @return string
* @return string|null
*/
public function getId(): ?string
{
@ -184,7 +184,7 @@ class Bot implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getName(): ?string
{
@ -200,7 +200,7 @@ class Bot implements ModelInterface
}
/**
* @return array
* @return array|null
*/
public function getEvents(): ?array
{
@ -216,7 +216,7 @@ class Bot implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getClientId(): ?string
{
@ -232,7 +232,7 @@ class Bot implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getAvatarUrl(): ?string
{
@ -248,7 +248,7 @@ class Bot implements ModelInterface
}
/**
* @return array
* @return array|null
*/
public function getRoles(): ?array
{
@ -264,7 +264,7 @@ class Bot implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getDeactivatedAt(): ?string
{
@ -280,7 +280,7 @@ class Bot implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isActive(): ?bool
{
@ -296,7 +296,7 @@ class Bot implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isSelf(): ?bool
{
@ -312,7 +312,7 @@ class Bot implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isSystem(): ?bool
{

10
src/Bot/Model/Entity/Channel/Channel.php
View File

@ -101,7 +101,7 @@ class Channel implements ModelInterface
private $name;
/**
* @return string
* @return string|null
*/
public function getId(): ?string
{
@ -181,7 +181,7 @@ class Channel implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isActive(): ?bool
{
@ -197,7 +197,7 @@ class Channel implements ModelInterface
}
/**
* @return ChannelSettings
* @return ChannelSettings|null
*/
public function getSettings(): ?ChannelSettings
{
@ -213,7 +213,7 @@ class Channel implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getType(): ?string
{
@ -229,7 +229,7 @@ class Channel implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getName(): ?string
{

14
src/Bot/Model/Entity/Channel/ChannelSettings.php
View File

@ -90,7 +90,7 @@ class ChannelSettings implements ModelInterface
private $file;
/**
* @return ChannelSettingsStatus
* @return ChannelSettingsStatus|null
*/
public function getStatus(): ?ChannelSettingsStatus
{
@ -106,7 +106,7 @@ class ChannelSettings implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isSpamAllowed(): ?bool
{
@ -122,7 +122,7 @@ class ChannelSettings implements ModelInterface
}
/**
* @return ChannelSettingsItem
* @return ChannelSettingsItem|null
*/
public function getText(): ?ChannelSettingsItem
{
@ -138,7 +138,7 @@ class ChannelSettings implements ModelInterface
}
/**
* @return ChannelSettingsItem
* @return ChannelSettingsItem|null
*/
public function getProduct(): ?ChannelSettingsItem
{
@ -154,7 +154,7 @@ class ChannelSettings implements ModelInterface
}
/**
* @return ChannelSettingsItem
* @return ChannelSettingsItem|null
*/
public function getOrder(): ?ChannelSettingsItem
{
@ -170,7 +170,7 @@ class ChannelSettings implements ModelInterface
}
/**
* @return ChannelSettingsItem
* @return ChannelSettingsItem|null
*/
public function getImage(): ?ChannelSettingsItem
{
@ -186,7 +186,7 @@ class ChannelSettings implements ModelInterface
}
/**
* @return ChannelSettingsItem
* @return ChannelSettingsItem|null
*/
public function getFile(): ?ChannelSettingsItem
{

16
src/Bot/Model/Entity/Channel/ChannelSettingsItem.php
View File

@ -101,7 +101,7 @@ class ChannelSettingsItem implements ModelInterface
private $noteMaxCharsCount;
/**
* @return string
* @return string|null
*/
public function getCreating(): ?string
{
@ -117,7 +117,7 @@ class ChannelSettingsItem implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getEditing(): ?string
{
@ -133,7 +133,7 @@ class ChannelSettingsItem implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getQuoting(): ?string
{
@ -149,7 +149,7 @@ class ChannelSettingsItem implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getDeleting(): ?string
{
@ -165,7 +165,7 @@ class ChannelSettingsItem implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getDelivered(): ?string
{
@ -181,7 +181,7 @@ class ChannelSettingsItem implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getMaxCharsCount(): ?int
{
@ -197,7 +197,7 @@ class ChannelSettingsItem implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getMaxItemsCount(): ?int
{
@ -213,7 +213,7 @@ class ChannelSettingsItem implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getNoteMaxCharsCount(): ?int
{

4
src/Bot/Model/Entity/Channel/ChannelSettingsStatus.php
View File

@ -47,7 +47,7 @@ class ChannelSettingsStatus implements ModelInterface
private $read;
/**
* @return string
* @return string|null
*/
public function getDelivered(): ?string
{
@ -63,7 +63,7 @@ class ChannelSettingsStatus implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getRead(): ?string
{

14
src/Bot/Model/Entity/Chat/Chat.php
View File

@ -168,7 +168,7 @@ class Chat implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getAvatar(): ?string
{
@ -184,7 +184,7 @@ class Chat implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getName(): ?string
{
@ -200,7 +200,7 @@ class Chat implements ModelInterface
}
/**
* @return Channel
* @return Channel|null
*/
public function getChannel(): ?Channel
{
@ -216,7 +216,7 @@ class Chat implements ModelInterface
}
/**
* @return array
* @return array|null
*/
public function getMembers(): ?array
{
@ -232,7 +232,7 @@ class Chat implements ModelInterface
}
/**
* @return Customer
* @return Customer|null
*/
public function getCustomer(): ?Customer
{
@ -248,7 +248,7 @@ class Chat implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getAuthorId(): ?int
{
@ -264,7 +264,7 @@ class Chat implements ModelInterface
}
/**
* @return ChatLastMessage
* @return ChatLastMessage|null
*/
public function getLastMessage(): ?ChatLastMessage
{

2
src/Bot/Model/Entity/Chat/ChatLastMessage.php
View File

@ -88,7 +88,7 @@ class ChatLastMessage implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getType(): ?string
{

8
src/Bot/Model/Entity/Chat/ChatMember.php
View File

@ -138,7 +138,7 @@ class ChatMember implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getChatId(): ?int
{
@ -154,7 +154,7 @@ class ChatMember implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getUserId(): ?int
{
@ -170,7 +170,7 @@ class ChatMember implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isAuthor(): ?bool
{
@ -186,7 +186,7 @@ class ChatMember implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getState(): ?string
{

6
src/Bot/Model/Entity/Command.php
View File

@ -72,7 +72,7 @@ class Command implements ModelInterface
private $description;
/**
* @return string
* @return string|null
*/
public function getId(): ?string
{
@ -120,7 +120,7 @@ class Command implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getName(): ?string
{
@ -136,7 +136,7 @@ class Command implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getDescription(): ?string
{

26
src/Bot/Model/Entity/Customer.php
View File

@ -174,7 +174,7 @@ class Customer implements ModelInterface
private $email;
/**
* @return string
* @return string|null
*/
public function getId(): ?string
{
@ -222,7 +222,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getExternalId(): ?string
{
@ -238,7 +238,7 @@ class Customer implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getChannelId(): ?int
{
@ -254,7 +254,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getUsername(): ?string
{
@ -270,7 +270,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getFirstName(): ?string
{
@ -286,7 +286,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getLastName(): ?string
{
@ -302,7 +302,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getAvatarUrl(): ?string
{
@ -318,7 +318,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getProfileUrl(): ?string
{
@ -334,7 +334,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getRevokedAt(): ?string
{
@ -350,7 +350,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getCountry(): ?string
{
@ -366,7 +366,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getLanguage(): ?string
{
@ -382,7 +382,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getPhone(): ?string
{
@ -398,7 +398,7 @@ class Customer implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getEmail(): ?string
{

16
src/Bot/Model/Entity/Dialog.php
View File

@ -126,7 +126,7 @@ class Dialog implements ModelInterface
private $isActive;
/**
* @return string
* @return string|null
*/
public function getId(): ?string
{
@ -174,7 +174,7 @@ class Dialog implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getBotId(): ?int
{
@ -190,7 +190,7 @@ class Dialog implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getChatId(): ?int
{
@ -206,7 +206,7 @@ class Dialog implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getBeginMessageId(): ?int
{
@ -222,7 +222,7 @@ class Dialog implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getEndingMessageId(): ?int
{
@ -254,7 +254,7 @@ class Dialog implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isAssigned(): ?bool
{
@ -270,7 +270,7 @@ class Dialog implements ModelInterface
}
/**
* @return Responsible
* @return Responsible|null
*/
public function getResponsible(): ?Responsible
{
@ -286,7 +286,7 @@ class Dialog implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isActive(): ?bool
{

4
src/Bot/Model/Entity/FileMeta.php
View File

@ -47,7 +47,7 @@ class FileMeta implements ModelInterface
private $width;
/**
* @return int
* @return int|null
*/
public function getHeight(): ?int
{
@ -63,7 +63,7 @@ class FileMeta implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getWidth(): ?int
{

6
src/Bot/Model/Entity/Message/Item.php
View File

@ -56,7 +56,7 @@ class Item implements ModelInterface
private $caption;
/**
* @return string
* @return string|null
*/
public function getId(): ?string
{
@ -72,7 +72,7 @@ class Item implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getSize(): ?int
{
@ -88,7 +88,7 @@ class Item implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getCaption()
{

28
src/Bot/Model/Entity/Message/Message.php
View File

@ -273,7 +273,7 @@ class Message implements ModelInterface
}
/**
* @return array
* @return array|null
*/
public function getItems(): ?array
{
@ -289,7 +289,7 @@ class Message implements ModelInterface
}
/**
* @return User
* @return User|null
*/
public function getFrom(): ?User
{
@ -321,7 +321,7 @@ class Message implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getType(): ?string
{
@ -337,7 +337,7 @@ class Message implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getScope(): ?string
{
@ -353,7 +353,7 @@ class Message implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getChatId(): ?int
{
@ -369,7 +369,7 @@ class Message implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getContent(): ?string
{
@ -385,7 +385,7 @@ class Message implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isRead(): ?bool
{
@ -401,7 +401,7 @@ class Message implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isEdit(): ?bool
{
@ -417,7 +417,7 @@ class Message implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getStatus(): ?string
{
@ -433,7 +433,7 @@ class Message implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getAction(): ?string
{
@ -449,7 +449,7 @@ class Message implements ModelInterface
}
/**
* @return Dialog
* @return Dialog|null
*/
public function getDialog(): ?Dialog
{
@ -465,7 +465,7 @@ class Message implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getChannelId(): ?int
{
@ -497,7 +497,7 @@ class Message implements ModelInterface
}
/**
* @return MessageOrder
* @return MessageOrder|null
*/
public function getOrder(): ?MessageOrder
{
@ -513,7 +513,7 @@ class Message implements ModelInterface
}
/**
* @return MessageProduct
* @return MessageProduct|null
*/
public function getProduct(): ?MessageProduct
{

4
src/Bot/Model/Entity/Message/MessageCost.php
View File

@ -49,7 +49,7 @@ class MessageCost implements ModelInterface
private $currency;
/**
* @return float
* @return float|null
*/
public function getValue()
{
@ -65,7 +65,7 @@ class MessageCost implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getCurrency()
{

8
src/Bot/Model/Entity/Message/MessageDelivery.php
View File

@ -68,7 +68,7 @@ class MessageDelivery implements ModelInterface
private $comment;
/**
* @return string
* @return string|null
*/
public function getName()
{
@ -84,7 +84,7 @@ class MessageDelivery implements ModelInterface
}
/**
* @return MessageCost
* @return MessageCost|null
*/
public function getPrice()
{
@ -100,7 +100,7 @@ class MessageDelivery implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getAddress()
{
@ -116,7 +116,7 @@ class MessageDelivery implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getComment()
{

16
src/Bot/Model/Entity/Message/MessageOrder.php
View File

@ -101,7 +101,7 @@ class MessageOrder implements ModelInterface
private $payments;
/**
* @return string
* @return string|null
*/
public function getNumber()
{
@ -117,7 +117,7 @@ class MessageOrder implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getUrl()
{
@ -133,7 +133,7 @@ class MessageOrder implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getDate()
{
@ -149,7 +149,7 @@ class MessageOrder implements ModelInterface
}
/**
* @return MessageCost
* @return MessageCost|null
*/
public function getCost()
{
@ -165,7 +165,7 @@ class MessageOrder implements ModelInterface
}
/**
* @return MessageStatus
* @return MessageStatus|null
*/
public function getStatus()
{
@ -181,7 +181,7 @@ class MessageOrder implements ModelInterface
}
/**
* @return MessageDelivery
* @return MessageDelivery|null
*/
public function getDelivery()
{
@ -197,7 +197,7 @@ class MessageOrder implements ModelInterface
}
/**
* @return array
* @return array|null
*/
public function getItems()
{
@ -213,7 +213,7 @@ class MessageOrder implements ModelInterface
}
/**
* @return array
* @return array|null
*/
public function getPayments()
{

10
src/Bot/Model/Entity/Message/MessageOrderItem.php
View File

@ -74,7 +74,7 @@ class MessageOrderItem implements ModelInterface
private $quantity;
/**
* @return string
* @return string|null
*/
public function getName()
{
@ -90,7 +90,7 @@ class MessageOrderItem implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getUrl()
{
@ -106,7 +106,7 @@ class MessageOrderItem implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getImg()
{
@ -122,7 +122,7 @@ class MessageOrderItem implements ModelInterface
}
/**
* @return MessageCost
* @return MessageCost|null
*/
public function getPrice()
{
@ -138,7 +138,7 @@ class MessageOrderItem implements ModelInterface
}
/**
* @return MessageQuantity
* @return MessageQuantity|null
*/
public function getQuantity()
{

4
src/Bot/Model/Entity/Message/MessageOrderPaymentStatus.php
View File

@ -47,7 +47,7 @@ class MessageOrderPaymentStatus implements ModelInterface
private $payed;
/**
* @return string
* @return string|null
*/
public function getName(): ?string
{
@ -63,7 +63,7 @@ class MessageOrderPaymentStatus implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function getPayed(): ?bool
{

6
src/Bot/Model/Entity/Message/MessagePayment.php
View File

@ -56,7 +56,7 @@ class MessagePayment implements ModelInterface
private $amount;
/**
* @return string
* @return string|null
*/
public function getName()
{
@ -72,7 +72,7 @@ class MessagePayment implements ModelInterface
}
/**
* @return MessageOrderPaymentStatus
* @return MessageOrderPaymentStatus|null
*/
public function getStatus()
{
@ -88,7 +88,7 @@ class MessagePayment implements ModelInterface
}
/**
* @return MessageCost
* @return MessageCost|null
*/
public function getAmount()
{

12
src/Bot/Model/Entity/Message/MessageProduct.php
View File

@ -108,7 +108,7 @@ class MessageProduct implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getName(): ?string
{
@ -124,7 +124,7 @@ class MessageProduct implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getArticle(): ?string
{
@ -140,7 +140,7 @@ class MessageProduct implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getUrl(): ?string
{
@ -156,7 +156,7 @@ class MessageProduct implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getImg(): ?string
{
@ -172,7 +172,7 @@ class MessageProduct implements ModelInterface
}
/**
* @return MessageCost
* @return MessageCost|null
*/
public function getCost(): ?MessageCost
{
@ -188,7 +188,7 @@ class MessageProduct implements ModelInterface
}
/**
* @return MessageQuantity
* @return MessageQuantity|null
*/
public function getQuantity(): ?MessageQuantity
{

4
src/Bot/Model/Entity/Message/MessageQuantity.php
View File

@ -49,7 +49,7 @@ class MessageQuantity implements ModelInterface
private $unit;
/**
* @return float
* @return float|null
*/
public function getValue()
{
@ -65,7 +65,7 @@ class MessageQuantity implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getUnit()
{

4
src/Bot/Model/Entity/Message/MessageStatus.php
View File

@ -47,7 +47,7 @@ class MessageStatus implements ModelInterface
private $name;
/**
* @return string
* @return string|null
*/
public function getCode(): ?string
{
@ -63,7 +63,7 @@ class MessageStatus implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getName(): ?string
{

6
src/Bot/Model/Entity/Responsible.php
View File

@ -56,7 +56,7 @@ class Responsible implements ModelInterface
private $type;
/**
* @return string
* @return string|null
*/
public function getAssignedAt(): ?string
{
@ -72,7 +72,7 @@ class Responsible implements ModelInterface
}
/**
* @return int
* @return int|null
*/
public function getId(): ?int
{
@ -88,7 +88,7 @@ class Responsible implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getType(): ?string
{

20
src/Bot/Model/Entity/User.php
View File

@ -149,7 +149,7 @@ class User implements ModelInterface
private $revokedAt;
/**
* @return string
* @return string|null
*/
public function getId(): ?string
{
@ -197,7 +197,7 @@ class User implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getExternalId(): ?string
{
@ -213,7 +213,7 @@ class User implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getType(): ?string
{
@ -229,7 +229,7 @@ class User implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getAvatar(): ?string
{
@ -245,7 +245,7 @@ class User implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getName(): ?string
{
@ -261,7 +261,7 @@ class User implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getUsername(): ?string
{
@ -277,7 +277,7 @@ class User implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getFirstName(): ?string
{
@ -293,7 +293,7 @@ class User implements ModelInterface
}
/**
* @return string
* @return string|null
*/
public function getLastName(): ?string
{
@ -309,7 +309,7 @@ class User implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isActive(): ?bool
{
@ -325,7 +325,7 @@ class User implements ModelInterface
}
/**
* @return bool
* @return bool|null
*/
public function isOnline(): ?bool
{

1
src/Bot/Model/ModelInterface.php
View File

@ -12,7 +12,6 @@
namespace RetailCrm\Mg\Bot\Model;
interface ModelInterface
{
}