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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
<?php
/* --------------------------------------------------------------
InfoBoxMessage.php 2016-08-26
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Class InfoBoxMessage
*
* @category System
* @package InfoBox
* @subpackage Entities
*/
class InfoBoxMessage implements InfoBoxMessageInterface
{
/**
* Message source
*
* @var string
*/
protected $source;
/**
* Message ID
*
* @var string
*/
protected $id;
/**
* Message identifier
*
* @var string
*/
protected $identifier;
/**
* Message status
*
* @var string
*/
protected $status;
/**
* Message type
*
* @var string
*/
protected $type;
/**
* Message visibility
*
* @var string
*/
protected $visibility;
/**
* Message button link.
*
* @var string
*/
protected $buttonLink;
/**
* Customer ID
*
* @var int
*/
protected $customerId;
/**
* Added date time.
*
* @var DateTime
*/
protected $addedDateTime;
/**
* Modified date time.
*
* @var DateTime
*/
protected $modifiedDateTime;
/**
* Message headlines
*
* @var EditableKeyValueCollection
*/
protected $headlines;
/**
* Messages
*
* @var EditableKeyValueCollection
*/
protected $messages;
/**
* Message button labels.
*
* @var EditableKeyValueCollection
*/
protected $buttonLabels;
/**
* InfoBoxMessage constructor.
*/
public function __construct()
{
$this->setSource(new StringType('intern'));
$this->setStatus(new StringType('new'));
$this->setType(new StringType('info'));
$this->setVisibility(new StringType('hideable'));
$this->setButtonLink(new StringType(''));
$this->setAddedDateTime(new DateTime());
$this->setModifiedDateTime(new DateTime());
$this->headlines = MainFactory::create('EditableKeyValueCollection', array());
$this->messages = MainFactory::create('EditableKeyValueCollection', array());
$this->buttonLabels = MainFactory::create('EditableKeyValueCollection', array());
}
/**
* Sets the message's source.
*
* @param StringType $source Source of the message (e.g. 'internal').
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setSource(StringType $source)
{
$this->source = $source->asString();
return $this;
}
/**
* Returns the message's source.
*
* @return string Source of the message.
*/
public function getSource()
{
return $this->source;
}
/**
* Sets the ID of the message.
*
* @param IdType $id Identifier of the message.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setId(IdType $id)
{
$this->id = $id->asInt();
return $this;
}
/**
* Returns the ID of the message.
*
* @return int ID of the message.
*/
public function getId()
{
return $this->id;
}
/**
* Sets the status of the message.
*
* @param StringType $status Status of the message.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setStatus(StringType $status)
{
$this->status = $status->asString();
return $this;
}
/**
* Returns the status of the message.
*
* @return string Status of the message.
*/
public function getStatus()
{
return $this->status;
}
/**
* Sets the type of the message.
*
* @param StringType $type Type of the message.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setType(StringType $type)
{
$this->type = $type->asString();
return $this;
}
/**
* Returns the type of the message.
*
* @return string
*/
public function getType()
{
return $this->type;
}
/**
* Sets the visibility of the message.
*
* @param StringType $visibility Visibility of the message.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setVisibility(StringType $visibility)
{
$this->visibility = $visibility->asString();
return $this;
}
/**
* Returns the visibility of the message.
*
* @return string Visibility of the message.
*/
public function getVisibility()
{
return $this->visibility;
}
/**
* Sets the link of the message button.
*
* @param StringType $buttonLink Link of the message button.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setButtonLink(StringType $buttonLink)
{
$this->buttonLink = $buttonLink->asString();
return $this;
}
/**
* Returns the link of the message button.
*
* @return string Link of the message button.
*/
public function getButtonLink()
{
return $this->buttonLink;
}
/**
* Sets the customer ID of the message.
*
* @param IdType $customerId Customer ID of the message.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setCustomerId(IdType $customerId)
{
$this->customerId = $customerId->asInt();
return $this;
}
/**
* Returns the customer ID of the message.
*
* @return int
*/
public function getCustomerId()
{
return $this->customerId;
}
/**
* Sets the message creation date time.
*
* @param DateTime $dateTime Message added date time value.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setAddedDateTime(DateTime $dateTime)
{
$this->addedDateTime = $dateTime;
return $this;
}
/**
* Returns the message creation date time.
*
* @return DateTime The added date time.
*/
public function getAddedDateTime()
{
return $this->addedDateTime;
}
/**
* Sets the message modification date time.
*
* @param DateTime $dateTime Message modification date time.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setModifiedDateTime(DateTime $dateTime)
{
$this->modifiedDateTime = $dateTime;
return $this;
}
/**
* Returns the message modification date time.
*
* @return DateTime The modified date time.
*/
public function getModifiedDateTime()
{
return $this->modifiedDateTime;
}
/**
* Sets the message headline.
*
* @param StringType $text Message headline.
* @param LanguageCode $languageCode Language code for message headline.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setHeadLine(StringType $text, LanguageCode $languageCode)
{
$this->headlines->setValue($languageCode->asString(), $text->asString());
return $this;
}
/**
* Returns the message headline.
*
* @param LanguageCode $languageCode Language code of the message headline.
*
* @return string The message headline.
*/
public function getHeadLine(LanguageCode $languageCode)
{
return $this->headlines->getValue($languageCode->asString());
}
/**
* Sets the message.
*
* @param StringType $text Message.
* @param LanguageCode $languageCode Language code of the message.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setMessage(StringType $text, LanguageCode $languageCode)
{
$this->messages->setValue($languageCode->asString(), $text->asString());
return $this;
}
/**
* Returns the message.
*
* @param LanguageCode $languageCode Language code of the message.
*
* @return string The message.
*/
public function getMessage(LanguageCode $languageCode)
{
return $this->messages->getValue($languageCode->asString());
}
/**
* Sets the message button label.
*
* @param StringType $text Button label text.
* @param LanguageCode $languageCode Button label text language code.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setButtonLabel(StringType $text, LanguageCode $languageCode)
{
$this->buttonLabels->setValue($languageCode->asString(), $text->asString());
return $this;
}
/**
* Returns the message button label.
*
* @param LanguageCode $languageCode Button label language code.
*
* @return string The message button label.
*/
public function getButtonLabel(LanguageCode $languageCode)
{
return $this->buttonLabels->getValue($languageCode->asString());
}
/**
* Sets the identifier string of the message
*
* @param StringType $identifier Message identifier.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setIdentifier(StringType $identifier)
{
$this->identifier = $identifier->asString();
return $this;
}
/**
* Returns the message identifier.
*
* @return string Message identifier.
*/
public function getIdentifier()
{
return $this->identifier;
}
/**
* Sets the messages by adding a collection.
*
* @param KeyValueCollection $messages Messages.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setMessageCollection(KeyValueCollection $messages)
{
$this->messages->addCollection($messages);
return $this;
}
/**
* Sets the message headlines.
*
* @param KeyValueCollection $headlines Message headlines.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setHeadLineCollection(KeyValueCollection $headlines)
{
$this->headlines->addCollection($headlines);
return $this;
}
/**
* Sets the button labels.
*
* @param KeyValueCollection $buttonLabels Message button labels.
*
* @return InfoBoxMessage Same instance for method chaining.
*/
public function setButtonLabelCollection(KeyValueCollection $buttonLabels)
{
$this->buttonLabels->addCollection($buttonLabels);
return $this;
}
/**
* Returns the message collection.
*
* @return EditableKeyValueCollection
*/
public function getMessageCollection()
{
return $this->messages;
}
/**
* Returns the headline collection.
*
* @return EditableKeyValueCollection
*/
public function getHeadLineCollection()
{
return $this->headlines;
}
/**
* Returns the button label collection.
*
* @return EditableKeyValueCollection
*/
public function getButtonLabelCollection()
{
return $this->buttonLabels;
}
}