From c753288cf861d6f8ed8b52733f7d204db1f0f962 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 6 Oct 2023 17:27:14 +0000 Subject: [PATCH] Deploy docs from c17c9804fd2cd2bc2accbeb8bc6adbe6320b78ba Tom Udding: Merge pull request #1727 from JortvD/feature/education-similar Add similar courses in course page Co-authored-by: tomudding --- .../Education-Controller-AdminController.html | 58 +-- ...cation-Controller-EducationController.html | 22 +- classes/Education-Form-Course.html | 158 +++++- classes/Education-Model-Course.html | 292 ++++++++++- ...xam.html => Education-Service-Course.html} | 465 +++++++++++------- classes/Education-View-Helper-ExamUrl.html | 126 ++--- ... module-education-src-service-course.html} | 14 +- indices/files.html | 2 +- js/searchIndex.js | 241 +++++---- namespaces/education-service.html | 2 +- packages/gewisweb.html | 2 +- reports/markers.html | 6 +- 12 files changed, 964 insertions(+), 424 deletions(-) rename classes/{Education-Service-Exam.html => Education-Service-Course.html} (81%) rename files/{module-education-src-service-exam.html => module-education-src-service-course.html} (96%) diff --git a/classes/Education-Controller-AdminController.html b/classes/Education-Controller-AdminController.html index 6cb9e54168..ccb00e7dfa 100644 --- a/classes/Education-Controller-AdminController.html +++ b/classes/Education-Controller-AdminController.html @@ -452,15 +452,15 @@

- $educationTempConfig + $courseService -  : array<string|int, mixed> +  : Course
- $examService + $educationTempConfig -  : Exam +  : array<string|int, mixed>
@@ -617,9 +617,9 @@

-private -read-only " > -

- $educationTempConfig - +

+ $courseService + read-only @@ -627,15 +627,15 @@

private - array<string|int, mixed> - $educationTempConfig + Course + $courseService @@ -650,9 +650,9 @@

-private -read-only " > -

- $examService - +

+ $educationTempConfig + read-only @@ -660,15 +660,15 @@

private - Exam - $examService + array<string|int, mixed> + $educationTempConfig @@ -738,7 +738,7 @@

public - __construct(AclService $aclService, Translator $translator, Exam $examService, array<string|int, mixed> $educationTempConfig) : mixed + __construct(AclService $aclService, Translator $translator, Course $courseService, array<string|int, mixed> $educationTempConfig) : mixed
@@ -760,8 +760,8 @@

Parameters
- $examService - : Exam + $courseService + : Course
@@ -844,7 +844,7 @@

@@ -879,7 +879,7 @@

@@ -949,7 +949,7 @@

@@ -984,7 +984,7 @@

@@ -1019,7 +1019,7 @@

@@ -1054,7 +1054,7 @@

@@ -1089,7 +1089,7 @@

@@ -1124,7 +1124,7 @@

@@ -1160,7 +1160,7 @@

@@ -1366,8 +1366,8 @@

