MailTemplateService.php 18.5 KB
Newer Older
1
2
3
4
<?php

namespace SGalinski\SgMail\Service;

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/***************************************************************
 *  Copyright notice
 *
 *  (c) sgalinski Internet Services (https://www.sgalinski.de)
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
28

29
use DateTime;
30
31
32
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\MailRepository;
33
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
34
35
use Swift_Attachment;
use Swift_OutputByteStream;
36
37
38
use TYPO3\CMS\Core\Mail\MailMessage;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;
39
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
40
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
41
42
use TYPO3\CMS\Fluid\View\StandaloneView;

43
44
45
/**
 * MailTemplateService
 */
46
class MailTemplateService {
47
	const MARKER_TYPE_STRING = 'String';
48
49
50
	const MARKER_TYPE_ARRAY = 'Array';
	const MARKER_TYPE_OBJECT = 'Object';

51
	/**
52
	 * @var array $registerArray
53
	 */
54
	private static $registerArray = [];
55

56
	/**
57
	 * @var array $toAddresses
58
	 */
59
	private $toAddresses = [];
60
61

	/**
62
	 * @var string $fromAddress
63
	 */
64
	private $fromAddress;
65
66

	/**
67
	 * @var array $ccAddresses
68
	 */
Paul Ilea's avatar
Paul Ilea committed
69
	private $ccAddresses;
70
71

	/**
72
	 * @var string $replyToAddress
73
	 */
74
	private $replyToAddress;
75
76

	/**
77
	 * @var string $language
78
	 */
79
	private $language;
80
81

	/**
82
	 * @var boolean $ignoreMailQueue
83
	 */
84
	private $ignoreMailQueue = FALSE;
85
86
87
88
89
90
91

	/**
	 * @var \TYPO3\CMS\Core\Mail\MailMessage $mailMessage
	 */
	private $mailMessage;

	/**
92
	 * @var string $templateName
93
94
95
96
	 */
	private $templateName;

	/**
97
	 * @var string $extensionKey
98
99
100
101
	 */
	private $extensionKey;

	/**
102
	 * @var array $markers
103
	 */
104
	private $markers = [];
105

106
107
108
	/**
	 * holds the TypoScript configuration for sg_mail
	 *
109
	 * @var array $tsSettings
110
	 */
Paul Ilea's avatar
Paul Ilea committed
111
	private $tsSettings;
112

113
114
115
	/**
	 * @var array $bccAddresses
	 */
Paul Ilea's avatar
Paul Ilea committed
116
	private $bccAddresses;
117

118
119
120
121
122
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

123
124
125
126
127
	/**
	 * @var int
	 */
	private $pid;

128
129
130
131
132
	/**
	 * @var string
	 */
	private $fromName = '';

133
134
135
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
136
137
138
139
140
141
	protected $templateRepository;

	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 */
	protected $persistenceManager;
142

143
144
145
146
147
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

148
149
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
150
151
	 *
	 * @throws \InvalidArgumentException
152
153
	 */
	public function __construct() {
154
155
156
157
158
159
		/** @var ObjectManager objectManager */
		$this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
		/** @var MailMessage mailMessage */
		$this->mailMessage = $this->objectManager->get(MailMessage::class);
		/** @var TypoScriptSettingsService $typoScriptSettingsService */
		$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
160
161
		$this->tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
		$this->language = $this->tsSettings['templateDefaultLanguage'];
162
163
164
165
		/** @var TemplateRepository templateRepository */
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		/** @var PersistenceManager persistenceManager */
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
166
167
168

		$this->fromAddress = $this->tsSettings['mail']['default']['from'];
		$this->mailMessage->setFrom($this->fromAddress);
169
		$this->bccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['bcc']);
170
171
172
173
174
175
176
177
178
179
180
181
182
183
		$this->ccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['cc']);

		foreach ($this->bccAddresses as $index => $email) {
			if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
				unset($this->bccAddresses[$index]);
			}
		}

		foreach ($this->ccAddresses as $index => $email) {
			if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
				unset($this->ccAddresses[$index]);
			}
		}

184
		if (count($this->bccAddresses) > 0) {
185
186
187
			$this->mailMessage->setBcc($this->bccAddresses);
		}

188
		if (count($this->ccAddresses) > 0) {
189
190
			$this->mailMessage->setCc($this->ccAddresses);
		}
191
192
	}

Torsten Oppermann's avatar
Torsten Oppermann committed
193
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
194
	 * register a template with sg_mail
Fabian Galinski's avatar
Fabian Galinski committed
195
	 *
