From da043dfec7667806ebebd6db15803fd4e7b4f2e2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 13 Dec 2024 23:37:52 +0000 Subject: [PATCH] Deploy docs from 39b99cbf528d5b83f0200e19f464821501c1f870 Tom Udding: Merge pull request #1943 from tomudding/feature/photo-album-search feat: photo album search and improved album layout Co-authored-by: tomudding --- classes/Application-Module.html | 14 +- ...plication-View-Helper-HighlightSearch.html | 695 +++++++++++++++++ classes/Application-View-HelperTrait.html | 64 +- classes/Photo-Controller-PhotoController.html | 112 ++- classes/Photo-Form-SearchAlbum.html | 738 ++++++++++++++++++ classes/Photo-Mapper-Album.html | 195 ++--- classes/Photo-Module.html | 8 +- classes/Photo-Service-Album.html | 283 ++++--- ...ation-src-view-helper-highlightsearch.html | 588 ++++++++++++++ files/module-photo-src-form-searchalbum.html | 588 ++++++++++++++ indices/files.html | 2 + js/searchIndex.js | 70 +- namespaces/application-view-helper.html | 2 +- namespaces/photo-form.html | 2 +- packages/gewisweb.html | 4 +- 15 files changed, 3103 insertions(+), 262 deletions(-) create mode 100644 classes/Application-View-Helper-HighlightSearch.html create mode 100644 classes/Photo-Form-SearchAlbum.html create mode 100644 files/module-application-src-view-helper-highlightsearch.html create mode 100644 files/module-photo-src-form-searchalbum.html diff --git a/classes/Application-Module.html b/classes/Application-Module.html index a0576c1460..74ed21cad1 100644 --- a/classes/Application-Module.html +++ b/classes/Application-Module.html @@ -431,7 +431,7 @@

@@ -531,7 +531,7 @@

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

@@ -608,7 +608,7 @@

@@ -647,7 +647,7 @@

@@ -691,7 +691,7 @@

@@ -735,7 +735,7 @@

diff --git a/classes/Application-View-Helper-HighlightSearch.html b/classes/Application-View-Helper-HighlightSearch.html new file mode 100644 index 0000000000..ce80a95ca5 --- /dev/null +++ b/classes/Application-View-Helper-HighlightSearch.html @@ -0,0 +1,695 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
+

Documentation

+ + + + + +
+ +
+
+ + + + +
+
+ + +
+

+ HighlightSearch + + + extends AbstractHelper + + +
+ in package + +
+ + +

+ +
+ + +
+ + + + + + + + + + + + +

+ Table of Contents + + +

+ + + + + + + + + + +

+ Methods + + +

+
+
+ __invoke() + +  : string +
+
Insert `<mark>` around a search prompt in the content of a returned result.
+ +
+ + + + + + + +
+

+ Methods + + +

+
+

+ __invoke() + + +

+ + +

Insert `<mark>` around a search prompt in the content of a returned result.

+ + + public + __invoke(string $query, string $content) : string + +
+
+ + +
Parameters
+
+
+ $query + : string +
+
+ +
+
+ $content + : string +
+
+ +
+
+ + + + + +
+
Return values
+ string +
+ +
+
+ +
+
+
+
+

