1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198:
<?php
/**
* Copyright 2016 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
namespace LINE\LINEBot\Event;
use LINE\LINEBot\Constant\EventSourceType;
use LINE\LINEBot\Exception\InvalidEventSourceException;
/**
* Base class of each events.
*
* Don't instantiate this class individually.
*
* @package LINE\LINEBot\Event
*/
class BaseEvent
{
/** @var array */
protected $event;
/**
* BaseEvent constructor.
*
* @param array $event
*/
public function __construct($event)
{
$this->event = $event;
}
/**
* Returns event type.
*
* @return string
*/
public function getType()
{
return $this->event['type'];
}
/**
* Returns mode.
*
* active: The channel is active.
* standby: The channel is waiting.
*
* @return string
*/
public function getMode()
{
return $this->event['mode'];
}
/**
* Returns timestamp of the event.
*
* @return int
*/
public function getTimestamp()
{
return $this->event['timestamp'];
}
/**
* Returns reply token of the event.
*
* @return string|null
*/
public function getReplyToken()
{
return isset($this->event['replyToken']) ? $this->event['replyToken'] : null;
}
/**
* Returns the event is user's one or not.
*
* @return bool
*/
public function isUserEvent()
{
return $this->event['source']['type'] === EventSourceType::USER;
}
/**
* Returns the event is group's one or not.
*
* @return bool
*/
public function isGroupEvent()
{
return $this->event['source']['type'] === EventSourceType::GROUP;
}
/**
* Returns the event is room's one or not.
*
* @return bool
*/
public function isRoomEvent()
{
return $this->event['source']['type'] === EventSourceType::ROOM;
}
/**
* Returns the event is unknown or not.
*
* @return bool
*/
public function isUnknownEvent()
{
return !($this->isUserEvent() || $this->isGroupEvent() || $this->isRoomEvent());
}
/**
* Returns user ID of the event.
*
* @return string|null
*/
public function getUserId()
{
return isset($this->event['source']['userId'])
? $this->event['source']['userId']
: null;
}
/**
* Returns group ID of the event.
*
* @return string|null
* @throws InvalidEventSourceException Raise when called with non group type event.
*/
public function getGroupId()
{
if (!$this->isGroupEvent()) {
throw new InvalidEventSourceException('This event source is not a group type');
}
return isset($this->event['source']['groupId'])
? $this->event['source']['groupId']
: null;
}
/**
* Returns room ID of the event.
*
* @return string|null
* @throws InvalidEventSourceException Raise when called with non room type event.
*/
public function getRoomId()
{
if (!$this->isRoomEvent()) {
throw new InvalidEventSourceException('This event source is not a room type');
}
return isset($this->event['source']['roomId'])
? $this->event['source']['roomId']
: null;
}
/**
* Returns the identifier of the event source that associated with event source type
* (i.e. userId, groupId or roomId).
*
* @return null|string
* @throws InvalidEventSourceException
*/
public function getEventSourceId()
{
if ($this->isUserEvent()) {
return $this->getUserId();
}
if ($this->isGroupEvent()) {
return $this->getGroupId();
}
if ($this->isRoomEvent()) {
return $this->getRoomId();
}
# Unknown event
return null;
}
}