196
197
198
	 * description and subject can now be an array i.e. with elements such as 'en' => 'english description'
	 * or an translation string used in locallang.xml
	 *
199
	 * @deprecated public usage of this function is deprecated. use registerByFile instead
200
	 * @param string $extension
Torsten Oppermann's avatar
Torsten Oppermann committed
201
202
	 * @param string $templateName
	 * @param string $templatePath
203
	 * @param mixed $description
204
	 * @param array $markers
205
	 * @param mixed $subject
206
	 * @param string $usage
Torsten Oppermann's avatar
Torsten Oppermann committed
207
	 */
208
	public static function registerTemplate(
209
		$extension, $templateName, $templatePath, $description, array $markers, $subject, $usage = ''
210
	) {
211
		MailTemplateService::$registerArray[$extension][$templateName] = [
212
			'templatePath' => $templatePath,
213
			'description' => $description,
214
			'marker' => $markers,
215
			'extension' => $extension,
216
			'templateName' => $templateName,
217
218
			'subject' => $subject,
			'usage' => $usage
219
220
		];
	}
221

222
223
224
	/**
	 * call in extlocalconf of an extension if you have a custom register class
	 *
Paul Ilea's avatar
Paul Ilea committed
225
226
	 * @param RegisterInterface $fileNameWithNamespace
	 * @param boolean $initObject Should the object initialize itself ?
227
228
	 *
	 * @return bool
Paul Ilea's avatar
Paul Ilea committed
229
	 * @throws \InvalidArgumentException
230
	 */
231
	public static function registerByFile($fileNameWithNamespace, $initObject = TRUE) {
232
233
234
235
236
237
		$registerObject = GeneralUtility::makeInstance($fileNameWithNamespace);
		// check instance of interface
		if (!($registerObject instanceof RegisterInterface)) {
			return FALSE;
		}

238
239
240
241
		// object calls registerTemplate, alternative way instead of localconf call
		if ($initObject) {
			$registerObject->init();
		}
242
243
244
245
		$registerObject->registerTemplate();
		return TRUE;
	}

246
247
248
249
250
251
252
253
254
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail') {
255
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275

		// Need the key for translations
		if (trim($extensionKey) === '') {
			return [];
		}

		$generatedMarker = [];
		foreach ($marker as $markerName) {
			$generatedMarker[] = [
				'marker' => $markerName,
				'value' => $languagePath . '.example.' . $markerName,
				'description' => $languagePath . '.description.' . $markerName,
				'backend_translation_key' => $translationKey . '.example.' . $markerName,
				'extension_key' => $extensionKey
			];
		}

		return $generatedMarker;
	}

276
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
277
	 * Get all registered templates
Fabian Galinski's avatar
Fabian Galinski committed
278
	 *
279
	 * @return array
280
	 */
281
282
	public static function getRegisterArray() {
		return self::$registerArray;
283
	}
284
285

	/**
286
	 * Send the Email
287
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
288
	 * @param boolean $isPreview
289
	 * @return boolean email was sent or added to mail queue successfully?
290
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
291
	 */