+        
+ +
+
+ + + +
+
+
+ +
+ On this page + + +
+ +
+
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/classes/Application-View-HelperTrait.html b/classes/Application-View-HelperTrait.html index e5b07c7a32..94e14a7792 100644 --- a/classes/Application-View-HelperTrait.html +++ b/classes/Application-View-HelperTrait.html @@ -417,7 +417,7 @@

    @@ -517,6 +517,12 @@

     : HashUrl +
    + highlightSearch() + +  : string +
    +
    hrefLang() @@ -1064,6 +1070,61 @@
    Return values
    HashUrl + +
    +

    + highlightSearch() + + +

    + + + + + public + highlightSearch([string $query = ][, string $content = ]) : string + +
    +
    + + +
    Parameters
    +
    +
    + $query + : string + =
    +
    + +
    +
    + $content + : string + =
    +
    + +
    +
    + + + + + +
    +
    Return values
    + string +
    +
    Return values

  • fileUrl()
  • glideUrl()
  • hashUrl()
  • +
  • highlightSearch()
  • hrefLang()
  • jobCategories()
  • localisedTextElement()
  • diff --git a/classes/Photo-Controller-PhotoController.html b/classes/Photo-Controller-PhotoController.html index 5823938d58..3e3f034796 100644 --- a/classes/Photo-Controller-PhotoController.html +++ b/classes/Photo-Controller-PhotoController.html @@ -531,6 +531,12 @@

    For removing a profile picture.
    +
    + searchAction() + +  : ViewModel +
    +
    setProfilePhotoAction() @@ -552,6 +558,13 @@

    Display the page containing previous pictures of the week.
    +
    + filterAlbums() + +  : array<string|int, Album> +
    +
    If the membership of the member has ended, only show albums before the end date or in which they are tagged.
    + @@ -855,7 +868,7 @@

    @@ -931,7 +944,7 @@

    @@ -955,6 +968,44 @@

    Return values
    Response + +
    +

    + searchAction() + + +

    + + + + + public + searchAction() : ViewModel + +
    +
    + + + + + + + +
    +
    Return values
    + ViewModel +
    +
    @@ -1009,7 +1060,7 @@

    @@ -1048,7 +1099,7 @@

    @@ -1072,6 +1123,55 @@

    Return values
    ViewModel +
    +
    +

    + filterAlbums() + + +

    + + +

    If the membership of the member has ended, only show albums before the end date or in which they are tagged.

    + + + private + filterAlbums(array<string|int, Album$albums) : array<string|int, Album> + +
    +
    + + +
    Parameters
    +
    +
    + $albums + : array<string|int, Album> +
    +
    + +
    +
    + + + + + +
    +
    Return values
    + array<string|int, Album> +
    +
    @@ -1201,9 +1301,11 @@
    Return values
  • downloadAction()
  • indexAction()
  • removeProfilePhotoAction()
  • +
  • searchAction()
  • setProfilePhotoAction()
  • voteAction()
  • weeklyAction()
  • +
  • filterAlbums()
  • diff --git a/classes/Photo-Form-SearchAlbum.html b/classes/Photo-Form-SearchAlbum.html new file mode 100644 index 0000000000..c35aaa9832 --- /dev/null +++ b/classes/Photo-Form-SearchAlbum.html @@ -0,0 +1,738 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
    +

    Documentation

    + + + + + +
    + +
    +
    + + + + +
    +
    + + +
    +

    + SearchAlbum + + + extends Form + + +
    + in package + +
    + + + implements + InputFilterProviderInterface + +

    + +
    + + +
    + + + + + + + + + + + + +

    + Table of Contents + + +

    + + + +

    + Interfaces + + +

    +
    +
    InputFilterProviderInterface
    + + + + + + + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    + +
    + getInputFilterSpecification() + +  : array<string|int, mixed> +
    +
    Input filter specification.
    + +
    + + + + + + + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + + + + public + __construct(Translator $translate) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $translate + : Translator +
    +
    + +
    +
    + + + + + + +
    +
    +

    + getInputFilterSpecification() + + +

    + + +

    Input filter specification.

    + + + public + getInputFilterSpecification() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    + +
    +
    +
    +
    +
    
    +        
    + +
    +
    + + + +
    +
    +
    + +
    + On this page + + +
    + +
    +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      + + +
      + + + + + + + + diff --git a/classes/Photo-Mapper-Album.html b/classes/Photo-Mapper-Album.html index aa92ca0253..c8f6228130 100644 --- a/classes/Photo-Mapper-Album.html +++ b/classes/Photo-Mapper-Album.html @@ -435,7 +435,7 @@

      @@ -590,20 +590,6 @@

      Returns the root album containing the oldest photos.
      -
      - getRootAlbums() - -  : array<string|int, Album> -
      -
      return all the sub-albums without a parent.
      - -
      - getSubAlbums() - -  : array<string|int, Album> -
      -
      Returns all the subalbums of a given album.
      -
      persist() @@ -637,6 +623,13 @@

      Removes multiple studies.
      +
      + search() + +  : array<string|int, Album> +
      +
      Gets all root albums based on their name.
      +
      transactional() @@ -1164,7 +1157,7 @@

      @@ -1231,7 +1224,7 @@

      @@ -1350,7 +1343,7 @@

      @@ -1399,7 +1392,7 @@

      @@ -1433,114 +1426,6 @@

      Return values
      Album|null - -
      -

      - getRootAlbums() - - -

      - - -

      return all the sub-albums without a parent.

      - - - public - getRootAlbums() : array<string|int, Album> - -
      -
      - - - - - - - -
      -
      Return values
      - array<string|int, Album> -
      - -
      -
      -

      - getSubAlbums() - - -

      - - -

      Returns all the subalbums of a given album.

      - - - public - getSubAlbums(Album $parent[, int $start = 0 ][, int|null $maxResults = null ]) : array<string|int, Album> - -
      -
      - - -
      Parameters
      -
      -
      - $parent - : Album -
      -
      -

      the parent album to retrieve the subalbum from

      -
      - -
      -
      - $start - : int - = 0
      -
      -

      the result to start at

      -
      - -
      -
      - $maxResults - : int|null - = null
      -
      -

      max amount of results to return, null for infinite

      -
      - -
      -
      - - - - - -
      -
      Return values
      - array<string|int, Album> -
      -
      +
      +
      + + + +

      Gets all root albums based on their name.

      + + + public + search(string $query) : array<string|int, Album> + +
      +
      + +

      Only returns published albums and grouping has to happen downstream at the consumers.

      +
      + +
      Parameters
      +
      +
      + $query + : string +
      +
      + +
      +
      + + + + + +
      +
      Return values
      + array<string|int, Album> +
      +
      @@ -2171,13 +2107,12 @@
      Return values
    • getEntityManager()
    • getNewestAlbum()
    • getOldestAlbum()
    • -
    • getRootAlbums()
    • -
    • getSubAlbums()
    • persist()
    • persistMultiple()
    • remove()
    • removeById()
    • removeMultiple()
    • +
    • search()
    • transactional()
    • getRepository()
    • getRepositoryName()
    • diff --git a/classes/Photo-Module.html b/classes/Photo-Module.html index 8fdec2a8dc..2ff7845ea7 100644 --- a/classes/Photo-Module.html +++ b/classes/Photo-Module.html @@ -431,7 +431,7 @@

      @@ -513,7 +513,7 @@

      @@ -556,7 +556,7 @@

      @@ -599,7 +599,7 @@

      diff --git a/classes/Photo-Service-Album.html b/classes/Photo-Service-Album.html index bc0f0a3dd8..2869424494 100644 --- a/classes/Photo-Service-Album.html +++ b/classes/Photo-Service-Album.html @@ -502,6 +502,12 @@

       : Photo

      +
      + $searchAlbumForm + +  : SearchAlbum +
      +
      $storageService @@ -582,14 +588,6 @@

      Retrieves the form for editing the specified album.
      -
      - getAlbums() - -  : array<string|int, Album> -
      -
      Retrieves all the albums in the root directory or in the specified -album.
      -
      getAlbumsByMember() @@ -625,6 +623,12 @@

      Retrieves all WeeklyPhotos.
      +
      + getSearchAlbumForm() + +  : SearchAlbum +
      +
      moveAlbum() @@ -639,6 +643,13 @@

      Moves a photo to a new album.
      +
      + search() + +  : array<string|int, Album> +
      +
      Search for albums.
      +
      updateAlbum() @@ -886,6 +897,42 @@

      + +
      +

      + $searchAlbumForm + + + + read-only +

      + + + + + + private + SearchAlbum + $searchAlbumForm + + + + + + + +
      public - __construct(AclService $aclService, Translator $translator, Photo $photoService, AlbumCover $albumCoverService, Member $memberService, FileStorage $storageService, Album $albumMapper, Tag $tagMapper, WeeklyPhoto $weeklyPhotoMapper, Album $albumForm) : mixed + __construct(AclService $aclService, Translator $translator, Photo $photoService, AlbumCover $albumCoverService, Member $memberService, FileStorage $storageService, Album $albumMapper, Tag $tagMapper, WeeklyPhoto $weeklyPhotoMapper, Album $albumForm, SearchAlbum $searchAlbumForm) : mixed
      @@ -1137,6 +1184,13 @@
      Parameters

      +
      +
      + $searchAlbumForm + : SearchAlbum +
      +
      +
      @@ -1160,7 +1214,7 @@

      @@ -1244,7 +1298,7 @@

      @@ -1306,7 +1360,7 @@

      @@ -1351,7 +1405,7 @@

      @@ -1415,7 +1469,7 @@

      @@ -1496,7 +1550,7 @@

      @@ -1547,76 +1601,6 @@

      Return values
      Album - -
      -

      - getAlbums() - - -

      - - -

      Retrieves all the albums in the root directory or in the specified -album.

      - - - public - getAlbums([Album|null $album = null ][, int $start = 0 ][, int|null $maxResults = null ]) : array<string|int, Album> - -
      -
      - - -
      Parameters
      -
      -
      - $album - : Album|null - = null
      -
      -

      The album to retrieve sub-albums of

      -
      - -
      -
      - $start - : int - = 0
      -
      -

      the result to start at

      -
      - -
      -
      - $maxResults - : int|null - = null
      -
      -

      max amount of results to return, null for infinite

      -
      - -
      -
      - - - - - -
      -
      Return values
      - array<string|int, Album> -
      -
      @@ -1681,7 +1665,7 @@

      @@ -1745,7 +1729,7 @@

      @@ -1786,7 +1770,7 @@

      @@ -1843,7 +1827,7 @@

      Album.php : - 256 + 223 @@ -1867,6 +1851,44 @@

      Return values
      array<string|int, WeeklyPhoto> +
      +
      +

      + getSearchAlbumForm() + + +

      + + + + + public + getSearchAlbumForm() : SearchAlbum + +
      +
      + + + + + + + +
      +
      Return values
      + SearchAlbum +
      +
      @@ -1961,7 +1983,7 @@

      @@ -2025,6 +2047,73 @@

      Return values
      +
      +
      + + + +

      Search for albums.

      + + + public + search(array<string|int, mixed> $data) : array<string|int, Album> + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> +
      +
      +

      Search data

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + phpcsSuppress +
      +
      + +

      SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

      +
      + +
      +
      + + + +
      +
      Return values
      + array<string|int, Album> +
      +
      @@ -2098,7 +2187,7 @@

      @@ -2146,7 +2235,7 @@

      @@ -2299,6 +2388,7 @@

      Return values
    • $albumMapper
    • $memberService
    • $photoService
    • +
    • $searchAlbumForm
    • $storageService
    • $tagMapper
    • $translator
    • @@ -2316,14 +2406,15 @@
      Return values
    • generateAlbumCover()
    • getAlbum()
    • getAlbumForm()
    • -
    • getAlbums()
    • getAlbumsByMember()
    • getAlbumsByYear()
    • getAlbumsWithoutDate()
    • getAlbumYears()
    • getLastPhotosOfTheWeekPerYear()
    • +
    • getSearchAlbumForm()
    • moveAlbum()
    • movePhoto()
    • +
    • search()
    • updateAlbum()
    • getMemberAlbum()
    • getWeeklyAlbum()
    • diff --git a/files/module-application-src-view-helper-highlightsearch.html b/files/module-application-src-view-helper-highlightsearch.html new file mode 100644 index 0000000000..0fdfe54956 --- /dev/null +++ b/files/module-application-src-view-helper-highlightsearch.html @@ -0,0 +1,588 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
      +

      Documentation

      + + + + + +
      + +
      +
      + + + + +
      +
      +
        +
      + +
      +

      HighlightSearch.php

      + + + + + + + + + + +

      + Table of Contents + + +

      + + + + +

      + Classes + + +

      +
      +
      HighlightSearch
      + + + + + + + + + + + + + +
      +
      +
      +
      +
      
      +        
      + +
      +
      + + + +
      +
      +
      + +
      + On this page + +
        +
      • Table Of Contents
      • +
      • + +
      • + + +
      +
      + +
      +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        + + +
        + + + + + + + + diff --git a/files/module-photo-src-form-searchalbum.html b/files/module-photo-src-form-searchalbum.html new file mode 100644 index 0000000000..addcfaa10b --- /dev/null +++ b/files/module-photo-src-form-searchalbum.html @@ -0,0 +1,588 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
        +

        Documentation

        + + + + + +
        + +
        +
        + + + + +
        +
        +
          +
        + +
        +

        SearchAlbum.php

        + + + + + + + + + + +

        + Table of Contents + + +

        + + + + +

        + Classes + + +

        +
        +
        SearchAlbum
        + + + + + + + + + + + + + +
        +
        +
        +
        +
        
        +        
        + +
        +
        + + + +
        +
        +
        + +
        + On this page + +
          +
        • Table Of Contents
        • +
        • + +
        • + + +
        +
        + +
        +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          + + +
          + + + + + + + + diff --git a/indices/files.html b/indices/files.html index 90db5d68b7..4e0732d8d9 100644 --- a/indices/files.html +++ b/indices/files.html @@ -625,6 +625,7 @@

          H

          I

          @@ -813,6 +814,7 @@

          R

          S