From 63af0d0afacc0c0a33686a151138ec496754c29d Mon Sep 17 00:00:00 2001 From: oliver Date: Sat, 28 May 2016 12:32:48 +0200 Subject: [PATCH] do not track generated documentation --- .hgignore | 1 + doc/classes/PHPMailer.html | 7052 ----------------- doc/classes/SMTP.html | 2653 ------- doc/classes/hhu.z.Controller.html | 1870 ----- doc/classes/hhu.z.Model.html | 1292 --- doc/classes/hhu.z.TextFormatter.html | 1117 --- doc/classes/hhu.z.Utils.html | 1204 --- doc/classes/hhu.z.agents.QuesttypeAgent.html | 2142 ----- doc/classes/hhu.z.agents.ToplevelAgent.html | 2264 ------ ....agents.bottomlevel.MailreceiverAgent.html | 1971 ----- .../hhu.z.agents.bottomlevel.MenuAgent.html | 1971 ----- ...omlevel.QuestgroupshierarchypathAgent.html | 1971 ----- ...z.agents.bottomlevel.SeminarybarAgent.html | 1971 ----- ....agents.bottomlevel.SeminarymenuAgent.html | 1971 ----- ...u.z.agents.bottomlevel.UserrolesAgent.html | 1971 ----- ...agents.intermediate.AchievementsAgent.html | 2012 ----- ...nts.intermediate.CharactergroupsAgent.html | 2012 ----- ...termediate.CharactergroupsquestsAgent.html | 2012 ----- ...z.agents.intermediate.CharactersAgent.html | 2052 ----- ...ents.intermediate.CharactertypesAgent.html | 2012 ----- .../hhu.z.agents.intermediate.ErrorAgent.html | 2012 ----- ...agents.intermediate.IntroductionAgent.html | 2012 ----- ...hu.z.agents.intermediate.LibraryAgent.html | 2012 ----- .../hhu.z.agents.intermediate.MailAgent.html | 2012 ----- .../hhu.z.agents.intermediate.MediaAgent.html | 2012 ----- ....agents.intermediate.QuestgroupsAgent.html | 2132 ----- ...ntermediate.QuestgroupshierarchyAgent.html | 1972 ----- ...hhu.z.agents.intermediate.QuestsAgent.html | 2292 ------ ...z.agents.intermediate.SeminariesAgent.html | 2012 ----- ...hu.z.agents.intermediate.UploadsAgent.html | 2012 ----- .../hhu.z.agents.intermediate.UsersAgent.html | 2052 ----- ...u.z.agents.intermediate.XplevelsAgent.html | 2012 ----- .../hhu.z.agents.toplevel.AjaxAgent.html | 2340 ------ .../hhu.z.agents.toplevel.BinaryAgent.html | 2305 ------ .../hhu.z.agents.toplevel.FaultAgent.html | 2324 ------ .../hhu.z.agents.toplevel.HtmlAgent.html | 2340 ------ .../hhu.z.agents.toplevel.HtmlmailAgent.html | 2305 ------ .../hhu.z.agents.toplevel.TextmailAgent.html | 2305 ------ doc/classes/hhu.z.apis.MailApi.html | 1437 ---- ....z.controllers.AchievementsController.html | 2615 ------ .../hhu.z.controllers.AjaxController.html | 1910 ----- .../hhu.z.controllers.BinaryController.html | 2148 ----- ...controllers.CharactergroupsController.html | 2736 ------- ...llers.CharactergroupsquestsController.html | 2516 ------ ...hu.z.controllers.CharactersController.html | 2569 ------ ....controllers.CharactertypesController.html | 2416 ------ .../hhu.z.controllers.ErrorController.html | 1920 ----- .../hhu.z.controllers.FaultController.html | 1788 ----- .../hhu.z.controllers.HtmlController.html | 1937 ----- .../hhu.z.controllers.HtmlmailController.html | 1786 ----- ....z.controllers.IntermediateController.html | 2100 ----- ....z.controllers.IntroductionController.html | 2148 ----- .../hhu.z.controllers.LibraryController.html | 2530 ------ .../hhu.z.controllers.MailController.html | 1957 ----- ....z.controllers.MailreceiverController.html | 1797 ----- .../hhu.z.controllers.MediaController.html | 2791 ------- .../hhu.z.controllers.MenuController.html | 1910 ----- ...u.z.controllers.QuestgroupsController.html | 2575 ------ ...ollers.QuestgroupshierarchyController.html | 2485 ------ ...rs.QuestgroupshierarchypathController.html | 1956 ----- .../hhu.z.controllers.QuestsController.html | 3121 -------- ...hhu.z.controllers.QuesttypeController.html | 2396 ------ ...hu.z.controllers.SeminariesController.html | 2484 ------ .../hhu.z.controllers.SeminaryController.html | 2206 ------ ...u.z.controllers.SeminarybarController.html | 1938 ----- ....z.controllers.SeminarymenuController.html | 1911 ----- .../hhu.z.controllers.TextmailController.html | 1787 ----- .../hhu.z.controllers.UploadsController.html | 2492 ------ ...hhu.z.controllers.UserrolesController.html | 1925 ----- .../hhu.z.controllers.UsersController.html | 2469 ------ .../hhu.z.controllers.XplevelsController.html | 2286 ------ ...llers.components.AchievementComponent.html | 1135 --- ....controllers.components.AuthComponent.html | 1197 --- ...lers.components.NotificationComponent.html | 1283 --- ...ollers.components.ValidationComponent.html | 1367 ---- .../hhu.z.exceptions.FileUploadException.html | 1154 --- .../hhu.z.exceptions.MailingException.html | 1154 --- ...hhu.z.exceptions.MaxFilesizeException.html | 1087 --- ...tions.QuesttypeAgentNotFoundException.html | 1154 --- ...tions.QuesttypeAgentNotValidException.html | 1154 --- ....QuesttypeControllerNotFoundException.html | 1154 --- ....QuesttypeControllerNotValidException.html | 1154 --- ...tions.QuesttypeModelNotFoundException.html | 1154 --- ...tions.QuesttypeModelNotValidException.html | 1154 --- ...xceptions.SubmissionNotValidException.html | 1154 --- ...u.z.exceptions.WrongFiletypeException.html | 1154 --- doc/classes/hhu.z.lib.PHPMailer.html | 979 --- doc/classes/hhu.z.lib.PHPMailerAutoload.html | 979 --- doc/classes/hhu.z.lib.Password.html | 979 --- doc/classes/hhu.z.lib.SMTP.html | 979 --- .../hhu.z.models.AchievementsModel.html | 3315 -------- doc/classes/hhu.z.models.AvatarsModel.html | 1467 ---- .../hhu.z.models.CharactergroupsModel.html | 2136 ----- ...u.z.models.CharactergroupsquestsModel.html | 1968 ----- .../hhu.z.models.CharacterrolesModel.html | 1399 ---- doc/classes/hhu.z.models.CharactersModel.html | 2198 ----- .../hhu.z.models.CharactertypesModel.html | 1571 ---- doc/classes/hhu.z.models.MediaModel.html | 1903 ----- .../hhu.z.models.QuestgroupsModel.html | 2491 ------ ...hu.z.models.QuestgroupshierarchyModel.html | 1706 ---- .../hhu.z.models.QuestgrouptextsModel.html | 1501 ---- doc/classes/hhu.z.models.QuestsModel.html | 2555 ------ doc/classes/hhu.z.models.QuesttextsModel.html | 1721 ---- .../hhu.z.models.QuesttopicsModel.html | 1935 ----- doc/classes/hhu.z.models.QuesttypeModel.html | 1416 ---- doc/classes/hhu.z.models.QuesttypesModel.html | 1349 ---- doc/classes/hhu.z.models.SeminariesModel.html | 1685 ---- ...z.models.SeminarycharacterfieldsModel.html | 1442 ---- doc/classes/hhu.z.models.UploadsModel.html | 1435 ---- doc/classes/hhu.z.models.UserrolesModel.html | 1437 ---- doc/classes/hhu.z.models.UsersModel.html | 1876 ----- doc/classes/hhu.z.models.XplevelsModel.html | 1497 ---- ....z.questtypes.BossfightQuesttypeAgent.html | 2157 ----- ...esttypes.BossfightQuesttypeController.html | 2451 ------ ....z.questtypes.BossfightQuesttypeModel.html | 1687 ---- ....questtypes.ChoiceinputQuesttypeAgent.html | 2157 ----- ...ttypes.ChoiceinputQuesttypeController.html | 2377 ------ ....questtypes.ChoiceinputQuesttypeModel.html | 1705 ---- ....z.questtypes.CrosswordQuesttypeAgent.html | 2157 ----- ...esttypes.CrosswordQuesttypeController.html | 2378 ------ ....z.questtypes.CrosswordQuesttypeModel.html | 1533 ---- ....z.questtypes.DragndropQuesttypeAgent.html | 2157 ----- ...esttypes.DragndropQuesttypeController.html | 2377 ------ ....z.questtypes.DragndropQuesttypeModel.html | 1657 ---- ...esttypes.MultiplechoiceQuesttypeAgent.html | 2157 ----- ...pes.MultiplechoiceQuesttypeController.html | 2466 ------ ...esttypes.MultiplechoiceQuesttypeModel.html | 1847 ----- ...hhu.z.questtypes.SubmitQuesttypeAgent.html | 2157 ----- ....questtypes.SubmitQuesttypeController.html | 2382 ------ ...hhu.z.questtypes.SubmitQuesttypeModel.html | 1655 ---- ....z.questtypes.TextinputQuesttypeAgent.html | 2157 ----- ...esttypes.TextinputQuesttypeController.html | 2420 ------ ....z.questtypes.TextinputQuesttypeModel.html | 1696 ---- doc/classes/hhu.z.requests.MailRequest.html | 1266 --- doc/classes/hhu.z.responses.MailResponse.html | 1464 ---- doc/classes/hhu.z.views.QuesttypeView.html | 1166 --- doc/classes/nre.agents.BottomlevelAgent.html | 1931 ----- doc/classes/nre.agents.IntermediateAgent.html | 1970 ----- doc/classes/nre.agents.ToplevelAgent.html | 2249 ------ doc/classes/nre.apis.WebApi.html | 1333 ---- doc/classes/nre.configs.AppConfig.html | 1307 --- doc/classes/nre.configs.CoreConfig.html | 1261 --- doc/classes/nre.core.Agent.html | 1882 ----- doc/classes/nre.core.Api.html | 1253 --- doc/classes/nre.core.Autoloader.html | 1107 --- doc/classes/nre.core.ClassLoader.html | 1196 --- doc/classes/nre.core.Component.html | 1069 --- doc/classes/nre.core.Config.html | 989 --- doc/classes/nre.core.Controller.html | 1720 ---- doc/classes/nre.core.Driver.html | 1100 --- doc/classes/nre.core.Exception.html | 1037 --- doc/classes/nre.core.Linker.html | 1309 --- doc/classes/nre.core.Logger.html | 1251 --- doc/classes/nre.core.Model.html | 1148 --- doc/classes/nre.core.Request.html | 1064 --- doc/classes/nre.core.Response.html | 1348 ---- doc/classes/nre.core.View.html | 1158 --- doc/classes/nre.core.WebUtils.html | 1095 --- doc/classes/nre.drivers.DatabaseDriver.html | 1260 --- doc/classes/nre.drivers.MysqliDriver.html | 1433 ---- .../nre.exceptions.AccessDeniedException.html | 1074 --- ...re.exceptions.ActionNotFoundException.html | 1144 --- ...nre.exceptions.AgentNotFoundException.html | 1180 --- ...nre.exceptions.AgentNotValidException.html | 1180 --- ...nre.exceptions.ClassNotFoundException.html | 1154 --- ...nre.exceptions.ClassNotValidException.html | 1154 --- ...exceptions.ComponentNotFoundException.html | 1180 --- ...exceptions.ComponentNotValidException.html | 1180 --- ...xceptions.ControllerNotFoundException.html | 1180 --- ...xceptions.ControllerNotValidException.html | 1180 --- .../nre.exceptions.DatamodelException.html | 1205 --- ...re.exceptions.DriverNotFoundException.html | 1180 --- ...re.exceptions.DriverNotValidException.html | 1180 --- ...re.exceptions.FatalDatamodelException.html | 1204 --- .../nre.exceptions.IdNotFoundException.html | 1144 --- ...re.exceptions.LayoutNotFoundException.html | 1214 --- ...re.exceptions.LayoutNotValidException.html | 1214 --- ...nre.exceptions.ModelNotFoundException.html | 1180 --- ...nre.exceptions.ModelNotValidException.html | 1180 --- ...re.exceptions.ParamsNotValidException.html | 1144 --- ...xceptions.ServiceUnavailableException.html | 1144 --- .../nre.exceptions.ViewNotFoundException.html | 1144 --- doc/classes/nre.models.DatabaseModel.html | 1293 --- doc/classes/nre.requests.WebRequest.html | 1762 ---- doc/classes/nre.responses.WebResponse.html | 1705 ---- doc/classes/phpmailerException.html | 975 --- doc/css/bootstrap-combined.no-icons.min.css | 732 -- doc/css/font-awesome.min.css | 403 - doc/css/jquery.iviewer.css | 65 - doc/css/phpdocumentor-clean-icons/Read Me.txt | 3 - .../fonts/phpdocumentor-clean-icons.dev.svg | 17 - .../fonts/phpdocumentor-clean-icons.eot | Bin 2324 -> 0 bytes .../fonts/phpdocumentor-clean-icons.svg | 17 - .../fonts/phpdocumentor-clean-icons.ttf | Bin 2080 -> 0 bytes .../fonts/phpdocumentor-clean-icons.woff | Bin 1832 -> 0 bytes doc/css/phpdocumentor-clean-icons/lte-ie7.js | 30 - doc/css/phpdocumentor-clean-icons/style.css | 48 - doc/css/prism.css | 204 - doc/css/template.css | 429 - doc/files/agents.BottomlevelAgent.html | 916 --- doc/files/agents.IntermediateAgent.html | 916 --- doc/files/agents.ToplevelAgent.html | 916 --- .../agents.bottomlevel.MailreceiverAgent.html | 915 --- doc/files/agents.bottomlevel.MenuAgent.html | 915 --- ...omlevel.QuestgroupshierarchypathAgent.html | 915 --- .../agents.bottomlevel.SeminarybarAgent.html | 915 --- .../agents.bottomlevel.SeminarymenuAgent.html | 915 --- .../agents.bottomlevel.UserrolesAgent.html | 915 --- ...agents.intermediate.AchievementsAgent.html | 915 --- ...nts.intermediate.CharactergroupsAgent.html | 915 --- ...termediate.CharactergroupsquestsAgent.html | 915 --- .../agents.intermediate.CharactersAgent.html | 915 --- ...ents.intermediate.CharactertypesAgent.html | 915 --- doc/files/agents.intermediate.ErrorAgent.html | 915 --- ...agents.intermediate.IntroductionAgent.html | 915 --- .../agents.intermediate.LibraryAgent.html | 915 --- doc/files/agents.intermediate.MailAgent.html | 915 --- doc/files/agents.intermediate.MediaAgent.html | 915 --- .../agents.intermediate.QuestgroupsAgent.html | 915 --- ...ntermediate.QuestgroupshierarchyAgent.html | 915 --- .../agents.intermediate.QuestsAgent.html | 915 --- .../agents.intermediate.SeminariesAgent.html | 915 --- .../agents.intermediate.UploadsAgent.html | 915 --- doc/files/agents.intermediate.UsersAgent.html | 915 --- .../agents.intermediate.XplevelsAgent.html | 915 --- doc/files/agents.toplevel.AjaxAgent.html | 915 --- doc/files/agents.toplevel.BinaryAgent.html | 915 --- doc/files/agents.toplevel.FaultAgent.html | 915 --- doc/files/agents.toplevel.HtmlAgent.html | 915 --- doc/files/agents.toplevel.HtmlmailAgent.html | 915 --- doc/files/agents.toplevel.TextmailAgent.html | 915 --- doc/files/agents/BottomlevelAgent.inc.txt | 26 - doc/files/agents/IntermediateAgent.inc.txt | 50 - doc/files/agents/ToplevelAgent.inc.txt | 396 - .../bottomlevel/MailreceiverAgent.inc.txt | 39 - .../agents/bottomlevel/MenuAgent.inc.txt | 41 - .../QuestgroupshierarchypathAgent.inc.txt | 39 - .../bottomlevel/SeminarybarAgent.inc.txt | 39 - .../bottomlevel/SeminarymenuAgent.inc.txt | 39 - .../agents/bottomlevel/UserrolesAgent.inc.txt | 39 - .../intermediate/AchievementsAgent.inc.txt | 39 - .../intermediate/CharactergroupsAgent.inc.txt | 39 - .../CharactergroupsquestsAgent.inc.txt | 39 - .../intermediate/CharactersAgent.inc.txt | 50 - .../intermediate/CharactertypesAgent.inc.txt | 39 - .../agents/intermediate/ErrorAgent.inc.txt | 39 - .../intermediate/IntroductionAgent.inc.txt | 39 - .../agents/intermediate/LibraryAgent.inc.txt | 39 - .../agents/intermediate/MailAgent.inc.txt | 39 - .../agents/intermediate/MediaAgent.inc.txt | 39 - .../intermediate/QuestgroupsAgent.inc.txt | 76 - .../QuestgroupshierarchyAgent.inc.txt | 25 - .../agents/intermediate/QuestsAgent.inc.txt | 124 - .../intermediate/SeminariesAgent.inc.txt | 39 - .../agents/intermediate/UploadsAgent.inc.txt | 39 - .../agents/intermediate/UsersAgent.inc.txt | 51 - .../agents/intermediate/XplevelsAgent.inc.txt | 39 - doc/files/agents/toplevel/AjaxAgent.inc.txt | 81 - doc/files/agents/toplevel/BinaryAgent.inc.txt | 52 - doc/files/agents/toplevel/FaultAgent.inc.txt | 39 - doc/files/agents/toplevel/HtmlAgent.inc.txt | 86 - .../agents/toplevel/HtmlmailAgent.inc.txt | 53 - .../agents/toplevel/TextmailAgent.inc.txt | 55 - doc/files/apis.WebApi.html | 915 --- doc/files/apis/WebApi.inc.txt | 251 - doc/files/app.Controller.html | 915 --- doc/files/app.Model.html | 915 --- doc/files/app.TextFormatter.html | 915 --- doc/files/app.Utils.html | 915 --- doc/files/app.agents.QuesttypeAgent.html | 915 --- doc/files/app.agents.ToplevelAgent.html | 915 --- doc/files/app.apis.MailApi.html | 915 --- ...pp.controllers.IntermediateController.html | 915 --- .../app.controllers.QuesttypeController.html | 915 --- .../app.controllers.SeminaryController.html | 916 --- .../app.exceptions.FileUploadException.html | 915 --- .../app.exceptions.MailingException.html | 915 --- .../app.exceptions.MaxFilesizeException.html | 915 --- ...tions.QuesttypeAgentNotFoundException.html | 915 --- ...tions.QuesttypeAgentNotValidException.html | 915 --- ....QuesttypeControllerNotFoundException.html | 915 --- ....QuesttypeControllerNotValidException.html | 915 --- ...tions.QuesttypeModelNotFoundException.html | 915 --- ...tions.QuesttypeModelNotValidException.html | 915 --- ...xceptions.SubmissionNotValidException.html | 915 --- ...app.exceptions.WrongFiletypeException.html | 915 --- doc/files/app.lib.PHPMailer.html | 923 --- doc/files/app.lib.PHPMailerAutoload.html | 1008 --- doc/files/app.lib.Password.html | 1205 --- doc/files/app.lib.SMTP.html | 919 --- doc/files/app.models.QuesttypeModel.html | 915 --- doc/files/app.requests.MailRequest.html | 915 --- doc/files/app.responses.MailResponse.html | 915 --- doc/files/app.views.QuesttypeView.html | 915 --- doc/files/app/Controller.inc.txt | 132 - doc/files/app/Model.inc.txt | 43 - doc/files/app/TextFormatter.inc.txt | 150 - doc/files/app/Utils.inc.txt | 215 - doc/files/app/agents/QuesttypeAgent.inc.txt | 286 - doc/files/app/agents/ToplevelAgent.inc.txt | 44 - doc/files/app/apis/MailApi.inc.txt | 203 - .../IntermediateController.inc.txt | 198 - .../controllers/QuesttypeController.inc.txt | 321 - .../controllers/SeminaryController.inc.txt | 329 - .../exceptions/FileUploadException.inc.txt | 80 - .../app/exceptions/MailingException.inc.txt | 80 - .../exceptions/MaxFilesizeException.inc.txt | 55 - .../QuesttypeAgentNotFoundException.inc.txt | 80 - .../QuesttypeAgentNotValidException.inc.txt | 80 - ...esttypeControllerNotFoundException.inc.txt | 80 - ...esttypeControllerNotValidException.inc.txt | 80 - .../QuesttypeModelNotFoundException.inc.txt | 80 - .../QuesttypeModelNotValidException.inc.txt | 80 - .../SubmissionNotValidException.inc.txt | 80 - .../exceptions/WrongFiletypeException.inc.txt | 80 - doc/files/app/lib/PHPMailer.inc.txt | 3454 -------- doc/files/app/lib/PHPMailerAutoload.inc.txt | 87 - doc/files/app/lib/Password.inc.txt | 317 - doc/files/app/lib/SMTP.inc.txt | 973 --- doc/files/app/models/QuesttypeModel.inc.txt | 155 - doc/files/app/requests/MailRequest.inc.txt | 93 - doc/files/app/responses/MailResponse.inc.txt | 56 - doc/files/app/views/QuesttypeView.inc.txt | 77 - doc/files/bootstrap.html | 883 --- doc/files/bootstrap.inc.txt | 34 - doc/files/configs.AppConfig.html | 915 --- doc/files/configs.CoreConfig.html | 915 --- doc/files/configs/AppConfig.inc.txt | 371 - doc/files/configs/CoreConfig.inc.txt | 168 - .../controllers.AchievementsController.html | 915 --- doc/files/controllers.AjaxController.html | 915 --- doc/files/controllers.BinaryController.html | 915 --- ...controllers.CharactergroupsController.html | 915 --- ...llers.CharactergroupsquestsController.html | 916 --- .../controllers.CharactersController.html | 915 --- .../controllers.CharactertypesController.html | 916 --- doc/files/controllers.ErrorController.html | 915 --- doc/files/controllers.FaultController.html | 915 --- doc/files/controllers.HtmlController.html | 915 --- doc/files/controllers.HtmlmailController.html | 915 --- .../controllers.IntroductionController.html | 915 --- doc/files/controllers.LibraryController.html | 915 --- doc/files/controllers.MailController.html | 915 --- .../controllers.MailreceiverController.html | 916 --- doc/files/controllers.MediaController.html | 915 --- doc/files/controllers.MenuController.html | 915 --- .../controllers.QuestgroupsController.html | 915 --- ...ollers.QuestgroupshierarchyController.html | 915 --- ...rs.QuestgroupshierarchypathController.html | 916 --- doc/files/controllers.QuestsController.html | 915 --- .../controllers.SeminariesController.html | 915 --- .../controllers.SeminarybarController.html | 916 --- .../controllers.SeminarymenuController.html | 916 --- doc/files/controllers.TextmailController.html | 916 --- doc/files/controllers.UploadsController.html | 915 --- .../controllers.UserrolesController.html | 915 --- doc/files/controllers.UsersController.html | 915 --- doc/files/controllers.XplevelsController.html | 916 --- ...llers.components.AchievementComponent.html | 915 --- .../controllers.components.AuthComponent.html | 915 --- ...lers.components.NotificationComponent.html | 915 --- ...ollers.components.ValidationComponent.html | 915 --- .../AchievementsController.inc.txt | 961 --- doc/files/controllers/AjaxController.inc.txt | 53 - .../controllers/BinaryController.inc.txt | 38 - .../CharactergroupsController.inc.txt | 760 -- .../CharactergroupsquestsController.inc.txt | 616 -- .../controllers/CharactersController.inc.txt | 696 -- .../CharactertypesController.inc.txt | 407 - doc/files/controllers/ErrorController.inc.txt | 52 - doc/files/controllers/FaultController.inc.txt | 38 - doc/files/controllers/HtmlController.inc.txt | 112 - .../controllers/HtmlmailController.inc.txt | 55 - .../IntroductionController.inc.txt | 38 - .../controllers/LibraryController.inc.txt | 514 -- doc/files/controllers/MailController.inc.txt | 137 - .../MailreceiverController.inc.txt | 40 - doc/files/controllers/MediaController.inc.txt | 563 -- doc/files/controllers/MenuController.inc.txt | 53 - .../controllers/QuestgroupsController.inc.txt | 715 -- .../QuestgroupshierarchyController.inc.txt | 347 - ...QuestgroupshierarchypathController.inc.txt | 92 - .../controllers/QuestsController.inc.txt | 1507 ---- .../controllers/SeminariesController.inc.txt | 468 -- .../controllers/SeminarybarController.inc.txt | 90 - .../SeminarymenuController.inc.txt | 54 - .../controllers/TextmailController.inc.txt | 56 - .../controllers/UploadsController.inc.txt | 319 - .../controllers/UserrolesController.inc.txt | 48 - doc/files/controllers/UsersController.inc.txt | 617 -- .../controllers/XplevelsController.inc.txt | 189 - .../components/AchievementComponent.inc.txt | 42 - .../components/AuthComponent.inc.txt | 80 - .../components/NotificationComponent.inc.txt | 109 - .../components/ValidationComponent.inc.txt | 184 - doc/files/core.Agent.html | 915 --- doc/files/core.Api.html | 915 --- doc/files/core.Autoloader.html | 915 --- doc/files/core.ClassLoader.html | 915 --- doc/files/core.Component.html | 915 --- doc/files/core.Config.html | 915 --- doc/files/core.Controller.html | 915 --- doc/files/core.Driver.html | 915 --- doc/files/core.Exception.html | 915 --- doc/files/core.Linker.html | 915 --- doc/files/core.Logger.html | 915 --- doc/files/core.Model.html | 915 --- doc/files/core.Request.html | 915 --- doc/files/core.Response.html | 915 --- doc/files/core.View.html | 915 --- doc/files/core.WebUtils.html | 915 --- doc/files/core/Agent.inc.txt | 609 -- doc/files/core/Api.inc.txt | 164 - doc/files/core/Autoloader.inc.txt | 99 - doc/files/core/ClassLoader.inc.txt | 130 - doc/files/core/Component.inc.txt | 86 - doc/files/core/Config.inc.txt | 50 - doc/files/core/Controller.inc.txt | 431 - doc/files/core/Driver.inc.txt | 98 - doc/files/core/Exception.inc.txt | 66 - doc/files/core/Linker.inc.txt | 314 - doc/files/core/Logger.inc.txt | 133 - doc/files/core/Model.inc.txt | 142 - doc/files/core/Request.inc.txt | 65 - doc/files/core/Response.inc.txt | 159 - doc/files/core/View.inc.txt | 125 - doc/files/core/WebUtils.inc.txt | 76 - doc/files/drivers.DatabaseDriver.html | 915 --- doc/files/drivers.MysqliDriver.html | 915 --- doc/files/drivers/DatabaseDriver.inc.txt | 88 - doc/files/drivers/MysqliDriver.inc.txt | 170 - .../exceptions.AccessDeniedException.html | 915 --- .../exceptions.ActionNotFoundException.html | 915 --- .../exceptions.AgentNotFoundException.html | 915 --- .../exceptions.AgentNotValidException.html | 915 --- .../exceptions.ClassNotFoundException.html | 915 --- .../exceptions.ClassNotValidException.html | 915 --- ...exceptions.ComponentNotFoundException.html | 915 --- ...exceptions.ComponentNotValidException.html | 915 --- ...xceptions.ControllerNotFoundException.html | 915 --- ...xceptions.ControllerNotValidException.html | 915 --- doc/files/exceptions.DatamodelException.html | 915 --- .../exceptions.DriverNotFoundException.html | 915 --- .../exceptions.DriverNotValidException.html | 915 --- .../exceptions.FatalDatamodelException.html | 915 --- doc/files/exceptions.IdNotFoundException.html | 915 --- .../exceptions.LayoutNotFoundException.html | 915 --- .../exceptions.LayoutNotValidException.html | 915 --- .../exceptions.ModelNotFoundException.html | 915 --- .../exceptions.ModelNotValidException.html | 915 --- .../exceptions.ParamsNotValidException.html | 915 --- ...xceptions.ServiceUnavailableException.html | 915 --- .../exceptions.ViewNotFoundException.html | 915 --- .../exceptions/AccessDeniedException.inc.txt | 52 - .../ActionNotFoundException.inc.txt | 78 - .../exceptions/AgentNotFoundException.inc.txt | 68 - .../exceptions/AgentNotValidException.inc.txt | 68 - .../exceptions/ClassNotFoundException.inc.txt | 80 - .../exceptions/ClassNotValidException.inc.txt | 80 - .../ComponentNotFoundException.inc.txt | 68 - .../ComponentNotValidException.inc.txt | 68 - .../ControllerNotFoundException.inc.txt | 68 - .../ControllerNotValidException.inc.txt | 68 - .../exceptions/DatamodelException.inc.txt | 100 - .../DriverNotFoundException.inc.txt | 69 - .../DriverNotValidException.inc.txt | 69 - .../FatalDatamodelException.inc.txt | 97 - .../exceptions/IdNotFoundException.inc.txt | 78 - .../LayoutNotFoundException.inc.txt | 69 - .../LayoutNotValidException.inc.txt | 68 - .../exceptions/ModelNotFoundException.inc.txt | 68 - .../exceptions/ModelNotValidException.inc.txt | 69 - .../ParamsNotValidException.inc.txt | 78 - .../ServiceUnavailableException.inc.txt | 78 - .../exceptions/ViewNotFoundException.inc.txt | 78 - doc/files/models.AchievementsModel.html | 915 --- doc/files/models.AvatarsModel.html | 915 --- doc/files/models.CharactergroupsModel.html | 916 --- .../models.CharactergroupsquestsModel.html | 916 --- doc/files/models.CharacterrolesModel.html | 915 --- doc/files/models.CharactersModel.html | 915 --- doc/files/models.CharactertypesModel.html | 915 --- doc/files/models.DatabaseModel.html | 915 --- doc/files/models.MediaModel.html | 915 --- doc/files/models.QuestgroupsModel.html | 915 --- .../models.QuestgroupshierarchyModel.html | 915 --- doc/files/models.QuestgrouptextsModel.html | 915 --- doc/files/models.QuestsModel.html | 915 --- doc/files/models.QuesttextsModel.html | 915 --- doc/files/models.QuesttopicsModel.html | 915 --- doc/files/models.QuesttypesModel.html | 915 --- doc/files/models.SeminariesModel.html | 915 --- .../models.SeminarycharacterfieldsModel.html | 915 --- doc/files/models.UploadsModel.html | 915 --- doc/files/models.UserrolesModel.html | 915 --- doc/files/models.UsersModel.html | 915 --- doc/files/models.XplevelsModel.html | 915 --- doc/files/models/AchievementsModel.inc.txt | 1174 --- doc/files/models/AvatarsModel.inc.txt | 147 - doc/files/models/CharactergroupsModel.inc.txt | 506 -- .../models/CharactergroupsquestsModel.inc.txt | 392 - doc/files/models/CharacterrolesModel.inc.txt | 101 - doc/files/models/CharactersModel.inc.txt | 698 -- doc/files/models/CharactertypesModel.inc.txt | 217 - doc/files/models/DatabaseModel.inc.txt | 84 - doc/files/models/MediaModel.inc.txt | 498 -- doc/files/models/QuestgroupsModel.inc.txt | 871 -- .../models/QuestgroupshierarchyModel.inc.txt | 320 - doc/files/models/QuestgrouptextsModel.inc.txt | 182 - doc/files/models/QuestsModel.inc.txt | 714 -- doc/files/models/QuesttextsModel.inc.txt | 333 - doc/files/models/QuesttopicsModel.inc.txt | 401 - doc/files/models/QuesttypesModel.inc.txt | 78 - doc/files/models/SeminariesModel.inc.txt | 243 - .../SeminarycharacterfieldsModel.inc.txt | 130 - doc/files/models/UploadsModel.inc.txt | 142 - doc/files/models/UserrolesModel.inc.txt | 121 - doc/files/models/UsersModel.inc.txt | 405 - doc/files/models/XplevelsModel.inc.txt | 201 - ...pes.bossfight.BossfightQuesttypeAgent.html | 915 --- ...ossfight.BossfightQuesttypeController.html | 915 --- ...pes.bossfight.BossfightQuesttypeModel.html | 915 --- ...choiceinput.ChoiceinputQuesttypeAgent.html | 915 --- ...einput.ChoiceinputQuesttypeController.html | 916 --- ...choiceinput.ChoiceinputQuesttypeModel.html | 916 --- ...pes.crossword.CrosswordQuesttypeAgent.html | 915 --- ...rossword.CrosswordQuesttypeController.html | 915 --- ...pes.crossword.CrosswordQuesttypeModel.html | 915 --- ...pes.dragndrop.DragndropQuesttypeAgent.html | 915 --- ...ragndrop.DragndropQuesttypeController.html | 915 --- ...pes.dragndrop.DragndropQuesttypeModel.html | 915 --- ...lechoice.MultiplechoiceQuesttypeAgent.html | 915 --- ...ice.MultiplechoiceQuesttypeController.html | 915 --- ...lechoice.MultiplechoiceQuesttypeModel.html | 915 --- ...uesttypes.submit.SubmitQuesttypeAgent.html | 915 --- ...ypes.submit.SubmitQuesttypeController.html | 915 --- ...uesttypes.submit.SubmitQuesttypeModel.html | 915 --- ...pes.textinput.TextinputQuesttypeAgent.html | 915 --- ...extinput.TextinputQuesttypeController.html | 915 --- ...pes.textinput.TextinputQuesttypeModel.html | 915 --- .../bossfight/BossfightQuesttypeAgent.inc.txt | 25 - .../BossfightQuesttypeController.inc.txt | 293 - .../bossfight/BossfightQuesttypeModel.inc.txt | 184 - .../ChoiceinputQuesttypeAgent.inc.txt | 25 - .../ChoiceinputQuesttypeController.inc.txt | 300 - .../ChoiceinputQuesttypeModel.inc.txt | 296 - .../crossword/CrosswordQuesttypeAgent.inc.txt | 25 - .../CrosswordQuesttypeController.inc.txt | 381 - .../crossword/CrosswordQuesttypeModel.inc.txt | 94 - .../dragndrop/DragndropQuesttypeAgent.inc.txt | 25 - .../DragndropQuesttypeController.inc.txt | 233 - .../dragndrop/DragndropQuesttypeModel.inc.txt | 181 - .../MultiplechoiceQuesttypeAgent.inc.txt | 25 - .../MultiplechoiceQuesttypeController.inc.txt | 386 - .../MultiplechoiceQuesttypeModel.inc.txt | 269 - .../submit/SubmitQuesttypeAgent.inc.txt | 25 - .../submit/SubmitQuesttypeController.inc.txt | 242 - .../submit/SubmitQuesttypeModel.inc.txt | 145 - .../textinput/TextinputQuesttypeAgent.inc.txt | 25 - .../TextinputQuesttypeController.inc.txt | 308 - .../textinput/TextinputQuesttypeModel.inc.txt | 222 - doc/files/requests.WebRequest.html | 915 --- doc/files/requests/WebRequest.inc.txt | 402 - doc/files/responses.WebResponse.html | 915 --- doc/files/responses/WebResponse.inc.txt | 251 - doc/files/www.index.html | 975 --- doc/files/www/index.php.txt | 46 - doc/font/FontAwesome.otf | Bin 75188 -> 0 bytes doc/font/fontawesome-webfont.eot | Bin 72449 -> 0 bytes doc/font/fontawesome-webfont.svg | 504 -- doc/font/fontawesome-webfont.ttf | Bin 141564 -> 0 bytes doc/font/fontawesome-webfont.woff | Bin 83760 -> 0 bytes doc/graphs/class.html | 174 - doc/graphs/classes.svg | 1846 ----- doc/images/apple-touch-icon-114x114.png | Bin 28338 -> 0 bytes doc/images/apple-touch-icon-72x72.png | Bin 12751 -> 0 bytes doc/images/apple-touch-icon.png | Bin 8358 -> 0 bytes doc/images/custom-icons.svg | 116 - doc/images/favicon.ico | Bin 1150 -> 0 bytes doc/images/hierarchy-item.png | Bin 236 -> 0 bytes doc/images/icon-class-13x13.png | Bin 428 -> 0 bytes doc/images/icon-class.svg | 77 - doc/images/icon-interface-13x13.png | Bin 308 -> 0 bytes doc/images/icon-interface.svg | 73 - doc/images/icon-trait-13x13.png | Bin 340 -> 0 bytes doc/images/icon-trait.svg | 73 - doc/images/iviewer/grab.cur | Bin 1150 -> 0 bytes doc/images/iviewer/hand.cur | Bin 1150 -> 0 bytes doc/images/iviewer/iviewer.rotate_left.png | Bin 1493 -> 0 bytes doc/images/iviewer/iviewer.rotate_right.png | Bin 1482 -> 0 bytes doc/images/iviewer/iviewer.zoom_fit.png | Bin 1252 -> 0 bytes doc/images/iviewer/iviewer.zoom_in.png | Bin 1420 -> 0 bytes doc/images/iviewer/iviewer.zoom_out.png | Bin 1416 -> 0 bytes doc/images/iviewer/iviewer.zoom_zero.png | Bin 1091 -> 0 bytes doc/index.html | 1278 --- doc/js/bootstrap.min.js | 7 - doc/js/html5.js | 8 - doc/js/jquery-1.11.0.min.js | 4 - doc/js/jquery.dotdotdot-1.5.9.js | 602 -- doc/js/jquery.dotdotdot-1.5.9.min.js | 15 - doc/js/jquery.iviewer.js | 1169 --- doc/js/jquery.iviewer.min.js | 47 - doc/js/jquery.mousewheel.js | 201 - doc/js/jquery.smooth-scroll.js | 32 - doc/js/prism.min.js | 16 - doc/js/ui/1.10.4/jquery-ui.min.js | 7 - doc/namespaces/default.html | 1278 --- doc/namespaces/hhu.html | 826 -- doc/namespaces/hhu.z.agents.bottomlevel.html | 853 -- doc/namespaces/hhu.z.agents.html | 847 -- doc/namespaces/hhu.z.agents.intermediate.html | 897 --- doc/namespaces/hhu.z.agents.toplevel.html | 853 -- doc/namespaces/hhu.z.apis.html | 831 -- .../hhu.z.controllers.components.html | 845 -- doc/namespaces/hhu.z.controllers.html | 970 --- doc/namespaces/hhu.z.exceptions.html | 871 -- doc/namespaces/hhu.z.html | 874 -- doc/namespaces/hhu.z.lib.html | 843 -- doc/namespaces/hhu.z.models.html | 917 --- doc/namespaces/hhu.z.questtypes.html | 913 --- doc/namespaces/hhu.z.requests.html | 831 -- doc/namespaces/hhu.z.responses.html | 831 -- doc/namespaces/hhu.z.views.html | 831 -- doc/namespaces/nre.agents.html | 840 -- doc/namespaces/nre.apis.html | 829 -- doc/namespaces/nre.configs.html | 833 -- doc/namespaces/nre.core.html | 889 --- doc/namespaces/nre.drivers.html | 833 -- doc/namespaces/nre.exceptions.html | 913 --- doc/namespaces/nre.html | 850 -- doc/namespaces/nre.models.html | 829 -- doc/namespaces/nre.requests.html | 829 -- doc/namespaces/nre.responses.html | 829 -- doc/reports/deprecated.html | 224 - doc/reports/errors.html | 553 -- doc/reports/markers.html | 223 - 636 files changed, 1 insertion(+), 565424 deletions(-) delete mode 100644 doc/classes/PHPMailer.html delete mode 100644 doc/classes/SMTP.html delete mode 100644 doc/classes/hhu.z.Controller.html delete mode 100644 doc/classes/hhu.z.Model.html delete mode 100644 doc/classes/hhu.z.TextFormatter.html delete mode 100644 doc/classes/hhu.z.Utils.html delete mode 100644 doc/classes/hhu.z.agents.QuesttypeAgent.html delete mode 100644 doc/classes/hhu.z.agents.ToplevelAgent.html delete mode 100644 doc/classes/hhu.z.agents.bottomlevel.MailreceiverAgent.html delete mode 100644 doc/classes/hhu.z.agents.bottomlevel.MenuAgent.html delete mode 100644 doc/classes/hhu.z.agents.bottomlevel.QuestgroupshierarchypathAgent.html delete mode 100644 doc/classes/hhu.z.agents.bottomlevel.SeminarybarAgent.html delete mode 100644 doc/classes/hhu.z.agents.bottomlevel.SeminarymenuAgent.html delete mode 100644 doc/classes/hhu.z.agents.bottomlevel.UserrolesAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.AchievementsAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.CharactergroupsAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.CharactergroupsquestsAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.CharactersAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.CharactertypesAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.ErrorAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.IntroductionAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.LibraryAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.MailAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.MediaAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.QuestgroupsAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.QuestgroupshierarchyAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.QuestsAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.SeminariesAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.UploadsAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.UsersAgent.html delete mode 100644 doc/classes/hhu.z.agents.intermediate.XplevelsAgent.html delete mode 100644 doc/classes/hhu.z.agents.toplevel.AjaxAgent.html delete mode 100644 doc/classes/hhu.z.agents.toplevel.BinaryAgent.html delete mode 100644 doc/classes/hhu.z.agents.toplevel.FaultAgent.html delete mode 100644 doc/classes/hhu.z.agents.toplevel.HtmlAgent.html delete mode 100644 doc/classes/hhu.z.agents.toplevel.HtmlmailAgent.html delete mode 100644 doc/classes/hhu.z.agents.toplevel.TextmailAgent.html delete mode 100644 doc/classes/hhu.z.apis.MailApi.html delete mode 100644 doc/classes/hhu.z.controllers.AchievementsController.html delete mode 100644 doc/classes/hhu.z.controllers.AjaxController.html delete mode 100644 doc/classes/hhu.z.controllers.BinaryController.html delete mode 100644 doc/classes/hhu.z.controllers.CharactergroupsController.html delete mode 100644 doc/classes/hhu.z.controllers.CharactergroupsquestsController.html delete mode 100644 doc/classes/hhu.z.controllers.CharactersController.html delete mode 100644 doc/classes/hhu.z.controllers.CharactertypesController.html delete mode 100644 doc/classes/hhu.z.controllers.ErrorController.html delete mode 100644 doc/classes/hhu.z.controllers.FaultController.html delete mode 100644 doc/classes/hhu.z.controllers.HtmlController.html delete mode 100644 doc/classes/hhu.z.controllers.HtmlmailController.html delete mode 100644 doc/classes/hhu.z.controllers.IntermediateController.html delete mode 100644 doc/classes/hhu.z.controllers.IntroductionController.html delete mode 100644 doc/classes/hhu.z.controllers.LibraryController.html delete mode 100644 doc/classes/hhu.z.controllers.MailController.html delete mode 100644 doc/classes/hhu.z.controllers.MailreceiverController.html delete mode 100644 doc/classes/hhu.z.controllers.MediaController.html delete mode 100644 doc/classes/hhu.z.controllers.MenuController.html delete mode 100644 doc/classes/hhu.z.controllers.QuestgroupsController.html delete mode 100644 doc/classes/hhu.z.controllers.QuestgroupshierarchyController.html delete mode 100644 doc/classes/hhu.z.controllers.QuestgroupshierarchypathController.html delete mode 100644 doc/classes/hhu.z.controllers.QuestsController.html delete mode 100644 doc/classes/hhu.z.controllers.QuesttypeController.html delete mode 100644 doc/classes/hhu.z.controllers.SeminariesController.html delete mode 100644 doc/classes/hhu.z.controllers.SeminaryController.html delete mode 100644 doc/classes/hhu.z.controllers.SeminarybarController.html delete mode 100644 doc/classes/hhu.z.controllers.SeminarymenuController.html delete mode 100644 doc/classes/hhu.z.controllers.TextmailController.html delete mode 100644 doc/classes/hhu.z.controllers.UploadsController.html delete mode 100644 doc/classes/hhu.z.controllers.UserrolesController.html delete mode 100644 doc/classes/hhu.z.controllers.UsersController.html delete mode 100644 doc/classes/hhu.z.controllers.XplevelsController.html delete mode 100644 doc/classes/hhu.z.controllers.components.AchievementComponent.html delete mode 100644 doc/classes/hhu.z.controllers.components.AuthComponent.html delete mode 100644 doc/classes/hhu.z.controllers.components.NotificationComponent.html delete mode 100644 doc/classes/hhu.z.controllers.components.ValidationComponent.html delete mode 100644 doc/classes/hhu.z.exceptions.FileUploadException.html delete mode 100644 doc/classes/hhu.z.exceptions.MailingException.html delete mode 100644 doc/classes/hhu.z.exceptions.MaxFilesizeException.html delete mode 100644 doc/classes/hhu.z.exceptions.QuesttypeAgentNotFoundException.html delete mode 100644 doc/classes/hhu.z.exceptions.QuesttypeAgentNotValidException.html delete mode 100644 doc/classes/hhu.z.exceptions.QuesttypeControllerNotFoundException.html delete mode 100644 doc/classes/hhu.z.exceptions.QuesttypeControllerNotValidException.html delete mode 100644 doc/classes/hhu.z.exceptions.QuesttypeModelNotFoundException.html delete mode 100644 doc/classes/hhu.z.exceptions.QuesttypeModelNotValidException.html delete mode 100644 doc/classes/hhu.z.exceptions.SubmissionNotValidException.html delete mode 100644 doc/classes/hhu.z.exceptions.WrongFiletypeException.html delete mode 100644 doc/classes/hhu.z.lib.PHPMailer.html delete mode 100644 doc/classes/hhu.z.lib.PHPMailerAutoload.html delete mode 100644 doc/classes/hhu.z.lib.Password.html delete mode 100644 doc/classes/hhu.z.lib.SMTP.html delete mode 100644 doc/classes/hhu.z.models.AchievementsModel.html delete mode 100644 doc/classes/hhu.z.models.AvatarsModel.html delete mode 100644 doc/classes/hhu.z.models.CharactergroupsModel.html delete mode 100644 doc/classes/hhu.z.models.CharactergroupsquestsModel.html delete mode 100644 doc/classes/hhu.z.models.CharacterrolesModel.html delete mode 100644 doc/classes/hhu.z.models.CharactersModel.html delete mode 100644 doc/classes/hhu.z.models.CharactertypesModel.html delete mode 100644 doc/classes/hhu.z.models.MediaModel.html delete mode 100644 doc/classes/hhu.z.models.QuestgroupsModel.html delete mode 100644 doc/classes/hhu.z.models.QuestgroupshierarchyModel.html delete mode 100644 doc/classes/hhu.z.models.QuestgrouptextsModel.html delete mode 100644 doc/classes/hhu.z.models.QuestsModel.html delete mode 100644 doc/classes/hhu.z.models.QuesttextsModel.html delete mode 100644 doc/classes/hhu.z.models.QuesttopicsModel.html delete mode 100644 doc/classes/hhu.z.models.QuesttypeModel.html delete mode 100644 doc/classes/hhu.z.models.QuesttypesModel.html delete mode 100644 doc/classes/hhu.z.models.SeminariesModel.html delete mode 100644 doc/classes/hhu.z.models.SeminarycharacterfieldsModel.html delete mode 100644 doc/classes/hhu.z.models.UploadsModel.html delete mode 100644 doc/classes/hhu.z.models.UserrolesModel.html delete mode 100644 doc/classes/hhu.z.models.UsersModel.html delete mode 100644 doc/classes/hhu.z.models.XplevelsModel.html delete mode 100644 doc/classes/hhu.z.questtypes.BossfightQuesttypeAgent.html delete mode 100644 doc/classes/hhu.z.questtypes.BossfightQuesttypeController.html delete mode 100644 doc/classes/hhu.z.questtypes.BossfightQuesttypeModel.html delete mode 100644 doc/classes/hhu.z.questtypes.ChoiceinputQuesttypeAgent.html delete mode 100644 doc/classes/hhu.z.questtypes.ChoiceinputQuesttypeController.html delete mode 100644 doc/classes/hhu.z.questtypes.ChoiceinputQuesttypeModel.html delete mode 100644 doc/classes/hhu.z.questtypes.CrosswordQuesttypeAgent.html delete mode 100644 doc/classes/hhu.z.questtypes.CrosswordQuesttypeController.html delete mode 100644 doc/classes/hhu.z.questtypes.CrosswordQuesttypeModel.html delete mode 100644 doc/classes/hhu.z.questtypes.DragndropQuesttypeAgent.html delete mode 100644 doc/classes/hhu.z.questtypes.DragndropQuesttypeController.html delete mode 100644 doc/classes/hhu.z.questtypes.DragndropQuesttypeModel.html delete mode 100644 doc/classes/hhu.z.questtypes.MultiplechoiceQuesttypeAgent.html delete mode 100644 doc/classes/hhu.z.questtypes.MultiplechoiceQuesttypeController.html delete mode 100644 doc/classes/hhu.z.questtypes.MultiplechoiceQuesttypeModel.html delete mode 100644 doc/classes/hhu.z.questtypes.SubmitQuesttypeAgent.html delete mode 100644 doc/classes/hhu.z.questtypes.SubmitQuesttypeController.html delete mode 100644 doc/classes/hhu.z.questtypes.SubmitQuesttypeModel.html delete mode 100644 doc/classes/hhu.z.questtypes.TextinputQuesttypeAgent.html delete mode 100644 doc/classes/hhu.z.questtypes.TextinputQuesttypeController.html delete mode 100644 doc/classes/hhu.z.questtypes.TextinputQuesttypeModel.html delete mode 100644 doc/classes/hhu.z.requests.MailRequest.html delete mode 100644 doc/classes/hhu.z.responses.MailResponse.html delete mode 100644 doc/classes/hhu.z.views.QuesttypeView.html delete mode 100644 doc/classes/nre.agents.BottomlevelAgent.html delete mode 100644 doc/classes/nre.agents.IntermediateAgent.html delete mode 100644 doc/classes/nre.agents.ToplevelAgent.html delete mode 100644 doc/classes/nre.apis.WebApi.html delete mode 100644 doc/classes/nre.configs.AppConfig.html delete mode 100644 doc/classes/nre.configs.CoreConfig.html delete mode 100644 doc/classes/nre.core.Agent.html delete mode 100644 doc/classes/nre.core.Api.html delete mode 100644 doc/classes/nre.core.Autoloader.html delete mode 100644 doc/classes/nre.core.ClassLoader.html delete mode 100644 doc/classes/nre.core.Component.html delete mode 100644 doc/classes/nre.core.Config.html delete mode 100644 doc/classes/nre.core.Controller.html delete mode 100644 doc/classes/nre.core.Driver.html delete mode 100644 doc/classes/nre.core.Exception.html delete mode 100644 doc/classes/nre.core.Linker.html delete mode 100644 doc/classes/nre.core.Logger.html delete mode 100644 doc/classes/nre.core.Model.html delete mode 100644 doc/classes/nre.core.Request.html delete mode 100644 doc/classes/nre.core.Response.html delete mode 100644 doc/classes/nre.core.View.html delete mode 100644 doc/classes/nre.core.WebUtils.html delete mode 100644 doc/classes/nre.drivers.DatabaseDriver.html delete mode 100644 doc/classes/nre.drivers.MysqliDriver.html delete mode 100644 doc/classes/nre.exceptions.AccessDeniedException.html delete mode 100644 doc/classes/nre.exceptions.ActionNotFoundException.html delete mode 100644 doc/classes/nre.exceptions.AgentNotFoundException.html delete mode 100644 doc/classes/nre.exceptions.AgentNotValidException.html delete mode 100644 doc/classes/nre.exceptions.ClassNotFoundException.html delete mode 100644 doc/classes/nre.exceptions.ClassNotValidException.html delete mode 100644 doc/classes/nre.exceptions.ComponentNotFoundException.html delete mode 100644 doc/classes/nre.exceptions.ComponentNotValidException.html delete mode 100644 doc/classes/nre.exceptions.ControllerNotFoundException.html delete mode 100644 doc/classes/nre.exceptions.ControllerNotValidException.html delete mode 100644 doc/classes/nre.exceptions.DatamodelException.html delete mode 100644 doc/classes/nre.exceptions.DriverNotFoundException.html delete mode 100644 doc/classes/nre.exceptions.DriverNotValidException.html delete mode 100644 doc/classes/nre.exceptions.FatalDatamodelException.html delete mode 100644 doc/classes/nre.exceptions.IdNotFoundException.html delete mode 100644 doc/classes/nre.exceptions.LayoutNotFoundException.html delete mode 100644 doc/classes/nre.exceptions.LayoutNotValidException.html delete mode 100644 doc/classes/nre.exceptions.ModelNotFoundException.html delete mode 100644 doc/classes/nre.exceptions.ModelNotValidException.html delete mode 100644 doc/classes/nre.exceptions.ParamsNotValidException.html delete mode 100644 doc/classes/nre.exceptions.ServiceUnavailableException.html delete mode 100644 doc/classes/nre.exceptions.ViewNotFoundException.html delete mode 100644 doc/classes/nre.models.DatabaseModel.html delete mode 100644 doc/classes/nre.requests.WebRequest.html delete mode 100644 doc/classes/nre.responses.WebResponse.html delete mode 100644 doc/classes/phpmailerException.html delete mode 100644 doc/css/bootstrap-combined.no-icons.min.css delete mode 100644 doc/css/font-awesome.min.css delete mode 100644 doc/css/jquery.iviewer.css delete mode 100644 doc/css/phpdocumentor-clean-icons/Read Me.txt delete mode 100644 doc/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.dev.svg delete mode 100644 doc/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.eot delete mode 100644 doc/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.svg delete mode 100644 doc/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.ttf delete mode 100644 doc/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.woff delete mode 100644 doc/css/phpdocumentor-clean-icons/lte-ie7.js delete mode 100644 doc/css/phpdocumentor-clean-icons/style.css delete mode 100644 doc/css/prism.css delete mode 100644 doc/css/template.css delete mode 100644 doc/files/agents.BottomlevelAgent.html delete mode 100644 doc/files/agents.IntermediateAgent.html delete mode 100644 doc/files/agents.ToplevelAgent.html delete mode 100644 doc/files/agents.bottomlevel.MailreceiverAgent.html delete mode 100644 doc/files/agents.bottomlevel.MenuAgent.html delete mode 100644 doc/files/agents.bottomlevel.QuestgroupshierarchypathAgent.html delete mode 100644 doc/files/agents.bottomlevel.SeminarybarAgent.html delete mode 100644 doc/files/agents.bottomlevel.SeminarymenuAgent.html delete mode 100644 doc/files/agents.bottomlevel.UserrolesAgent.html delete mode 100644 doc/files/agents.intermediate.AchievementsAgent.html delete mode 100644 doc/files/agents.intermediate.CharactergroupsAgent.html delete mode 100644 doc/files/agents.intermediate.CharactergroupsquestsAgent.html delete mode 100644 doc/files/agents.intermediate.CharactersAgent.html delete mode 100644 doc/files/agents.intermediate.CharactertypesAgent.html delete mode 100644 doc/files/agents.intermediate.ErrorAgent.html delete mode 100644 doc/files/agents.intermediate.IntroductionAgent.html delete mode 100644 doc/files/agents.intermediate.LibraryAgent.html delete mode 100644 doc/files/agents.intermediate.MailAgent.html delete mode 100644 doc/files/agents.intermediate.MediaAgent.html delete mode 100644 doc/files/agents.intermediate.QuestgroupsAgent.html delete mode 100644 doc/files/agents.intermediate.QuestgroupshierarchyAgent.html delete mode 100644 doc/files/agents.intermediate.QuestsAgent.html delete mode 100644 doc/files/agents.intermediate.SeminariesAgent.html delete mode 100644 doc/files/agents.intermediate.UploadsAgent.html delete mode 100644 doc/files/agents.intermediate.UsersAgent.html delete mode 100644 doc/files/agents.intermediate.XplevelsAgent.html delete mode 100644 doc/files/agents.toplevel.AjaxAgent.html delete mode 100644 doc/files/agents.toplevel.BinaryAgent.html delete mode 100644 doc/files/agents.toplevel.FaultAgent.html delete mode 100644 doc/files/agents.toplevel.HtmlAgent.html delete mode 100644 doc/files/agents.toplevel.HtmlmailAgent.html delete mode 100644 doc/files/agents.toplevel.TextmailAgent.html delete mode 100644 doc/files/agents/BottomlevelAgent.inc.txt delete mode 100644 doc/files/agents/IntermediateAgent.inc.txt delete mode 100644 doc/files/agents/ToplevelAgent.inc.txt delete mode 100644 doc/files/agents/bottomlevel/MailreceiverAgent.inc.txt delete mode 100644 doc/files/agents/bottomlevel/MenuAgent.inc.txt delete mode 100644 doc/files/agents/bottomlevel/QuestgroupshierarchypathAgent.inc.txt delete mode 100644 doc/files/agents/bottomlevel/SeminarybarAgent.inc.txt delete mode 100644 doc/files/agents/bottomlevel/SeminarymenuAgent.inc.txt delete mode 100644 doc/files/agents/bottomlevel/UserrolesAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/AchievementsAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/CharactergroupsAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/CharactergroupsquestsAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/CharactersAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/CharactertypesAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/ErrorAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/IntroductionAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/LibraryAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/MailAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/MediaAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/QuestgroupsAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/QuestgroupshierarchyAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/QuestsAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/SeminariesAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/UploadsAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/UsersAgent.inc.txt delete mode 100644 doc/files/agents/intermediate/XplevelsAgent.inc.txt delete mode 100644 doc/files/agents/toplevel/AjaxAgent.inc.txt delete mode 100644 doc/files/agents/toplevel/BinaryAgent.inc.txt delete mode 100644 doc/files/agents/toplevel/FaultAgent.inc.txt delete mode 100644 doc/files/agents/toplevel/HtmlAgent.inc.txt delete mode 100644 doc/files/agents/toplevel/HtmlmailAgent.inc.txt delete mode 100644 doc/files/agents/toplevel/TextmailAgent.inc.txt delete mode 100644 doc/files/apis.WebApi.html delete mode 100644 doc/files/apis/WebApi.inc.txt delete mode 100644 doc/files/app.Controller.html delete mode 100644 doc/files/app.Model.html delete mode 100644 doc/files/app.TextFormatter.html delete mode 100644 doc/files/app.Utils.html delete mode 100644 doc/files/app.agents.QuesttypeAgent.html delete mode 100644 doc/files/app.agents.ToplevelAgent.html delete mode 100644 doc/files/app.apis.MailApi.html delete mode 100644 doc/files/app.controllers.IntermediateController.html delete mode 100644 doc/files/app.controllers.QuesttypeController.html delete mode 100644 doc/files/app.controllers.SeminaryController.html delete mode 100644 doc/files/app.exceptions.FileUploadException.html delete mode 100644 doc/files/app.exceptions.MailingException.html delete mode 100644 doc/files/app.exceptions.MaxFilesizeException.html delete mode 100644 doc/files/app.exceptions.QuesttypeAgentNotFoundException.html delete mode 100644 doc/files/app.exceptions.QuesttypeAgentNotValidException.html delete mode 100644 doc/files/app.exceptions.QuesttypeControllerNotFoundException.html delete mode 100644 doc/files/app.exceptions.QuesttypeControllerNotValidException.html delete mode 100644 doc/files/app.exceptions.QuesttypeModelNotFoundException.html delete mode 100644 doc/files/app.exceptions.QuesttypeModelNotValidException.html delete mode 100644 doc/files/app.exceptions.SubmissionNotValidException.html delete mode 100644 doc/files/app.exceptions.WrongFiletypeException.html delete mode 100644 doc/files/app.lib.PHPMailer.html delete mode 100644 doc/files/app.lib.PHPMailerAutoload.html delete mode 100644 doc/files/app.lib.Password.html delete mode 100644 doc/files/app.lib.SMTP.html delete mode 100644 doc/files/app.models.QuesttypeModel.html delete mode 100644 doc/files/app.requests.MailRequest.html delete mode 100644 doc/files/app.responses.MailResponse.html delete mode 100644 doc/files/app.views.QuesttypeView.html delete mode 100644 doc/files/app/Controller.inc.txt delete mode 100644 doc/files/app/Model.inc.txt delete mode 100644 doc/files/app/TextFormatter.inc.txt delete mode 100644 doc/files/app/Utils.inc.txt delete mode 100644 doc/files/app/agents/QuesttypeAgent.inc.txt delete mode 100644 doc/files/app/agents/ToplevelAgent.inc.txt delete mode 100644 doc/files/app/apis/MailApi.inc.txt delete mode 100644 doc/files/app/controllers/IntermediateController.inc.txt delete mode 100644 doc/files/app/controllers/QuesttypeController.inc.txt delete mode 100644 doc/files/app/controllers/SeminaryController.inc.txt delete mode 100644 doc/files/app/exceptions/FileUploadException.inc.txt delete mode 100644 doc/files/app/exceptions/MailingException.inc.txt delete mode 100644 doc/files/app/exceptions/MaxFilesizeException.inc.txt delete mode 100644 doc/files/app/exceptions/QuesttypeAgentNotFoundException.inc.txt delete mode 100644 doc/files/app/exceptions/QuesttypeAgentNotValidException.inc.txt delete mode 100644 doc/files/app/exceptions/QuesttypeControllerNotFoundException.inc.txt delete mode 100644 doc/files/app/exceptions/QuesttypeControllerNotValidException.inc.txt delete mode 100644 doc/files/app/exceptions/QuesttypeModelNotFoundException.inc.txt delete mode 100644 doc/files/app/exceptions/QuesttypeModelNotValidException.inc.txt delete mode 100644 doc/files/app/exceptions/SubmissionNotValidException.inc.txt delete mode 100644 doc/files/app/exceptions/WrongFiletypeException.inc.txt delete mode 100644 doc/files/app/lib/PHPMailer.inc.txt delete mode 100644 doc/files/app/lib/PHPMailerAutoload.inc.txt delete mode 100644 doc/files/app/lib/Password.inc.txt delete mode 100644 doc/files/app/lib/SMTP.inc.txt delete mode 100644 doc/files/app/models/QuesttypeModel.inc.txt delete mode 100644 doc/files/app/requests/MailRequest.inc.txt delete mode 100644 doc/files/app/responses/MailResponse.inc.txt delete mode 100644 doc/files/app/views/QuesttypeView.inc.txt delete mode 100644 doc/files/bootstrap.html delete mode 100644 doc/files/bootstrap.inc.txt delete mode 100644 doc/files/configs.AppConfig.html delete mode 100644 doc/files/configs.CoreConfig.html delete mode 100644 doc/files/configs/AppConfig.inc.txt delete mode 100644 doc/files/configs/CoreConfig.inc.txt delete mode 100644 doc/files/controllers.AchievementsController.html delete mode 100644 doc/files/controllers.AjaxController.html delete mode 100644 doc/files/controllers.BinaryController.html delete mode 100644 doc/files/controllers.CharactergroupsController.html delete mode 100644 doc/files/controllers.CharactergroupsquestsController.html delete mode 100644 doc/files/controllers.CharactersController.html delete mode 100644 doc/files/controllers.CharactertypesController.html delete mode 100644 doc/files/controllers.ErrorController.html delete mode 100644 doc/files/controllers.FaultController.html delete mode 100644 doc/files/controllers.HtmlController.html delete mode 100644 doc/files/controllers.HtmlmailController.html delete mode 100644 doc/files/controllers.IntroductionController.html delete mode 100644 doc/files/controllers.LibraryController.html delete mode 100644 doc/files/controllers.MailController.html delete mode 100644 doc/files/controllers.MailreceiverController.html delete mode 100644 doc/files/controllers.MediaController.html delete mode 100644 doc/files/controllers.MenuController.html delete mode 100644 doc/files/controllers.QuestgroupsController.html delete mode 100644 doc/files/controllers.QuestgroupshierarchyController.html delete mode 100644 doc/files/controllers.QuestgroupshierarchypathController.html delete mode 100644 doc/files/controllers.QuestsController.html delete mode 100644 doc/files/controllers.SeminariesController.html delete mode 100644 doc/files/controllers.SeminarybarController.html delete mode 100644 doc/files/controllers.SeminarymenuController.html delete mode 100644 doc/files/controllers.TextmailController.html delete mode 100644 doc/files/controllers.UploadsController.html delete mode 100644 doc/files/controllers.UserrolesController.html delete mode 100644 doc/files/controllers.UsersController.html delete mode 100644 doc/files/controllers.XplevelsController.html delete mode 100644 doc/files/controllers.components.AchievementComponent.html delete mode 100644 doc/files/controllers.components.AuthComponent.html delete mode 100644 doc/files/controllers.components.NotificationComponent.html delete mode 100644 doc/files/controllers.components.ValidationComponent.html delete mode 100644 doc/files/controllers/AchievementsController.inc.txt delete mode 100644 doc/files/controllers/AjaxController.inc.txt delete mode 100644 doc/files/controllers/BinaryController.inc.txt delete mode 100644 doc/files/controllers/CharactergroupsController.inc.txt delete mode 100644 doc/files/controllers/CharactergroupsquestsController.inc.txt delete mode 100644 doc/files/controllers/CharactersController.inc.txt delete mode 100644 doc/files/controllers/CharactertypesController.inc.txt delete mode 100644 doc/files/controllers/ErrorController.inc.txt delete mode 100644 doc/files/controllers/FaultController.inc.txt delete mode 100644 doc/files/controllers/HtmlController.inc.txt delete mode 100644 doc/files/controllers/HtmlmailController.inc.txt delete mode 100644 doc/files/controllers/IntroductionController.inc.txt delete mode 100644 doc/files/controllers/LibraryController.inc.txt delete mode 100644 doc/files/controllers/MailController.inc.txt delete mode 100644 doc/files/controllers/MailreceiverController.inc.txt delete mode 100644 doc/files/controllers/MediaController.inc.txt delete mode 100644 doc/files/controllers/MenuController.inc.txt delete mode 100644 doc/files/controllers/QuestgroupsController.inc.txt delete mode 100644 doc/files/controllers/QuestgroupshierarchyController.inc.txt delete mode 100644 doc/files/controllers/QuestgroupshierarchypathController.inc.txt delete mode 100644 doc/files/controllers/QuestsController.inc.txt delete mode 100644 doc/files/controllers/SeminariesController.inc.txt delete mode 100644 doc/files/controllers/SeminarybarController.inc.txt delete mode 100644 doc/files/controllers/SeminarymenuController.inc.txt delete mode 100644 doc/files/controllers/TextmailController.inc.txt delete mode 100644 doc/files/controllers/UploadsController.inc.txt delete mode 100644 doc/files/controllers/UserrolesController.inc.txt delete mode 100644 doc/files/controllers/UsersController.inc.txt delete mode 100644 doc/files/controllers/XplevelsController.inc.txt delete mode 100644 doc/files/controllers/components/AchievementComponent.inc.txt delete mode 100644 doc/files/controllers/components/AuthComponent.inc.txt delete mode 100644 doc/files/controllers/components/NotificationComponent.inc.txt delete mode 100644 doc/files/controllers/components/ValidationComponent.inc.txt delete mode 100644 doc/files/core.Agent.html delete mode 100644 doc/files/core.Api.html delete mode 100644 doc/files/core.Autoloader.html delete mode 100644 doc/files/core.ClassLoader.html delete mode 100644 doc/files/core.Component.html delete mode 100644 doc/files/core.Config.html delete mode 100644 doc/files/core.Controller.html delete mode 100644 doc/files/core.Driver.html delete mode 100644 doc/files/core.Exception.html delete mode 100644 doc/files/core.Linker.html delete mode 100644 doc/files/core.Logger.html delete mode 100644 doc/files/core.Model.html delete mode 100644 doc/files/core.Request.html delete mode 100644 doc/files/core.Response.html delete mode 100644 doc/files/core.View.html delete mode 100644 doc/files/core.WebUtils.html delete mode 100644 doc/files/core/Agent.inc.txt delete mode 100644 doc/files/core/Api.inc.txt delete mode 100644 doc/files/core/Autoloader.inc.txt delete mode 100644 doc/files/core/ClassLoader.inc.txt delete mode 100644 doc/files/core/Component.inc.txt delete mode 100644 doc/files/core/Config.inc.txt delete mode 100644 doc/files/core/Controller.inc.txt delete mode 100644 doc/files/core/Driver.inc.txt delete mode 100644 doc/files/core/Exception.inc.txt delete mode 100644 doc/files/core/Linker.inc.txt delete mode 100644 doc/files/core/Logger.inc.txt delete mode 100644 doc/files/core/Model.inc.txt delete mode 100644 doc/files/core/Request.inc.txt delete mode 100644 doc/files/core/Response.inc.txt delete mode 100644 doc/files/core/View.inc.txt delete mode 100644 doc/files/core/WebUtils.inc.txt delete mode 100644 doc/files/drivers.DatabaseDriver.html delete mode 100644 doc/files/drivers.MysqliDriver.html delete mode 100644 doc/files/drivers/DatabaseDriver.inc.txt delete mode 100644 doc/files/drivers/MysqliDriver.inc.txt delete mode 100644 doc/files/exceptions.AccessDeniedException.html delete mode 100644 doc/files/exceptions.ActionNotFoundException.html delete mode 100644 doc/files/exceptions.AgentNotFoundException.html delete mode 100644 doc/files/exceptions.AgentNotValidException.html delete mode 100644 doc/files/exceptions.ClassNotFoundException.html delete mode 100644 doc/files/exceptions.ClassNotValidException.html delete mode 100644 doc/files/exceptions.ComponentNotFoundException.html delete mode 100644 doc/files/exceptions.ComponentNotValidException.html delete mode 100644 doc/files/exceptions.ControllerNotFoundException.html delete mode 100644 doc/files/exceptions.ControllerNotValidException.html delete mode 100644 doc/files/exceptions.DatamodelException.html delete mode 100644 doc/files/exceptions.DriverNotFoundException.html delete mode 100644 doc/files/exceptions.DriverNotValidException.html delete mode 100644 doc/files/exceptions.FatalDatamodelException.html delete mode 100644 doc/files/exceptions.IdNotFoundException.html delete mode 100644 doc/files/exceptions.LayoutNotFoundException.html delete mode 100644 doc/files/exceptions.LayoutNotValidException.html delete mode 100644 doc/files/exceptions.ModelNotFoundException.html delete mode 100644 doc/files/exceptions.ModelNotValidException.html delete mode 100644 doc/files/exceptions.ParamsNotValidException.html delete mode 100644 doc/files/exceptions.ServiceUnavailableException.html delete mode 100644 doc/files/exceptions.ViewNotFoundException.html delete mode 100644 doc/files/exceptions/AccessDeniedException.inc.txt delete mode 100644 doc/files/exceptions/ActionNotFoundException.inc.txt delete mode 100644 doc/files/exceptions/AgentNotFoundException.inc.txt delete mode 100644 doc/files/exceptions/AgentNotValidException.inc.txt delete mode 100644 doc/files/exceptions/ClassNotFoundException.inc.txt delete mode 100644 doc/files/exceptions/ClassNotValidException.inc.txt delete mode 100644 doc/files/exceptions/ComponentNotFoundException.inc.txt delete mode 100644 doc/files/exceptions/ComponentNotValidException.inc.txt delete mode 100644 doc/files/exceptions/ControllerNotFoundException.inc.txt delete mode 100644 doc/files/exceptions/ControllerNotValidException.inc.txt delete mode 100644 doc/files/exceptions/DatamodelException.inc.txt delete mode 100644 doc/files/exceptions/DriverNotFoundException.inc.txt delete mode 100644 doc/files/exceptions/DriverNotValidException.inc.txt delete mode 100644 doc/files/exceptions/FatalDatamodelException.inc.txt delete mode 100644 doc/files/exceptions/IdNotFoundException.inc.txt delete mode 100644 doc/files/exceptions/LayoutNotFoundException.inc.txt delete mode 100644 doc/files/exceptions/LayoutNotValidException.inc.txt delete mode 100644 doc/files/exceptions/ModelNotFoundException.inc.txt delete mode 100644 doc/files/exceptions/ModelNotValidException.inc.txt delete mode 100644 doc/files/exceptions/ParamsNotValidException.inc.txt delete mode 100644 doc/files/exceptions/ServiceUnavailableException.inc.txt delete mode 100644 doc/files/exceptions/ViewNotFoundException.inc.txt delete mode 100644 doc/files/models.AchievementsModel.html delete mode 100644 doc/files/models.AvatarsModel.html delete mode 100644 doc/files/models.CharactergroupsModel.html delete mode 100644 doc/files/models.CharactergroupsquestsModel.html delete mode 100644 doc/files/models.CharacterrolesModel.html delete mode 100644 doc/files/models.CharactersModel.html delete mode 100644 doc/files/models.CharactertypesModel.html delete mode 100644 doc/files/models.DatabaseModel.html delete mode 100644 doc/files/models.MediaModel.html delete mode 100644 doc/files/models.QuestgroupsModel.html delete mode 100644 doc/files/models.QuestgroupshierarchyModel.html delete mode 100644 doc/files/models.QuestgrouptextsModel.html delete mode 100644 doc/files/models.QuestsModel.html delete mode 100644 doc/files/models.QuesttextsModel.html delete mode 100644 doc/files/models.QuesttopicsModel.html delete mode 100644 doc/files/models.QuesttypesModel.html delete mode 100644 doc/files/models.SeminariesModel.html delete mode 100644 doc/files/models.SeminarycharacterfieldsModel.html delete mode 100644 doc/files/models.UploadsModel.html delete mode 100644 doc/files/models.UserrolesModel.html delete mode 100644 doc/files/models.UsersModel.html delete mode 100644 doc/files/models.XplevelsModel.html delete mode 100644 doc/files/models/AchievementsModel.inc.txt delete mode 100644 doc/files/models/AvatarsModel.inc.txt delete mode 100644 doc/files/models/CharactergroupsModel.inc.txt delete mode 100644 doc/files/models/CharactergroupsquestsModel.inc.txt delete mode 100644 doc/files/models/CharacterrolesModel.inc.txt delete mode 100644 doc/files/models/CharactersModel.inc.txt delete mode 100644 doc/files/models/CharactertypesModel.inc.txt delete mode 100644 doc/files/models/DatabaseModel.inc.txt delete mode 100644 doc/files/models/MediaModel.inc.txt delete mode 100644 doc/files/models/QuestgroupsModel.inc.txt delete mode 100644 doc/files/models/QuestgroupshierarchyModel.inc.txt delete mode 100644 doc/files/models/QuestgrouptextsModel.inc.txt delete mode 100644 doc/files/models/QuestsModel.inc.txt delete mode 100644 doc/files/models/QuesttextsModel.inc.txt delete mode 100644 doc/files/models/QuesttopicsModel.inc.txt delete mode 100644 doc/files/models/QuesttypesModel.inc.txt delete mode 100644 doc/files/models/SeminariesModel.inc.txt delete mode 100644 doc/files/models/SeminarycharacterfieldsModel.inc.txt delete mode 100644 doc/files/models/UploadsModel.inc.txt delete mode 100644 doc/files/models/UserrolesModel.inc.txt delete mode 100644 doc/files/models/UsersModel.inc.txt delete mode 100644 doc/files/models/XplevelsModel.inc.txt delete mode 100644 doc/files/questtypes.bossfight.BossfightQuesttypeAgent.html delete mode 100644 doc/files/questtypes.bossfight.BossfightQuesttypeController.html delete mode 100644 doc/files/questtypes.bossfight.BossfightQuesttypeModel.html delete mode 100644 doc/files/questtypes.choiceinput.ChoiceinputQuesttypeAgent.html delete mode 100644 doc/files/questtypes.choiceinput.ChoiceinputQuesttypeController.html delete mode 100644 doc/files/questtypes.choiceinput.ChoiceinputQuesttypeModel.html delete mode 100644 doc/files/questtypes.crossword.CrosswordQuesttypeAgent.html delete mode 100644 doc/files/questtypes.crossword.CrosswordQuesttypeController.html delete mode 100644 doc/files/questtypes.crossword.CrosswordQuesttypeModel.html delete mode 100644 doc/files/questtypes.dragndrop.DragndropQuesttypeAgent.html delete mode 100644 doc/files/questtypes.dragndrop.DragndropQuesttypeController.html delete mode 100644 doc/files/questtypes.dragndrop.DragndropQuesttypeModel.html delete mode 100644 doc/files/questtypes.multiplechoice.MultiplechoiceQuesttypeAgent.html delete mode 100644 doc/files/questtypes.multiplechoice.MultiplechoiceQuesttypeController.html delete mode 100644 doc/files/questtypes.multiplechoice.MultiplechoiceQuesttypeModel.html delete mode 100644 doc/files/questtypes.submit.SubmitQuesttypeAgent.html delete mode 100644 doc/files/questtypes.submit.SubmitQuesttypeController.html delete mode 100644 doc/files/questtypes.submit.SubmitQuesttypeModel.html delete mode 100644 doc/files/questtypes.textinput.TextinputQuesttypeAgent.html delete mode 100644 doc/files/questtypes.textinput.TextinputQuesttypeController.html delete mode 100644 doc/files/questtypes.textinput.TextinputQuesttypeModel.html delete mode 100644 doc/files/questtypes/bossfight/BossfightQuesttypeAgent.inc.txt delete mode 100644 doc/files/questtypes/bossfight/BossfightQuesttypeController.inc.txt delete mode 100644 doc/files/questtypes/bossfight/BossfightQuesttypeModel.inc.txt delete mode 100644 doc/files/questtypes/choiceinput/ChoiceinputQuesttypeAgent.inc.txt delete mode 100644 doc/files/questtypes/choiceinput/ChoiceinputQuesttypeController.inc.txt delete mode 100644 doc/files/questtypes/choiceinput/ChoiceinputQuesttypeModel.inc.txt delete mode 100644 doc/files/questtypes/crossword/CrosswordQuesttypeAgent.inc.txt delete mode 100644 doc/files/questtypes/crossword/CrosswordQuesttypeController.inc.txt delete mode 100644 doc/files/questtypes/crossword/CrosswordQuesttypeModel.inc.txt delete mode 100644 doc/files/questtypes/dragndrop/DragndropQuesttypeAgent.inc.txt delete mode 100644 doc/files/questtypes/dragndrop/DragndropQuesttypeController.inc.txt delete mode 100644 doc/files/questtypes/dragndrop/DragndropQuesttypeModel.inc.txt delete mode 100644 doc/files/questtypes/multiplechoice/MultiplechoiceQuesttypeAgent.inc.txt delete mode 100644 doc/files/questtypes/multiplechoice/MultiplechoiceQuesttypeController.inc.txt delete mode 100644 doc/files/questtypes/multiplechoice/MultiplechoiceQuesttypeModel.inc.txt delete mode 100644 doc/files/questtypes/submit/SubmitQuesttypeAgent.inc.txt delete mode 100644 doc/files/questtypes/submit/SubmitQuesttypeController.inc.txt delete mode 100644 doc/files/questtypes/submit/SubmitQuesttypeModel.inc.txt delete mode 100644 doc/files/questtypes/textinput/TextinputQuesttypeAgent.inc.txt delete mode 100644 doc/files/questtypes/textinput/TextinputQuesttypeController.inc.txt delete mode 100644 doc/files/questtypes/textinput/TextinputQuesttypeModel.inc.txt delete mode 100644 doc/files/requests.WebRequest.html delete mode 100644 doc/files/requests/WebRequest.inc.txt delete mode 100644 doc/files/responses.WebResponse.html delete mode 100644 doc/files/responses/WebResponse.inc.txt delete mode 100644 doc/files/www.index.html delete mode 100644 doc/files/www/index.php.txt delete mode 100644 doc/font/FontAwesome.otf delete mode 100644 doc/font/fontawesome-webfont.eot delete mode 100644 doc/font/fontawesome-webfont.svg delete mode 100644 doc/font/fontawesome-webfont.ttf delete mode 100644 doc/font/fontawesome-webfont.woff delete mode 100644 doc/graphs/class.html delete mode 100644 doc/graphs/classes.svg delete mode 100644 doc/images/apple-touch-icon-114x114.png delete mode 100644 doc/images/apple-touch-icon-72x72.png delete mode 100644 doc/images/apple-touch-icon.png delete mode 100644 doc/images/custom-icons.svg delete mode 100644 doc/images/favicon.ico delete mode 100644 doc/images/hierarchy-item.png delete mode 100644 doc/images/icon-class-13x13.png delete mode 100644 doc/images/icon-class.svg delete mode 100644 doc/images/icon-interface-13x13.png delete mode 100644 doc/images/icon-interface.svg delete mode 100644 doc/images/icon-trait-13x13.png delete mode 100644 doc/images/icon-trait.svg delete mode 100644 doc/images/iviewer/grab.cur delete mode 100644 doc/images/iviewer/hand.cur delete mode 100644 doc/images/iviewer/iviewer.rotate_left.png delete mode 100644 doc/images/iviewer/iviewer.rotate_right.png delete mode 100644 doc/images/iviewer/iviewer.zoom_fit.png delete mode 100644 doc/images/iviewer/iviewer.zoom_in.png delete mode 100644 doc/images/iviewer/iviewer.zoom_out.png delete mode 100644 doc/images/iviewer/iviewer.zoom_zero.png delete mode 100644 doc/index.html delete mode 100644 doc/js/bootstrap.min.js delete mode 100644 doc/js/html5.js delete mode 100644 doc/js/jquery-1.11.0.min.js delete mode 100644 doc/js/jquery.dotdotdot-1.5.9.js delete mode 100644 doc/js/jquery.dotdotdot-1.5.9.min.js delete mode 100644 doc/js/jquery.iviewer.js delete mode 100644 doc/js/jquery.iviewer.min.js delete mode 100644 doc/js/jquery.mousewheel.js delete mode 100644 doc/js/jquery.smooth-scroll.js delete mode 100644 doc/js/prism.min.js delete mode 100644 doc/js/ui/1.10.4/jquery-ui.min.js delete mode 100644 doc/namespaces/default.html delete mode 100644 doc/namespaces/hhu.html delete mode 100644 doc/namespaces/hhu.z.agents.bottomlevel.html delete mode 100644 doc/namespaces/hhu.z.agents.html delete mode 100644 doc/namespaces/hhu.z.agents.intermediate.html delete mode 100644 doc/namespaces/hhu.z.agents.toplevel.html delete mode 100644 doc/namespaces/hhu.z.apis.html delete mode 100644 doc/namespaces/hhu.z.controllers.components.html delete mode 100644 doc/namespaces/hhu.z.controllers.html delete mode 100644 doc/namespaces/hhu.z.exceptions.html delete mode 100644 doc/namespaces/hhu.z.html delete mode 100644 doc/namespaces/hhu.z.lib.html delete mode 100644 doc/namespaces/hhu.z.models.html delete mode 100644 doc/namespaces/hhu.z.questtypes.html delete mode 100644 doc/namespaces/hhu.z.requests.html delete mode 100644 doc/namespaces/hhu.z.responses.html delete mode 100644 doc/namespaces/hhu.z.views.html delete mode 100644 doc/namespaces/nre.agents.html delete mode 100644 doc/namespaces/nre.apis.html delete mode 100644 doc/namespaces/nre.configs.html delete mode 100644 doc/namespaces/nre.core.html delete mode 100644 doc/namespaces/nre.drivers.html delete mode 100644 doc/namespaces/nre.exceptions.html delete mode 100644 doc/namespaces/nre.html delete mode 100644 doc/namespaces/nre.models.html delete mode 100644 doc/namespaces/nre.requests.html delete mode 100644 doc/namespaces/nre.responses.html delete mode 100644 doc/reports/deprecated.html delete mode 100644 doc/reports/errors.html delete mode 100644 doc/reports/markers.html diff --git a/.hgignore b/.hgignore index 29a79b09..f1a7c8b0 100644 --- a/.hgignore +++ b/.hgignore @@ -1,4 +1,5 @@ syntax: regexp +^doc/* ^logs/* ^media/* ^tmp/* diff --git a/doc/classes/PHPMailer.html b/doc/classes/PHPMailer.html deleted file mode 100644 index b5d80bfc..00000000 --- a/doc/classes/PHPMailer.html +++ /dev/null @@ -1,7052 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\PHPMailer

-

PHPMailer - PHP email creation and transport class.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- __construct()
- __destruct()
- isHTML()
- isSMTP()
- isMail()
- isSendmail()
- isQmail()
- addAddress()
- addCC()
- addBCC()
- addReplyTo()
- setFrom()
- getLastMessageID()
- validateAddress()
- send()
- preSend()
- postSend()
- getSMTPInstance()
- smtpConnect()
- smtpClose()
- setLanguage()
- getTranslations()
- addrAppend()
- addrFormat()
- wrapText()
- utf8CharBoundary()
- setWordWrap()
- createHeader()
- getMailMIME()
- getSentMIMEMessage()
- createBody()
- headerLine()
- textLine()
- addAttachment()
- getAttachments()
- encodeString()
- encodeHeader()
- hasMultiBytes()
- has8bitChars()
- base64EncodeWrapMB()
- encodeQP()
- encodeQPphp()
- encodeQ()
- addStringAttachment()
- addEmbeddedImage()
- addStringEmbeddedImage()
- inlineImageExists()
- attachmentExists()
- alternativeExists()
- clearAddresses()
- clearCCs()
- clearBCCs()
- clearReplyTos()
- clearAllRecipients()
- clearAttachments()
- clearCustomHeaders()
- rfcDate()
- isError()
- fixEOL()
- addCustomHeader()
- msgHTML()
- html2text()
- _mime_types()
- filenameToType()
- mb_pathinfo()
- set()
- secureHeader()
- normalizeBreaks()
- sign()
- DKIM_QP()
- DKIM_Sign()
- DKIM_HeaderC()
- DKIM_BodyC()
- DKIM_Add()
- getToAddresses()
- getCcAddresses()
- getBccAddresses()
- getReplyToAddresses()
- getAllRecipientAddresses()
-
-
- $Version
- $Priority
- $CharSet
- $ContentType
- $Encoding
- $ErrorInfo
- $From
- $FromName
- $Sender
- $ReturnPath
- $Subject
- $Body
- $AltBody
- $Ical
- $WordWrap
- $Mailer
- $Sendmail
- $UseSendmailOptions
- $PluginDir
- $ConfirmReadingTo
- $Hostname
- $MessageID
- $MessageDate
- $Host
- $Port
- $Helo
- $SMTPSecure
- $SMTPAuth
- $Username
- $Password
- $AuthType
- $Realm
- $Workstation
- $Timeout
- $SMTPDebug
- $Debugoutput
- $SMTPKeepAlive
- $SingleTo
- $SingleToArray
- $do_verp
- $AllowEmpty
- $LE
- $DKIM_selector
- $DKIM_identity
- $DKIM_passphrase
- $DKIM_domain
- $DKIM_private
- $action_function
- $XMailer
-
-
- STOP_MESSAGE
- STOP_CONTINUE
- STOP_CRITICAL
- CRLF
-
-
-
-
- edebug()
- addAnAddress()
- sendmailSend()
- mailSend()
- smtpSend()
- getBoundary()
- endBoundary()
- setMessageType()
- attachAll()
- encodeFile()
- setError()
- serverHostname()
- lang()
- doCallback()
-
-
- $MIMEBody
- $MIMEHeader
- $mailHeader
- $smtp
- $to
- $cc
- $bcc
- $ReplyTo
- $all_recipients
- $attachment
- $CustomHeader
- $lastMessageID
- $message_type
- $boundary
- $language
- $error_count
- $sign_cert_file
- $sign_key_file
- $sign_key_pass
- $exceptions
-
-
- N/A -
-
-
-
- mailPassthru()
-
-
- No private properties found -
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

STOP_MESSAGE

- 
STOP_MESSAGE
-

Error severity: message only, continue processing

- -
-
- -
- -
-
- -
-

STOP_CONTINUE

- 
STOP_CONTINUE
-

Error severity: message, likely ok to continue processing

- -
-
- -
- -
-
- -
-

STOP_CRITICAL

- 
STOP_CRITICAL
-

Error severity: message, plus full stop, critical error reached

- -
-
- -
- -
-
- -
-

CRLF

- 
CRLF
-

SMTP RFC standard line ending

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$Version

- 
$Version :
-

The PHPMailer Version number.

- - -

Type

- -
-
- -
- -
-
- -
-

$Priority

- 
$Priority :
-

Email priority.

-

Options: 1 = High, 3 = Normal, 5 = low.

- -

Type

- -
-
- -
- -
-
- -
-

$CharSet

- 
$CharSet :
-

The character set of the message.

- - -

Type

- -
-
- -
- -
-
- -
-

$ContentType

- 
$ContentType :
-

The MIME Content-type of the message.

- - -

Type

- -
-
- -
- -
-
- -
-

$Encoding

- 
$Encoding :
-

The message encoding.

-

Options: "8bit", "7bit", "binary", "base64", and "quoted-printable".

- -

Type

- -
-
- -
- -
-
- -
-

$ErrorInfo

- 
$ErrorInfo :
-

Holds the most recent mailer error message.

- - -

Type

- -
-
- -
- -
-
- -
-

$From

- 
$From :
-

The From email address for the message.

- - -

Type

- -
-
- -
- -
-
- -
-

$FromName

- 
$FromName :
-

The From name of the message.

- - -

Type

- -
-
- -
- -
-
- -
-

$Sender

- 
$Sender :
-

The Sender email (Return-Path) of the message.

-

If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.

- -

Type

- -
-
- -
- -
-
- -
-

$ReturnPath

- 
$ReturnPath :
-

The Return-Path of the message.

-

If empty, it will be set to either From or Sender.

- -

Type

- -
-
- -
- -
-
- -
-

$Subject

- 
$Subject :
-

The Subject of the message.

- - -

Type

- -
-
- -
- -
-
- -
-

$Body

- 
$Body :
-

An HTML or plain text message body.

-

If HTML then call isHTML(true).

- -

Type

- -
-
- -
- -
-
- -
-

$AltBody

- 
$AltBody :
-

The plain-text message body.

-

This body can be read by mail clients that do not have HTML email -capability such as mutt & Eudora. -Clients that can read HTML will view the normal Body.

- -

Type

- -
-
- -
- -
-
- -
-

$Ical

- 
$Ical :
-

An iCal message part body.

-

Only supported in simple alt or alt_inline message types -To generate iCal events, use the bundled extras/EasyPeasyICS.php class or iCalcreator

- -

Type

- -
-
- -
- -
-
- -
-

$WordWrap

- 
$WordWrap :
-

Word-wrap the message body to this number of chars.

- - -

Type

- -
-
- -
- -
-
- -
-

$Mailer

- 
$Mailer :
-

Which method to use to send mail.

-

Options: "mail", "sendmail", or "smtp".

- -

Type

- -
-
- -
- -
-
- -
-

$Sendmail

- 
$Sendmail :
-

The path to the sendmail program.

- - -

Type

- -
-
- -
- -
-
- -
-

$UseSendmailOptions

- 
$UseSendmailOptions :
-

Whether mail() uses a fully sendmail-compatible MTA.

-

One which supports sendmail's "-oi -f" options.

- -

Type

- -
-
- -
- -
-
- -
-

$PluginDir

- 
$PluginDir :
-

Path to PHPMailer plugins.

-

Useful if the SMTP class is not in the PHP include path.

- -

Type

- -
-
- -
- -
-
- -
-

$ConfirmReadingTo

- 
$ConfirmReadingTo :
-

The email address that a reading confirmation should be sent to.

- - -

Type

- -
-
- -
- -
-
- -
-

$Hostname

- 
$Hostname :
-

The hostname to use in Message-Id and Received headers -and as default HELO string.

-

If empty, the value returned -by SERVER_NAME is used or 'localhost.localdomain'.

- -

Type

- -
-
- -
- -
-
- -
-

$MessageID

- 
$MessageID :
-

An ID to be used in the Message-Id header.

-

If empty, a unique id will be generated.

- -

Type

- -
-
- -
- -
-
- -
-

$MessageDate

- 
$MessageDate :
-

The message Date to be used in the Date header.

-

If empty, the current date will be added.

- -

Type

- -
-
- -
- -
-
- -
-

$Host

- 
$Host :
-

SMTP hosts.

-

Either a single hostname or multiple semicolon-delimited hostnames. -You can also specify a different port -for each host by using this format: [hostname:port] -(e.g. "smtp1.example.com:25;smtp2.example.com"). -Hosts will be tried in order.

- -

Type

- -
-
- -
- -
-
- -
-

$Port

- 
$Port :
-

The default SMTP server port.

- - -

Type

- -
-
- -
- -
-
- -
-

$Helo

- 
$Helo :
-

The SMTP HELO of the message.

-

Default is $Hostname.

- -

Type

- -
-
- -
- -
-
- -
-

$SMTPSecure

- 
$SMTPSecure :
-

The secure connection prefix.

-

Options: "", "ssl" or "tls"

- -

Type

- -
-
- -
- -
-
- -
-

$SMTPAuth

- 
$SMTPAuth :
-

Whether to use SMTP authentication.

-

Uses the Username and Password properties.

- -

Type

- -
-
- -
- -
-
- -
-

$Username

- 
$Username :
-

SMTP username.

- - -

Type

- -
-
- -
- -
-
- -
-

$Password

- 
$Password :
-

SMTP password.

- - -

Type

- -
-
- -
- -
-
- -
-

$AuthType

- 
$AuthType :
-

SMTP auth type.

-

Options are LOGIN (default), PLAIN, NTLM, CRAM-MD5

- -

Type

- -
-
- -
- -
-
- -
-

$Realm

- 
$Realm :
-

SMTP realm.

-

Used for NTLM auth

- -

Type

- -
-
- -
- -
-
- -
-

$Workstation

- 
$Workstation :
-

SMTP workstation.

-

Used for NTLM auth

- -

Type

- -
-
- -
- -
-
- -
-

$Timeout

- 
$Timeout :
-

The SMTP server timeout in seconds.

- - -

Type

- -
-
- -
- -
-
- -
-

$SMTPDebug

- 
$SMTPDebug :
-

SMTP class debug output mode.

-

Options: -0: no output -1: commands -2: data and commands -3: as 2 plus connection status -4: low level data output

- -

Type

- -
-
- -
- -
-
- -
-

$Debugoutput

- 
$Debugoutput :
-

How to handle debug output.

-

Options: -'echo': Output plain-text as-is, appropriate for CLI -'html': Output escaped, line breaks converted to
, appropriate for browser output -'error_log': Output to error log as configured in php.ini

- -

Type

- -
-
- -
- -
-
- -
-

$SMTPKeepAlive

- 
$SMTPKeepAlive :
-

Whether to keep SMTP connection open after each message.

-

If this is set to true then to close the connection -requires an explicit call to smtpClose().

- -

Type

- -
-
- -
- -
-
- -
-

$SingleTo

- 
$SingleTo :
-

Whether to split multiple to addresses into multiple messages -or send them all in one message.

- - -

Type

- -
-
- -
- -
-
- -
-

$SingleToArray

- 
$SingleToArray :
-

Storage for addresses when SingleTo is enabled.

- - -

Type

- -
-
- -
- -
-
- -
-

$do_verp

- 
$do_verp :
-

Whether to generate VERP addresses on send.

-

Only applicable when sending via SMTP.

- -

Type

- -
-
- -
- -
-
- -
-

$AllowEmpty

- 
$AllowEmpty :
-

Whether to allow sending messages with an empty body.

- - -

Type

- -
-
- -
- -
-
- -
-

$LE

- 
$LE :
-

The default line ending.

- - -

Type

- -
-
- -
- -
-
- -
-

$DKIM_selector

- 
$DKIM_selector :
-

DKIM selector.

- - -

Type

- -
-
- -
- -
-
- -
-

$DKIM_identity

- 
$DKIM_identity :
-

DKIM Identity.

-

Usually the email address used as the source of the email

- -

Type

- -
-
- -
- -
-
- -
-

$DKIM_passphrase

- 
$DKIM_passphrase :
-

DKIM passphrase.

-

Used if your key is encrypted.

- -

Type

- -
-
- -
- -
-
- -
-

$DKIM_domain

- 
$DKIM_domain :
-

DKIM signing domain name.

- - -

Type

- -
-
- -
- -
-
- -
-

$DKIM_private

- 
$DKIM_private :
-

DKIM private key file path.

- - -

Type

- -
-
- -
- -
-
- -
-

$action_function

- 
$action_function :
-

Callback Action function name.

-

The function that handles the result of the send email action. -It is called out by send() for each email sent.

-

Value can be any php callable: http://www.php.net/is_callable

-

Parameters: -bool $result result of the send action -string $to email address of the recipient -string $cc cc email addresses -string $bcc bcc email addresses -string $subject the subject -string $body the email body -string $from email address of sender

- -

Type

- -
-
- -
- -
-
- -
-

$XMailer

- 
$XMailer :
-

What to use in the X-Mailer header.

-

Options: null for default, whitespace for none, or a string to use

- -

Type

- -
-
- -
- -
-
- -
-

$MIMEBody

- 
$MIMEBody :
-

The complete compiled MIME message body.

- - -

Type

- -
-
- -
- -
-
- -
-

$MIMEHeader

- 
$MIMEHeader :
-

The complete compiled MIME message headers.

- - -

Type

- -
-
- -
- -
-
- -
-

$mailHeader

- 
$mailHeader :
-

Extra headers that createHeader() doesn't fold in.

- - -

Type

- -
-
- -
- -
-
- -
-

$smtp

- 
$smtp :
-

An instance of the SMTP sender class.

- - -

Type

- -
-
- -
- -
-
- -
-

$to

- 
$to :
-

The array of 'to' addresses.

- - -

Type

- -
-
- -
- -
-
- -
-

$cc

- 
$cc :
-

The array of 'cc' addresses.

- - -

Type

- -
-
- -
- -
-
- -
-

$bcc

- 
$bcc :
-

The array of 'bcc' addresses.

- - -

Type

- -
-
- -
- -
-
- -
-

$ReplyTo

- 
$ReplyTo :
-

The array of reply-to names and addresses.

- - -

Type

- -
-
- -
- -
-
- -
-

$all_recipients

- 
$all_recipients :
-

An array of all kinds of addresses.

-

Includes all of $to, $cc, $bcc, $replyto

- -

Type

- -
-
- -
- -
-
- -
-

$attachment

- 
$attachment :
-

The array of attachments.

- - -

Type

- -
-
- -
- -
-
- -
-

$CustomHeader

- 
$CustomHeader :
-

The array of custom headers.

- - -

Type

- -
-
- -
- -
-
- -
-

$lastMessageID

- 
$lastMessageID :
-

The most recent Message-ID (including angular brackets).

- - -

Type

- -
-
- -
- -
-
- -
-

$message_type

- 
$message_type :
-

The message's MIME type.

- - -

Type

- -
-
- -
- -
-
- -
-

$boundary

- 
$boundary :
-

The array of MIME boundary strings.

- - -

Type

- -
-
- -
- -
-
- -
-

$language

- 
$language :
-

The array of available languages.

- - -

Type

- -
-
- -
- -
-
- -
-

$error_count

- 
$error_count :
-

The number of errors encountered.

- - -

Type

- -
-
- -
- -
-
- -
-

$sign_cert_file

- 
$sign_cert_file :
-

The S/MIME certificate file path.

- - -

Type

- -
-
- -
- -
-
- -
-

$sign_key_file

- 
$sign_key_file :
-

The S/MIME key file path.

- - -

Type

- -
-
- -
- -
-
- -
-

$sign_key_pass

- 
$sign_key_pass :
-

The S/MIME password for the key.

-

Used only if the key is encrypted.

- -

Type

- -
-
- -
- -
-
- -
-

$exceptions

- 
$exceptions :
-

Whether to throw exceptions for errors.

- - -

Type

- -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

__construct()

- - 
__construct(boolean  $exceptions = false)
-

Constructor

- - -

Parameters

- - - - - - -
boolean$exceptions

Should we throw external exceptions?

- - - -
-
- -
- -
-
- -
-

__destruct()

- - 
__destruct()
-

Destructor.

- - - - - -
-
- -
- -
-
- -
-

isHTML()

- - 
isHTML(boolean  $ishtml = true) : void
-

Sets message type to HTML or plain.

- - -

Parameters

- - - - - - -
boolean$ishtml

True for HTML mode.

- - - -
-
- -
- -
-
- -
-

isSMTP()

- - 
isSMTP() : void
-

Send messages using SMTP.

- - - - - -
-
- -
- -
-
- -
-

isMail()

- - 
isMail() : void
-

Send messages using PHP's mail() function.

- - - - - -
-
- -
- -
-
- -
-

isSendmail()

- - 
isSendmail() : void
-

Send messages using $Sendmail.

- - - - - -
-
- -
- -
-
- -
-

isQmail()

- - 
isQmail() : void
-

Send messages using qmail.

- - - - - -
-
- -
- -
-
- -
-

addAddress()

- - 
addAddress(string  $address, string  $name = '') : boolean
-

Add a "To" address.

- - -

Parameters

- - - - - - - - - - - -
string$address
string$name
- - -

Returns

- boolean - —

true on success, false if address already used

- -
-
- -
- -
-
- -
-

addCC()

- - 
addCC(string  $address, string  $name = '') : boolean
-

Add a "CC" address.

- - -

Parameters

- - - - - - - - - - - -
string$address
string$name
- - -

Returns

- boolean - —

true on success, false if address already used

- -
-
- -
- -
-
- -
-

addBCC()

- - 
addBCC(string  $address, string  $name = '') : boolean
-

Add a "BCC" address.

- - -

Parameters

- - - - - - - - - - - -
string$address
string$name
- - -

Returns

- boolean - —

true on success, false if address already used

- -
-
- -
- -
-
- -
-

addReplyTo()

- - 
addReplyTo(string  $address, string  $name = '') : boolean
-

Add a "Reply-to" address.

- - -

Parameters

- - - - - - - - - - - -
string$address
string$name
- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

setFrom()

- - 
setFrom(string  $address, string  $name = '', boolean  $auto = true) : boolean
-

Set the From and FromName properties.

- - -

Parameters

- - - - - - - - - - - - - - - - -
string$address
string$name
boolean$auto

Whether to also set the Sender address, defaults to true

- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - -
-
- -
- -
-
- -
-

getLastMessageID()

- - 
getLastMessageID() : string
-

Return the Message-ID header of the last email.

-

Technically this is the value from the last time the headers were created, -but it's also the message ID of the last sent message except in -pathological cases.

- - - -

Returns

- string - -
-
- -
- -
-
- -
-

validateAddress()

- - 
validateAddress(string  $address, string  $patternselect = 'auto') : boolean
-

Check that a string looks like an email address.

- - -

Parameters

- - - - - - - - - - - -
string$address

The email address to check

string$patternselect

A selector for the validation pattern to use :

-
    -
  • auto Pick strictest one automatically;
    • -
  • pcre8 Use the squiloople.com pattern, requires PCRE > 8.0, PHP >= 5.3.2, 5.2.14;
    • -
  • pcre Use old PCRE implementation;
    • -
  • php Use PHP built-in FILTER_VALIDATE_EMAIL; same as pcre8 but does not allow 'dotless' domains;
    • -
  • html5 Use the pattern given by the HTML5 spec for 'email' type form input elements.
    • -
  • noregex Don't use a regex: super fast, really dumb.
    • -
- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

send()

- - 
send() : boolean
-

Create a message and send it.

-

Uses the sending method specified by $Mailer.

- - -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - —

false on error - See the ErrorInfo property for details of the error.

- -
-
- -
- -
-
- -
-

preSend()

- - 
preSend() : boolean
-

Prepare a message for sending.

- - - -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - -
-
- -
- -
-
- -
-

postSend()

- - 
postSend() : boolean
-

Actually send a message.

-

Send the email via the selected mechanism

- - -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - -
-
- -
- -
-
- -
-

getSMTPInstance()

- - 
getSMTPInstance() : \SMTP
-

Get an instance to use for SMTP operations.

-

Override this function to load your own SMTP implementation

- - - -

Returns

- \SMTP - -
-
- -
- -
-
- -
-

smtpConnect()

- - 
smtpConnect(array  $options = array()) : boolean
-

Initiate a connection to an SMTP server.

-

Returns false if the operation failed.

- -

Parameters

- - - - - - -
array$options

An array of options compatible with stream_context_create()

- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - -
-
- -
- -
-
- -
-

smtpClose()

- - 
smtpClose() : void
-

Close the active SMTP session if one exists.

- - - - - -
-
- -
- -
-
- -
-

setLanguage()

- - 
setLanguage(string  $langcode = 'en', string  $lang_path = '') : boolean
-

Set the language for error messages.

-

Returns false if it cannot load the language file. -The default language is English.

- -

Parameters

- - - - - - - - - - - -
string$langcode

ISO 639-1 2-character language code (e.g. French is "fr")

string$lang_path

Path to the language file directory, with trailing separator (slash)

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

getTranslations()

- - 
getTranslations() : array
-

Get the array of strings for the current language.

- - - - -

Returns

- array - -
-
- -
- -
-
- -
-

addrAppend()

- - 
addrAppend(string  $type, array  $addr) : string
-

Create recipient headers.

- - -

Parameters

- - - - - - - - - - - -
string$type
array$addr

An array of recipient, -where each recipient is a 2-element indexed array with element 0 containing an address -and element 1 containing a name, like: -array(array('joe@example.com', 'Joe User'), array('zoe@example.com', 'Zoe User'))

- - -

Returns

- string - -
-
- -
- -
-
- -
-

addrFormat()

- - 
addrFormat(array  $addr) : string
-

Format an address for use in a message header.

- - -

Parameters

- - - - - - -
array$addr

A 2-element indexed array, element 0 containing an address, element 1 containing a name -like array('joe@example.com', 'Joe User')

- - -

Returns

- string - -
-
- -
- -
-
- -
-

wrapText()

- - 
wrapText(string  $message, integer  $length, boolean  $qp_mode = false) : string
-

Word-wrap message.

-

For use with mailers that do not automatically perform wrapping -and for quoted-printable encoded messages. -Original written by philippe.

- -

Parameters

- - - - - - - - - - - - - - - - -
string$message

The message to wrap

integer$length

The line length to wrap to

boolean$qp_mode

Whether to run in Quoted-Printable mode

- - -

Returns

- string - -
-
- -
- -
-
- -
-

utf8CharBoundary()

- - 
utf8CharBoundary(string  $encodedText, integer  $maxLength) : integer
-

Find the last character boundary prior to $maxLength in a utf-8 -quoted (printable) encoded string.

-

Original written by Colin Brown.

- -

Parameters

- - - - - - - - - - - -
string$encodedText

utf-8 QP text

integer$maxLength

find last character boundary prior to this length

- - -

Returns

- integer - -
-
- -
- -
-
- -
-

setWordWrap()

- - 
setWordWrap() : void
-

Set the body wrapping.

- - - - - -
-
- -
- -
-
- -
-

createHeader()

- - 
createHeader() : string
-

Assemble message headers.

- - - - -

Returns

- string - —

The assembled headers

- -
-
- -
- -
-
- -
-

getMailMIME()

- - 
getMailMIME() : string
-

Get the message MIME type headers.

- - - - -

Returns

- string - -
-
- -
- -
-
- -
-

getSentMIMEMessage()

- - 
getSentMIMEMessage() : string
-

Returns the whole MIME message.

-

Includes complete headers and body. -Only valid post preSend().

- - - -

Returns

- string - -
-
- -
- -
-
- -
-

createBody()

- - 
createBody() : string
-

Assemble the message body.

-

Returns an empty string on failure.

- - -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- string - —

The assembled message body

- -
-
- -
- -
-
- -
-

headerLine()

- - 
headerLine(string  $name, string  $value) : string
-

Format a header line.

- - -

Parameters

- - - - - - - - - - - -
string$name
string$value
- - -

Returns

- string - -
-
- -
- -
-
- -
-

textLine()

- - 
textLine(string  $value) : string
-

Return a formatted mail line.

- - -

Parameters

- - - - - - -
string$value
- - -

Returns

- string - -
-
- -
- -
-
- -
-

addAttachment()

- - 
addAttachment(string  $path, string  $name = '', string  $encoding = 'base64', string  $type = '', string  $disposition = 'attachment') : boolean
-

Add an attachment from a path on the filesystem.

-

Returns false if the file could not be found or read.

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
string$path

Path to the attachment.

string$name

Overrides the attachment name.

string$encoding

File encoding (see $Encoding).

string$type

File extension (MIME) type.

string$disposition

Disposition to use

- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - -
-
- -
- -
-
- -
-

getAttachments()

- - 
getAttachments() : array
-

Return the array of attachments.

- - - - -

Returns

- array - -
-
- -
- -
-
- -
-

encodeString()

- - 
encodeString(string  $str, string  $encoding = 'base64') : string
-

Encode a string in requested format.

-

Returns an empty string on failure.

- -

Parameters

- - - - - - - - - - - -
string$str

The text to encode

string$encoding

The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'

- - -

Returns

- string - -
-
- -
- -
-
- -
-

encodeHeader()

- - 
encodeHeader(string  $str, string  $position = 'text') : string
-

Encode a header string optimally.

-

Picks shortest of Q, B, quoted-printable or none.

- -

Parameters

- - - - - - - - - - - -
string$str
string$position
- - -

Returns

- string - -
-
- -
- -
-
- -
-

hasMultiBytes()

- - 
hasMultiBytes(string  $str) : boolean
-

Check if a string contains multi-byte characters.

- - -

Parameters

- - - - - - -
string$str

multi-byte text to wrap encode

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

has8bitChars()

- - 
has8bitChars(string  $text) : boolean
-

Does a string contain any 8-bit chars (in any charset)?

- - -

Parameters

- - - - - - -
string$text
- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

base64EncodeWrapMB()

- - 
base64EncodeWrapMB(string  $str, string  $linebreak = null) : string
-

Encode and wrap long multibyte strings for mail headers -without breaking lines within a character.

-

Adapted from a function by paravoid

- -

Parameters

- - - - - - - - - - - -
string$str

multi-byte text to wrap encode

string$linebreak

string to use as linefeed/end-of-line

- - -

Returns

- string - -
-
- -
- -
-
- -
-

encodeQP()

- - 
encodeQP(string  $string, integer  $line_max = 76) : string
-

Encode a string in quoted-printable format.

-

According to RFC2045 section 6.7.

- -

Parameters

- - - - - - - - - - - -
string$string

The text to encode

integer$line_max

Number of chars allowed on a line before wrapping

- - -

Returns

- string - -
-
- -
- -
-
- -
-

encodeQPphp()

- - 
encodeQPphp(string  $string, integer  $line_max = 76, boolean  $space_conv = false) : string
-

Backward compatibility wrapper for an old QP encoding function that was removed.

- - -

Parameters

- - - - - - - - - - - - - - - - -
string$string
integer$line_max
boolean$space_conv
- - -

Returns

- string - -
-
- -
- -
-
- -
-

encodeQ()

- - 
encodeQ(string  $str, string  $position = 'text') : string
-

Encode a string using Q encoding.

- - -

Parameters

- - - - - - - - - - - -
string$str

the text to encode

string$position

Where the text is going to be used, see the RFC for what that means

- - -

Returns

- string - -
-
- -
- -
-
- -
-

addStringAttachment()

- - 
addStringAttachment(string  $string, string  $filename, string  $encoding = 'base64', string  $type = '', string  $disposition = 'attachment') : void
-

Add a string or binary attachment (non-filesystem).

-

This method can be used to attach ascii or binary data, -such as a BLOB record from a database.

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
string$string

String attachment data.

string$filename

Name of the attachment.

string$encoding

File encoding (see $Encoding).

string$type

File extension (MIME) type.

string$disposition

Disposition to use

- - - -
-
- -
- -
-
- -
-

addEmbeddedImage()

- - 
addEmbeddedImage(string  $path, string  $cid, string  $name = '', string  $encoding = 'base64', string  $type = '', string  $disposition = 'inline') : boolean
-

Add an embedded (inline) attachment from a file.

-

This can include images, sounds, and just about any other document type. -These differ from 'regular' attachmants in that they are intended to be -displayed inline with the message, not just attached for download. -This is used in HTML messages that embed the images -the HTML refers to using the $cid value.

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string$path

Path to the attachment.

string$cid

Content ID of the attachment; Use this to reference -the content when using an embedded image in HTML.

string$name

Overrides the attachment name.

string$encoding

File encoding (see $Encoding).

string$type

File MIME type.

string$disposition

Disposition to use

- - -

Returns

- boolean - —

True on successfully adding an attachment

- -
-
- -
- -
-
- -
-

addStringEmbeddedImage()

- - 
addStringEmbeddedImage(string  $string, string  $cid, string  $name = '', string  $encoding = 'base64', string  $type = '', string  $disposition = 'inline') : boolean
-

Add an embedded stringified attachment.

-

This can include images, sounds, and just about any other document type. -Be sure to set the $type to an image type for images: -JPEG images use 'image/jpeg', GIF uses 'image/gif', PNG uses 'image/png'.

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string$string

The attachment binary data.

string$cid

Content ID of the attachment; Use this to reference -the content when using an embedded image in HTML.

string$name
string$encoding

File encoding (see $Encoding).

string$type

MIME type.

string$disposition

Disposition to use

- - -

Returns

- boolean - —

True on successfully adding an attachment

- -
-
- -
- -
-
- -
-

inlineImageExists()

- - 
inlineImageExists() : boolean
-

Check if an inline attachment is present.

- - - - -

Returns

- boolean - -
-
- -
- -
-
- -
-

attachmentExists()

- - 
attachmentExists() : boolean
-

Check if an attachment (non-inline) is present.

- - - - -

Returns

- boolean - -
-
- -
- -
-
- -
-

alternativeExists()

- - 
alternativeExists() : boolean
-

Check if this message has an alternative body set.

- - - - -

Returns

- boolean - -
-
- -
- -
-
- -
-

clearAddresses()

- - 
clearAddresses() : void
-

Clear all To recipients.

- - - - - -
-
- -
- -
-
- -
-

clearCCs()

- - 
clearCCs() : void
-

Clear all CC recipients.

- - - - - -
-
- -
- -
-
- -
-

clearBCCs()

- - 
clearBCCs() : void
-

Clear all BCC recipients.

- - - - - -
-
- -
- -
-
- -
-

clearReplyTos()

- - 
clearReplyTos() : void
-

Clear all ReplyTo recipients.

- - - - - -
-
- -
- -
-
- -
-

clearAllRecipients()

- - 
clearAllRecipients() : void
-

Clear all recipient types.

- - - - - -
-
- -
- -
-
- -
-

clearAttachments()

- - 
clearAttachments() : void
-

Clear all filesystem, string, and binary attachments.

- - - - - -
-
- -
- -
-
- -
-

clearCustomHeaders()

- - 
clearCustomHeaders() : void
-

Clear all custom headers.

- - - - - -
-
- -
- -
-
- -
-

rfcDate()

- - 
rfcDate() : string
-

Return an RFC 822 formatted date.

- - - - -

Returns

- string - -
-
- -
- -
-
- -
-

isError()

- - 
isError() : boolean
-

Check if an error occurred.

- - - - -

Returns

- boolean - —

True if an error did occur.

- -
-
- -
- -
-
- -
-

fixEOL()

- - 
fixEOL(string  $str) : string
-

Ensure consistent line endings in a string.

-

Changes every end of line from CRLF, CR or LF to $this->LE.

- -

Parameters

- - - - - - -
string$str

String to fixEOL

- - -

Returns

- string - -
-
- -
- -
-
- -
-

addCustomHeader()

- - 
addCustomHeader(string  $name, string  $value = null) : void
-

Add a custom header.

-

$name value can be overloaded to contain -both header name and value (name:value)

- -

Parameters

- - - - - - - - - - - -
string$name

Custom header name

string$value

Header value

- - - -
-
- -
- -
-
- -
-

msgHTML()

- - 
msgHTML(string  $message, string  $basedir = '', boolean  $advanced = false) : string
-

Create a message from an HTML string.

-

Automatically makes modifications for inline images and backgrounds -and creates a plain-text version by converting the HTML. -Overwrites any existing values in $this->Body and $this->AltBody

- -

Parameters

- - - - - - - - - - - - - - - - -
string$message

HTML message string

string$basedir

baseline directory for path

boolean$advanced

Whether to use the advanced HTML to text converter

- - -

Returns

- string - —

$message

- -
-
- -
- -
-
- -
-

html2text()

- - 
html2text(string  $html, boolean  $advanced = false) : string
-

Convert an HTML string into plain text.

- - -

Parameters

- - - - - - - - - - - -
string$html

The HTML text to convert

boolean$advanced

Should this use the more complex html2text converter or just a simple one?

- - -

Returns

- string - -
-
- -
- -
-
- -
-

_mime_types()

- - 
_mime_types(string  $ext = '') : string
-

Get the MIME type for a file extension.

- - -

Parameters

- - - - - - -
string$ext

File extension

- - -

Returns

- string - —

MIME type of file.

- -
-
- -
- -
-
- -
-

filenameToType()

- - 
filenameToType(string  $filename) : string
-

Map a file name to a MIME type.

-

Defaults to 'application/octet-stream', i.e.. arbitrary binary data.

- -

Parameters

- - - - - - -
string$filename

A file name or full path, does not need to exist as a file

- - -

Returns

- string - -
-
- -
- -
-
- -
-

mb_pathinfo()

- - 
mb_pathinfo(string  $path, integer|string  $options = null) : string|array
-

Multi-byte-safe pathinfo replacement.

-

Drop-in replacement for pathinfo(), but multibyte-safe, cross-platform-safe, old-version-safe. -Works similarly to the one in PHP >= 5.2.0

- -

Parameters

- - - - - - - - - - - -
string$path

A filename or path, does not need to exist as a file

integer|string$options

Either a PATHINFO_* constant, -or a string name to return only the specified piece, allows 'filename' to work on PHP < 5.2

- - -

Returns

- string|array - -
-
- -
- -
-
- -
-

set()

- - 
set(string  $name, mixed  $value = '') : boolean
-

Set or reset instance properties.

-

Usage Example: -$page->set('X-Priority', '3');

- -

Parameters

- - - - - - - - - - - -
string$name
mixed$value

NOTE: will not work with arrays, there are no arrays to set/reset

- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - -
-
- -
- -
-
- -
-

secureHeader()

- - 
secureHeader(string  $str) : string
-

Strip newlines to prevent header injection.

- - -

Parameters

- - - - - - -
string$str
- - -

Returns

- string - -
-
- -
- -
-
- -
-

normalizeBreaks()

- - 
normalizeBreaks(string  $text, string  $breaktype = "\r\n") : string
-

Normalize line breaks in a string.

-

Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format. -Defaults to CRLF (for message bodies) and preserves consecutive breaks.

- -

Parameters

- - - - - - - - - - - -
string$text
string$breaktype

What kind of line break to use, defaults to CRLF

- - -

Returns

- string - -
-
- -
- -
-
- -
-

sign()

- - 
sign(string  $cert_filename, string  $key_filename, string  $key_pass)
-

Set the public and private key files and password for S/MIME signing.

- - -

Parameters

- - - - - - - - - - - - - - - - -
string$cert_filename
string$key_filename
string$key_pass

Password for private key

- - - -
-
- -
- -
-
- -
-

DKIM_QP()

- - 
DKIM_QP(string  $txt) : string
-

Quoted-Printable-encode a DKIM header.

- - -

Parameters

- - - - - - -
string$txt
- - -

Returns

- string - -
-
- -
- -
-
- -
-

DKIM_Sign()

- - 
DKIM_Sign(string  $signheader) : string
-

Generate a DKIM signature.

- - -

Parameters

- - - - - - -
string$signheader

Header

- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- string - -
-
- -
- -
-
- -
-

DKIM_HeaderC()

- - 
DKIM_HeaderC(string  $signheader) : string
-

Generate a DKIM canonicalization header.

- - -

Parameters

- - - - - - -
string$signheader

Header

- - -

Returns

- string - -
-
- -
- -
-
- -
-

DKIM_BodyC()

- - 
DKIM_BodyC(string  $body) : string
-

Generate a DKIM canonicalization body.

- - -

Parameters

- - - - - - -
string$body

Message Body

- - -

Returns

- string - -
-
- -
- -
-
- -
-

DKIM_Add()

- - 
DKIM_Add(string  $headers_line, string  $subject, string  $body) : string
-

Create the DKIM header and body in a new message header.

- - -

Parameters

- - - - - - - - - - - - - - - - -
string$headers_line

Header lines

string$subject

Subject

string$body

Body

- - -

Returns

- string - -
-
- -
- -
-
- -
-

getToAddresses()

- - 
getToAddresses() : array
-

Allows for public read access to 'to' property.

- - - - -

Returns

- array - -
-
- -
- -
-
- -
-

getCcAddresses()

- - 
getCcAddresses() : array
-

Allows for public read access to 'cc' property.

- - - - -

Returns

- array - -
-
- -
- -
-
- -
-

getBccAddresses()

- - 
getBccAddresses() : array
-

Allows for public read access to 'bcc' property.

- - - - -

Returns

- array - -
-
- -
- -
-
- -
-

getReplyToAddresses()

- - 
getReplyToAddresses() : array
-

Allows for public read access to 'ReplyTo' property.

- - - - -

Returns

- array - -
-
- -
- -
-
- -
-

getAllRecipientAddresses()

- - 
getAllRecipientAddresses() : array
-

Allows for public read access to 'all_recipients' property.

- - - - -

Returns

- array - -
-
- -
- -
-
- -
-

edebug()

- - 
edebug(string  $str)
-

Output debugging info via user-defined method.

-

Only if debug output is enabled.

- -

Parameters

- - - - - - -
string$str
- - - -
-
- -
- -
-
- -
-

addAnAddress()

- - 
addAnAddress(string  $kind, string  $address, string  $name = '') : boolean
-

Add an address to one of the recipient arrays.

-

Addresses that have been added already return false, but do not throw exceptions

- -

Parameters

- - - - - - - - - - - - - - - - -
string$kind

One of 'to', 'cc', 'bcc', 'ReplyTo'

string$address

The email address to send to

string$name
- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - —

true on success, false if address already used or invalid in some way

- -
-
- -
- -
-
- -
-

sendmailSend()

- - 
sendmailSend(string  $header, string  $body) : boolean
-

Send mail using the $Sendmail program.

- - -

Parameters

- - - - - - - - - - - -
string$header

The message headers

string$body

The message body

- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - -
-
- -
- -
-
- -
-

mailSend()

- - 
mailSend(string  $header, string  $body) : boolean
-

Send mail using the PHP mail() function.

- - -

Parameters

- - - - - - - - - - - -
string$header

The message headers

string$body

The message body

- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - -
-
- -
- -
-
- -
-

smtpSend()

- - 
smtpSend(string  $header, string  $body) : boolean
-

Send mail via SMTP.

-

Returns false if there is a bad MAIL FROM, RCPT, or DATA input. -Uses the PHPMailerSMTP class by default.

- -

Parameters

- - - - - - - - - - - -
string$header

The message headers

string$body

The message body

- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- boolean - -
-
- -
- -
-
- -
-

getBoundary()

- - 
getBoundary(string  $boundary, string  $charSet, string  $contentType, string  $encoding) : string
-

Return the start of a message boundary.

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$boundary
string$charSet
string$contentType
string$encoding
- - -

Returns

- string - -
-
- -
- -
-
- -
-

endBoundary()

- - 
endBoundary(string  $boundary) : string
-

Return the end of a message boundary.

- - -

Parameters

- - - - - - -
string$boundary
- - -

Returns

- string - -
-
- -
- -
-
- -
-

setMessageType()

- - 
setMessageType() : void
-

Set the message type.

-

PHPMailer only supports some preset message types, -not arbitrary MIME structures.

- - - - -
-
- -
- -
-
- -
-

attachAll()

- - 
attachAll(string  $disposition_type, string  $boundary) : string
-

Attach all file, string, and binary attachments to the message.

-

Returns an empty string on failure.

- -

Parameters

- - - - - - - - - - - -
string$disposition_type
string$boundary
- - -

Returns

- string - -
-
- -
- -
-
- -
-

encodeFile()

- - 
encodeFile(string  $path, string  $encoding = 'base64') : string
-

Encode a file attachment in requested format.

-

Returns an empty string on failure.

- -

Parameters

- - - - - - - - - - - -
string$path

The full path to the file

string$encoding

The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'

- -

Throws

-
-
\phpmailerException
-
-
- -

Returns

- string - -
-
- -
- -
-
- -
-

setError()

- - 
setError(string  $msg) : void
-

Add an error message to the error container.

- - -

Parameters

- - - - - - -
string$msg
- - - -
-
- -
- -
-
- -
-

serverHostname()

- - 
serverHostname() : string
-

Get the server hostname.

-

Returns 'localhost.localdomain' if unknown.

- - - -

Returns

- string - -
-
- -
- -
-
- -
-

lang()

- - 
lang(string  $key) : string
-

Get an error message in the current language.

- - -

Parameters

- - - - - - -
string$key
- - -

Returns

- string - -
-
- -
- -
-
- -
-

doCallback()

- - 
doCallback(boolean  $isSent, string  $to, string  $cc, string  $bcc, string  $subject, string  $body, string  $from = null)
-

Perform a callback.

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
boolean$isSent
string$to
string$cc
string$bcc
string$subject
string$body
string$from
- - - -
-
- -
- -
-
- -
-

mailPassthru()

- - 
mailPassthru(string  $to, string  $subject, string  $body, string  $header, string  $params) : boolean
-

Call mail() in a safe_mode-aware fashion.

-

Also, unless sendmail_path points to sendmail (or something that -claims to be sendmail), don't pass params (not a perfect fix, -but it will do)

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
string$to

To

string$subject

Subject

string$body

Message Body

string$header

Additional Header(s)

string$params

Params

- - -

Returns

- boolean - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/SMTP.html b/doc/classes/SMTP.html deleted file mode 100644 index 1f1811c9..00000000 --- a/doc/classes/SMTP.html +++ /dev/null @@ -1,2653 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\SMTP

-

PHPMailer RFC821 SMTP email transport class.

-

Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.

- - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- __construct()
- connect()
- startTLS()
- authenticate()
- connected()
- close()
- data()
- hello()
- mail()
- quit()
- recipient()
- reset()
- sendAndMail()
- verify()
- noop()
- turn()
- client_send()
- getError()
- getLastReply()
- setVerp()
- getVerp()
- setDebugOutput()
- getDebugOutput()
- setDebugLevel()
- getDebugLevel()
- setTimeout()
- getTimeout()
-
-
- $Version
- $SMTP_PORT
- $CRLF
- $do_debug
- $Debugoutput
- $do_verp
- $Timeout
- $Timelimit
-
-
- VERSION
- CRLF
- DEFAULT_SMTP_PORT
- MAX_LINE_LENGTH
-
-
-
-
- edebug()
- hmac()
- sendHello()
- sendCommand()
- get_lines()
-
-
- $smtp_conn
- $error
- $helo_rply
- $last_reply
-
-
- N/A -
-
-
-
- No private methods found -
-
- No private properties found -
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

VERSION

- 
VERSION
-

The PHPMailer SMTP version number.

- -
-
- -
- -
-
- -
-

CRLF

- 
CRLF
-

SMTP line break constant.

- -
-
- -
- -
-
- -
-

DEFAULT_SMTP_PORT

- 
DEFAULT_SMTP_PORT
-

The SMTP port to use if one is not specified.

- -
-
- -
- -
-
- -
-

MAX_LINE_LENGTH

- 
MAX_LINE_LENGTH
-

The maximum line length allowed by RFC 2822 section 2.1.1

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$Version

- 
$Version :
-

The PHPMailer SMTP Version number.

- - -

Type

- -
-
- -
- -
-
- -
-

$SMTP_PORT

- 
$SMTP_PORT :
-

SMTP server port number.

- - -

Type

- -
-
- -
- -
-
- -
-

$CRLF

- 
$CRLF :
-

SMTP reply line ending.

- - -

Type

- -
-
- -
- -
-
- -
-

$do_debug

- 
$do_debug :
-

Debug output level.

-

Options:

-
    -
  • 0 No output
    • -
  • 1 Commands
    • -
  • 2 Data and commands
    • -
  • 3 As 2 plus connection status
    • -
  • 4 Low-level data output
    • -
- -

Type

- -
-
- -
- -
-
- -
-

$Debugoutput

- 
$Debugoutput :
-

How to handle debug output.

-

Options:

-
    -
  • echo Output plain-text as-is, appropriate for CLI
    • -
  • html Output escaped, line breaks converted to
    , appropriate for browser output
    • -
  • error_log Output to error log as configured in php.ini
    • -
- -

Type

- -
-
- -
- -
-
- -
-

$do_verp

- 
$do_verp :
-

Whether to use VERP.

- - -

Type

- -
-
- -
- -
-
- -
-

$Timeout

- 
$Timeout :
-

The timeout value for connection, in seconds.

-

Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2 -This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.

- -

Type

- -
-
- -
- -
-
- -
-

$Timelimit

- 
$Timelimit :
-

The SMTP timelimit value for reads, in seconds.

- - -

Type

- -
-
- -
- -
-
- -
-

$smtp_conn

- 
$smtp_conn :
-

The socket for the server connection.

- - -

Type

- -
-
- -
- -
-
- -
-

$error

- 
$error :
-

Error message, if any, for the last call.

- - -

Type

- -
-
- -
- -
-
- -
-

$helo_rply

- 
$helo_rply :
-

The reply the server sent to us for HELO.

- - -

Type

- -
-
- -
- -
-
- -
-

$last_reply

- 
$last_reply :
-

The most recent reply received from the server.

- - -

Type

- -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

__construct()

- - 
__construct()
-

Constructor.

- - - - - -
-
- -
- -
-
- -
-

connect()

- - 
connect(string  $host, integer  $port = null, integer  $timeout = 30, array  $options = array()) : boolean
-

Connect to an SMTP server.

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$host

SMTP server IP or host name

integer$port

The port number to connect to

integer$timeout

How long to wait for the connection to open

array$options

An array of options for stream_context_create()

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

startTLS()

- - 
startTLS() : boolean
-

Initiate a TLS (encrypted) session.

- - - - -

Returns

- boolean - -
-
- -
- -
-
- -
-

authenticate()

- - 
authenticate(string  $username, string  $password, string  $authtype = 'LOGIN', string  $realm = '', string  $workstation = '') : boolean
-

Perform SMTP authentication.

-

Must be run after hello().

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
string$username

The user name

string$password

The password

string$authtype

The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5)

string$realm

The auth realm for NTLM

string$workstation

The auth workstation for NTLM

- - -

Returns

- boolean - —

True if successfully authenticated.

- -
-
- -
- -
-
- -
-

connected()

- - 
connected() : boolean
-

Check connection state.

- - - - -

Returns

- boolean - —

True if connected.

- -
-
- -
- -
-
- -
-

close()

- - 
close() : void
-

Close the socket and clean up the state of the class.

-

Don't use this function without first trying to use QUIT.

- - - - -
-
- -
- -
-
- -
-

data()

- - 
data(string  $msg_data) : boolean
-

Send an SMTP DATA command.

-

Issues a data command and sends the msg_data to the server, -finializing the mail transaction. $msg_data is the message -that is to be send with the headers. Each header needs to be -on a single line followed by a with the message headers -and the message body being separated by and additional . -Implements rfc 821: DATA

- -

Parameters

- - - - - - -
string$msg_data

Message data to send

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

hello()

- - 
hello(string  $host = '') : boolean
-

Send an SMTP HELO or EHLO command.

-

Used to identify the sending server to the receiving server. -This makes sure that client and server are in a known state. -Implements RFC 821: HELO -and RFC 2821 EHLO.

- -

Parameters

- - - - - - -
string$host

The host name or IP to connect to

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

mail()

- - 
mail(string  $from) : boolean
-

Send an SMTP MAIL command.

-

Starts a mail transaction from the email address specified in -$from. Returns true if successful or false otherwise. If True -the mail transaction is started and then one or more recipient -commands may be called followed by a data command. -Implements rfc 821: MAIL FROM:

- -

Parameters

- - - - - - -
string$from

Source address of this message

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

quit()

- - 
quit(boolean  $close_on_error = true) : boolean
-

Send an SMTP QUIT command.

-

Closes the socket if there is no error or the $close_on_error argument is true. -Implements from rfc 821: QUIT

- -

Parameters

- - - - - - -
boolean$close_on_error

Should the connection close if an error occurs?

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

recipient()

- - 
recipient(string  $toaddr) : boolean
-

Send an SMTP RCPT command.

-

Sets the TO argument to $toaddr. -Returns true if the recipient was accepted false if it was rejected. -Implements from rfc 821: RCPT TO:

- -

Parameters

- - - - - - -
string$toaddr

The address the message is being sent to

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

reset()

- - 
reset() : boolean
-

Send an SMTP RSET command.

-

Abort any transaction that is currently in progress. -Implements rfc 821: RSET

- - - -

Returns

- boolean - —

True on success.

- -
-
- -
- -
-
- -
-

sendAndMail()

- - 
sendAndMail(string  $from) : boolean
-

Send an SMTP SAML command.

-

Starts a mail transaction from the email address specified in $from. -Returns true if successful or false otherwise. If True -the mail transaction is started and then one or more recipient -commands may be called followed by a data command. This command -will send the message to the users terminal if they are logged -in and send them an email. -Implements rfc 821: SAML FROM:

- -

Parameters

- - - - - - -
string$from

The address the message is from

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

verify()

- - 
verify(string  $name) : boolean
-

Send an SMTP VRFY command.

- - -

Parameters

- - - - - - -
string$name

The name to verify

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

noop()

- - 
noop() : boolean
-

Send an SMTP NOOP command.

-

Used to keep keep-alives alive, doesn't actually do anything

- - - -

Returns

- boolean - -
-
- -
- -
-
- -
-

turn()

- - 
turn() : boolean
-

Send an SMTP TURN command.

-

This is an optional command for SMTP that this class does not support. -This method is here to make the RFC821 Definition complete for this class -and may be implemented in future -Implements from rfc 821: TURN

- - - -

Returns

- boolean - -
-
- -
- -
-
- -
-

client_send()

- - 
client_send(string  $data) : integer|boolean
-

Send raw data to the server.

- - -

Parameters

- - - - - - -
string$data

The data to send

- - -

Returns

- integer|boolean - —

The number of bytes sent to the server or false on error

- -
-
- -
- -
-
- -
-

getError()

- - 
getError() : array
-

Get the latest error.

- - - - -

Returns

- array - -
-
- -
- -
-
- -
-

getLastReply()

- - 
getLastReply() : string
-

Get the last reply from the server.

- - - - -

Returns

- string - -
-
- -
- -
-
- -
-

setVerp()

- - 
setVerp(boolean  $enabled = false)
-

Enable or disable VERP address generation.

- - -

Parameters

- - - - - - -
boolean$enabled
- - - -
-
- -
- -
-
- -
-

getVerp()

- - 
getVerp() : boolean
-

Get VERP address generation mode.

- - - - -

Returns

- boolean - -
-
- -
- -
-
- -
-

setDebugOutput()

- - 
setDebugOutput(string  $method = 'echo')
-

Set debug output method.

- - -

Parameters

- - - - - - -
string$method

The function/method to use for debugging output.

- - - -
-
- -
- -
-
- -
-

getDebugOutput()

- - 
getDebugOutput() : string
-

Get debug output method.

- - - - -

Returns

- string - -
-
- -
- -
-
- -
-

setDebugLevel()

- - 
setDebugLevel(integer  $level)
-

Set debug output level.

- - -

Parameters

- - - - - - -
integer$level
- - - -
-
- -
- -
-
- -
-

getDebugLevel()

- - 
getDebugLevel() : integer
-

Get debug output level.

- - - - -

Returns

- integer - -
-
- -
- -
-
- -
-

setTimeout()

- - 
setTimeout(integer  $timeout)
-

Set SMTP timeout.

- - -

Parameters

- - - - - - -
integer$timeout
- - - -
-
- -
- -
-
- -
-

getTimeout()

- - 
getTimeout() : integer
-

Get SMTP timeout.

- - - - -

Returns

- integer - -
-
- -
- -
-
- -
-

edebug()

- - 
edebug(string  $str) : void
-

Output debugging info via a user-selected method.

- - -

Parameters

- - - - - - -
string$str

Debug string to output

- - - -
-
- -
- -
-
- -
-

hmac()

- - 
hmac(string  $data, string  $key) : string
-

Calculate an MD5 HMAC hash.

-

Works like hash_hmac('md5', $data, $key) -in case that function is not available

- -

Parameters

- - - - - - - - - - - -
string$data

The data to hash

string$key

The key to hash with

- - -

Returns

- string - -
-
- -
- -
-
- -
-

sendHello()

- - 
sendHello(string  $hello, string  $host) : boolean
-

Send an SMTP HELO or EHLO command.

-

Low-level implementation used by hello()

- -

Parameters

- - - - - - - - - - - -
string$hello

The HELO string

string$host

The hostname to say we are

- - -

Returns

- boolean - -
-
- -
- -
-
- -
-

sendCommand()

- - 
sendCommand(string  $command, string  $commandstring, integer|array  $expect) : boolean
-

Send a command to an SMTP server and check its return code.

- - -

Parameters

- - - - - - - - - - - - - - - - -
string$command

The command name - not sent to the server

string$commandstring

The actual command to send

integer|array$expect

One or more expected integer success codes

- - -

Returns

- boolean - —

True on success.

- -
-
- -
- -
-
- -
-

get_lines()

- - 
get_lines() : string
-

Read the SMTP server's response.

-

Either before eof or socket timeout occurs on the operation. -With SMTP we can tell if we have more lines to read if the -4th character is '-' symbol. If it is a space then we don't -need to read anything else.

- - - -

Returns

- string - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.Controller.html b/doc/classes/hhu.z.Controller.html deleted file mode 100644 index 10c09301..00000000 --- a/doc/classes/hhu.z.Controller.html +++ /dev/null @@ -1,1870 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\zController

-

Abstract class for implementing an application Controller.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- load()
- factory()
- __construct()
- preFilter()
- postFilter()
- run()
- render()
-
-
- $components
-
-
- No constants found -
-
-
-
- set()
- redirect()
- checkModels()
- getView()
- loadModels()
- loadView()
- log()
-
-
- $agent
- $view
- $viewData
- $request
- $response
- $log
- $linker
-
-
- N/A -
-
-
-
- getClassName()
- loadComponents()
-
-
- No private properties found -
-
- N/A -
-
-
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$components

- 
$components : array
-

Required components

- - -

Type

- array -
-
- -
- -
-
- -
-

$agent

- 
$agent : \nre\core\Agent
-

Corresponding Agent

- - -

Type

- \nre\core\Agent -
-
- -
- -
-
- -
-

$view

- 
$view : \nre\core\View
-

View of the Controller

- - -

Type

- \nre\core\View -
-
- -
- -
-
- -
-

$viewData

- 
$viewData : array
-

Data to pass to the View

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- -
-
- -
-

$log

- 
$log : \nre\core\Logger
-

Logger instance

- - -

Type

- \nre\core\Logger -
-
- -
- -
-
- -
-

$linker

- 
$linker : \nre\core\Linker
-

Linker instance

- - -

Type

- \nre\core\Linker -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

load()

- - 
load(string  $controllerName)
-

Load the class of a Controller.

- - -

Parameters

- - - - - - -
string$controllerName

Name of the Controller to load

- -

Throws

-
-
\nre\exceptions\ControllerNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $controllerName, string  $layoutName, string  $action, string  $agent)
-

Instantiate a Controller (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$controllerName

Name of the Controller to instantiate

string$layoutName

Name of the current Layout

string$action

Current Action

string$agent

Corresponding Agent

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(string  $layoutName, string  $action, \nre\core\Agent  $agent)
-

Construct a new application Controller.

- - -

Parameters

- - - - - - - - - - - - - - - - -
string$layoutName

Name of the current Layout

string$action

Current Action

\nre\core\Agent$agent

Corresponding Agent

- -

Throws

-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

preFilter()

- - 
preFilter(\nre\core\Request  $request, \nre\core\Response  $response)
-

Prefilter that is executed before running the Controller.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

postFilter()

- - 
postFilter(\nre\core\Request  $request, \nre\core\Response  $response)
-

Postfilter that is executed after running the Controller.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response)
-

Run the Controller.

-

This method executes the Action of the Controller defined by -the current Request.

- -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

render()

- - 
render(array  $viewData = null) : string
-

Generate the output.

- - -

Parameters

- - - - - - -
array$viewData

Data to pass to the View

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

set()

- - 
set(string  $name, mixed  $data)
-

Set data for the View.

- - -

Parameters

- - - - - - - - - - - -
string$name

Key

mixed$data

Value

- - - -
-
- -
- -
-
- -
-

redirect()

- - 
redirect(string  $url)
-

Redirect to the given URL.

- - -

Parameters

- - - - - - -
string$url

Relative URL

- - - -
-
- -
- -
-
- -
-

checkModels()

- - 
checkModels(string  $modelName) : boolean
-

Check if Models of this Controller are loaded and available.

- - -

Parameters

- - - - - - -
string$modelName

Arbitrary number of Models to check

- - -

Returns

- boolean - —

All given Models are loaded and available

- -
-
- -
- -
-
- -
-

getView()

- - 
getView() : \nre\core\View
-

Get the View of the Controller

- - - - -

Returns

- \nre\core\View - —

View of the Controller

- -
-
- -
- -
-
- -
-

loadModels()

- - 
loadModels()
-

Load the Models of this Controller.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

loadView()

- - 
loadView(string  $layoutName, string  $action)
-

Load the View of this Controller.

- - -

Parameters

- - - - - - - - - - - -
string$layoutName

Name of the current Layout

string$action

Current Action

- -

Throws

-
-
\nre\exceptions\ViewNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(string  $message, integer  $logMode = \nre\core\Logger::LOGMODE_AUTO)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
string$message

Error message to log

integer$logMode

Log mode (optional)

- - - -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $controllerName) : string
-

Determine the classname for the given Controller name.

- - -

Parameters

- - - - - - -
string$controllerName

Controller name to get classname of

- - -

Returns

- string - —

Classname for the Controller name

- -
-
- -
- -
-
- -
-

loadComponents()

- - 
loadComponents()
-

Load the Components of this Controller.

- - - -

Throws

-
-
\nre\exceptions\ComponentNotValidException
-
-
\nre\exceptions\ComponentNotFoundException
-
-
- - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.Model.html b/doc/classes/hhu.z.Model.html deleted file mode 100644 index 666c68b6..00000000 --- a/doc/classes/hhu.z.Model.html +++ /dev/null @@ -1,1292 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\zModel

-

Abstract class for implementing an application Model.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- __construct()
- load()
- factory()
-
-
- No public properties found -
-
- No constants found -
-
-
-
- No protected methods found -
-
- $db
-
-
- N/A -
-
-
-
- loadDriver()
- connect()
- getClassName()
- loadModels()
-
-
- No private properties found -
-
- N/A -
-
-
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$db

- 
$db : \nre\models\DatabaseDriver
-

Database connection

- - -

Type

- \nre\models\DatabaseDriver -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

__construct()

- - 
__construct()
-

Construct a new application Model.

-

TODO Catch exception

- - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

load()

- - 
load(string  $modelName)
-

Load the class of a Model.

- - -

Parameters

- - - - - - -
string$modelName

Name of the Model to load

- -

Throws

-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $modelName)
-

Instantiate a Model (Factory Pattern).

- - -

Parameters

- - - - - - -
string$modelName

Name of the Model to instantiate

- - - -
-
- -
- -
-
- -
-

loadDriver()

- - 
loadDriver(string  $driverName)
-

Load the database driver.

- - -

Parameters

- - - - - - -
string$driverName

Name of the database driver

- -

Throws

-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\DriverNotValidException
-
-
- - -
-
- -
- -
-
- -
-

connect()

- - 
connect(string  $driverName, array  $config)
-

Establish a connection to the database.

- - -

Parameters

- - - - - - - - - - - -
string$driverName

Name of the database driver

array$config

Connection settings

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- - -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $modelName) : string
-

Determine the classname for the given Model name.

- - -

Parameters

- - - - - - -
string$modelName

Model name to get classname of

- - -

Returns

- string - —

Classname fore the Model name

- -
-
- -
- -
-
- -
-

loadModels()

- - 
loadModels()
-

Load the Models of this Model.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
- - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.TextFormatter.html b/doc/classes/hhu.z.TextFormatter.html deleted file mode 100644 index e5d900e1..00000000 --- a/doc/classes/hhu.z.TextFormatter.html +++ /dev/null @@ -1,1117 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\zTextFormatter

-

Class to format text with different syntax tags.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- __construct()
- t()
-
-
- No public properties found -
-
- No constants found -
-
-
-
- No protected methods found -
-
- No protected properties found -
-
- N/A -
-
-
-
- loadMediaModel()
-
-
- $linker
- $Media
-
-
- N/A -
-
-
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$linker

- 
$linker : \nre\core\Linker
-

Linker to create links.

- - -

Type

- \nre\core\Linker -
-
- -
- -
-
- -
-

$Media

- 
$Media : \nre\core\Model
-

Media-Model to retrieve media data

- - -

Type

- \nre\core\Model -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Linker  $linker)
-

Create a new text formatter.

- - -

Parameters

- - - - - - -
\nre\core\Linker$linker

Linker to create links with

- - - -
-
- -
- -
-
- -
-

t()

- - 
t(string  $string) : string
-

Format a string.

- - -

Parameters

- - - - - - -
string$string

String to format

- - -

Returns

- string - —

Formatted string

- -
-
- -
- -
-
- -
-

loadMediaModel()

- - 
loadMediaModel() : boolean
-

Load the Media-Model if it is not loaded

- - - - -

Returns

- boolean - —

Whether the Media-Model has been loaded or not

- -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.Utils.html b/doc/classes/hhu.z.Utils.html deleted file mode 100644 index 38a7b5a4..00000000 --- a/doc/classes/hhu.z.Utils.html +++ /dev/null @@ -1,1204 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\zUtils

-

Class for implementing utility methods.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- t()
- htmlspecialchars_utf8()
- shortenString()
- sendMail()
- getMimetype()
-
-
- No public properties found -
-
- No constants found -
-
-
-
- No protected methods found -
-
- No protected properties found -
-
- N/A -
-
-
-
- No private methods found -
-
- No private properties found -
-
- N/A -
-
-
-
- -
- - - - -
-

Methods

- -
- -
-
- -
-

t()

- - 
t(string  $string) : string
-

Mask HTML-chars for save output.

- - -

Parameters

- - - - - - -
string$string

String to be masked

- - -

Returns

- string - —

Masked string

- -
-
- -
- -
-
- -
-

htmlspecialchars_utf8()

- - 
htmlspecialchars_utf8(string  $string) : string
-

‚htmlspecialchars‘ with support for UTF-8.

- - -

Parameters

- - - - - - -
string$string

String to be masked

- - -

Returns

- string - —

Masked string

- -
-
- -
- -
-
- -
-

shortenString()

- - 
shortenString(string  $string, integer  $length, integer  $scope) : string
-

Cut a string to the given length but only word boundaries.

- - -

Parameters

- - - - - - - - - - - - - - - - -
string$string

String to cut

integer$length

Length to cut string

integer$scope

Maximum length to cut string regardless word boundaries

- - -

Returns

- string - —

Cutted string

- -
-
- -
- -
-
- -
-

sendMail()

- - 
sendMail(mixed  $to, string  $messageAction, boolean  $html = false, array  $params = null, \nre\core\Linker  $linker = null)
-

Send an e‑mail.

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
mixed$to

One (string) or many (array) receivers

string$messageAction

Message Action

boolean$html

Whether mail should be formatted as HTML or not

array$params

Parameters to pass

\nre\core\Linker$linker

Linker instance

- -

Throws

-
-
\hhu\z\exceptions\MailingException
-
-
- - -
-
- -
- -
-
- -
-

getMimetype()

- - 
getMimetype(string  $filename, string  $defaultMimetype = null) : string
-

Detect Mimetype of a file.

- - -

Parameters

- - - - - - - - - - - -
string$filename

Name of file to detect Mimetype of

string$defaultMimetype

Default Mimetype to use

- - -

Returns

- string - —

Detected Mimetype of file

- -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.QuesttypeAgent.html b/doc/classes/hhu.z.agents.QuesttypeAgent.html deleted file mode 100644 index 14dcbe21..00000000 --- a/doc/classes/hhu.z.agents.QuesttypeAgent.html +++ /dev/null @@ -1,2142 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agentsQuesttypeAgent

-

Abstract class for implementing a QuesttypeAgent.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- load()
- factory()
- run()
- render()
- checkClass()
- saveAnswersOfCharacter()
- matchAnswersOfCharacter()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
- loadClass()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

load()

- - 
load(string  $questtypeName)
-

Load a QuesttypeAgent.

- - -

Parameters

- - - - - - -
string$questtypeName

Name of the QuesttypeAgent to load

- -

Throws

-
-
\hhu\z\exceptions\QuesttypeAgentNotFoundException
-
-
\hhu\z\exceptions\QuesttypeAgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $questtypeName, \hhu\z\agents\Request  $request, \hhu\z\agents\Response  $response, \hhu\z\agents\Logger  $log = null)
-

Instantiate a QuesttypeAgent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$questtypeName

Name of the QuesttypeAgent to instantiate

\hhu\z\agents\Request$request

Current request

\hhu\z\agents\Response$response

Current respone

\hhu\z\agents\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\hhu\z\exceptions\QuesttypeModelNotValidException
-
-
\hhu\z\exceptions\QuesttypeModelNotFoundException
-
-
\hhu\z\exceptions\QuesttypeControllerNotValidException
-
-
\hhu\z\exceptions\QuesttypeControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

checkClass()

- - 
checkClass(string  $className, string  $parentClassName)
-

Check inheritance of the QuesttypeAgent-class.

- - -

Parameters

- - - - - - - - - - - -
string$className

Name of the class to check

string$parentClassName

Name of the parent class

- -

Throws

-
-
\nre\exceptions\ClassNotValidException
-
-
- - -
-
- -
- -
-
- -
-

saveAnswersOfCharacter()

- - 
saveAnswersOfCharacter(array  $seminary, array  $questgroup, array  $quest, array  $character, array  $answers)
-

Save the answers of a Character for a Quest.

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
array$seminary

Current Seminary data

array$questgroup

Current Questgroup data

array$quest

Current Quest data

array$character

Current Character data

array$answers

Character answers for the Quest

- - - -
-
- -
- -
-
- -
-

matchAnswersOfCharacter()

- - 
matchAnswersOfCharacter(array  $seminary, array  $questgroup, array  $quest, array  $character, array  $answers)
-

Check if answers of a Character for a Quest match the correct ones.

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
array$seminary

Current Seminary data

array$questgroup

Current Questgroup data

array$quest

Current Quest data

array$character

Current Character data

array$answers

Character answers for the Quest

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new QuesttypeAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\hhu\z\exceptions\QuesttypeModelNotValidException
-
-
\hhu\z\exceptions\QuesttypeModelNotFoundException
-
-
\hhu\z\exceptions\QuesttypeControllerNotValidException
-
-
\hhu\z\exceptions\QuesttypeControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\hhu\z\exceptions\QuesttypeModelNotValidException
-
-
\hhu\z\exceptions\QuesttypeModelNotFoundException
-
-
\hhu\z\exceptions\QuesttypeControllerNotValidException
-
-
\hhu\z\exceptions\QuesttypeControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $questtypeName, string  $agentType = null) : string
-

Determine the Agent-classname for the given Questtype-name.

- - -

Parameters

- - - - - - - - - - - -
string$questtypeName

Questtype-name to get Agent-classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Questtype-name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- -
-

loadClass()

- - 
loadClass(string  $questtypeName, string  $fullClassName)
-

Load the class of a QuesttypeAgent.

- - -

Parameters

- - - - - - - - - - - -
string$questtypeName

Name of the QuesttypeAgent to load

string$fullClassName

Name of the class to load

- -

Throws

-
-
\nre\exceptions\ClassNotFoundException
-
-
- - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.ToplevelAgent.html b/doc/classes/hhu.z.agents.ToplevelAgent.html deleted file mode 100644 index 2ad9720a..00000000 --- a/doc/classes/hhu.z.agents.ToplevelAgent.html +++ /dev/null @@ -1,2264 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agentsToplevelAgent

-

Abstract class for implementing an application Controller.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- run()
- render()
- getIntermediateAgent()
- load()
- factory()
-
-
- $controller
-
-
- STAGE_LOAD
- STAGE_RUN
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- addSubAgent()
- actionConstruct()
- loadController()
- log()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- loadIntermediateAgent()
- _loadIntermediateAgent()
- _run()
- runIntermediateAgent()
- error()
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
- $layout
- $intermediateAgent
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

STAGE_LOAD

- 
STAGE_LOAD
-

Stage: Load

- -
-
- -
- -
-
- -
-

STAGE_RUN

- 
STAGE_RUN
-

Stage: Run

- -
-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- -
-
- -
-

$layout

- 
$layout : \nre\core\Layout
-

Layout instace

- - -

Type

- \nre\core\Layout -
-
- -
- -
-
- -
-

$intermediateAgent

- 
$intermediateAgent : \nre\agents\IntermediateAgent
-

IntermediateAgent instance

- - -

Type

- \nre\agents\IntermediateAgent -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

getIntermediateAgent()

- - 
getIntermediateAgent() : \nre\agents\IntermediateAgent
-

Return the IntermediateAgent.

- - - - -

Returns

- \nre\agents\IntermediateAgent - —

IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new ToplevlAgent

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

\nre\core\Logger$log

Logger instance

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

loadIntermediateAgent()

- - 
loadIntermediateAgent()
-

Load IntermediateAgent defined by the current request.

- - - -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
- - -
-
- -
- -
-
- -
-

_loadIntermediateAgent()

- - 
_loadIntermediateAgent()
-

Load IntermediateAgent defined by the current request.

- - - -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
- - -
-
- -
- -
-
- -
-

_run()

- - 
_run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\AccessDeniedException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

runIntermediateAgent()

- - 
runIntermediateAgent()
-

Run IntermediateAgent.

- - - -

Throws

-
-
\nre\exceptions\AccessDeniedException
-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
- - -
-
- -
- -
-
- -
-

error()

- - 
error(\Exception  $exception, integer  $httpStatusCode, string  $stage = self::STAGE_LOAD)
-

Handle an error that occurred during -loading/cnostructing/running of the IntermediateAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$httpStatusCode

HTTP-statuscode

string$stage

Stage of execution

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.bottomlevel.MailreceiverAgent.html b/doc/classes/hhu.z.agents.bottomlevel.MailreceiverAgent.html deleted file mode 100644 index 70ad0804..00000000 --- a/doc/classes/hhu.z.agents.bottomlevel.MailreceiverAgent.html +++ /dev/null @@ -1,1971 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\bottomlevelMailreceiverAgent

-

Agent to generate a mail receiver salutation.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.bottomlevel.MenuAgent.html b/doc/classes/hhu.z.agents.bottomlevel.MenuAgent.html deleted file mode 100644 index 7bedee57..00000000 --- a/doc/classes/hhu.z.agents.bottomlevel.MenuAgent.html +++ /dev/null @@ -1,1971 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\bottomlevelMenuAgent

-

Agent to display a menu.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.bottomlevel.QuestgroupshierarchypathAgent.html b/doc/classes/hhu.z.agents.bottomlevel.QuestgroupshierarchypathAgent.html deleted file mode 100644 index 0f8575a4..00000000 --- a/doc/classes/hhu.z.agents.bottomlevel.QuestgroupshierarchypathAgent.html +++ /dev/null @@ -1,1971 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\bottomlevelQuestgroupshierarchypathAgent

-

Agent to display the Questgroups hierarchy path.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.bottomlevel.SeminarybarAgent.html b/doc/classes/hhu.z.agents.bottomlevel.SeminarybarAgent.html deleted file mode 100644 index 46cc35f9..00000000 --- a/doc/classes/hhu.z.agents.bottomlevel.SeminarybarAgent.html +++ /dev/null @@ -1,1971 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\bottomlevelSeminarybarAgent

-

Agent to display a sidebar with Seminary related information.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.bottomlevel.SeminarymenuAgent.html b/doc/classes/hhu.z.agents.bottomlevel.SeminarymenuAgent.html deleted file mode 100644 index 4bd07065..00000000 --- a/doc/classes/hhu.z.agents.bottomlevel.SeminarymenuAgent.html +++ /dev/null @@ -1,1971 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\bottomlevelSeminarymenuAgent

-

Agent to display a menu with Seminary related links.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.bottomlevel.UserrolesAgent.html b/doc/classes/hhu.z.agents.bottomlevel.UserrolesAgent.html deleted file mode 100644 index 74030f3e..00000000 --- a/doc/classes/hhu.z.agents.bottomlevel.UserrolesAgent.html +++ /dev/null @@ -1,1971 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\bottomlevelUserrolesAgent

-

Agent to display and manage userroles.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- load()
- factory()
- run()
- render()
- user()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

user()

- - 
user(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: user.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.AchievementsAgent.html b/doc/classes/hhu.z.agents.intermediate.AchievementsAgent.html deleted file mode 100644 index e3f78376..00000000 --- a/doc/classes/hhu.z.agents.intermediate.AchievementsAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateAchievementsAgent

-

Agent to list Achievements.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.CharactergroupsAgent.html b/doc/classes/hhu.z.agents.intermediate.CharactergroupsAgent.html deleted file mode 100644 index 7c43eaec..00000000 --- a/doc/classes/hhu.z.agents.intermediate.CharactergroupsAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateCharactergroupsAgent

-

Agent to display Character groups.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.CharactergroupsquestsAgent.html b/doc/classes/hhu.z.agents.intermediate.CharactergroupsquestsAgent.html deleted file mode 100644 index d42a9971..00000000 --- a/doc/classes/hhu.z.agents.intermediate.CharactergroupsquestsAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateCharactergroupsquestsAgent

-

Agent to display Character groups Quests.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.CharactersAgent.html b/doc/classes/hhu.z.agents.intermediate.CharactersAgent.html deleted file mode 100644 index 2d3e3f9a..00000000 --- a/doc/classes/hhu.z.agents.intermediate.CharactersAgent.html +++ /dev/null @@ -1,2052 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateCharactersAgent

-

Agent to list registered Characters and their data.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
- character()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

character()

- - 
character(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: character.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.CharactertypesAgent.html b/doc/classes/hhu.z.agents.intermediate.CharactertypesAgent.html deleted file mode 100644 index c3b552ff..00000000 --- a/doc/classes/hhu.z.agents.intermediate.CharactertypesAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateCharactertypesAgent

-

Agent to handle Charactertyes of a Seminary.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.ErrorAgent.html b/doc/classes/hhu.z.agents.intermediate.ErrorAgent.html deleted file mode 100644 index b63ed165..00000000 --- a/doc/classes/hhu.z.agents.intermediate.ErrorAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateErrorAgent

-

Agent to show an error page.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.IntroductionAgent.html b/doc/classes/hhu.z.agents.intermediate.IntroductionAgent.html deleted file mode 100644 index 5fa8154d..00000000 --- a/doc/classes/hhu.z.agents.intermediate.IntroductionAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateIntroductionAgent

-

Agent to show an introduction page.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.LibraryAgent.html b/doc/classes/hhu.z.agents.intermediate.LibraryAgent.html deleted file mode 100644 index 5197a5b2..00000000 --- a/doc/classes/hhu.z.agents.intermediate.LibraryAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateLibraryAgent

-

Agent to list Quest topics.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.MailAgent.html b/doc/classes/hhu.z.agents.intermediate.MailAgent.html deleted file mode 100644 index 475e1b34..00000000 --- a/doc/classes/hhu.z.agents.intermediate.MailAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateMailAgent

-

Agent to generate a mail-message.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.MediaAgent.html b/doc/classes/hhu.z.agents.intermediate.MediaAgent.html deleted file mode 100644 index eb726f1f..00000000 --- a/doc/classes/hhu.z.agents.intermediate.MediaAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateMediaAgent

-

Agent to process and show media.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.QuestgroupsAgent.html b/doc/classes/hhu.z.agents.intermediate.QuestgroupsAgent.html deleted file mode 100644 index dd07c9b0..00000000 --- a/doc/classes/hhu.z.agents.intermediate.QuestgroupsAgent.html +++ /dev/null @@ -1,2132 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateQuestgroupsAgent

-

Agent to display Questgroups.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- questgroup()
- edit()
- edittexts()
- delete()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

questgroup()

- - 
questgroup(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: questgroup.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

edit()

- - 
edit(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: edit.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

edittexts()

- - 
edittexts(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: edittexts.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

delete()

- - 
delete(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: delete.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.QuestgroupshierarchyAgent.html b/doc/classes/hhu.z.agents.intermediate.QuestgroupshierarchyAgent.html deleted file mode 100644 index 52aaebe7..00000000 --- a/doc/classes/hhu.z.agents.intermediate.QuestgroupshierarchyAgent.html +++ /dev/null @@ -1,1972 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateQuestgroupshierarchyAgent

-

Agent to manage Questgroupshierarchy.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.QuestsAgent.html b/doc/classes/hhu.z.agents.intermediate.QuestsAgent.html deleted file mode 100644 index 4a35e7d0..00000000 --- a/doc/classes/hhu.z.agents.intermediate.QuestsAgent.html +++ /dev/null @@ -1,2292 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateQuestsAgent

-

Agent to display Quests.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- quest()
- submissions()
- submission()
- create()
- edit()
- edittask()
- edittexts()
- delete()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

quest()

- - 
quest(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: quest.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

submissions()

- - 
submissions(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: submissions.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

submission()

- - 
submission(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: submission.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

create()

- - 
create(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: create.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

edit()

- - 
edit(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: edit.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

edittask()

- - 
edittask(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: edittask.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

edittexts()

- - 
edittexts(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: edittexts.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

delete()

- - 
delete(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: delete.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.SeminariesAgent.html b/doc/classes/hhu.z.agents.intermediate.SeminariesAgent.html deleted file mode 100644 index 982aa1bc..00000000 --- a/doc/classes/hhu.z.agents.intermediate.SeminariesAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateSeminariesAgent

-

Agent to list registered seminaries.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.UploadsAgent.html b/doc/classes/hhu.z.agents.intermediate.UploadsAgent.html deleted file mode 100644 index 7f659e3d..00000000 --- a/doc/classes/hhu.z.agents.intermediate.UploadsAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateUploadsAgent

-

Agent to process and show user uploads.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.UsersAgent.html b/doc/classes/hhu.z.agents.intermediate.UsersAgent.html deleted file mode 100644 index 5956ebc9..00000000 --- a/doc/classes/hhu.z.agents.intermediate.UsersAgent.html +++ /dev/null @@ -1,2052 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateUsersAgent

-

Agent to list registered users and their data.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
- user()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

user()

- - 
user(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: user.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.intermediate.XplevelsAgent.html b/doc/classes/hhu.z.agents.intermediate.XplevelsAgent.html deleted file mode 100644 index af563136..00000000 --- a/doc/classes/hhu.z.agents.intermediate.XplevelsAgent.html +++ /dev/null @@ -1,2012 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\intermediateXplevelsAgent

-

Agent to handle XP-levels of a Seminary.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- getLayout()
- load()
- factory()
- run()
- render()
- index()
-
-
- $controller
-
-
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- actionConstruct()
- loadController()
- log()
- addSubAgent()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
-
-
- $request
- $response
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

getLayout()

- - 
getLayout(string  $agentName) : string
-

Get the layout if it was explicitly defined.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- - -

Returns

- string - —

Layout of the IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new Agent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.toplevel.AjaxAgent.html b/doc/classes/hhu.z.agents.toplevel.AjaxAgent.html deleted file mode 100644 index 90bf6f5f..00000000 --- a/doc/classes/hhu.z.agents.toplevel.AjaxAgent.html +++ /dev/null @@ -1,2340 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - Questlab - -
- -
-
-
- - - -
- -
-
-
-
-
-
- - \ -
-
-
- -
-
-
- - hhu -
-
-
- -
-
-
- - z -
-
-
- -
-
-
- - agents -
-
-
- -
-
-
- - bottomlevel -
-
-
- - - -
-
-
-
- -
-
-
- - intermediate -
-
-
- - - -
-
-
-
- -
-
-
- - toplevel -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - controllers -
-
-
- -
-
-
- - components -
-
-
- - - -
-
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - lib -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - questtypes -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- -
-
-
- - views -
-
-
- - - -
-
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- -
-
-
- - nre -
-
-
- -
-
-
- - agents -
-
-
- - - -
-
-
-
- -
-
-
- - apis -
-
-
- - - -
-
-
-
- -
-
-
- - configs -
-
-
- - - -
-
-
-
- -
-
-
- - core -
-
-
- - - -
-
-
-
- -
-
-
- - drivers -
-
-
- - - -
-
-
-
- -
-
-
- - exceptions -
-
-
- - - -
-
-
-
- -
-
-
- - models -
-
-
- - - -
-
-
-
- -
-
-
- - requests -
-
-
- - - -
-
-
-
- -
-
-
- - responses -
-
-
- - - -
-
-
-
- - -
    -
-
-
-
-
- - - -
-
-
-
- -
-
-
-
-
-
- - - -

\hhu\z\agents\toplevelAjaxAgent

-

Agent to return a JSON-string used by AJAX.

- - - -
-

Summary

-
-
- Methods -
-
- Properties -
-
- Constants -
-
-
-
- run()
- render()
- getIntermediateAgent()
- load()
- factory()
- index()
-
-
- $controller
-
-
- STAGE_LOAD
- STAGE_RUN
- INLINEERROR_AGENT
-
-
-
-
- __construct()
- addSubAgent()
- actionConstruct()
- loadController()
- log()
- _addSubAgent()
-
-
- $log
- $subAgents
-
-
- N/A -
-
-
-
- loadIntermediateAgent()
- _loadIntermediateAgent()
- _run()
- runIntermediateAgent()
- error()
- getAgentType()
- getClassName()
- newSubAgent()
- renderSubAgent()
- errorInline()
- newInlineError()
- newInlineErrorService()
- setLanguage()
-
-
- $request
- $response
- $layout
- $intermediateAgent
-
-
- N/A -
-
-
-
- -
- - -
-
-

Constants

-
- -
- -
-
- -
-

STAGE_LOAD

- 
STAGE_LOAD
-

Stage: Load

- -
-
- -
- -
-
- -
-

STAGE_RUN

- 
STAGE_RUN
-

Stage: Run

- -
-
- -
- -
-
- -
-

INLINEERROR_AGENT

- 
INLINEERROR_AGENT
-

Name of BottomlevelAgent for showing inline errors

- -
-
- -
- - - -
-
-

Properties

-
- -
- -
-
- -
-

$controller

- 
$controller : \nre\core\Controller
-

Controller of this Agent

- - -

Type

- \nre\core\Controller -
-
- -
- -
-
- - -
- -
- -
-
- -
-

$subAgents

- 
$subAgents : array
-

SubAgents

- - -

Type

- array -
-
- -
- -
-
- -
-

$request

- 
$request : \nre\core\Request
-

Current request

- - -

Type

- \nre\core\Request -
-
- -
- -
-
- -
-

$response

- 
$response : \nre\core\Response
-

Current response

- - -

Type

- \nre\core\Response -
-
- -
- -
-
- -
-

$layout

- 
$layout : \nre\core\Layout
-

Layout instace

- - -

Type

- \nre\core\Layout -
-
- -
- -
-
- -
-

$intermediateAgent

- 
$intermediateAgent : \nre\agents\IntermediateAgent
-

IntermediateAgent instance

- - -

Type

- \nre\agents\IntermediateAgent -
-
- -
- - - -
-

Methods

- -
- -
-
- -
-

run()

- - 
run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\ActionNotFoundException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

render()

- - 
render(array  $data = array()) : string
-

Generate output of the Controller of this Agent and its -SubAgents.

- - -

Parameters

- - - - - - -
array$data

View data

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

getIntermediateAgent()

- - 
getIntermediateAgent() : \nre\agents\IntermediateAgent
-

Return the IntermediateAgent.

- - - - -

Returns

- \nre\agents\IntermediateAgent - —

IntermediateAgent

- -
-
- -
- -
-
- -
-

load()

- - 
load(string  $agentName)
-

Load the class of an Agent.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

factory()

- - 
factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Instantiate an Agent (Factory Pattern).

- - -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string$agentName

Name of the Agent to instantiate

\nre\core\Request$request

Current request

\nre\core\Response$response
\nre\core\Logger$log

Log-system

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

index()

- - 
index(\nre\core\Request  $request, \nre\core\Response  $response)
-

Action: index.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- - - -
-
- -
- -
-
- -
-

__construct()

- - 
__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)
-

Construct a new AjaxAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

\nre\core\Logger$log

Logger instance

- - - -
-
- -
- -
-
- -
-

addSubAgent()

- - 
addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

actionConstruct()

- - 
actionConstruct()
-

Construct SubAgents (per Action).

- - - - - -
-
- -
- -
-
- -
-

loadController()

- - 
loadController()
-

Load the Controller of this Agent.

- - - -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\DriverNotValidException
-
-
\nre\exceptions\DriverNotFoundException
-
-
\nre\exceptions\ViewNotFoundException
-
-
\nre\exceptions\ModelNotValidException
-
-
\nre\exceptions\ModelNotFoundException
-
-
\nre\exceptions\ControllerNotValidException
-
-
\nre\exceptions\ControllerNotFoundException
-
-
- - -
-
- -
- -
-
- -
-

log()

- - 
log(\Exception  $exception, integer  $logMode)
-

Log an error.

- - -

Parameters

- - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$logMode

Log mode

- - - -
-
- -
- -
-
- -
-

_addSubAgent()

- - 
_addSubAgent(string  $agentName)
-

Load a SubAgent and add it.

- - -

Parameters

- - - - - - -
string$agentName

Name of the Agent to load

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
\nre\exceptions\AgentNotFoundException
-
-
\nre\exceptions\AgentNotValidException
-
-
- - -
-
- -
- -
-
- -
-

loadIntermediateAgent()

- - 
loadIntermediateAgent()
-

Load IntermediateAgent defined by the current request.

- - - -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
- - -
-
- -
- -
-
- -
-

_loadIntermediateAgent()

- - 
_loadIntermediateAgent()
-

Load IntermediateAgent defined by the current request.

- - - -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
- - -
-
- -
- -
-
- -
-

_run()

- - 
_run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception
-

Run the Controller of this Agent and its SubAgents.

- - -

Parameters

- - - - - - - - - - - -
\nre\core\Request$request

Current request

\nre\core\Response$response

Current response

- -

Throws

-
-
\nre\exceptions\AccessDeniedException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- \Exception - —

Last occurred exception of SubAgents

- -
-
- -
- -
-
- -
-

runIntermediateAgent()

- - 
runIntermediateAgent()
-

Run IntermediateAgent.

- - - -

Throws

-
-
\nre\exceptions\AccessDeniedException
-
-
\nre\exceptions\ParamsNotValidException
-
-
\nre\exceptions\IdNotFoundException
-
-
\nre\exceptions\ServiceUnavailableException
-
-
\nre\exceptions\DatamodelException
-
-
- - -
-
- -
- -
-
- -
-

error()

- - 
error(\Exception  $exception, integer  $httpStatusCode, string  $stage = self::STAGE_LOAD)
-

Handle an error that occurred during -loading/cnostructing/running of the IntermediateAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
\Exception$exception

Occurred exception

integer$httpStatusCode

HTTP-statuscode

string$stage

Stage of execution

- -

Throws

-
-
\nre\exceptions\ServiceUnavailableException
-
-
- - -
-
- -
- -
-
- -
-

getAgentType()

- - 
getAgentType() : string
-

Determine the type of an Agent.

- - - - -

Returns

- string - —

Agent type

- -
-
- -
- -
-
- -
-

getClassName()

- - 
getClassName(string  $agentName, string  $agentType) : string
-

Determine the classname for the given Agent name.

- - -

Parameters

- - - - - - - - - - - -
string$agentName

Agent name to get classname of

string$agentType

Agent type of given Agent name

- - -

Returns

- string - —

Classname for the Agent name

- -
-
- -
- -
-
- -
-

newSubAgent()

- - 
newSubAgent(string  $agentName) : array
-

Create a new SubAgent.

- - -

Parameters

- - - - - - -
string$agentName

Agent name

- -

Throws

-
-
\nre\exceptions\DatamodelException
-
-
- -

Returns

- array - —

SubAgent

- -
-
- -
- -
-
- -
-

renderSubAgent()

- - 
renderSubAgent(array  $subAgent) : string
-

Render a SubAgent.

- - -

Parameters

- - - - - - -
array$subAgent

SubAgent to render

- - -

Returns

- string - —

Generated output

- -
-
- -
- -
-
- -
-

errorInline()

- - 
errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array
-

Handle the exception of a SubAgent.

- - -

Parameters

- - - - - - - - - - - - - - - - -
array$subAgent

Original (Sub-) Agent

\nre\core\Request$request

Current request

\nre\core\Excepiton$exception

Occurred exception

- - -

Returns

- array - —

InlineError-SubAgent

- -
-
- -
- -
-
- -
-

newInlineError()

- - 
newInlineError(string  $label, \Exception  $exception)
-

Create a new InlineError.

- - -

Parameters

- - - - - - - - - - - -
string$label

Name of the original Agent

\Exception$exception

Occurred exception

- - - -
-
- -
- -
-
- -
-

newInlineErrorService()

- - 
newInlineErrorService()
-

Handle a hardcore error that could not be handled by the -system.

- - - - - -
-
- -
- -
-
- -
-

setLanguage()

- - 
setLanguage(\nre\core\Request  $request)
-

Set requested language.

- - -

Parameters

- - - - - - -
\nre\core\Request$request

Current request

- - - -
-
- -
- -
-
- - - - -
- - - diff --git a/doc/classes/hhu.z.agents.toplevel.BinaryAgent.html b/doc/classes/hhu.z.agents.toplevel.BinaryAgent.html deleted file mode 100644 index 1c841868..00000000 --- a/doc/classes/hhu.z.agents.toplevel.BinaryAgent.html +++ /dev/null @@ -1,2305 +0,0 @@ - - - - - - Questlab - - - - - - - - - - - - - - - - - - - -