292
	public function sendEmail($isPreview = FALSE) {
293
294
295
296
		if (!$this->pid) {
			return FALSE;
		}
		$siteRootId = BackendService::getSiteRoot($this->pid);
297

298
		/** @var Template $template */
299
		$template = $this->templateRepository->findOneByTemplate(
300
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
301
		);
302

303
304
305
306
307
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

308
309
310
311
312
313
314
315
		// If there is no template for this language, use the default template
		if ($template === NULL) {
			$templatePath = self::$registerArray[$this->extensionKey][$this->templateName]['templatePath'];
			$templateFile = $templatePath . $this->language . '.template.html';
			if (file_exists($templateFile)) {
				$defaultTemplateContent = file_get_contents($templatePath . $this->language . '.template.html');
			} else {
				// no language found and no default template
Paul Ilea's avatar
Paul Ilea committed
316
				$this->setLanguage($this->tsSettings['templateDefaultLanguage'] ?: 'en');
317
318
319
320
321
322
323
				// does an english default template exist ?
				if (file_exists($templatePath . $this->language . '.template.html')) {
					$this->sendEmail();
					return TRUE;
				}

				return FALSE;
324
			}
325
326
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
327
328
		if ($isPreview) {
			$previewMarker = [];
Paul Ilea's avatar
Paul Ilea committed
329
			/** @var array $markerArray */
Torsten Oppermann's avatar
Torsten Oppermann committed
330
331
			$markerArray = self::$registerArray[$this->extensionKey][$this->templateName]['marker'];
			foreach ($markerArray as $marker) {
332
333
334
335
336
337
338
339
340
341
342
343
				$markerPath = GeneralUtility::trimExplode('.', $marker['marker']);
				$temporaryMarkerArray = [];
				foreach (array_reverse($markerPath) as $index => $markerPathSegment) {
					if ($index === 0) {
						if ($marker['backend_translation_key']) {
							$temporaryMarkerArray[$markerPathSegment] = LocalizationUtility::translate(
								$marker['backend_translation_key'], $marker['extension_key']
							);
						} else {
							$temporaryMarkerArray[$markerPathSegment] = $marker['value'];
						}
					} else {
344
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
345
					}
346
				}
347
				$previewMarker = array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
348
			}
349
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
350
351
352
			$this->setMarkers($previewMarker);
		}

353
		/** @var StandaloneView $emailView */
354
		$emailView = $this->objectManager->get(StandaloneView::class);
355

356
		if (NULL === $defaultTemplateContent) {
357
			$emailView->setTemplateSource($template->getContent());
358
			$subject = $template->getSubject();
359
360
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
361
362
363
364
365
366
367
368
369
370

			$subject = self::$registerArray[$this->extensionKey][$this->templateName]['subject'];
			if (is_array($subject)) {
				$subject = self::$registerArray[$this->extensionKey][$this->templateName]['subject'][$this->language];
			} else {
				$subject = LocalizationUtility::translate(
					self::$registerArray[$this->extensionKey][$this->templateName]['subject'],
					$this->extensionKey
				);
			}
371
		}
372
		$this->mailMessage->setSubject($subject);
373

374
		$emailView->assignMultiple($this->markers);
375
		$emailBody = $emailView->render();
376

377
378
379
380
		// insert <br /> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = nl2br($emailBody);
		$emailBody = preg_replace('/(<br[\s]?[\/]?>[\s]*){3,}/', '<br /><br />', $emailBody);
		if ($this->ignoreMailQueue) {
381

382
			$this->mailMessage->setBody($emailBody, 'text/html');
383
			$this->mailMessage->send();
384
			$dateTime = new DateTime();
385
			$currentTimestamp = $dateTime->getTimestamp();
386
			$this->addMailToMailQueue(
387
				$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
388
				$currentTimestamp, TRUE, $currentTimestamp, $this->language, $siteRootId
389
390
			);

391
		} else {
392
393
394
395
			$this->addMailToMailQueue(
				$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority, 0, FALSE, 0,
				$this->language, $siteRootId
			);
396
		}
397
398

		return TRUE;
399
400
401
	}

	/**
402
	 * Adds a new mail to the mail queue.
403
	 *
404
405
	 * @param string $extensionKey
	 * @param string $templateName
406
	 * @param string $subject
407
	 * @param string $emailBody
408
	 * @param int $sendingTime
409
	 * @param int $priority
410
	 * @param int $lastSendingTime
411
	 * @param string $language
412
	 * @param int $pid
413
	 * @param bool $sent
Paul Ilea's avatar
Paul Ilea committed
414
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
415
	 */
416
	private function addMailToMailQueue(
417
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0, $sent = FALSE,
418
		$lastSendingTime = 0, $language = 'en', $pid = 0
419
	) {
420
		$mail = $this->objectManager->get(Mail::class);
421
		$mail->setPid($pid);
422
423
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
424
		$mail->setLanguage($language);
425
		$mail->setFromAddress($this->fromAddress);
426
		$mail->setFromName($this->fromName);
427
		$mail->setToAddress($this->toAddresses);
428
		$mail->setMailSubject($subject);
429
		$mail->setMailBody($emailBody);
430
		$mail->setPriority($priority);
431
432
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
433
		$mail->setSent($sent);
434
		$mail->setSendingTime($sendingTime);
435
		$mail->setLastSendingTime($lastSendingTime);
436
		$mail->setReplyTo($this->replyToAddress);
437

438
		$mailRepository = $this->objectManager->get(MailRepository::class);
439
		$mailRepository->add($mail);
440
		$this->persistenceManager->persistAll();
441
	}
442

443
444
445
446
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
Paul Ilea's avatar
Paul Ilea committed
447
448
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
449
450
451
452
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
453
		$mailToSend = $mailRepository->findOneByUid($uid);
454
455
456
457
458
459

		if ($mailToSend) {
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
			$this->mailMessage->setTo($mailToSend->getToAddress());
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
460

461
			if ($mailToSend->getBccAddresses()) {
462
463
464
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

465
			if ($mailToSend->getCcAddresses()) {
466
467
468
469
470
471
472
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

			if ($mailToSend->getReplyTo()) {
				$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
			}

473
474
			$dateTime = new DateTime();
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
475
			$this->mailMessage->send();
476
477
478
			if (!$mailToSend->getSent()) {
				$mailToSend->setSent(TRUE);
			}
479
			$mailRepository->update($mailToSend);
480
481
482
		}
	}

483
484
	/**
	 * @param array $registerArray
485
	 * @return void
486
	 */
487
	public static function setRegisterArray(array $registerArray) {
488
489
490
491
		self::$registerArray = $registerArray;
	}

	/**
492
	 * @param string $toAddresses
493
494
	 * @return MailTemplateService
	 */
495
496
497
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
498
499
500
501
		return $this;
	}

	/**
502
	 * @param string $fromAddress
503
	 * @param string $fromName
504
505
	 * @return MailTemplateService
	 */
506
	public function setFromAddress($fromAddress, $fromName = '') {
507
508
509
510
511
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

512
513
514
515
		return $this;
	}

	/**
516
	 * @param string $ccAddresses
517
518
	 * @return MailTemplateService
	 */
519
	public function setCcAddresses($ccAddresses) {
520
521
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
522
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
523
524
		}

525
526
527
528
		return $this;
	}

	/**
529
	 * @param string $replyToAddress
530
531
	 * @return MailTemplateService
	 */
