directory.collections.directory_entry
=====================================

.. py:module:: directory.collections.directory_entry


Attributes
----------

.. autoapisummary::

   directory.collections.directory_entry.T
   directory.collections.directory_entry.DirectoryEntryT


Classes
-------

.. autoapisummary::

   directory.collections.directory_entry.DirectorySearchWidget
   directory.collections.directory_entry.DirectoryEntryCollection


Module Contents
---------------

.. py:data:: T

.. py:data:: DirectoryEntryT

.. py:class:: DirectorySearchWidget

   Bases: :py:obj:`Protocol`\ [\ :py:obj:`DirectoryEntryT`\ ]


   .. py:property:: name
      :type: str



   .. py:property:: search_query
      :type: sqlalchemy.orm.Query[DirectoryEntryT]



   .. py:method:: adapt(query: sqlalchemy.orm.Query[DirectoryEntryT]) -> sqlalchemy.orm.Query[DirectoryEntryT]


   .. py:method:: html(layout: Any) -> markupsafe.Markup


.. py:class:: DirectoryEntryCollection(directory: onegov.directory.models.Directory, type: str = '*', keywords: collections.abc.Mapping[str, list[str]] | None = None, page: int = 0, search_widget: DirectorySearchWidget[DirectoryEntryT] | None = None)

   Bases: :py:obj:`onegov.core.collection.GenericCollection`\ [\ :py:obj:`DirectoryEntryT`\ ], :py:obj:`onegov.core.collection.Pagination`\ [\ :py:obj:`DirectoryEntryT`\ ]


   Provides a view on a directory's entries.

   The directory itself might be a natural place for lots of these methods
   to reside, but ultimately we want to avoid mixing the concerns of the
   directory model and this view-supporting collection.



   .. py:attribute:: type
      :value: '*'



   .. py:attribute:: directory


   .. py:attribute:: keywords


   .. py:attribute:: page
      :value: 0



   .. py:attribute:: search_widget
      :value: None



   .. py:method:: __eq__(other: object) -> bool

      Returns True if the current and the other Pagination instance
      are equal. Used to find the current page in a list of pages.




   .. py:method:: subset() -> sqlalchemy.orm.Query[DirectoryEntryT]

      Returns an SQLAlchemy query containing all records that should
      be considered for pagination.




   .. py:property:: search
      :type: str | None



   .. py:property:: search_query
      :type: sqlalchemy.orm.Query[DirectoryEntryT] | None



   .. py:property:: page_index
      :type: int


      Returns the current page index (starting at 0). 



   .. py:method:: page_by_index(index: int) -> Self

      Returns the page at the given index. A page here means an instance
      of the class inheriting from the ``Pagination`` base class.




   .. py:method:: by_name(name: str) -> DirectoryEntryT | None


   .. py:method:: query() -> sqlalchemy.orm.Query[DirectoryEntryT]


   .. py:method:: valid_keywords(parameters: collections.abc.Mapping[str, T]) -> dict[str, T]


   .. py:property:: directory_name
      :type: str



   .. py:property:: model_class
      :type: type[DirectoryEntryT]



   .. py:method:: available_filters(sort_choices: bool = False, sortfunc: collections.abc.Callable[[str], _typeshed.SupportsRichComparison] | None = None) -> collections.abc.Iterable[tuple[str, str, list[str]]]

      Retrieve the filters with their choices.

      By default the choices are returned in the same order as defined in the
      structrue. To filter alphabetically, set `sort_choices=True`.



   .. py:method:: for_keywords(singular: bool = False, **keywords: list[str]) -> Self


   .. py:method:: for_toggled_keyword_value(keyword: str, value: str, singular: bool = False) -> Self


   .. py:method:: without_keywords() -> Self