ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
CrawlerException.php
Go to the documentation of this file.
1 <?php
2 
3 declare(strict_types=1);
4 
21 namespace ILIAS\UI\Implementation\Crawler\Exception;
22 
30 class CrawlerException extends \Exception
31 {
32  public const UNKNOWN_EXCEPTION = -1;
33 
34  public const ARRAY_EXPECTED = 1000;
35  public const STRING_EXPECTED = 1001;
36  public const INVALID_TYPE = 1002;
37  public const EMPTY_STRING = 1002;
38 
39  public const EMPTY_ENTRY = 2000;
40  public const INVALID_MANDATORY_ENTRY_ATTRIBUTE = 2001;
41  public const DUPLICATE_ENTRY = 2002;
42  public const DUPLICATE_ROOT_ENTRY = 2003;
43  public const INVALID_ID = 2004;
44  public const INVALID_FILE_PATH = 2005;
45  public const INVALID_RULES_ENTRY = 2006;
46  public const ENTRY_WITH_NO_YAML_DESCRIPTION = 2007;
47  public const ENTRY_WITH_NO_VALID_RETURN_STATEMENT = 2008;
48  public const PARSING_YAML_ENTRY_FAILED = 2009;
49  public const ENTRY_TITLE_MISSING = 2010;
50  public const ENTRY_WITHOUT_FUNCTION = 2011;
51 
52  public const FILE_CREATION_FAILED = 3000;
53  public const FOLDER_CREATION_FAILED = 3001;
54  public const FILE_OPENING_FAILED = 3002;
55  public const LESS_COMPILE_FAILED = 3003;
56  public const FOLDER_DELETION_FAILED = 3004;
57  public const FILE_DELETION_FAILED = 3005;
58 
59  public const INVALID_INDEX = 4000;
60  public const MISSING_INDEX = 4001;
61 
62  public const CRAWL_MAX_NESTING_REACHED = 5000;
63 
64  protected string $add_info = "";
65 
69  public function __construct(int $exception_code = -1, string $exception_info = "")
70  {
71  $this->add_info = $exception_info;
72  $this->code = $exception_code;
73  $this->assignMessageToCode();
74  parent::__construct($this->message, $exception_code);
75  }
76 
77  protected function assignMessageToCode(): void
78  {
79  switch ($this->code) {
80  case self::ARRAY_EXPECTED:
81  $this->message = "Array was expected, got " . $this->add_info;
82  break;
83  case self::STRING_EXPECTED:
84  $this->message = "String was expected, got " . $this->add_info;
85  break;
86  case self::INVALID_TYPE:
87  $this->message = "Invalid type: " . $this->add_info;
88  break;
89  case self::EMPTY_STRING:
90  $this->message = "String can not be empty: " . $this->add_info;
91  break;
92 
93  case self::EMPTY_ENTRY:
94  $this->message = "Empty Entry " . $this->add_info;
95  break;
96  case self::INVALID_MANDATORY_ENTRY_ATTRIBUTE:
97  $this->message = "Invalid mandatory entry Attribute: " . $this->add_info;
98  break;
99  case self::DUPLICATE_ENTRY:
100  $this->message = "There are entries with the same ID. Duplicate: " . $this->add_info;
101  break;
102  case self::DUPLICATE_ROOT_ENTRY:
103  $this->message = "There are multiple root entry. Duplicate: " . $this->add_info;
104  break;
105  case self::INVALID_ID:
106  $this->message = "No such ID in tree: " . $this->add_info;
107  break;
108  case self::ENTRY_WITH_NO_YAML_DESCRIPTION:
109  $this->message = "No YAML Description found for Entry returned by: '" . $this->add_info .
110  "' (check if the entry is properly introduced and closed with '---' before return statement)";
111  break;
112  case self::ENTRY_WITH_NO_VALID_RETURN_STATEMENT:
113  $this->message = "No Return statement given for Entry: " . $this->add_info;
114  break;
115  case self::PARSING_YAML_ENTRY_FAILED:
116  $this->message = "Parsing Yaml entry failed: " . $this->add_info;
117  break;
118  case self::ENTRY_TITLE_MISSING:
119  $this->message = "Entry Title missing (check if valid function name is set for all entries): " . $this->add_info;
120  break;
121  case self::ENTRY_WITHOUT_FUNCTION:
122  $this->message = "Entry Function missing: " . $this->add_info;
123  break;
124 
125  case self::INVALID_FILE_PATH:
126  $this->message = "Invalid file path or file not readable: " . $this->add_info;
127  break;
128  case self::FILE_CREATION_FAILED:
129  $this->message = "File creation failed, path: " . $this->add_info;
130  break;
131  case self::FOLDER_CREATION_FAILED:
132  $this->message = "Folder creation failed, path: " . $this->add_info;
133  break;
134  case self::FOLDER_DELETION_FAILED:
135  $this->message = "Folder delation failed, path: " . $this->add_info;
136  break;
137  case self::FILE_DELETION_FAILED:
138  $this->message = "File delation failed, path: " . $this->add_info;
139  break;
140  case self::LESS_COMPILE_FAILED:
141  $this->message = "Compilation of less failed: " . $this->add_info;
142  break;
143  case self::FILE_OPENING_FAILED:
144  $this->message = "Failed to open file : " . $this->add_info;
145  break;
146 
147  case self::INVALID_INDEX:
148  $this->message = "Invalid index: " . $this->add_info;
149  break;
150  case self::MISSING_INDEX:
151  $this->message = "Missing index in class: " . $this->add_info;
152  break;
153  case self::CRAWL_MAX_NESTING_REACHED:
154  $this->message = "Max nesting reached while crowling (Factories might contain a circle), info: " . $this->add_info;
155  break;
156 
157  case self::UNKNOWN_EXCEPTION:
158  default:
159  $this->message = "Unknown Exception " . $this->add_info;
160  break;
161  }
162  }
163 
164  public function __toString(): string
165  {
166  return
167  get_class($this) .
168  " '$this->message' in $this->file($this->line)\n" .
169  "{$this->getTraceAsString()}"
170  ;
171  }
172 }
ILIAS\UI\Implementation\Crawler\Exception\CrawlerException\__construct
__construct(int $exception_code=-1, string $exception_info="")
ilKitchenSinkException constructor.
Definition: CrawlerException.php:69
ILIAS\MetaData\Repository\Validation\Data\__construct
__construct(VocabulariesInterface $vocabularies)
Definition: VocabularyBridge.php:31
ILIAS\UI\Implementation\Crawler\Exception
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: CrawlerAssertion.php:21