Total Complexity | 90 |
Total Lines | 1357 |
Duplicated Lines | 0 % |
Changes | 0 |
Complex classes like ScheduledScanModel often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ScheduledScanModel, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
13 | class ScheduledScanModel |
||
14 | { |
||
15 | /** |
||
16 | * Gets or sets the last executed scan task identifier. |
||
17 | * |
||
18 | * @var string |
||
19 | */ |
||
20 | protected $lastExecutedScanTaskId; |
||
21 | /** |
||
22 | * Gets or sets the last execution error. |
||
23 | * |
||
24 | * @var int |
||
25 | */ |
||
26 | protected $lastExecutionError; |
||
27 | /** |
||
28 | * Gets or sets the last execution status. If value is not {Netsparker.Cloud.Core.Models.ScanLaunchStatus.Ok}, specifies error type of. |
||
29 | {Netsparker.Cloud.Infrastructure.Models.ScheduledScanModel.LastExecutionError} |
||
30 | * |
||
31 | * @var string |
||
32 | */ |
||
33 | protected $lastExecutionStatus; |
||
34 | /** |
||
35 | * Represents a model for carrying out scan time window settings. |
||
36 | * |
||
37 | * @var ScanTimeWindowModel |
||
38 | */ |
||
39 | protected $timeWindow; |
||
40 | /** |
||
41 | * Gets or sets the identifier. |
||
42 | * |
||
43 | * @var string |
||
44 | */ |
||
45 | protected $id; |
||
46 | /** |
||
47 | * Gets or sets the how many times a scheduled scan triggered. |
||
48 | * |
||
49 | * @var int |
||
50 | */ |
||
51 | protected $occurencesCount; |
||
52 | /** |
||
53 | * Gets or sets a value indicating whether scheduled scan is disabled. |
||
54 | * |
||
55 | * @var bool |
||
56 | */ |
||
57 | protected $disabled; |
||
58 | /** |
||
59 | * Gets or sets a value indicating whether scheduling enabled. |
||
60 | * |
||
61 | * @var bool |
||
62 | */ |
||
63 | protected $enableScheduling; |
||
64 | /** |
||
65 | * Gets or sets the name. |
||
66 | * |
||
67 | * @var string |
||
68 | */ |
||
69 | protected $name; |
||
70 | /** |
||
71 | * Gets or sets the next execution time. |
||
72 | * |
||
73 | * @var string |
||
74 | */ |
||
75 | protected $nextExecutionTime; |
||
76 | /** |
||
77 | * Gets or sets scan group id. |
||
78 | * |
||
79 | * @var string |
||
80 | */ |
||
81 | protected $scanGroupId; |
||
82 | /** |
||
83 | * Gets or sets scan type. |
||
84 | * |
||
85 | * @var string |
||
86 | */ |
||
87 | protected $scanType; |
||
88 | /** |
||
89 | * Gets or sets the run interval of scheduled scan. |
||
90 | * |
||
91 | * @var string |
||
92 | */ |
||
93 | protected $scheduleRunType; |
||
94 | /** |
||
95 | * Scheduled scan recurrence view model. |
||
96 | * |
||
97 | * @var ScheduledScanRecurrenceViewModel |
||
98 | */ |
||
99 | protected $customRecurrence; |
||
100 | /** |
||
101 | * Gets or sets whether is target URL required. |
||
102 | * |
||
103 | * @var bool |
||
104 | */ |
||
105 | protected $isTargetUrlRequired; |
||
106 | /** |
||
107 | * Represents a model for carrying out additional websites. |
||
108 | * |
||
109 | * @var AdditionalWebsitesSettingModel |
||
110 | */ |
||
111 | protected $additionalWebsites; |
||
112 | /** |
||
113 | * Gets or sets the agent group identifier. |
||
114 | * |
||
115 | * @var string |
||
116 | */ |
||
117 | protected $agentGroupId; |
||
118 | /** |
||
119 | * Gets or sets the agent identifier. |
||
120 | * |
||
121 | * @var string |
||
122 | */ |
||
123 | protected $agentId; |
||
124 | /** |
||
125 | * Represents a model for carrying out basic authentication settings. |
||
126 | * |
||
127 | * @var BasicAuthenticationSettingModel |
||
128 | */ |
||
129 | protected $basicAuthenticationSetting; |
||
130 | /** |
||
131 | * Gets or sets the can edit. |
||
132 | * |
||
133 | * @var bool |
||
134 | */ |
||
135 | protected $canEdit; |
||
136 | /** |
||
137 | * Represents a model for carrying out client certificate authentication settings. |
||
138 | * |
||
139 | * @var ClientCertificateAuthenticationViewModel |
||
140 | */ |
||
141 | protected $clientCertificateAuthentication; |
||
142 | /** |
||
143 | * Gets or sets the cookies. |
||
144 | * |
||
145 | * @var string |
||
146 | */ |
||
147 | protected $cookies; |
||
148 | /** |
||
149 | * Gets or sets a value indicating whether parallel attacker is enabled. |
||
150 | * |
||
151 | * @var bool |
||
152 | */ |
||
153 | protected $crawlAndAttack; |
||
154 | /** |
||
155 | * Gets or sets the type of the create. |
||
156 | * |
||
157 | * @var string |
||
158 | */ |
||
159 | protected $createType; |
||
160 | /** |
||
161 | * Gets or sets a value indicating whether automatic crawling is enabled. |
||
162 | * |
||
163 | * @var bool |
||
164 | */ |
||
165 | protected $findAndFollowNewLinks; |
||
166 | /** |
||
167 | * Represents a model for carrying out form authentication settings. |
||
168 | * |
||
169 | * @var FormAuthenticationSettingModel |
||
170 | */ |
||
171 | protected $formAuthenticationSetting; |
||
172 | /** |
||
173 | * Represents a model for carrying out header authentication setttings. |
||
174 | * |
||
175 | * @var HeaderAuthenticationModel |
||
176 | */ |
||
177 | protected $headerAuthentication; |
||
178 | /** |
||
179 | * Represents a class that carries out imported links. |
||
180 | * |
||
181 | * @var ImportedLinksSetting |
||
182 | */ |
||
183 | protected $importedLinks; |
||
184 | /** |
||
185 | * Gets or sets a value indicating whether max scan duration is enabled. |
||
186 | This is only used for scheduled group scan and regular group scan. |
||
187 | * |
||
188 | * @var bool |
||
189 | */ |
||
190 | protected $isMaxScanDurationEnabled; |
||
191 | /** |
||
192 | * Gets or sets a value indicating whether this instance is primary. |
||
193 | * |
||
194 | * @var bool |
||
195 | */ |
||
196 | protected $isPrimary; |
||
197 | /** |
||
198 | * Gets or sets a value indicating whether this instance is shared. |
||
199 | * |
||
200 | * @var bool |
||
201 | */ |
||
202 | protected $isShared; |
||
203 | /** |
||
204 | * Gets or sets the maximum duration of the scan in hours. |
||
205 | * |
||
206 | * @var int |
||
207 | */ |
||
208 | protected $maxScanDuration; |
||
209 | /** |
||
210 | * Gets or sets the scan policy identifier. This property is required if CreateType is Website. |
||
211 | * |
||
212 | * @var string |
||
213 | */ |
||
214 | protected $policyId; |
||
215 | /** |
||
216 | * Gets or sets the profile identifier. |
||
217 | * |
||
218 | * @var string |
||
219 | */ |
||
220 | protected $profileId; |
||
221 | /** |
||
222 | * Gets or sets a name for this instance. |
||
223 | * |
||
224 | * @var string |
||
225 | */ |
||
226 | protected $profileName; |
||
227 | /** |
||
228 | * Gets or sets the report policy identifier. This property is required if CreateType is Website. |
||
229 | * |
||
230 | * @var string |
||
231 | */ |
||
232 | protected $reportPolicyId; |
||
233 | /** |
||
234 | * Gets or sets the save scan profile. |
||
235 | * |
||
236 | * @var bool |
||
237 | */ |
||
238 | protected $saveScanProfile; |
||
239 | /** |
||
240 | * Represents a class that carries out scope settings. |
||
241 | * |
||
242 | * @var ScopeSetting |
||
243 | */ |
||
244 | protected $scopeSetting; |
||
245 | /** |
||
246 | * Gets or sets the agent selections for the websites that use custom agent. This property is needed for Gorup Scans. |
||
247 | * |
||
248 | * @var AgentSelectionModel[] |
||
249 | */ |
||
250 | protected $selectedAgents; |
||
251 | /** |
||
252 | * Gets or sets the selected scan profile identifier. |
||
253 | * |
||
254 | * @var string |
||
255 | */ |
||
256 | protected $selectedScanProfileId; |
||
257 | /** |
||
258 | * Gets or sets the name of the selected scan profile. |
||
259 | * |
||
260 | * @var string |
||
261 | */ |
||
262 | protected $selectedScanProfileName; |
||
263 | /** |
||
264 | * Gets or sets the target website URL. This property is required if CreateType is Website. |
||
265 | * |
||
266 | * @var string |
||
267 | */ |
||
268 | protected $targetUrl; |
||
269 | /** |
||
270 | * Represents a class that carries out url rewrite settings. |
||
271 | * |
||
272 | * @var UrlRewriteSetting |
||
273 | */ |
||
274 | protected $urlRewriteSetting; |
||
275 | /** |
||
276 | * Gets or sets the user identifier. |
||
277 | * |
||
278 | * @var string |
||
279 | */ |
||
280 | protected $userId; |
||
281 | /** |
||
282 | * Gets or sets the website group identifier. This property is required if CreateType is WebsiteGroup. |
||
283 | * |
||
284 | * @var string |
||
285 | */ |
||
286 | protected $websiteGroupId; |
||
287 | |||
288 | /** |
||
289 | * Gets or sets the last executed scan task identifier. |
||
290 | * |
||
291 | * @return string |
||
292 | */ |
||
293 | public function getLastExecutedScanTaskId(): ?string |
||
294 | { |
||
295 | return $this->lastExecutedScanTaskId; |
||
296 | } |
||
297 | |||
298 | /** |
||
299 | * Gets or sets the last executed scan task identifier. |
||
300 | * |
||
301 | * @param string $lastExecutedScanTaskId |
||
302 | * |
||
303 | * @return self |
||
304 | */ |
||
305 | public function setLastExecutedScanTaskId(?string $lastExecutedScanTaskId): self |
||
306 | { |
||
307 | $this->lastExecutedScanTaskId = $lastExecutedScanTaskId; |
||
308 | |||
309 | return $this; |
||
310 | } |
||
311 | |||
312 | /** |
||
313 | * Gets or sets the last execution error. |
||
314 | * |
||
315 | * @return int |
||
316 | */ |
||
317 | public function getLastExecutionError(): ?int |
||
318 | { |
||
319 | return $this->lastExecutionError; |
||
320 | } |
||
321 | |||
322 | /** |
||
323 | * Gets or sets the last execution error. |
||
324 | * |
||
325 | * @param int $lastExecutionError |
||
326 | * |
||
327 | * @return self |
||
328 | */ |
||
329 | public function setLastExecutionError(?int $lastExecutionError): self |
||
330 | { |
||
331 | $this->lastExecutionError = $lastExecutionError; |
||
332 | |||
333 | return $this; |
||
334 | } |
||
335 | |||
336 | /** |
||
337 | * Gets or sets the last execution status. If value is not {Netsparker.Cloud.Core.Models.ScanLaunchStatus.Ok}, specifies error type of. |
||
338 | {Netsparker.Cloud.Infrastructure.Models.ScheduledScanModel.LastExecutionError} |
||
339 | * |
||
340 | * @return string |
||
341 | */ |
||
342 | public function getLastExecutionStatus(): ?string |
||
343 | { |
||
344 | return $this->lastExecutionStatus; |
||
345 | } |
||
346 | |||
347 | /** |
||
348 | * Gets or sets the last execution status. If value is not {Netsparker.Cloud.Core.Models.ScanLaunchStatus.Ok}, specifies error type of. |
||
349 | {Netsparker.Cloud.Infrastructure.Models.ScheduledScanModel.LastExecutionError} |
||
350 | * |
||
351 | * @param string $lastExecutionStatus |
||
352 | * |
||
353 | * @return self |
||
354 | */ |
||
355 | public function setLastExecutionStatus(?string $lastExecutionStatus): self |
||
356 | { |
||
357 | $this->lastExecutionStatus = $lastExecutionStatus; |
||
358 | |||
359 | return $this; |
||
360 | } |
||
361 | |||
362 | /** |
||
363 | * Represents a model for carrying out scan time window settings. |
||
364 | * |
||
365 | * @return ScanTimeWindowModel |
||
366 | */ |
||
367 | public function getTimeWindow(): ?ScanTimeWindowModel |
||
368 | { |
||
369 | return $this->timeWindow; |
||
370 | } |
||
371 | |||
372 | /** |
||
373 | * Represents a model for carrying out scan time window settings. |
||
374 | * |
||
375 | * @param ScanTimeWindowModel $timeWindow |
||
376 | * |
||
377 | * @return self |
||
378 | */ |
||
379 | public function setTimeWindow(?ScanTimeWindowModel $timeWindow): self |
||
380 | { |
||
381 | $this->timeWindow = $timeWindow; |
||
382 | |||
383 | return $this; |
||
384 | } |
||
385 | |||
386 | /** |
||
387 | * Gets or sets the identifier. |
||
388 | * |
||
389 | * @return string |
||
390 | */ |
||
391 | public function getId(): ?string |
||
392 | { |
||
393 | return $this->id; |
||
394 | } |
||
395 | |||
396 | /** |
||
397 | * Gets or sets the identifier. |
||
398 | * |
||
399 | * @param string $id |
||
400 | * |
||
401 | * @return self |
||
402 | */ |
||
403 | public function setId(?string $id): self |
||
404 | { |
||
405 | $this->id = $id; |
||
406 | |||
407 | return $this; |
||
408 | } |
||
409 | |||
410 | /** |
||
411 | * Gets or sets the how many times a scheduled scan triggered. |
||
412 | * |
||
413 | * @return int |
||
414 | */ |
||
415 | public function getOccurencesCount(): ?int |
||
416 | { |
||
417 | return $this->occurencesCount; |
||
418 | } |
||
419 | |||
420 | /** |
||
421 | * Gets or sets the how many times a scheduled scan triggered. |
||
422 | * |
||
423 | * @param int $occurencesCount |
||
424 | * |
||
425 | * @return self |
||
426 | */ |
||
427 | public function setOccurencesCount(?int $occurencesCount): self |
||
428 | { |
||
429 | $this->occurencesCount = $occurencesCount; |
||
430 | |||
431 | return $this; |
||
432 | } |
||
433 | |||
434 | /** |
||
435 | * Gets or sets a value indicating whether scheduled scan is disabled. |
||
436 | * |
||
437 | * @return bool |
||
438 | */ |
||
439 | public function getDisabled(): ?bool |
||
440 | { |
||
441 | return $this->disabled; |
||
442 | } |
||
443 | |||
444 | /** |
||
445 | * Gets or sets a value indicating whether scheduled scan is disabled. |
||
446 | * |
||
447 | * @param bool $disabled |
||
448 | * |
||
449 | * @return self |
||
450 | */ |
||
451 | public function setDisabled(?bool $disabled): self |
||
452 | { |
||
453 | $this->disabled = $disabled; |
||
454 | |||
455 | return $this; |
||
456 | } |
||
457 | |||
458 | /** |
||
459 | * Gets or sets a value indicating whether scheduling enabled. |
||
460 | * |
||
461 | * @return bool |
||
462 | */ |
||
463 | public function getEnableScheduling(): ?bool |
||
464 | { |
||
465 | return $this->enableScheduling; |
||
466 | } |
||
467 | |||
468 | /** |
||
469 | * Gets or sets a value indicating whether scheduling enabled. |
||
470 | * |
||
471 | * @param bool $enableScheduling |
||
472 | * |
||
473 | * @return self |
||
474 | */ |
||
475 | public function setEnableScheduling(?bool $enableScheduling): self |
||
476 | { |
||
477 | $this->enableScheduling = $enableScheduling; |
||
478 | |||
479 | return $this; |
||
480 | } |
||
481 | |||
482 | /** |
||
483 | * Gets or sets the name. |
||
484 | * |
||
485 | * @return string |
||
486 | */ |
||
487 | public function getName(): ?string |
||
488 | { |
||
489 | return $this->name; |
||
490 | } |
||
491 | |||
492 | /** |
||
493 | * Gets or sets the name. |
||
494 | * |
||
495 | * @param string $name |
||
496 | * |
||
497 | * @return self |
||
498 | */ |
||
499 | public function setName(?string $name): self |
||
500 | { |
||
501 | $this->name = $name; |
||
502 | |||
503 | return $this; |
||
504 | } |
||
505 | |||
506 | /** |
||
507 | * Gets or sets the next execution time. |
||
508 | * |
||
509 | * @return string |
||
510 | */ |
||
511 | public function getNextExecutionTime(): ?string |
||
512 | { |
||
513 | return $this->nextExecutionTime; |
||
514 | } |
||
515 | |||
516 | /** |
||
517 | * Gets or sets the next execution time. |
||
518 | * |
||
519 | * @param string $nextExecutionTime |
||
520 | * |
||
521 | * @return self |
||
522 | */ |
||
523 | public function setNextExecutionTime(?string $nextExecutionTime): self |
||
524 | { |
||
525 | $this->nextExecutionTime = $nextExecutionTime; |
||
526 | |||
527 | return $this; |
||
528 | } |
||
529 | |||
530 | /** |
||
531 | * Gets or sets scan group id. |
||
532 | * |
||
533 | * @return string |
||
534 | */ |
||
535 | public function getScanGroupId(): ?string |
||
536 | { |
||
537 | return $this->scanGroupId; |
||
538 | } |
||
539 | |||
540 | /** |
||
541 | * Gets or sets scan group id. |
||
542 | * |
||
543 | * @param string $scanGroupId |
||
544 | * |
||
545 | * @return self |
||
546 | */ |
||
547 | public function setScanGroupId(?string $scanGroupId): self |
||
548 | { |
||
549 | $this->scanGroupId = $scanGroupId; |
||
550 | |||
551 | return $this; |
||
552 | } |
||
553 | |||
554 | /** |
||
555 | * Gets or sets scan type. |
||
556 | * |
||
557 | * @return string |
||
558 | */ |
||
559 | public function getScanType(): ?string |
||
560 | { |
||
561 | return $this->scanType; |
||
562 | } |
||
563 | |||
564 | /** |
||
565 | * Gets or sets scan type. |
||
566 | * |
||
567 | * @param string $scanType |
||
568 | * |
||
569 | * @return self |
||
570 | */ |
||
571 | public function setScanType(?string $scanType): self |
||
572 | { |
||
573 | $this->scanType = $scanType; |
||
574 | |||
575 | return $this; |
||
576 | } |
||
577 | |||
578 | /** |
||
579 | * Gets or sets the run interval of scheduled scan. |
||
580 | * |
||
581 | * @return string |
||
582 | */ |
||
583 | public function getScheduleRunType(): ?string |
||
584 | { |
||
585 | return $this->scheduleRunType; |
||
586 | } |
||
587 | |||
588 | /** |
||
589 | * Gets or sets the run interval of scheduled scan. |
||
590 | * |
||
591 | * @param string $scheduleRunType |
||
592 | * |
||
593 | * @return self |
||
594 | */ |
||
595 | public function setScheduleRunType(?string $scheduleRunType): self |
||
596 | { |
||
597 | $this->scheduleRunType = $scheduleRunType; |
||
598 | |||
599 | return $this; |
||
600 | } |
||
601 | |||
602 | /** |
||
603 | * Scheduled scan recurrence view model. |
||
604 | * |
||
605 | * @return ScheduledScanRecurrenceViewModel |
||
606 | */ |
||
607 | public function getCustomRecurrence(): ?ScheduledScanRecurrenceViewModel |
||
608 | { |
||
609 | return $this->customRecurrence; |
||
610 | } |
||
611 | |||
612 | /** |
||
613 | * Scheduled scan recurrence view model. |
||
614 | * |
||
615 | * @param ScheduledScanRecurrenceViewModel $customRecurrence |
||
616 | * |
||
617 | * @return self |
||
618 | */ |
||
619 | public function setCustomRecurrence(?ScheduledScanRecurrenceViewModel $customRecurrence): self |
||
620 | { |
||
621 | $this->customRecurrence = $customRecurrence; |
||
622 | |||
623 | return $this; |
||
624 | } |
||
625 | |||
626 | /** |
||
627 | * Gets or sets whether is target URL required. |
||
628 | * |
||
629 | * @return bool |
||
630 | */ |
||
631 | public function getIsTargetUrlRequired(): ?bool |
||
632 | { |
||
633 | return $this->isTargetUrlRequired; |
||
634 | } |
||
635 | |||
636 | /** |
||
637 | * Gets or sets whether is target URL required. |
||
638 | * |
||
639 | * @param bool $isTargetUrlRequired |
||
640 | * |
||
641 | * @return self |
||
642 | */ |
||
643 | public function setIsTargetUrlRequired(?bool $isTargetUrlRequired): self |
||
644 | { |
||
645 | $this->isTargetUrlRequired = $isTargetUrlRequired; |
||
646 | |||
647 | return $this; |
||
648 | } |
||
649 | |||
650 | /** |
||
651 | * Represents a model for carrying out additional websites. |
||
652 | * |
||
653 | * @return AdditionalWebsitesSettingModel |
||
654 | */ |
||
655 | public function getAdditionalWebsites(): ?AdditionalWebsitesSettingModel |
||
656 | { |
||
657 | return $this->additionalWebsites; |
||
658 | } |
||
659 | |||
660 | /** |
||
661 | * Represents a model for carrying out additional websites. |
||
662 | * |
||
663 | * @param AdditionalWebsitesSettingModel $additionalWebsites |
||
664 | * |
||
665 | * @return self |
||
666 | */ |
||
667 | public function setAdditionalWebsites(?AdditionalWebsitesSettingModel $additionalWebsites): self |
||
668 | { |
||
669 | $this->additionalWebsites = $additionalWebsites; |
||
670 | |||
671 | return $this; |
||
672 | } |
||
673 | |||
674 | /** |
||
675 | * Gets or sets the agent group identifier. |
||
676 | * |
||
677 | * @return string |
||
678 | */ |
||
679 | public function getAgentGroupId(): ?string |
||
680 | { |
||
681 | return $this->agentGroupId; |
||
682 | } |
||
683 | |||
684 | /** |
||
685 | * Gets or sets the agent group identifier. |
||
686 | * |
||
687 | * @param string $agentGroupId |
||
688 | * |
||
689 | * @return self |
||
690 | */ |
||
691 | public function setAgentGroupId(?string $agentGroupId): self |
||
692 | { |
||
693 | $this->agentGroupId = $agentGroupId; |
||
694 | |||
695 | return $this; |
||
696 | } |
||
697 | |||
698 | /** |
||
699 | * Gets or sets the agent identifier. |
||
700 | * |
||
701 | * @return string |
||
702 | */ |
||
703 | public function getAgentId(): ?string |
||
704 | { |
||
705 | return $this->agentId; |
||
706 | } |
||
707 | |||
708 | /** |
||
709 | * Gets or sets the agent identifier. |
||
710 | * |
||
711 | * @param string $agentId |
||
712 | * |
||
713 | * @return self |
||
714 | */ |
||
715 | public function setAgentId(?string $agentId): self |
||
716 | { |
||
717 | $this->agentId = $agentId; |
||
718 | |||
719 | return $this; |
||
720 | } |
||
721 | |||
722 | /** |
||
723 | * Represents a model for carrying out basic authentication settings. |
||
724 | * |
||
725 | * @return BasicAuthenticationSettingModel |
||
726 | */ |
||
727 | public function getBasicAuthenticationSetting(): ?BasicAuthenticationSettingModel |
||
728 | { |
||
729 | return $this->basicAuthenticationSetting; |
||
730 | } |
||
731 | |||
732 | /** |
||
733 | * Represents a model for carrying out basic authentication settings. |
||
734 | * |
||
735 | * @param BasicAuthenticationSettingModel $basicAuthenticationSetting |
||
736 | * |
||
737 | * @return self |
||
738 | */ |
||
739 | public function setBasicAuthenticationSetting(?BasicAuthenticationSettingModel $basicAuthenticationSetting): self |
||
740 | { |
||
741 | $this->basicAuthenticationSetting = $basicAuthenticationSetting; |
||
742 | |||
743 | return $this; |
||
744 | } |
||
745 | |||
746 | /** |
||
747 | * Gets or sets the can edit. |
||
748 | * |
||
749 | * @return bool |
||
750 | */ |
||
751 | public function getCanEdit(): ?bool |
||
752 | { |
||
753 | return $this->canEdit; |
||
754 | } |
||
755 | |||
756 | /** |
||
757 | * Gets or sets the can edit. |
||
758 | * |
||
759 | * @param bool $canEdit |
||
760 | * |
||
761 | * @return self |
||
762 | */ |
||
763 | public function setCanEdit(?bool $canEdit): self |
||
764 | { |
||
765 | $this->canEdit = $canEdit; |
||
766 | |||
767 | return $this; |
||
768 | } |
||
769 | |||
770 | /** |
||
771 | * Represents a model for carrying out client certificate authentication settings. |
||
772 | * |
||
773 | * @return ClientCertificateAuthenticationViewModel |
||
774 | */ |
||
775 | public function getClientCertificateAuthentication(): ?ClientCertificateAuthenticationViewModel |
||
776 | { |
||
777 | return $this->clientCertificateAuthentication; |
||
778 | } |
||
779 | |||
780 | /** |
||
781 | * Represents a model for carrying out client certificate authentication settings. |
||
782 | * |
||
783 | * @param ClientCertificateAuthenticationViewModel $clientCertificateAuthentication |
||
784 | * |
||
785 | * @return self |
||
786 | */ |
||
787 | public function setClientCertificateAuthentication(?ClientCertificateAuthenticationViewModel $clientCertificateAuthentication): self |
||
788 | { |
||
789 | $this->clientCertificateAuthentication = $clientCertificateAuthentication; |
||
790 | |||
791 | return $this; |
||
792 | } |
||
793 | |||
794 | /** |
||
795 | * Gets or sets the cookies. |
||
796 | * |
||
797 | * @return string |
||
798 | */ |
||
799 | public function getCookies(): ?string |
||
800 | { |
||
801 | return $this->cookies; |
||
802 | } |
||
803 | |||
804 | /** |
||
805 | * Gets or sets the cookies. |
||
806 | * |
||
807 | * @param string $cookies |
||
808 | * |
||
809 | * @return self |
||
810 | */ |
||
811 | public function setCookies(?string $cookies): self |
||
812 | { |
||
813 | $this->cookies = $cookies; |
||
814 | |||
815 | return $this; |
||
816 | } |
||
817 | |||
818 | /** |
||
819 | * Gets or sets a value indicating whether parallel attacker is enabled. |
||
820 | * |
||
821 | * @return bool |
||
822 | */ |
||
823 | public function getCrawlAndAttack(): ?bool |
||
824 | { |
||
825 | return $this->crawlAndAttack; |
||
826 | } |
||
827 | |||
828 | /** |
||
829 | * Gets or sets a value indicating whether parallel attacker is enabled. |
||
830 | * |
||
831 | * @param bool $crawlAndAttack |
||
832 | * |
||
833 | * @return self |
||
834 | */ |
||
835 | public function setCrawlAndAttack(?bool $crawlAndAttack): self |
||
836 | { |
||
837 | $this->crawlAndAttack = $crawlAndAttack; |
||
838 | |||
839 | return $this; |
||
840 | } |
||
841 | |||
842 | /** |
||
843 | * Gets or sets the type of the create. |
||
844 | * |
||
845 | * @return string |
||
846 | */ |
||
847 | public function getCreateType(): ?string |
||
848 | { |
||
849 | return $this->createType; |
||
850 | } |
||
851 | |||
852 | /** |
||
853 | * Gets or sets the type of the create. |
||
854 | * |
||
855 | * @param string $createType |
||
856 | * |
||
857 | * @return self |
||
858 | */ |
||
859 | public function setCreateType(?string $createType): self |
||
860 | { |
||
861 | $this->createType = $createType; |
||
862 | |||
863 | return $this; |
||
864 | } |
||
865 | |||
866 | /** |
||
867 | * Gets or sets a value indicating whether automatic crawling is enabled. |
||
868 | * |
||
869 | * @return bool |
||
870 | */ |
||
871 | public function getFindAndFollowNewLinks(): ?bool |
||
872 | { |
||
873 | return $this->findAndFollowNewLinks; |
||
874 | } |
||
875 | |||
876 | /** |
||
877 | * Gets or sets a value indicating whether automatic crawling is enabled. |
||
878 | * |
||
879 | * @param bool $findAndFollowNewLinks |
||
880 | * |
||
881 | * @return self |
||
882 | */ |
||
883 | public function setFindAndFollowNewLinks(?bool $findAndFollowNewLinks): self |
||
884 | { |
||
885 | $this->findAndFollowNewLinks = $findAndFollowNewLinks; |
||
886 | |||
887 | return $this; |
||
888 | } |
||
889 | |||
890 | /** |
||
891 | * Represents a model for carrying out form authentication settings. |
||
892 | * |
||
893 | * @return FormAuthenticationSettingModel |
||
894 | */ |
||
895 | public function getFormAuthenticationSetting(): ?FormAuthenticationSettingModel |
||
896 | { |
||
897 | return $this->formAuthenticationSetting; |
||
898 | } |
||
899 | |||
900 | /** |
||
901 | * Represents a model for carrying out form authentication settings. |
||
902 | * |
||
903 | * @param FormAuthenticationSettingModel $formAuthenticationSetting |
||
904 | * |
||
905 | * @return self |
||
906 | */ |
||
907 | public function setFormAuthenticationSetting(?FormAuthenticationSettingModel $formAuthenticationSetting): self |
||
908 | { |
||
909 | $this->formAuthenticationSetting = $formAuthenticationSetting; |
||
910 | |||
911 | return $this; |
||
912 | } |
||
913 | |||
914 | /** |
||
915 | * Represents a model for carrying out header authentication setttings. |
||
916 | * |
||
917 | * @return HeaderAuthenticationModel |
||
918 | */ |
||
919 | public function getHeaderAuthentication(): ?HeaderAuthenticationModel |
||
920 | { |
||
921 | return $this->headerAuthentication; |
||
922 | } |
||
923 | |||
924 | /** |
||
925 | * Represents a model for carrying out header authentication setttings. |
||
926 | * |
||
927 | * @param HeaderAuthenticationModel $headerAuthentication |
||
928 | * |
||
929 | * @return self |
||
930 | */ |
||
931 | public function setHeaderAuthentication(?HeaderAuthenticationModel $headerAuthentication): self |
||
932 | { |
||
933 | $this->headerAuthentication = $headerAuthentication; |
||
934 | |||
935 | return $this; |
||
936 | } |
||
937 | |||
938 | /** |
||
939 | * Represents a class that carries out imported links. |
||
940 | * |
||
941 | * @return ImportedLinksSetting |
||
942 | */ |
||
943 | public function getImportedLinks(): ?ImportedLinksSetting |
||
944 | { |
||
945 | return $this->importedLinks; |
||
946 | } |
||
947 | |||
948 | /** |
||
949 | * Represents a class that carries out imported links. |
||
950 | * |
||
951 | * @param ImportedLinksSetting $importedLinks |
||
952 | * |
||
953 | * @return self |
||
954 | */ |
||
955 | public function setImportedLinks(?ImportedLinksSetting $importedLinks): self |
||
956 | { |
||
957 | $this->importedLinks = $importedLinks; |
||
958 | |||
959 | return $this; |
||
960 | } |
||
961 | |||
962 | /** |
||
963 | * Gets or sets a value indicating whether max scan duration is enabled. |
||
964 | This is only used for scheduled group scan and regular group scan. |
||
965 | * |
||
966 | * @return bool |
||
967 | */ |
||
968 | public function getIsMaxScanDurationEnabled(): ?bool |
||
969 | { |
||
970 | return $this->isMaxScanDurationEnabled; |
||
971 | } |
||
972 | |||
973 | /** |
||
974 | * Gets or sets a value indicating whether max scan duration is enabled. |
||
975 | This is only used for scheduled group scan and regular group scan. |
||
976 | * |
||
977 | * @param bool $isMaxScanDurationEnabled |
||
978 | * |
||
979 | * @return self |
||
980 | */ |
||
981 | public function setIsMaxScanDurationEnabled(?bool $isMaxScanDurationEnabled): self |
||
982 | { |
||
983 | $this->isMaxScanDurationEnabled = $isMaxScanDurationEnabled; |
||
984 | |||
985 | return $this; |
||
986 | } |
||
987 | |||
988 | /** |
||
989 | * Gets or sets a value indicating whether this instance is primary. |
||
990 | * |
||
991 | * @return bool |
||
992 | */ |
||
993 | public function getIsPrimary(): ?bool |
||
994 | { |
||
995 | return $this->isPrimary; |
||
996 | } |
||
997 | |||
998 | /** |
||
999 | * Gets or sets a value indicating whether this instance is primary. |
||
1000 | * |
||
1001 | * @param bool $isPrimary |
||
1002 | * |
||
1003 | * @return self |
||
1004 | */ |
||
1005 | public function setIsPrimary(?bool $isPrimary): self |
||
1006 | { |
||
1007 | $this->isPrimary = $isPrimary; |
||
1008 | |||
1009 | return $this; |
||
1010 | } |
||
1011 | |||
1012 | /** |
||
1013 | * Gets or sets a value indicating whether this instance is shared. |
||
1014 | * |
||
1015 | * @return bool |
||
1016 | */ |
||
1017 | public function getIsShared(): ?bool |
||
1018 | { |
||
1019 | return $this->isShared; |
||
1020 | } |
||
1021 | |||
1022 | /** |
||
1023 | * Gets or sets a value indicating whether this instance is shared. |
||
1024 | * |
||
1025 | * @param bool $isShared |
||
1026 | * |
||
1027 | * @return self |
||
1028 | */ |
||
1029 | public function setIsShared(?bool $isShared): self |
||
1030 | { |
||
1031 | $this->isShared = $isShared; |
||
1032 | |||
1033 | return $this; |
||
1034 | } |
||
1035 | |||
1036 | /** |
||
1037 | * Gets or sets the maximum duration of the scan in hours. |
||
1038 | * |
||
1039 | * @return int |
||
1040 | */ |
||
1041 | public function getMaxScanDuration(): ?int |
||
1042 | { |
||
1043 | return $this->maxScanDuration; |
||
1044 | } |
||
1045 | |||
1046 | /** |
||
1047 | * Gets or sets the maximum duration of the scan in hours. |
||
1048 | * |
||
1049 | * @param int $maxScanDuration |
||
1050 | * |
||
1051 | * @return self |
||
1052 | */ |
||
1053 | public function setMaxScanDuration(?int $maxScanDuration): self |
||
1054 | { |
||
1055 | $this->maxScanDuration = $maxScanDuration; |
||
1056 | |||
1057 | return $this; |
||
1058 | } |
||
1059 | |||
1060 | /** |
||
1061 | * Gets or sets the scan policy identifier. This property is required if CreateType is Website. |
||
1062 | * |
||
1063 | * @return string |
||
1064 | */ |
||
1065 | public function getPolicyId(): ?string |
||
1066 | { |
||
1067 | return $this->policyId; |
||
1068 | } |
||
1069 | |||
1070 | /** |
||
1071 | * Gets or sets the scan policy identifier. This property is required if CreateType is Website. |
||
1072 | * |
||
1073 | * @param string $policyId |
||
1074 | * |
||
1075 | * @return self |
||
1076 | */ |
||
1077 | public function setPolicyId(?string $policyId): self |
||
1078 | { |
||
1079 | $this->policyId = $policyId; |
||
1080 | |||
1081 | return $this; |
||
1082 | } |
||
1083 | |||
1084 | /** |
||
1085 | * Gets or sets the profile identifier. |
||
1086 | * |
||
1087 | * @return string |
||
1088 | */ |
||
1089 | public function getProfileId(): ?string |
||
1092 | } |
||
1093 | |||
1094 | /** |
||
1095 | * Gets or sets the profile identifier. |
||
1096 | * |
||
1097 | * @param string $profileId |
||
1098 | * |
||
1099 | * @return self |
||
1100 | */ |
||
1101 | public function setProfileId(?string $profileId): self |
||
1102 | { |
||
1103 | $this->profileId = $profileId; |
||
1104 | |||
1105 | return $this; |
||
1106 | } |
||
1107 | |||
1108 | /** |
||
1109 | * Gets or sets a name for this instance. |
||
1110 | * |
||
1111 | * @return string |
||
1112 | */ |
||
1113 | public function getProfileName(): ?string |
||
1114 | { |
||
1115 | return $this->profileName; |
||
1116 | } |
||
1117 | |||
1118 | /** |
||
1119 | * Gets or sets a name for this instance. |
||
1120 | * |
||
1121 | * @param string $profileName |
||
1122 | * |
||
1123 | * @return self |
||
1124 | */ |
||
1125 | public function setProfileName(?string $profileName): self |
||
1126 | { |
||
1127 | $this->profileName = $profileName; |
||
1128 | |||
1129 | return $this; |
||
1130 | } |
||
1131 | |||
1132 | /** |
||
1133 | * Gets or sets the report policy identifier. This property is required if CreateType is Website. |
||
1134 | * |
||
1135 | * @return string |
||
1136 | */ |
||
1137 | public function getReportPolicyId(): ?string |
||
1138 | { |
||
1139 | return $this->reportPolicyId; |
||
1140 | } |
||
1141 | |||
1142 | /** |
||
1143 | * Gets or sets the report policy identifier. This property is required if CreateType is Website. |
||
1144 | * |
||
1145 | * @param string $reportPolicyId |
||
1146 | * |
||
1147 | * @return self |
||
1148 | */ |
||
1149 | public function setReportPolicyId(?string $reportPolicyId): self |
||
1150 | { |
||
1151 | $this->reportPolicyId = $reportPolicyId; |
||
1152 | |||
1153 | return $this; |
||
1154 | } |
||
1155 | |||
1156 | /** |
||
1157 | * Gets or sets the save scan profile. |
||
1158 | * |
||
1159 | * @return bool |
||
1160 | */ |
||
1161 | public function getSaveScanProfile(): ?bool |
||
1162 | { |
||
1163 | return $this->saveScanProfile; |
||
1164 | } |
||
1165 | |||
1166 | /** |
||
1167 | * Gets or sets the save scan profile. |
||
1168 | * |
||
1169 | * @param bool $saveScanProfile |
||
1170 | * |
||
1171 | * @return self |
||
1172 | */ |
||
1173 | public function setSaveScanProfile(?bool $saveScanProfile): self |
||
1174 | { |
||
1175 | $this->saveScanProfile = $saveScanProfile; |
||
1176 | |||
1177 | return $this; |
||
1178 | } |
||
1179 | |||
1180 | /** |
||
1181 | * Represents a class that carries out scope settings. |
||
1182 | * |
||
1183 | * @return ScopeSetting |
||
1184 | */ |
||
1185 | public function getScopeSetting(): ?ScopeSetting |
||
1188 | } |
||
1189 | |||
1190 | /** |
||
1191 | * Represents a class that carries out scope settings. |
||
1192 | * |
||
1193 | * @param ScopeSetting $scopeSetting |
||
1194 | * |
||
1195 | * @return self |
||
1196 | */ |
||
1197 | public function setScopeSetting(?ScopeSetting $scopeSetting): self |
||
1198 | { |
||
1199 | $this->scopeSetting = $scopeSetting; |
||
1200 | |||
1201 | return $this; |
||
1202 | } |
||
1203 | |||
1204 | /** |
||
1205 | * Gets or sets the agent selections for the websites that use custom agent. This property is needed for Gorup Scans. |
||
1206 | * |
||
1207 | * @return AgentSelectionModel[] |
||
1208 | */ |
||
1209 | public function getSelectedAgents(): ?array |
||
1210 | { |
||
1211 | return $this->selectedAgents; |
||
1212 | } |
||
1213 | |||
1214 | /** |
||
1215 | * Gets or sets the agent selections for the websites that use custom agent. This property is needed for Gorup Scans. |
||
1216 | * |
||
1217 | * @param AgentSelectionModel[] $selectedAgents |
||
1218 | * |
||
1219 | * @return self |
||
1220 | */ |
||
1221 | public function setSelectedAgents(?array $selectedAgents): self |
||
1222 | { |
||
1223 | $this->selectedAgents = $selectedAgents; |
||
1224 | |||
1225 | return $this; |
||
1226 | } |
||
1227 | |||
1228 | /** |
||
1229 | * Gets or sets the selected scan profile identifier. |
||
1230 | * |
||
1231 | * @return string |
||
1232 | */ |
||
1233 | public function getSelectedScanProfileId(): ?string |
||
1234 | { |
||
1235 | return $this->selectedScanProfileId; |
||
1236 | } |
||
1237 | |||
1238 | /** |
||
1239 | * Gets or sets the selected scan profile identifier. |
||
1240 | * |
||
1241 | * @param string $selectedScanProfileId |
||
1242 | * |
||
1243 | * @return self |
||
1244 | */ |
||
1245 | public function setSelectedScanProfileId(?string $selectedScanProfileId): self |
||
1246 | { |
||
1247 | $this->selectedScanProfileId = $selectedScanProfileId; |
||
1248 | |||
1249 | return $this; |
||
1250 | } |
||
1251 | |||
1252 | /** |
||
1253 | * Gets or sets the name of the selected scan profile. |
||
1254 | * |
||
1255 | * @return string |
||
1256 | */ |
||
1257 | public function getSelectedScanProfileName(): ?string |
||
1258 | { |
||
1259 | return $this->selectedScanProfileName; |
||
1260 | } |
||
1261 | |||
1262 | /** |
||
1263 | * Gets or sets the name of the selected scan profile. |
||
1264 | * |
||
1265 | * @param string $selectedScanProfileName |
||
1266 | * |
||
1267 | * @return self |
||
1268 | */ |
||
1269 | public function setSelectedScanProfileName(?string $selectedScanProfileName): self |
||
1270 | { |
||
1271 | $this->selectedScanProfileName = $selectedScanProfileName; |
||
1272 | |||
1273 | return $this; |
||
1274 | } |
||
1275 | |||
1276 | /** |
||
1277 | * Gets or sets the target website URL. This property is required if CreateType is Website. |
||
1278 | * |
||
1279 | * @return string |
||
1280 | */ |
||
1281 | public function getTargetUrl(): ?string |
||
1284 | } |
||
1285 | |||
1286 | /** |
||
1287 | * Gets or sets the target website URL. This property is required if CreateType is Website. |
||
1288 | * |
||
1289 | * @param string $targetUrl |
||
1290 | * |
||
1291 | * @return self |
||
1292 | */ |
||
1293 | public function setTargetUrl(?string $targetUrl): self |
||
1294 | { |
||
1295 | $this->targetUrl = $targetUrl; |
||
1296 | |||
1297 | return $this; |
||
1298 | } |
||
1299 | |||
1300 | /** |
||
1301 | * Represents a class that carries out url rewrite settings. |
||
1302 | * |
||
1303 | * @return UrlRewriteSetting |
||
1304 | */ |
||
1305 | public function getUrlRewriteSetting(): ?UrlRewriteSetting |
||
1306 | { |
||
1307 | return $this->urlRewriteSetting; |
||
1308 | } |
||
1309 | |||
1310 | /** |
||
1311 | * Represents a class that carries out url rewrite settings. |
||
1312 | * |
||
1313 | * @param UrlRewriteSetting $urlRewriteSetting |
||
1314 | * |
||
1315 | * @return self |
||
1316 | */ |
||
1317 | public function setUrlRewriteSetting(?UrlRewriteSetting $urlRewriteSetting): self |
||
1322 | } |
||
1323 | |||
1324 | /** |
||
1325 | * Gets or sets the user identifier. |
||
1326 | * |
||
1327 | * @return string |
||
1328 | */ |
||
1329 | public function getUserId(): ?string |
||
1330 | { |
||
1331 | return $this->userId; |
||
1332 | } |
||
1333 | |||
1334 | /** |
||
1335 | * Gets or sets the user identifier. |
||
1336 | * |
||
1337 | * @param string $userId |
||
1338 | * |
||
1339 | * @return self |
||
1340 | */ |
||
1341 | public function setUserId(?string $userId): self |
||
1342 | { |
||
1343 | $this->userId = $userId; |
||
1344 | |||
1345 | return $this; |
||
1346 | } |
||
1347 | |||
1348 | /** |
||
1349 | * Gets or sets the website group identifier. This property is required if CreateType is WebsiteGroup. |
||
1350 | * |
||
1351 | * @return string |
||
1352 | */ |
||
1353 | public function getWebsiteGroupId(): ?string |
||
1356 | } |
||
1357 | |||
1358 | /** |
||
1359 | * Gets or sets the website group identifier. This property is required if CreateType is WebsiteGroup. |
||
1360 | * |
||
1361 | * @param string $websiteGroupId |
||
1362 | * |
||
1363 | * @return self |
||
1364 | */ |
||
1365 | public function setWebsiteGroupId(?string $websiteGroupId): self |
||
1366 | { |
||
1370 | } |
||
1371 | } |
||
1372 |