532
	public function setReplyToAddress($replyToAddress) {
533
534
535
536
537
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
		return $this;
	}

	/**
	 * @param string $language
	 * @return MailTemplateService
	 */
	public function setLanguage($language) {
		$this->language = $language;
		return $this;
	}

	/**
	 * @param boolean $ignoreMailQueue
	 * @return MailTemplateService
	 */
	public function setIgnoreMailQueue($ignoreMailQueue) {
		$this->ignoreMailQueue = $ignoreMailQueue;
		return $this;
	}

	/**
	 * @param string $templateName
	 * @return MailTemplateService
	 */
	public function setTemplateName($templateName) {
		$this->templateName = $templateName;
		return $this;
	}

	/**
	 * @param string $extensionKey
	 * @return MailTemplateService
	 */
	public function setExtensionKey($extensionKey) {
		$this->extensionKey = $extensionKey;
		return $this;
	}

577
	/**
578
	 * @param array $markers
579
580
	 * @return MailTemplateService
	 */
581
582
	public function setMarkers(array $markers) {
		$this->markers = $markers;
583
584
		return $this;
	}
585
586

	/**
587
	 * @param string $bccAddresses
588
589
	 * @return MailTemplateService
	 */
590
	public function setBccAddresses($bccAddresses) {
591
592
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
593
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
594
595
		}

596
597
598
		return $this;
	}

599
600
601
602
603
604
605
606
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
607
608
609

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
610
	 * @param string $filename
611
612
613
614
615
616
617
618
619
620
621
	 * @param string $contentType
	 * @return MailTemplateService
	 */
	public function addAttachment($data, $filename, $contentType) {
		$attachment = Swift_Attachment::newInstance()
			->setFilename($filename)
			->setContentType($contentType)
			->setBody($data);
		$this->mailMessage->attach($attachment);
		return $this;
	}
622
623
624
625
626
627
628
629

	/**
	 * @return MailMessage
	 */
	public function getMailMessage() {
		return $this->mailMessage;
	}

630
631
632
633
634
635
636
637
638
639
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
		$this->setFromAddress($template->getFromMail(), $template->getFromName());
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
640
641
642
643
644
645
646
647
648
		$this->setFromName($template->getFromName());
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
649
	}
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
	public static function getReadableMarkerType($markerType) {
		switch ($markerType) {
			case self::MARKER_TYPE_STRING :
				LocalizationUtility::translate('backend.marker.type.string', 'sg_mail');
				break;
			case self::MARKER_TYPE_ARRAY :
				LocalizationUtility::translate('backend.marker.type.array', 'sg_mail');
				break;
			case self::MARKER_TYPE_OBJECT :
				LocalizationUtility::translate('backend.marker.type.object', 'sg_mail');
				break;
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}
671
672
673
674
675
676
677
678
679
680
681

	/**
	 * set the page id from which this was called
	 *
	 * @param int $pid
	 * @return MailTemplateService
	 */
	public function setPid($pid) {
		$this->pid = (int) $pid;
		return $this;
	}
682
}