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