Return values
  • diff --git a/classes/Education-Controller-EducationController.html b/classes/Education-Controller-EducationController.html index 0c4db8cce5..6e6daf4f54 100644 --- a/classes/Education-Controller-EducationController.html +++ b/classes/Education-Controller-EducationController.html @@ -446,9 +446,9 @@

    - $examService + $courseService -  : Exam +  : Course
    @@ -511,9 +511,9 @@

    -private -read-only " > -

    - $examService - +

    + $courseService + read-only @@ -528,8 +528,8 @@

    private - Exam - $examService + Course + $courseService @@ -599,7 +599,7 @@

    public - __construct(Exam $examService, SearchCourse $searchCourseForm) : mixed + __construct(Course $courseService, SearchCourse $searchCourseForm) : mixed
    @@ -607,8 +607,8 @@

    Parameters
    - $examService - : Exam + $courseService + : Course
    @@ -845,7 +845,7 @@
    Return values
  • Properties
  • diff --git a/classes/Education-Form-Course.html b/classes/Education-Form-Course.html index 3cbe1ae7d0..2dc6d1553b 100644 --- a/classes/Education-Form-Course.html +++ b/classes/Education-Form-Course.html @@ -418,7 +418,7 @@

    @@ -487,6 +487,13 @@

     : mixed

    +
    + areSimilarValid() + +  : bool +
    +
    Check if the similar courses are valid.
    +
    getInputFilterSpecification() @@ -498,6 +505,14 @@

     : bool

    +
    Check if a course code is unique.
    + +
    + isSimilarValid() + +  : bool +
    +
    Check if a similar course is valid.
    setCurrentCode() @@ -537,7 +552,7 @@

    @@ -570,7 +585,7 @@

    @@ -603,7 +618,7 @@

    @@ -641,7 +656,7 @@

    @@ -674,6 +689,75 @@

    Parameters
    + +
    +

    + areSimilarValid() + + +

    + + +

    Check if the similar courses are valid.

    + + + public + areSimilarValid(string $similar[, array<string|int, mixed> $context = [] ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $similar + : string +
    +
    + +
    +
    + $context + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + phpcsSuppress +
    +
    + +

    SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

    +
    + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -724,11 +808,12 @@

    - +

    Check if a course code is unique.

    + public isCourseCodeUnique(string $code) : bool @@ -749,6 +834,59 @@

    Parameters
    +
    +
    Return values
    + bool +
    + +
    +
    +

    + isSimilarValid() + + +

    + + +

    Check if a similar course is valid.

    + + + public + isSimilarValid(string $similar, string $code) : bool + +
    +
    + +
    Parameters
    +
    +
    + $similar + : string +
    +
    + +
    +
    + $code + : string +
    +
    + +
    +
    + + +
    Return values
    bool @@ -769,7 +907,7 @@

    @@ -920,8 +1058,10 @@

    Parameters
  • diff --git a/classes/Education-Model-Course.html b/classes/Education-Model-Course.html index baa37a6f86..d8b1167002 100644 --- a/classes/Education-Model-Course.html +++ b/classes/Education-Model-Course.html @@ -415,7 +415,7 @@

    @@ -474,6 +474,20 @@

    Course name.
    +
    + $similarCoursesFrom + +  : Collection<string|int, Course> +
    +
    Courses that say they are similar to this course
    + +
    + $similarCoursesTo + +  : Collection<string|int, Course> +
    +
    Courses similar to this course
    +

    @@ -488,6 +502,20 @@

     : mixed +
    + addSimilarCourseTo() + +  : void +
    +
    Adds a course to the similar courses to list if it doesn't yet exist.
    + +
    + clearSimilarCoursesTo() + +  : void +
    +
    Removes all references to similar courses to this course.
    +
    getCode() @@ -516,6 +544,20 @@

    Get the resource ID.
    +
    + getSimilarCoursesAsString() + +  : string +
    +
    Get the similar courses to this course as a comma separated string.
    + +
    + getSimilarCoursesTo() + +  : Collection<string|int, Course> +
    +
    Get the similar courses to this course.
    +
    setCode() @@ -533,7 +575,7 @@

    toArray() -  : array{code: string, name: string} +  : array{code: string, name: string, similar: string}
    @@ -567,7 +609,7 @@

    @@ -601,7 +643,7 @@

    @@ -637,7 +679,7 @@

    @@ -653,6 +695,74 @@

    + +
    +

    + $similarCoursesFrom + + + + +

    + + +

    Courses that say they are similar to this course

    + + + protected + Collection<string|int, Course> + $similarCoursesFrom + + + + + + +
    +
    +

    + $similarCoursesTo + + + + +

    + + +

    Courses similar to this course

    + + + private + Collection<string|int, Course> + $similarCoursesTo + + + + + +
    @@ -676,7 +786,7 @@

    @@ -692,6 +802,80 @@

    + +
    +

    + addSimilarCourseTo() + + +

    + + +

    Adds a course to the similar courses to list if it doesn't yet exist.

    + + + public + addSimilarCourseTo(self $course) : void + +
    +
    + +
    Parameters
    +
    +
    + $course + : self +
    +
    + +
    +
    + + + + +
    +
    +

    + clearSimilarCoursesTo() + + +

    + + +

    Removes all references to similar courses to this course.

    + + + public + clearSimilarCoursesTo() : void + +
    +
    + + + + +
    @@ -743,7 +927,7 @@

    @@ -779,7 +963,7 @@

    @@ -815,7 +999,7 @@

    @@ -836,6 +1020,78 @@

    Return values
    string +
    +
    +

    + getSimilarCoursesAsString() + + +

    + + +

    Get the similar courses to this course as a comma separated string.

    + + + public + getSimilarCoursesAsString() : string + +
    +
    + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getSimilarCoursesTo() + + +

    + + +

    Get the similar courses to this course.

    + + + public + getSimilarCoursesTo() : Collection<string|int, Course> + +
    +
    + + + + +
    +
    Return values
    + Collection<string|int, Course> +
    +
    @@ -893,7 +1149,7 @@

    @@ -935,14 +1191,14 @@

    public - toArray() : array{code: string, name: string} + toArray() : array{code: string, name: string, similar: string}
    @@ -952,7 +1208,7 @@

    Return values
    - array{code: string, name: string} + array{code: string, name: string, similar: string}

    @@ -1072,6 +1328,8 @@

    Return values
  • $code
  • $documents
  • $name
  • +
  • $similarCoursesFrom
  • +
  • $similarCoursesTo
  • @@ -1079,10 +1337,14 @@
    Return values
  • @@ -2755,7 +2848,7 @@

    Search results

    - + diff --git a/classes/Education-View-Helper-ExamUrl.html b/classes/Education-View-Helper-ExamUrl.html index 3d4711b1f9..e9f2300ce9 100644 --- a/classes/Education-View-Helper-ExamUrl.html +++ b/classes/Education-View-Helper-ExamUrl.html @@ -447,18 +447,18 @@

    - $dir + $courseService -  : string +  : Course
    -
    Education data dir.
    +
    Course service.
    - $examService + $dir -  : Exam +  : string
    -
    Exam service.
    +
    Education data dir.
    @@ -476,32 +476,32 @@

    Get the exam URL.
    - getDir() + getCourseService() -  : string +  : Course
    -
    Get the data dir.
    +
    Get the course service.
    - getExamService() + getDir() -  : Exam +  : string
    -
    Get the authentication service.
    +
    Get the data dir.
    - setDir() + setCourseService()  : void
    -
    Set the data dir.
    +
    Set the course service.
    - setExamService() + setDir()  : void
    -
    Set the authentication service.
    +
    Set the data dir.
    @@ -524,9 +524,9 @@

    -protected " > -

    - $dir - +

    + $courseService + @@ -534,16 +534,16 @@

    -

    Education data dir.

    +

    Course service.

    protected - string - $dir + Course + $courseService @@ -558,9 +558,9 @@

    -protected " > -

    - $examService - +

    + $dir + @@ -568,16 +568,16 @@

    -

    Exam service.

    +

    Education data dir.

    protected - Exam - $examService + string + $dir @@ -645,23 +645,23 @@

    Return values
    -public " > -

    - getDir() - +

    + getCourseService() +

    -

    Get the data dir.

    +

    Get the course service.

    public - getDir() : string + getCourseService() : Course
    @@ -671,7 +671,7 @@

    Return values
    - string + Course
    @@ -681,23 +681,23 @@

    Return values
    -public " > -

    - getExamService() - +

    + getDir() +

    -

    Get the authentication service.

    +

    Get the data dir.

    public - getExamService() : Exam + getDir() : string
    @@ -707,7 +707,7 @@

    Return values
    - Exam + string
    @@ -717,23 +717,23 @@

    Return values
    -public " > -

    - setDir() - +

    + setCourseService() +

    -

    Set the data dir.

    +

    Set the course service.

    public - setDir(string $dir) : void + setCourseService(Course $courseService) : void
    @@ -741,8 +741,8 @@

    Parameters
    - $dir - : string + $courseService + : Course
    @@ -759,23 +759,23 @@
    Parameters
    -public " > -

    - setExamService() - +

    + setDir() +

    -

    Set the authentication service.

    +

    Set the data dir.

    public - setExamService(Exam $examService) : void + setDir(string $dir) : void
    @@ -783,8 +783,8 @@

    Parameters
    - $examService - : Exam + $dir + : string
    @@ -908,8 +908,8 @@
    Parameters
  • Properties
  • @@ -917,10 +917,10 @@
    Parameters
  • diff --git a/files/module-education-src-service-exam.html b/files/module-education-src-service-course.html similarity index 96% rename from files/module-education-src-service-exam.html rename to files/module-education-src-service-course.html index 8c301b57a6..8b5adc9de4 100644 --- a/files/module-education-src-service-exam.html +++ b/files/module-education-src-service-course.html @@ -388,7 +388,7 @@

    Fil

    @@ -429,7 +429,7 @@

    -
    
    +            
    
             
    @@ -528,7 +528,7 @@

  • Table Of Contents
  • @@ -550,7 +550,7 @@

    Search results

    - + diff --git a/indices/files.html b/indices/files.html index 8b16f80de6..1078239d5f 100644 --- a/indices/files.html +++ b/indices/files.html @@ -542,6 +542,7 @@

    C

  • Course.php
  • Course.php
  • Course.php
  • +
  • Course.php
  • CourseDocument.php
  • CourseDocument.php
  • CreateAlbum.php
  • @@ -569,7 +570,6 @@

    E

  • Email.php
  • Exam.php
  • Exam.php
  • -
  • Exam.php
  • ExamTypeHydratorStrategy.php
  • ExamTypes.php
  • ExamUrl.php
  • diff --git a/js/searchIndex.js b/js/searchIndex.js index ae93dc0702..b4465b2a84 100644 --- a/js/searchIndex.js +++ b/js/searchIndex.js @@ -10741,10 +10741,10 @@ Search.appendIndex( "summary": "", "url": "classes/Education-Controller-AdminController.html#property_translator" }, { - "fqsen": "\\Education\\Controller\\AdminController\u003A\u003A\u0024examService", - "name": "examService", + "fqsen": "\\Education\\Controller\\AdminController\u003A\u003A\u0024courseService", + "name": "courseService", "summary": "", - "url": "classes/Education-Controller-AdminController.html#property_examService" + "url": "classes/Education-Controller-AdminController.html#property_courseService" }, { "fqsen": "\\Education\\Controller\\AdminController\u003A\u003A\u0024educationTempConfig", "name": "educationTempConfig", @@ -10776,10 +10776,10 @@ Search.appendIndex( "summary": "Download\u0020an\u0020exam.", "url": "classes/Education-Controller-EducationController.html#method_downloadAction" }, { - "fqsen": "\\Education\\Controller\\EducationController\u003A\u003A\u0024examService", - "name": "examService", + "fqsen": "\\Education\\Controller\\EducationController\u003A\u003A\u0024courseService", + "name": "courseService", "summary": "", - "url": "classes/Education-Controller-EducationController.html#property_examService" + "url": "classes/Education-Controller-EducationController.html#property_courseService" }, { "fqsen": "\\Education\\Controller\\EducationController\u003A\u003A\u0024searchCourseForm", "name": "searchCourseForm", @@ -10858,8 +10858,18 @@ Search.appendIndex( }, { "fqsen": "\\Education\\Form\\Course\u003A\u003AisCourseCodeUnique\u0028\u0029", "name": "isCourseCodeUnique", - "summary": "", + "summary": "Check\u0020if\u0020a\u0020course\u0020code\u0020is\u0020unique.", "url": "classes/Education-Form-Course.html#method_isCourseCodeUnique" + }, { + "fqsen": "\\Education\\Form\\Course\u003A\u003AareSimilarValid\u0028\u0029", + "name": "areSimilarValid", + "summary": "Check\u0020if\u0020the\u0020similar\u0020courses\u0020are\u0020valid.", + "url": "classes/Education-Form-Course.html#method_areSimilarValid" + }, { + "fqsen": "\\Education\\Form\\Course\u003A\u003AisSimilarValid\u0028\u0029", + "name": "isSimilarValid", + "summary": "Check\u0020if\u0020a\u0020similar\u0020course\u0020is\u0020valid.", + "url": "classes/Education-Form-Course.html#method_isSimilarValid" }, { "fqsen": "\\Education\\Form\\Course\u003A\u003A\u0024currentCode", "name": "currentCode", @@ -11055,6 +11065,26 @@ Search.appendIndex( "name": "toArray", "summary": "", "url": "classes/Education-Model-Course.html#method_toArray" + }, { + "fqsen": "\\Education\\Model\\Course\u003A\u003AgetSimilarCoursesAsString\u0028\u0029", + "name": "getSimilarCoursesAsString", + "summary": "Get\u0020the\u0020similar\u0020courses\u0020to\u0020this\u0020course\u0020as\u0020a\u0020comma\u0020separated\u0020string.", + "url": "classes/Education-Model-Course.html#method_getSimilarCoursesAsString" + }, { + "fqsen": "\\Education\\Model\\Course\u003A\u003AgetSimilarCoursesTo\u0028\u0029", + "name": "getSimilarCoursesTo", + "summary": "Get\u0020the\u0020similar\u0020courses\u0020to\u0020this\u0020course.", + "url": "classes/Education-Model-Course.html#method_getSimilarCoursesTo" + }, { + "fqsen": "\\Education\\Model\\Course\u003A\u003AaddSimilarCourseTo\u0028\u0029", + "name": "addSimilarCourseTo", + "summary": "Adds\u0020a\u0020course\u0020to\u0020the\u0020similar\u0020courses\u0020to\u0020list\u0020if\u0020it\u0020doesn\u0027t\u0020yet\u0020exist.", + "url": "classes/Education-Model-Course.html#method_addSimilarCourseTo" + }, { + "fqsen": "\\Education\\Model\\Course\u003A\u003AclearSimilarCoursesTo\u0028\u0029", + "name": "clearSimilarCoursesTo", + "summary": "Removes\u0020all\u0020references\u0020to\u0020similar\u0020courses\u0020to\u0020this\u0020course.", + "url": "classes/Education-Model-Course.html#method_clearSimilarCoursesTo" }, { "fqsen": "\\Education\\Model\\Course\u003A\u003AgetResourceId\u0028\u0029", "name": "getResourceId", @@ -11075,6 +11105,16 @@ Search.appendIndex( "name": "documents", "summary": "Exams\u0020\u0028and\u0020summaries\u0029\u0020in\u0020this\u0020course.", "url": "classes/Education-Model-Course.html#property_documents" + }, { + "fqsen": "\\Education\\Model\\Course\u003A\u003A\u0024similarCoursesFrom", + "name": "similarCoursesFrom", + "summary": "Courses\u0020that\u0020say\u0020they\u0020are\u0020similar\u0020to\u0020this\u0020course", + "url": "classes/Education-Model-Course.html#property_similarCoursesFrom" + }, { + "fqsen": "\\Education\\Model\\Course\u003A\u003A\u0024similarCoursesTo", + "name": "similarCoursesTo", + "summary": "Courses\u0020similar\u0020to\u0020this\u0020course", + "url": "classes/Education-Model-Course.html#property_similarCoursesTo" }, { "fqsen": "\\Education\\Model\\CourseDocument", "name": "CourseDocument", @@ -11266,195 +11306,200 @@ Search.appendIndex( "summary": "", "url": "classes/Education-Service-AclService.html#method_createAcl" }, { - "fqsen": "\\Education\\Service\\Exam", - "name": "Exam", - "summary": "Exam\u0020service.", - "url": "classes/Education-Service-Exam.html" + "fqsen": "\\Education\\Service\\Course", + "name": "Course", + "summary": "Course\u0020service.", + "url": "classes/Education-Service-Course.html" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A__construct\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003A__construct\u0028\u0029", "name": "__construct", "summary": "", - "url": "classes/Education-Service-Exam.html#method___construct" + "url": "classes/Education-Service-Course.html#method___construct" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AsearchCourse\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AsearchCourse\u0028\u0029", "name": "searchCourse", "summary": "Search\u0020for\u0020a\u0020course.", - "url": "classes/Education-Service-Exam.html#method_searchCourse" + "url": "classes/Education-Service-Course.html#method_searchCourse" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetCourse\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetCourse\u0028\u0029", "name": "getCourse", "summary": "Get\u0020a\u0020course.", - "url": "classes/Education-Service-Exam.html#method_getCourse" + "url": "classes/Education-Service-Course.html#method_getCourse" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetDocumentDownload\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetDocumentDownload\u0028\u0029", "name": "getDocumentDownload", "summary": "Get\u0020an\u0020exam.", - "url": "classes/Education-Service-Exam.html#method_getDocumentDownload" + "url": "classes/Education-Service-Course.html#method_getDocumentDownload" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AbulkEdit\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AbulkEdit\u0028\u0029", "name": "bulkEdit", "summary": "Finish\u0020the\u0020bulk\u0020edit.", - "url": "classes/Education-Service-Exam.html#method_bulkEdit" + "url": "classes/Education-Service-Course.html#method_bulkEdit" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AbulkExamEdit\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AbulkExamEdit\u0028\u0029", "name": "bulkExamEdit", "summary": "", - "url": "classes/Education-Service-Exam.html#method_bulkExamEdit" + "url": "classes/Education-Service-Course.html#method_bulkExamEdit" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AbulkSummaryEdit\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AbulkSummaryEdit\u0028\u0029", "name": "bulkSummaryEdit", "summary": "", - "url": "classes/Education-Service-Exam.html#method_bulkSummaryEdit" + "url": "classes/Education-Service-Course.html#method_bulkSummaryEdit" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AtempUpload\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AtempUpload\u0028\u0029", "name": "tempUpload", "summary": "Temporary\u0020exam\u0020upload.", - "url": "classes/Education-Service-Exam.html#method_tempUpload" + "url": "classes/Education-Service-Course.html#method_tempUpload" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AtempExamUpload\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AtempExamUpload\u0028\u0029", "name": "tempExamUpload", "summary": "", - "url": "classes/Education-Service-Exam.html#method_tempExamUpload" + "url": "classes/Education-Service-Course.html#method_tempExamUpload" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AtempSummaryUpload\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AtempSummaryUpload\u0028\u0029", "name": "tempSummaryUpload", "summary": "", - "url": "classes/Education-Service-Exam.html#method_tempSummaryUpload" + "url": "classes/Education-Service-Course.html#method_tempSummaryUpload" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AcourseDocumentToFilename\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AcourseDocumentToFilename\u0028\u0029", "name": "courseDocumentToFilename", "summary": "Get\u0020a\u0020filename\u0020from\u0020an\u0020exam\u0020\u0028or\u0020summary\u0029.", - "url": "classes/Education-Service-Exam.html#method_courseDocumentToFilename" + "url": "classes/Education-Service-Course.html#method_courseDocumentToFilename" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetConfig\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetConfig\u0028\u0029", "name": "getConfig", "summary": "Get\u0020the\u0020education\u0020config,\u0020as\u0020used\u0020by\u0020this\u0020service.", - "url": "classes/Education-Service-Exam.html#method_getConfig" + "url": "classes/Education-Service-Course.html#method_getConfig" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AdeleteTempExam\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AdeleteTempExam\u0028\u0029", "name": "deleteTempExam", "summary": "Deletes\u0020a\u0020temp\u0020uploaded\u0020exam\u0020or\u0020summary.", - "url": "classes/Education-Service-Exam.html#method_deleteTempExam" + "url": "classes/Education-Service-Course.html#method_deleteTempExam" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetBulkForm\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetBulkForm\u0028\u0029", "name": "getBulkForm", "summary": "Get\u0020the\u0020bulk\u0020edit\u0020form.", - "url": "classes/Education-Service-Exam.html#method_getBulkForm" + "url": "classes/Education-Service-Course.html#method_getBulkForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetBulkSummaryForm\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetBulkSummaryForm\u0028\u0029", "name": "getBulkSummaryForm", "summary": "Get\u0020the\u0020bulk\u0020summary\u0020edit\u0020form.", - "url": "classes/Education-Service-Exam.html#method_getBulkSummaryForm" + "url": "classes/Education-Service-Course.html#method_getBulkSummaryForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetBulkExamForm\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetBulkExamForm\u0028\u0029", "name": "getBulkExamForm", "summary": "Get\u0020the\u0020bulk\u0020exam\u0020edit\u0020form.", - "url": "classes/Education-Service-Exam.html#method_getBulkExamForm" + "url": "classes/Education-Service-Course.html#method_getBulkExamForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AguessCourseDocumentData\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AguessCourseDocumentData\u0028\u0029", "name": "guessCourseDocumentData", "summary": "Guesses\u0020the\u0020course\u0020code\u0020and\u0020date\u0020based\u0020on\u0020an\u0020exam\u0027s\u0020filename.", - "url": "classes/Education-Service-Exam.html#method_guessCourseDocumentData" + "url": "classes/Education-Service-Course.html#method_guessCourseDocumentData" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AguessSummaryAuthor\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AguessSummaryAuthor\u0028\u0029", "name": "guessSummaryAuthor", "summary": "Guesses\u0020the\u0020summary\u0020author\u0020based\u0020on\u0020a\u0020summary\u0027s\u0020filename.", - "url": "classes/Education-Service-Exam.html#method_guessSummaryAuthor" + "url": "classes/Education-Service-Course.html#method_guessSummaryAuthor" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetTempUploadForm\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetTempUploadForm\u0028\u0029", "name": "getTempUploadForm", "summary": "Get\u0020the\u0020Temporary\u0020Upload\u0020form.", - "url": "classes/Education-Service-Exam.html#method_getTempUploadForm" + "url": "classes/Education-Service-Course.html#method_getTempUploadForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetCourseForm\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetCourseForm\u0028\u0029", "name": "getCourseForm", "summary": "Get\u0020the\u0020add\u0020course\u0020form.", - "url": "classes/Education-Service-Exam.html#method_getCourseForm" + "url": "classes/Education-Service-Course.html#method_getCourseForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AsaveCourse\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AsaveCourse\u0028\u0029", "name": "saveCourse", - "summary": "Add\u0020a\u0020new\u0020course.", - "url": "classes/Education-Service-Exam.html#method_saveCourse" + "summary": "Save\u0020a\u0020course.", + "url": "classes/Education-Service-Course.html#method_saveCourse" + }, { + "fqsen": "\\Education\\Service\\Course\u003A\u003AupdateCourse\u0028\u0029", + "name": "updateCourse", + "summary": "Update\u0020a\u0020course.", + "url": "classes/Education-Service-Course.html#method_updateCourse" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AdeleteCourse\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AdeleteCourse\u0028\u0029", "name": "deleteCourse", "summary": "Delete\u0020a\u0020course\u0020and\u0020all\u0020its\u0020documents.", - "url": "classes/Education-Service-Exam.html#method_deleteCourse" + "url": "classes/Education-Service-Course.html#method_deleteCourse" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetAllCourses\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetAllCourses\u0028\u0029", "name": "getAllCourses", "summary": "Get\u0020all\u0020courses.", - "url": "classes/Education-Service-Exam.html#method_getAllCourses" + "url": "classes/Education-Service-Course.html#method_getAllCourses" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetDocumentsForCourse\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetDocumentsForCourse\u0028\u0029", "name": "getDocumentsForCourse", "summary": "Get\u0020all\u0020documents\u0020of\u0020a\u0020specific\u0020type\u0020for\u0020a\u0020specific\u0020course.", - "url": "classes/Education-Service-Exam.html#method_getDocumentsForCourse" + "url": "classes/Education-Service-Course.html#method_getDocumentsForCourse" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AgetDocument\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AgetDocument\u0028\u0029", "name": "getDocument", "summary": "Get\u0020a\u0020specific\u0020course\u0020document.", - "url": "classes/Education-Service-Exam.html#method_getDocument" + "url": "classes/Education-Service-Course.html#method_getDocument" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003AdeleteDocument\u0028\u0029", + "fqsen": "\\Education\\Service\\Course\u003A\u003AdeleteDocument\u0028\u0029", "name": "deleteDocument", "summary": "Delete\u0020a\u0020course\u0020document", - "url": "classes/Education-Service-Exam.html#method_deleteDocument" + "url": "classes/Education-Service-Course.html#method_deleteDocument" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024bulkForm", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024bulkForm", "name": "bulkForm", "summary": "", - "url": "classes/Education-Service-Exam.html#property_bulkForm" + "url": "classes/Education-Service-Course.html#property_bulkForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024aclService", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024aclService", "name": "aclService", "summary": "", - "url": "classes/Education-Service-Exam.html#property_aclService" + "url": "classes/Education-Service-Course.html#property_aclService" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024translator", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024translator", "name": "translator", "summary": "", - "url": "classes/Education-Service-Exam.html#property_translator" + "url": "classes/Education-Service-Course.html#property_translator" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024storageService", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024storageService", "name": "storageService", "summary": "", - "url": "classes/Education-Service-Exam.html#property_storageService" + "url": "classes/Education-Service-Course.html#property_storageService" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024courseMapper", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024courseMapper", "name": "courseMapper", "summary": "", - "url": "classes/Education-Service-Exam.html#property_courseMapper" + "url": "classes/Education-Service-Course.html#property_courseMapper" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024courseDocumentMapper", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024courseDocumentMapper", "name": "courseDocumentMapper", "summary": "", - "url": "classes/Education-Service-Exam.html#property_courseDocumentMapper" + "url": "classes/Education-Service-Course.html#property_courseDocumentMapper" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024courseForm", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024courseForm", "name": "courseForm", "summary": "", - "url": "classes/Education-Service-Exam.html#property_courseForm" + "url": "classes/Education-Service-Course.html#property_courseForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024tempUploadForm", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024tempUploadForm", "name": "tempUploadForm", "summary": "", - "url": "classes/Education-Service-Exam.html#property_tempUploadForm" + "url": "classes/Education-Service-Course.html#property_tempUploadForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024bulkSummaryForm", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024bulkSummaryForm", "name": "bulkSummaryForm", "summary": "", - "url": "classes/Education-Service-Exam.html#property_bulkSummaryForm" + "url": "classes/Education-Service-Course.html#property_bulkSummaryForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024bulkExamForm", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024bulkExamForm", "name": "bulkExamForm", "summary": "", - "url": "classes/Education-Service-Exam.html#property_bulkExamForm" + "url": "classes/Education-Service-Course.html#property_bulkExamForm" }, { - "fqsen": "\\Education\\Service\\Exam\u003A\u003A\u0024config", + "fqsen": "\\Education\\Service\\Course\u003A\u003A\u0024config", "name": "config", "summary": "", - "url": "classes/Education-Service-Exam.html#property_config" + "url": "classes/Education-Service-Course.html#property_config" }, { "fqsen": "\\Education\\View\\Helper\\ExamUrl", "name": "ExamUrl", @@ -11476,20 +11521,20 @@ Search.appendIndex( "summary": "Set\u0020the\u0020data\u0020dir.", "url": "classes/Education-View-Helper-ExamUrl.html#method_setDir" }, { - "fqsen": "\\Education\\View\\Helper\\ExamUrl\u003A\u003AgetExamService\u0028\u0029", - "name": "getExamService", - "summary": "Get\u0020the\u0020authentication\u0020service.", - "url": "classes/Education-View-Helper-ExamUrl.html#method_getExamService" + "fqsen": "\\Education\\View\\Helper\\ExamUrl\u003A\u003AgetCourseService\u0028\u0029", + "name": "getCourseService", + "summary": "Get\u0020the\u0020course\u0020service.", + "url": "classes/Education-View-Helper-ExamUrl.html#method_getCourseService" }, { - "fqsen": "\\Education\\View\\Helper\\ExamUrl\u003A\u003AsetExamService\u0028\u0029", - "name": "setExamService", - "summary": "Set\u0020the\u0020authentication\u0020service.", - "url": "classes/Education-View-Helper-ExamUrl.html#method_setExamService" + "fqsen": "\\Education\\View\\Helper\\ExamUrl\u003A\u003AsetCourseService\u0028\u0029", + "name": "setCourseService", + "summary": "Set\u0020the\u0020course\u0020service.", + "url": "classes/Education-View-Helper-ExamUrl.html#method_setCourseService" }, { - "fqsen": "\\Education\\View\\Helper\\ExamUrl\u003A\u003A\u0024examService", - "name": "examService", - "summary": "Exam\u0020service.", - "url": "classes/Education-View-Helper-ExamUrl.html#property_examService" + "fqsen": "\\Education\\View\\Helper\\ExamUrl\u003A\u003A\u0024courseService", + "name": "courseService", + "summary": "Course\u0020service.", + "url": "classes/Education-View-Helper-ExamUrl.html#property_courseService" }, { "fqsen": "\\Education\\View\\Helper\\ExamUrl\u003A\u003A\u0024dir", "name": "dir", diff --git a/namespaces/education-service.html b/namespaces/education-service.html index f5f18b20a4..3927fa22b9 100644 --- a/namespaces/education-service.html +++ b/namespaces/education-service.html @@ -407,7 +407,7 @@

    -
    AclService
    Exam
    Exam service.
    +
    AclService
    Course
    Course service.
    diff --git a/packages/gewisweb.html b/packages/gewisweb.html index 5ae28efef0..fec1723547 100644 --- a/packages/gewisweb.html +++ b/packages/gewisweb.html @@ -454,7 +454,7 @@

    types to ensure that the returned values are as expected. As {@link LocalisedTextModel} does not have its own mapper, any of such objects can be persisted and/or removed from the base mapper.

  • Member
    The base mapper to be used for all other mappers. It helps with preventing duplicate Doctrine code. It uses special types to ensure that the returned values are as expected. As {@link LocalisedTextModel} does not have its own mapper, -any of such objects can be persisted and/or removed from the base mapper.
    Organ
    Mappers for organs.
    Address
    Address model.
    AssociationYear
    Authorization
    Authorization model.
    BoardMember
    Board member entity.
    Decision
    Decision model.
    Keyholder
    keyholder entity.
    MailingList
    Mailing List model.
    Meeting
    Meeting model.
    MeetingDocument
    Meeting document model.
    MeetingMinutes
    Meeting minutes.
    Member
    Member model.
    Organ
    Organ entity.
    OrganInformation
    Organ information.
    OrganMember
    Organ member entity.
    Abrogation
    Abrogation of an organ.
    Discharge
    Discharge from board position.
    Installation
    Installation as board member.
    Release
    Release from board duties.
    Budget
    Budget decision.
    Destroy
    Destroying a decision.
    Discharge
    Discharge from organ.
    Foundation
    Foundation of an organ.
    FoundationReference
    Reference to organ foundation.
    Installation
    Installation into organ.
    Granting
    SubDecision model.
    Withdrawal
    SubDecision model.
    Other
    Entity for undefined decisions.
    Reckoning
    Budget decision.
    SubDecision
    SubDecision model.
    Module
    AclService
    Decision
    Decision service.
    Member
    Member service.
    MemberInfo
    Member service.
    Organ
    User service.
    ControllerTest
    AdminController
    EducationController
    AdminControllerFactory
    EducationControllerFactory
    Bulk
    Course
    Exam
    Summary
    SearchCourse
    TempUpload
    ExamTypeHydratorStrategy
    Course
    Mappers for Courses.
    CourseDocument
    Mapper for course documents.
    Course
    Course.
    CourseDocument
    Exam
    Exam.
    Summary
    Summary.
    Module
    AclService
    Exam
    Exam service.
    ExamUrl
    ControllerTest
    AdminController
    AdminControllerFactory
    FrontpageControllerFactory
    InfimumControllerFactory
    NewsAdminControllerFactory
    OrganControllerFactory
    PageAdminControllerFactory
    PageControllerFactory
    PollAdminControllerFactory
    PollControllerFactory
    FrontpageController
    InfimumController
    NewsAdminController
    OrganController
    PageAdminController
    PageController
    PollAdminController
    PollController
    NewsItem
    Page
    Poll
    PollApproval
    PollComment
    PollOption
    NewsItem
    Mappers for NewsItems.
    Page
    Mappers for Pages.
    Poll
    Mappers for Polls.
    PollComment
    Mappers for poll comments.
    PollOption
    Mappers for poll options.
    FrontpageLocalisedText
    {@link LocalisedText} for the Frontpage module.
    NewsItem
    News item.
    Page
    Page.
    Poll
    Poll.
    PollComment
    Poll comment.
    PollOption
    Poll Option.
    PollVote
    Poll response +any of such objects can be persisted and/or removed from the base mapper.
    Organ
    Mappers for organs.
    Address
    Address model.
    AssociationYear
    Authorization
    Authorization model.
    BoardMember
    Board member entity.
    Decision
    Decision model.
    Keyholder
    keyholder entity.
    MailingList
    Mailing List model.
    Meeting
    Meeting model.
    MeetingDocument
    Meeting document model.
    MeetingMinutes
    Meeting minutes.
    Member
    Member model.
    Organ
    Organ entity.
    OrganInformation
    Organ information.
    OrganMember
    Organ member entity.
    Abrogation
    Abrogation of an organ.
    Discharge
    Discharge from board position.
    Installation
    Installation as board member.
    Release
    Release from board duties.
    Budget
    Budget decision.
    Destroy
    Destroying a decision.
    Discharge
    Discharge from organ.
    Foundation
    Foundation of an organ.
    FoundationReference
    Reference to organ foundation.
    Installation
    Installation into organ.
    Granting
    SubDecision model.
    Withdrawal
    SubDecision model.
    Other
    Entity for undefined decisions.
    Reckoning
    Budget decision.
    SubDecision
    SubDecision model.
    Module
    AclService
    Decision
    Decision service.
    Member
    Member service.
    MemberInfo
    Member service.
    Organ
    User service.
    ControllerTest
    AdminController
    EducationController
    AdminControllerFactory
    EducationControllerFactory
    Bulk
    Course
    Exam
    Summary
    SearchCourse
    TempUpload
    ExamTypeHydratorStrategy
    Course
    Mappers for Courses.
    CourseDocument
    Mapper for course documents.
    Course
    Course.
    CourseDocument
    Exam
    Exam.
    Summary
    Summary.
    Module
    AclService
    Course
    Course service.
    ExamUrl
    ControllerTest
    AdminController
    AdminControllerFactory
    FrontpageControllerFactory
    InfimumControllerFactory
    NewsAdminControllerFactory
    OrganControllerFactory
    PageAdminControllerFactory
    PageControllerFactory
    PollAdminControllerFactory
    PollControllerFactory
    FrontpageController
    InfimumController
    NewsAdminController
    OrganController
    PageAdminController
    PageController
    PollAdminController
    PollController
    NewsItem
    Page
    Poll
    PollApproval
    PollComment
    PollOption
    NewsItem
    Mappers for NewsItems.
    Page
    Mappers for Pages.
    Poll
    Mappers for Polls.
    PollComment
    Mappers for poll comments.
    PollOption
    Mappers for poll options.
    FrontpageLocalisedText
    {@link LocalisedText} for the Frontpage module.
    NewsItem
    News item.
    Page
    Page.
    Poll
    Poll.
    PollComment
    Poll comment.
    PollOption
    Poll Option.
    PollVote
    Poll response Represents a vote on a poll option.
    Module
    AclService
    Frontpage
    Frontpage service.
    News
    News service.
    Page
    Page service, used for content management.
    Poll
    Poll service.
    ControllerTest
    WeeklyPhoto
    AlbumAdminController
    AlbumController
    ApiController
    AlbumAdminControllerFactory
    AlbumControllerFactory
    ApiControllerFactory
    PhotoAdminControllerFactory
    PhotoControllerFactory
    AlbumPluginFactory
    TagControllerFactory
    PhotoAdminController
    PhotoController
    AlbumPaginatorAdapter
    Paginator for album pages.
    AlbumPlugin
    This plugin helps with rendering the pages doing album related stuff.
    TagController
    CreateAlbum
    EditAlbum
    AlbumDate
    Doctrine event listener class for Album and Photo entities.
    Remove
    Doctrine event listener class for Album and Photo entities.
    Album
    Mappers for Album.
    Photo
    Mappers for Photo.
    ProfilePhoto
    Mappers for ProfilePhoto.
    Tag
    Mappers for Tags.
    Vote
    Mappers for Vote.
    WeeklyPhoto
    Mappers for WeeklyPhoto.
    Album
    Album.
    MemberAlbum
    Contains all photos with tags of a member.
    Photo
    Photo.
    ProfilePhoto
    ProfilePhoto.
    Tag
    Tag.
    VirtualAlbum
    VirtualAlbum.
    Vote
    Vote, represents a vote for a photo of the week.
    WeeklyAlbum
    Contains all photos of the week in a certain year. This is a VirtualAlbum, meaning that it is not persisted.
    WeeklyPhoto
    Maintains a list of the "Foto of the week".
    Module
    AclService
    Admin
    Admin service for all photo admin related functions.
    Album
    Album service.
    AlbumCover
    Album cover services. Used for (re)generating album covers.
    Metadata
    Metadata service. This service implements all functionality related to gathering metadata about photos.
    Photo
    Photo service.
    GlideUrl
    Url view helper for generating (signed) glide urls Usage: $this->glideUrl()->getUrl('path to image', ['parameters']);.
    ControllerTest
    ApiUserAdapter
    CompanyUserAdapter
    UserAdapter
    ApiAuthenticationService
    AuthenticationService
    LoginAttempt
    CompanyUserSession
    UserSession
    AclServiceFactory
    GenericAclService
    ApiAdminController
    ApiAuthenticationController
    ApiAdminControllerFactory
    ApiAuthenticationControllerFactory
    UserControllerFactory
    UserController
    Activate
    ApiAppAuthorisation
    ApiToken
    CompanyUserLogin
    CompanyUserReset
    Password
    Register
    UserLogin
    UserReset
    ApiApp
    The base mapper to be used for all other mappers. It helps with preventing duplicate Doctrine code. It uses special diff --git a/reports/markers.html b/reports/markers.html index a1127349f2..11a962c937 100644 --- a/reports/markers.html +++ b/reports/markers.html @@ -415,7 +415,7 @@

    Table of Contents

    1 - module/Education/src/Service/Exam.php + module/Education/src/Service/Course.php 1 @@ -536,8 +536,8 @@

    Organ.php

    - -

    Exam.php

    + +

    Course.php