add own logic
This commit is contained in:
rnsrk
commit
5cabe99d1e
64 changed files with 6031 additions and 0 deletions
24
.github/workflows/gitlab-mirror.yml
vendored
Normal file
24
.github/workflows/gitlab-mirror.yml
vendored
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
name: Mirror to Drupal.org GitLab
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [2.x]
|
||||
tags: '*'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Mirror + trigger CI
|
||||
uses: SvanBoxel/gitlab-mirror-and-ci-action@master
|
||||
with:
|
||||
args: "https://git.drupalcode.org/project/advanced_search"
|
||||
env:
|
||||
FOLLOW_TAGS: "true"
|
||||
FORCE_PUSH: "false"
|
||||
GITLAB_HOSTNAME: "git.drupal.org"
|
||||
GITLAB_USERNAME: "project_116926_bot"
|
||||
GITLAB_PASSWORD: ${{ secrets.GITLAB_PASSWORD }}
|
||||
GITLAB_PROJECT_ID: "116926"
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
73
CONTRIBUTING.md
Normal file
73
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
# Welcome!
|
||||
|
||||
If you are reading this document then you are interested in contributing to Islandora 8. All contributions are welcome: use-cases, documentation, code, patches, bug reports, feature requests, etc. You do not need to be a programmer to speak up!
|
||||
|
||||
We also have an IRC channel -- #islandora -- on freenode.net. Feel free to hang out there, ask questions, and help others out if you can.
|
||||
|
||||
Please note that this project operates under the [Islandora Community Code of Conduct](http://islandora.ca/codeofconduct). By participating in this project you agree to abide by its terms.
|
||||
|
||||
## Workflows
|
||||
|
||||
The group meets each Wednesday at 1:00 PM Eastern. Meeting notes and announcements are posted to the [Islandora community list](https://groups.google.com/forum/#!forum/islandora) and the [Islandora developers list](https://groups.google.com/forum/#!forum/islandora-dev). You can view meeting agendas, notes, and call-in information [here](https://github.com/Islandora/documentation/wiki#islandora-8-tech-calls). Anybody is welcome to join the calls, and add items to the agenda.
|
||||
|
||||
### Use cases
|
||||
|
||||
If you would like to submit a use case to the Islandora 8 project, please submit an issue [here](https://github.com/Islandora/documentation/issues/new) using the [Use Case template](https://github.com/Islandora/documentation/wiki/Use-Case-template), prepending "Use Case:" to the title of the issue.
|
||||
|
||||
### Documentation
|
||||
|
||||
You can contribute documentation in two different ways. One way is to create an issue [here](https://github.com/Islandora/documentation/issues/new), prepending "Documentation:" to the title of the issue. Another way is by pull request, which is the same process as [Contribute Code](https://github.com/Islandora/documentation/blob/master/CONTRIBUTING.md#contribute-code). All documentation resides in [`docs`](https://github.com/Islandora/documentation/tree/master/docs).
|
||||
|
||||
### Request a new feature
|
||||
|
||||
To request a new feature you should [open an issue in the Islandora 8 repository](https://github.com/Islandora/documentation/issues/new) or create a use case (see the _Use cases_ section above), and summarize the desired functionality. Prepend "Enhancement:" if creating an issue on the project repo, and "Use Case:" if creating a use case.
|
||||
|
||||
### Report a bug
|
||||
|
||||
To report a bug you should [open an issue in the Islandora 8 repository](https://github.com/Islandora/documentation/issues/new) that summarizes the bug. Prepend the label "Bug:" to the title of the issue.
|
||||
|
||||
In order to help us understand and fix the bug it would be great if you could provide us with:
|
||||
|
||||
1. The steps to reproduce the bug. This includes information about e.g. the Islandora version you were using along with the versions of stack components.
|
||||
2. The expected behavior.
|
||||
3. The actual, incorrect behavior.
|
||||
|
||||
Feel free to search the issue queue for existing issues (aka tickets) that already describe the problem; if there is such a ticket please add your information as a comment.
|
||||
|
||||
**If you want to provide a pull along with your bug report:**
|
||||
|
||||
That is great! In this case please send us a pull request as described in the section _Create a pull request_ below.
|
||||
|
||||
### Contribute code
|
||||
|
||||
Before you set out to contribute code you will need to have completed a [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or be covered by a [Corporate Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). The signed copy of the license agreement should be sent to <mailto:community@islandora.ca>
|
||||
|
||||
_If you are interested in contributing code to Islandora but do not know where to begin:_
|
||||
|
||||
In this case you should [browse open issues](https://github.com/Islandora/documentation/issues) and check out [use cases](https://github.com/Islandora/documentation/labels/use%20case).
|
||||
|
||||
If you are contributing Drupal code, it must adhere to [Drupal Coding Standards](https://www.drupal.org/coding-standards); Travis CI will check for this on pull requests.
|
||||
|
||||
Contributions to the Islandora codebase should be sent as GitHub pull requests. See section _Create a pull request_ below for details. If there is any problem with the pull request we can work through it using the commenting features of GitHub.
|
||||
|
||||
* For _small patches_, feel free to submit pull requests directly for those patches.
|
||||
* For _larger code contributions_, please use the following process. The idea behind this process is to prevent any wasted work and catch design issues early on.
|
||||
|
||||
1. [Open an issue](https://github.com/Islandora/documentation/issues), prepending "Enhancement:" in the title if a similar issue does not exist already. If a similar issue does exist, then you may consider participating in the work on the existing issue.
|
||||
2. Comment on the issue with your plan for implementing the issue. Explain what pieces of the codebase you are going to touch and how everything is going to fit together.
|
||||
3. Islandora committers will work with you on the design to make sure you are on the right track.
|
||||
4. Implement your issue, create a pull request (see below), and iterate from there.
|
||||
|
||||
### Create a pull request
|
||||
|
||||
Take a look at [Creating a pull request](https://help.github.com/articles/creating-a-pull-request). In a nutshell you need to:
|
||||
|
||||
1. [Fork](https://help.github.com/articles/fork-a-repo) this repository to your personal or institutional GitHub account (depending on the CLA you are working under). Be cautious of which branches you work from though (you'll want to base your work off master, or for Drupal modules use the most recent version branch). See [Fork a repo](https://help.github.com/articles/fork-a-repo) for detailed instructions.
|
||||
2. Commit any changes to your fork.
|
||||
3. Send a [pull request](https://help.github.com/articles/creating-a-pull-request) using the [pull request template](https://github.com/Islandora/documentation/blob/master/.github/PULL_REQUEST_TEMPLATE.md) to the Islandora GitHub repository that you forked in step 1. If your pull request is related to an existing issue -- for instance, because you reported a [bug/issue](https://github.com/Islandora/documentation/issues) earlier -- prefix the title of your pull request with the corresponding issue number (e.g. `issue-123: ...`). Please also include a reference to the issue in the description of the pull. This can be done by using '#' plus the issue number like so '#123', also try to pick an appropriate name for the branch in which you're issuing the pull request from.
|
||||
|
||||
You may want to read [Syncing a fork](https://help.github.com/articles/syncing-a-fork) for instructions on how to keep your fork up to date with the latest changes of the upstream (official) repository.
|
||||
|
||||
## License Agreements
|
||||
|
||||
The Islandora Foundation requires that contributors complete a [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or be covered by a [Corporate Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). The signed copy of the license agreement should be sent to <a href="mailto:community@islandora.ca?Subject=Contributor%20License%20Agreement" target="_top">community@islandora.ca</a>. This license is for your protection as a contributor as well as the protection of the Foundation and its users; it does not change your rights to use your own contributions for any other purpose. A list of current CLAs is kept [here](https://github.com/Islandora/islandora/wiki/Contributor-License-Agreements).
|
||||
339
LICENSE
Normal file
339
LICENSE
Normal file
|
|
@ -0,0 +1,339 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License.
|
||||
339
LICENSE.txt
Normal file
339
LICENSE.txt
Normal file
|
|
@ -0,0 +1,339 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License.
|
||||
570
README.md
Normal file
570
README.md
Normal file
|
|
@ -0,0 +1,570 @@
|
|||
# Islandora Advanced Search <!-- omit in toc -->
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Feature and Advantages](#features-and-advantages)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [Configuration](#configuration)
|
||||
- [Configuring Solr](#configuring-solr)
|
||||
- [eDismax Search](#edismax-search)
|
||||
- [Configure Collection Search](#configure-collection-search)
|
||||
- [Configure Views](#configure-views)
|
||||
- [Exposed Form](#exposed-form)
|
||||
- [Collection Search](#collection-search)
|
||||
- [Paging](#paging)
|
||||
- [Sorting](#sorting)
|
||||
- [Search Highlighting](#search-highlighting)
|
||||
- [Result Summary](#result-summary)
|
||||
<!--- - [Configure Facets](#configure-facets)
|
||||
- [Include / Exclude Facets](#include--exclude-facets) --->
|
||||
- [Configure Blocks](#configure-blocks)
|
||||
- [Advanced Search Block](#advanced-search-block)
|
||||
- [Search Block (NEW)](#search-block-new)
|
||||
- [Documentation](#documentation)
|
||||
- [Troubleshooting/Issues](#troubleshootingissues)
|
||||
- [Maintainers](#maintainers)
|
||||
- [Sponsors](#sponsors)
|
||||
- [Development](#development)
|
||||
- [License](#license)
|
||||
|
||||
|
||||
## Introduction
|
||||
The Advanced Search module provides keyword search, field search, boolean search, and search within collections and sub collections. It provides a pager UI component that allows the user to set the number of items to show, select sort criteria and display style (grid or list). It provides a global search block, which redirects the search query to a search page. It also enables the use of Ajax with views (powered by Solr), search blocks, facets, and search results.
|
||||
|
||||
|
||||
|
||||
## Features and Advantages
|
||||
|
||||
The module provides Boolean search, enables you to use AND, OR or NOT options to helps expanding or narrowing your search parameters.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td> </td>
|
||||
<td>
|
||||
<p><strong>Standard Query Parser</strong></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><strong>The Extended DisMax (eDismax) Query Parser </strong></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Use</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">If Edimax is turned off in configuration, the “Standard Query Parser” is used.</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Edismax is enabled by default, but can be turned off in configuration (/admin/config/search/advanced). </span></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Capacity</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Search a content field</span></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Search a content field</span></li>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Search across all of the fields which are indexed to Solr in Search API configuration. </span></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Search</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Content indexed into a string field</span></p>
|
||||
<ul>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Search returns on an exact field match (case sensitive)</span></li>
|
||||
</ul>
|
||||
<br />
|
||||
<p><span style="font-weight: 400;">Content indexed into a full-text field</span></p>
|
||||
<ul>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Search returns on single words or phrases (words in order), and is case insensitive. </span></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Content indexed into a string field</span></p>
|
||||
<ul>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Search returns on an exact field match (case sensitive)</span></li>
|
||||
</ul>
|
||||
<br />
|
||||
<p><span style="font-weight: 400;">Content indexed into a full-text field</span></p>
|
||||
<ul>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">“Bounded” searches return exact phrase matches, replicating the standard query parser features.</span></li>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Case insensitive</span></li>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Support for word searching in any order.</span></li>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Syntax for wildcards and other search features available (described in table below)</span></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Use the following syntaxes (eDismax ONLY) to increase Search acuracy is provided below:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<p><strong>Operator</strong></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><strong>Usage</strong></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><strong>Example</strong></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">AND</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Narrow down your search to include results that contain both search terms</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">orientation AND games</span></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">OR</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Broaden your search to include results that contain either search term</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">students OR undergraduates</span></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">NOT</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Narrow your search by excluding certain words or phrases</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">orientation NOT games</span></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Asterisk (*)</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Replaces the asterisk with multiple characters. Use to search for multiple beginnings, middles, and endings of words.</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">librar* </span></p>
|
||||
<br />
|
||||
<p><span style="font-weight: 400;">will include results like:</span></p>
|
||||
<ul>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">librar</span><strong>y</strong></li>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">librar</span><strong>ies</strong></li>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">librar</span><strong>ian</strong></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Question Mark (?)</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Replaces the question mark with a single character. Use to search for multiple beginnings, middles, and endings of words.</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">?est</span></p>
|
||||
<br />
|
||||
<p><span style="font-weight: 400;">will include results like:</span></p>
|
||||
<ul>
|
||||
<li style="font-weight: 400;"><strong>T</strong><span style="font-weight: 400;">est</span></li>
|
||||
<li style="font-weight: 400;"><strong>P</strong><span style="font-weight: 400;">est</span></li>
|
||||
<li style="font-weight: 400;"><strong>W</strong><span style="font-weight: 400;">est</span></li>
|
||||
</ul>
|
||||
<br />
|
||||
<p><span style="font-weight: 400;">Will not include:</span></p>
|
||||
<ul>
|
||||
<li><strong>Cont</strong><span style="font-weight: 400;">est</span></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Tilde (~)</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Use to make your search ‘fuzzy’ or search for synonyms and alternate spellings. </span></p>
|
||||
<br />
|
||||
<p><span style="font-weight: 400;">Only works for Keyword search.</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Shaun~</span></p>
|
||||
<br />
|
||||
<p><span style="font-weight: 400;">will include results like:</span></p>
|
||||
<ul>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Shaun</span></li>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Sean</span></li>
|
||||
<li style="font-weight: 400;"><span style="font-weight: 400;">Shawn</span></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Quotation Marks (“”)</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">Use quotation marks to search for a specific word or phrase.</span></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><span style="font-weight: 400;">“alumni golf tournament”</span></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p> </p>
|
||||
|
||||
|
||||
## Requirements
|
||||
|
||||
Advanced Search requires an installation of Solr, as its syntax is Solr-specific.
|
||||
The Advanced Search blocks also utilize the Facets API, therefore they only work on Views where Facets are enabled.
|
||||
|
||||
The following requirements (Drupal modules) will be downloaded automatically by Composer:
|
||||
|
||||
- [facets](https://www.drupal.org/project/facets)
|
||||
- [search_api_solr](https://www.drupal.org/project/search_api_solr)
|
||||
|
||||
You do not need to use Islandora, however the instructions below for setting up search within a collection
|
||||
(and optionally, its subcollections) use an pattern that is used by Islandora whereby nodes are organized
|
||||
in a hierarchy using an Entity Reference field (typically called "Member Of" / `field_member_of`) on a node
|
||||
that accepts other nodes as values. If you are using Advanced Search and want to make use
|
||||
of "Search Sub-collections" then you will need to set up such a field on your content type(s).
|
||||
|
||||
## Installation
|
||||
|
||||
This module is part of the [Islandora Starter Site](https://github.com/Islandora-Devops/islandora-starter-site), which is a full Drupal site setup that includes
|
||||
Solr, and automatically sets up the views and facets required for Advanced Search to work.
|
||||
|
||||
To download and enable just this module, use the following from the command line:
|
||||
|
||||
```bash
|
||||
composer require drupal/advanced_search
|
||||
drush en advanced_search
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
This module will make the following blocks available for every _display_
|
||||
of a Search API view:
|
||||
* Advanced Search Block
|
||||
* Pager Block
|
||||
|
||||
This module also provides a block called "Search" that you can place and configure as a global search block.
|
||||
|
||||
You can configure these blocks to show up on pages with their respective views using Drupal's Block interface.
|
||||
|
||||
You can set the following configuration at
|
||||
`/admin/config/search/advanced`:
|
||||
|
||||
|
||||
|
||||
|
||||
## Configuring Solr
|
||||
|
||||
Please review
|
||||
[Islandora Documentation](https://islandora.github.io/documentation/user-documentation/searching/)
|
||||
before continuing. The following assumes you already have a working Solr and the
|
||||
Drupal Search API setup.
|
||||
|
||||
## Extended Dismax (eDismax) Search
|
||||
|
||||
Read the [Drupal.org documentation on Solr Query Parsers](https://www.drupal.org/docs/contributed-modules/search-api-solr/solr-query-parsers) to find more detail about
|
||||
eDismax Search in Drupal.
|
||||
|
||||
You can enable Extended Dismax search on this module's configuration page at
|
||||
`admin/config/islandora/advanced_search`. This will affect all Advanced Search
|
||||
and Search blocks provided by this module.
|
||||
|
||||
## Configure Search Fields for Collection Search
|
||||
|
||||
See "Requirements" for a discussion of the use of `field_member_of`.
|
||||
|
||||
In this section we set up fields in our Solr index (using Search API).
|
||||
The first Search API field ("Member of") indexes a node's parent(s) based
|
||||
on the Drupal field `field_member_of`, and the second ("Descendant of")
|
||||
indexes a node's parents and its parents' parents. This second field's
|
||||
recursive behaviour is achieved by using Search API's "Index hierarchy"
|
||||
processor.
|
||||
|
||||
First ensure that your hierarchy field (assumed for convenience to be `field_member_of`)
|
||||
is indexed at `admin/config/search/search-api/index/[your default index]/fields`. If
|
||||
not, add the field using the "Add field" button. When you find "Member of (field_member_of)",
|
||||
click the "Add" button - do not delve into the child properties under "(+)".
|
||||
We will assume that the Search API field's name is also "Member of". The field type
|
||||
should be "Integer".
|
||||
|
||||
Next, create a second Search API field, exactly the same as the first field
|
||||
except for its name, so we can tell them apart. We'll call this one "Descendant of".
|
||||
|
||||
|
||||
|
||||
Then, under the Processors tab (`admin/config/search/search-api/index/[your default index]/processors`)
|
||||
enable the checkbox for `Index hierarchy` and at the bottom of the page, setup the processor
|
||||
to index hierarchy for "Descendant of" (but not "Member of").
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
This "Descendant of" field now contains a list of all its ancestors, so can
|
||||
be used as a contextual filter on views, thereby allowing the view to display all
|
||||
descendants of a given node.
|
||||
|
||||
See the section below, "Collection search", to finish configuring your site
|
||||
for collection and sub-collection search.
|
||||
|
||||
> N.B. You may have to re-index to make sure the field is populated.
|
||||
|
||||
## Configure Views
|
||||
|
||||
Detailed instruction on the configuration of views is outside of the scope of this document.
|
||||
Please read the [Drupal Documentation](https://www.drupal.org/docs/8/core/modules/views), as
|
||||
well as the
|
||||
[Search API Documentation](https://www.drupal.org/docs/contributed-modules/search-api).
|
||||
|
||||
To use the Advanced Search module, you will need to create at least one view that
|
||||
is based on Search API and uses Solr. However, do NOT add the "Fulltext search"
|
||||
filter, despite that being the "usual" way of setting up a Search view. All
|
||||
fulltext searching (and fielded searching) will be handled by blocks provided
|
||||
by this module.
|
||||
|
||||
### Exposed Form
|
||||
|
||||
Solr views allow the user to configure an exposed form (_optionally as a
|
||||
block_). This form / block is **different** from the
|
||||
[Advanced Search Block](#advanced-search-block). This module does not make any
|
||||
changes to the form, but this form can cause the Advanced Search Block to not
|
||||
function if configured incorrectly.
|
||||
|
||||
The Advanced Search Block requires that if present the Exposed forms
|
||||
`Exposed form style` is set to `Basic` rather than `Input Required`. As
|
||||
`Input Required` will prevent any search from occurring unless the user puts an
|
||||
additional query in the Exposed form as well.
|
||||
|
||||
|
||||
|
||||
### Collection Search
|
||||
|
||||
This module's "Advanced Search" block can be set up on a
|
||||
"collection" (or, generically, on hierarchical entities
|
||||
that can contain other entities). This block allows the user
|
||||
to select whether they want the search to include sub-collections.
|
||||
|
||||
|
||||
|
||||
The following instructions describe how to set up this feature.
|
||||
|
||||
First, in your Search API view, set up **two** contextual filters:
|
||||
|
||||
1. "Member of" (Direct descendants only)
|
||||
2. "Descendant of" (All descendants)
|
||||
|
||||
|
||||
|
||||
|
||||
Both of these filters are configured the exact same way. The only configuration
|
||||
to set is "When the filter value is NOT available" then "Provide default value".
|
||||
Under Type, select "Content ID from URL".
|
||||
|
||||
|
||||
|
||||
These two contextual filters are used by the Advanced Search block to
|
||||
expose the toggle to search direct descendants or all descendants
|
||||
(documented under "Advanced Search Block", below).
|
||||
|
||||
### Paging
|
||||
|
||||
The paging options specified here can have an affect on the pager block
|
||||
(*documented below*).
|
||||
|
||||
|
||||
|
||||
### Sorting
|
||||
|
||||
Additional the fields listed as `Sort Criteria` as `Exposed` will be made
|
||||
available in the pager block (*documented below*).
|
||||
|
||||
|
||||
|
||||
### Search Highlighting
|
||||
|
||||
1. Add Search Excerpt to the Advanced Search View.
|
||||
- Navigate to `/admin/structure/views/view/advanced_search`. In the `Fields` section, click `Add`, then select `Search Excerpt`.'
|
||||
|
||||
|
||||
|
||||
2. Turn on Search API highlight processor
|
||||
- Navigate to `/admin/config/search/search-api` > Edit Index > Processors > Enable Highlight processor.
|
||||
|
||||
|
||||
|
||||
- At the bottom of the form, under Processor Settings > Highlight > Select `Create excerpt`.
|
||||
|
||||
|
||||
|
||||
3. Configure Solr Server.
|
||||
- Navigate to `/admin/config/search/search-api` > Edit Server > Configure Solr backend > Advanced > Select `Retrieve highlighted snippets`.
|
||||
|
||||
|
||||
|
||||
### Result Summary
|
||||
|
||||
In your view, in the `Header` section, clikc `Add`, then search and select for "Result summary".
|
||||
|
||||
|
||||
|
||||
Then, paste the following code to `Display` textarea in `Configure Header: Global: Result summary`
|
||||
|
||||
````
|
||||
<div id="ajax-page-summary" class="pager__summary">Displaying @start - @end of @total</div>
|
||||
````
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--- ## Configure Facets
|
||||
|
||||
The facets can be configured at `admin/config/search/facets`. Facets are linked
|
||||
to a **Source** which is a **Search API View Display** so it will be typically
|
||||
to have to duplicate your configuration for a given facet across each of the
|
||||
displays where you want it to show up.
|
||||
|
||||
### Include / Exclude Facets
|
||||
|
||||
To be able to display exclude facet links as well as include links in the facets
|
||||
block we have to duplicate the configuration for the facet like so.
|
||||
|
||||
|
||||
|
||||
Both the include / exclude facets must use the widget
|
||||
`List of links that allow the user to include / exclude facets`
|
||||
|
||||
|
||||
|
||||
The excluded facet also needs the following settings to appear and function
|
||||
correctly.
|
||||
|
||||
The `URL alias` must match the same value as the include facet except it must be
|
||||
prefixed with `~` character that is what links to the two facets to each other.
|
||||
|
||||
|
||||
|
||||
And it must also explicitly be set to exclude:
|
||||
|
||||
|
||||
|
||||
You may also want to enable `Hide active items` and `Hide non-narrowing results`
|
||||
for a cleaner presentation of facets.
|
||||
--->
|
||||
## Configure Blocks
|
||||
|
||||
For each block type:
|
||||
|
||||
- Facet
|
||||
- Pager
|
||||
- Advanced Search
|
||||
|
||||
There will be **one block** per `View Display`. The block should be limited to
|
||||
only appear when the view it was derived from is also being displayed on the
|
||||
same page.
|
||||
|
||||
This requires configuring the `visibility` of the block as appropriate. For
|
||||
collection based searches be sure to limit the display of the Facets block to
|
||||
the models you want to display the search on, e.g:
|
||||
|
||||
|
||||
|
||||
### Advanced Search Block
|
||||
|
||||
For any valid Search API field, you can drag / drop and reorder the fields to
|
||||
display in the advanced search form on. The configuration resides on the block
|
||||
so this can differ across views / displays if need be.
|
||||
|
||||
If the view this block is attached to has *two* exposed filters, then you can
|
||||
choose which one corresponds to direct descendants. This will enable the
|
||||
"Include Sub-Collections" search checkbox on the Advanced Search block.
|
||||
|
||||
|
||||
|
||||
> N.B. Be aware that the Search views [Exposed Form](#exposed-form) can have an
|
||||
> affect on the function of the
|
||||
> [Advanced Search Block](#advanced-search-block). Please refer to that section
|
||||
> to learn more.
|
||||
|
||||
### Search Block (NEW)
|
||||
|
||||
To associate this simple search block to a Advanced Search Result Page view,
|
||||
you can select its machine name in the dropdown list. With that, this form
|
||||
will redirect to the view with search parameters.
|
||||
|
||||
You can also change the search form's appearance by changing the default label,
|
||||
placeholder text for the search text field, and search button.
|
||||
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
Further documentation for this module is available on the
|
||||
[Islandora 8 documentation site](https://islandora.github.io/documentation/).
|
||||
|
||||
## Troubleshooting/Issues
|
||||
|
||||
Having problems or solved a problem? Check out the Islandora google groups for
|
||||
a solution.
|
||||
|
||||
- [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora)
|
||||
- [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev)
|
||||
|
||||
## Maintainers
|
||||
|
||||
Current maintainers:
|
||||
|
||||
- [Nigel Banks](https://github.com/nigelgbanks)
|
||||
|
||||
## Sponsors
|
||||
|
||||
- LYRASIS
|
||||
|
||||
## Development
|
||||
|
||||
If you would like to contribute, please get involved by attending our weekly
|
||||
[Tech Call](https://github.com/Islandora/documentation/wiki). We love to hear
|
||||
from you!
|
||||
|
||||
If you would like to contribute code to the project, you need to be covered by
|
||||
an Islandora Foundation
|
||||
[Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf)
|
||||
or
|
||||
[Corporate Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf).
|
||||
Please see the [Contributors](http://islandora.ca/resources/contributors) pages
|
||||
on Islandora.ca for more information.
|
||||
|
||||
We recommend using the
|
||||
[islandora-playbook](https://github.com/Islandora-Devops/islandora-playbook) to
|
||||
get started.
|
||||
|
||||
## License
|
||||
|
||||
[GPLv2](http://www.gnu.org/licenses/gpl-2.0.txt)
|
||||
|
||||
16
advanced_search.info.yml
Normal file
16
advanced_search.info.yml
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# This .info.yml files provides the basic information about our module to Drupal
|
||||
# More: https://www.drupal.org/node/2000204
|
||||
name: 'Advanced Search'
|
||||
description: "Creates an Advanced Search block and other enhancements to search."
|
||||
type: module
|
||||
package: Islandora
|
||||
core_version_requirement: ^8.8 || ^9 || ^10
|
||||
dependencies:
|
||||
- drupal:facets
|
||||
- drupal:facets_summary
|
||||
- drupal:search_api_solr
|
||||
|
||||
# Information added by Drupal.org packaging script on 2024-09-14
|
||||
version: '2.1.1'
|
||||
project: 'advanced_search'
|
||||
datestamp: 1726285663
|
||||
20
advanced_search.libraries.yml
Normal file
20
advanced_search.libraries.yml
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
advanced.search.admin:
|
||||
js:
|
||||
js/advanced_search.admin.js: {}
|
||||
dependencies:
|
||||
- core/drupal.tabledrag
|
||||
- core/jquery
|
||||
- core/once
|
||||
|
||||
advanced.search.form:
|
||||
js:
|
||||
js/advanced_search.form.js: {}
|
||||
js/advanced_search.entityFields.js: {}
|
||||
css:
|
||||
component:
|
||||
css/advanced_search.form.css: {}
|
||||
|
||||
advanced.search.pager:
|
||||
css:
|
||||
component:
|
||||
css/advanced_search.pager.css: {}
|
||||
6
advanced_search.links.menu.yml
Normal file
6
advanced_search.links.menu.yml
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
advanced_search.settings:
|
||||
title: 'Advanced Search Settings'
|
||||
route_name: advanced_search.settings
|
||||
description: 'Configure Islandora Advanced Search settings'
|
||||
parent: system.admin_config_search
|
||||
weight: 99
|
||||
152
advanced_search.module
Normal file
152
advanced_search.module
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains advanced_search.module.
|
||||
*
|
||||
* This file is part of the Islandora Project.
|
||||
*
|
||||
* (c) Islandora Foundation
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
use Drupal\block\Entity\Block;
|
||||
use Drupal\Component\Utility\Unicode;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\advanced_search\AdvancedSearchQuery;
|
||||
use Drupal\advanced_search\Form\SettingsForm;
|
||||
use Drupal\advanced_search\Utilities;
|
||||
use Drupal\search_api\Query\QueryInterface as DrupalQueryInterface;
|
||||
use Drupal\views\ViewExecutable;
|
||||
use Solarium\Core\Query\QueryInterface as SolariumQueryInterface;
|
||||
|
||||
/**
|
||||
* Implements hook_theme().
|
||||
*/
|
||||
function advanced_search_theme() {
|
||||
return [
|
||||
'facets_result_item__summary' => [
|
||||
'template' => 'facets/facets-result-item--summary',
|
||||
'base hook' => 'facets_result_item',
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_library_info_alter().
|
||||
*/
|
||||
function advanced_search_library_info_alter(&$libraries, $extension) {
|
||||
if ($extension == 'facets') {
|
||||
// Override facets module javascript with customizations.
|
||||
// https://www.drupal.org/node/2940438
|
||||
$path = '/' . \Drupal::service('extension.list.module')->getPath('advanced_search') . '/js/facets';
|
||||
$libraries['soft-limit']['js'] = [
|
||||
"$path/soft-limit.js" => [],
|
||||
];
|
||||
$libraries['drupal.facets.views-ajax']['js'] = [
|
||||
"$path/facets-views-ajax.js" => [],
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_form_form_id_alter().
|
||||
*/
|
||||
function advanced_search_form_block_form_alter(&$form, FormStateInterface $form_state, $form_id) {
|
||||
// Islandora removes this condition from the form, but we require it.
|
||||
// So we can show blocks for nodes which belong to specific models.
|
||||
// Allowing us to add a block for collections only.
|
||||
$visibility = [];
|
||||
$entity_id = $form['id']['#default_value'];
|
||||
$block = Block::load($entity_id);
|
||||
if ($block) {
|
||||
$visibility = $block->getVisibility();
|
||||
}
|
||||
$manager = \Drupal::getContainer()->get('plugin.manager.condition');
|
||||
$condition_id = 'node_has_term';
|
||||
|
||||
/** @var \Drupal\Core\Condition\ConditionInterface $condition */
|
||||
if (array_key_exists($condition_id, $visibility)) {
|
||||
$condition = $manager->createInstance($condition_id, $visibility[$condition_id] ?? []);
|
||||
$form_state->set(['conditions', $condition_id], $condition);
|
||||
$condition_form = $condition->buildConfigurationForm([], $form_state);
|
||||
$condition_form['#type'] = 'details';
|
||||
$condition_form['#title'] = $condition->getPluginDefinition()['label'];
|
||||
$condition_form['#group'] = 'visibility_tabs';
|
||||
// Not all blocks are required to give this field.
|
||||
$condition_form['term']['#required'] = FALSE;
|
||||
$form['visibility'][$condition_id] = $condition_form;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_preprocess_block__facets_summary().
|
||||
*/
|
||||
function advanced_search_preprocess_block__facets_summary(&$variables) {
|
||||
// Copy data-attributes to the content as the javascript expects
|
||||
// there to be no elements between the data declaration and the
|
||||
// content of the block.
|
||||
foreach ($variables['attributes'] as $key => $value) {
|
||||
if (substr($key, 0, 4) === "data") {
|
||||
$variables['content_attributes'][$key] = $value;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_preprocess_preprocess_views_view().
|
||||
*/
|
||||
function advanced_search_preprocess_views_view(&$variables) {
|
||||
/** @var \Drupal\views\ViewExecutable $view */
|
||||
$view = &$variables['view'];
|
||||
$views = Utilities::getPagerViewDisplays();
|
||||
// Only add the toggle class for view display on displays in which the pager
|
||||
// has been created for.
|
||||
if (in_array([$view->id(), $view->current_display], $views)) {
|
||||
// Toggle between 'list' and 'grid' display depending on url parameter.
|
||||
$config = \Drupal::config(SettingsForm::CONFIG_NAME);
|
||||
|
||||
$format = \Drupal::request()->query->get('display') ?? $config->get(SettingsForm::DISPLAY_DEFAULT);
|
||||
$variables['attributes']['class'][] = "view-{$format}";
|
||||
$view->element['#attached']['library'][] = 'advanced_search/advanced.search.pager';
|
||||
}
|
||||
$view = &$variables['view'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_views_pre_view().
|
||||
*/
|
||||
function advanced_search_views_pre_view(ViewExecutable $view, $display_id, array &$args) {
|
||||
// Allow for recursive searches by disabling contextual filter.
|
||||
$advanced_search_query = new AdvancedSearchQuery();
|
||||
$advanced_search_query->alterView(\Drupal::request(), $view, $display_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_preprocess_facets_result_item().
|
||||
*/
|
||||
function advanced_search_preprocess_facets_result_item(&$variables) {
|
||||
$settings = \Drupal::config(SettingsForm::CONFIG_NAME);
|
||||
$length = $settings->get(SettingsForm::FACET_TRUNCATE);
|
||||
if (is_numeric($length)) {
|
||||
// Limit the length of facets display to at most 32 characters.
|
||||
if (is_string($variables['value'])) {
|
||||
$variables['value'] = Unicode::truncate(
|
||||
$variables['value'],
|
||||
$length,
|
||||
TRUE,
|
||||
TRUE
|
||||
);
|
||||
}
|
||||
elseif (is_string($variables['value']['text']['#title'])) {
|
||||
$variables['value']['text']['#title'] = Unicode::truncate(
|
||||
$variables['value']['text']['#title'],
|
||||
$length,
|
||||
TRUE,
|
||||
TRUE
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
17
advanced_search.routing.yml
Executable file
17
advanced_search.routing.yml
Executable file
|
|
@ -0,0 +1,17 @@
|
|||
advanced_search.ajax.blocks:
|
||||
path: '/islandora-advanced-search-ajax-blocks'
|
||||
defaults:
|
||||
_controller: '\Drupal\advanced_search\Controller\AjaxBlocksController::respond'
|
||||
requirements:
|
||||
# Allow public access to search blocks.
|
||||
_access: 'TRUE'
|
||||
|
||||
advanced_search.settings:
|
||||
path: '/admin/config/search/advanced'
|
||||
defaults:
|
||||
_form: '\Drupal\advanced_search\Form\SettingsForm'
|
||||
_title: 'Islandora Advanced Search Settings'
|
||||
requirements:
|
||||
_permission: 'administer site configuration'
|
||||
options:
|
||||
_admin_route: TRUE
|
||||
4
advanced_search.services.yml
Normal file
4
advanced_search.services.yml
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
services:
|
||||
Drupal\advanced_search\EventSubscriber\PostConvertedQueryEventSubscriber:
|
||||
tags:
|
||||
- { name: 'event_subscriber' }
|
||||
44
composer.json
Normal file
44
composer.json
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
{
|
||||
"name": "islandora/advanced_search",
|
||||
"type": "drupal-module",
|
||||
"description": "This module creates several blocks to support searching. It also enables the use of Ajax with search blocks, facets, and search results.",
|
||||
"keywords": [
|
||||
"Islandora",
|
||||
"Advanced Search"
|
||||
],
|
||||
"license": "GPL-2.0-only",
|
||||
"homepage": "https://github.com/digitalutsc/advanced_search",
|
||||
"support": {
|
||||
"issues": "https://github.com/digitalutsc/advanced_search/issues",
|
||||
"source": "https://github.com/digitalutsc/advanced_search/tree/islandora_lite"
|
||||
},
|
||||
"minimum-stability": "dev",
|
||||
"repositories": {
|
||||
"drupal": {
|
||||
"type": "composer",
|
||||
"url": "https://packages.drupal.org/8"
|
||||
}
|
||||
},
|
||||
"require": {
|
||||
"drupal/facets": "^2.0",
|
||||
"drupal/search_api_solr": "^4.2"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^8",
|
||||
"squizlabs/php_codesniffer": "^3",
|
||||
"drupal/coder": "*",
|
||||
"sebastian/phpcpd": "*"
|
||||
},
|
||||
"scripts": {
|
||||
"post-install-cmd": [
|
||||
"./vendor/bin/phpcs --config-set installed_paths ~/.composer/vendor/drupal/coder/coder_sniffer"
|
||||
],
|
||||
"post-update-cmd": [
|
||||
"./vendor/bin/phpcs --config-set installed_paths ~/.composer/vendor/drupal/coder/coder_sniffer"
|
||||
],
|
||||
"check": [
|
||||
"./vendor/bin/phpcs --standard=Drupal --ignore=*.md,vendor --extensions=php,module,inc,install,test,profile,theme,css,info .",
|
||||
"./vendor/bin/phpcpd --names='*.module,*.inc,*.test,*.php' --exclude=vendor ."
|
||||
]
|
||||
}
|
||||
}
|
||||
36
config/schema/advanced_search.schema.yml
Normal file
36
config/schema/advanced_search.schema.yml
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
advanced_search.settings:
|
||||
type: config_object
|
||||
mapping:
|
||||
lucene_on_off:
|
||||
type: integer
|
||||
label: Enable Extended DisMax Query
|
||||
lucene_label:
|
||||
type: string
|
||||
label: Set the label for the option of searching all fields
|
||||
all_fields_on_off:
|
||||
type: integer
|
||||
label: Enable searching all fields
|
||||
list_on_off:
|
||||
type: integer
|
||||
label: Expose "List view" option
|
||||
grid_on_off:
|
||||
type: integer
|
||||
label: Expose "Grid view" option.
|
||||
default-display-mode:
|
||||
type: string
|
||||
label: Default view mode
|
||||
search_query_parameter:
|
||||
type: string
|
||||
label: Search Query Parameter
|
||||
search_recursive_parameter:
|
||||
type: string
|
||||
label: Recurse Query Parameter
|
||||
search_add_operator:
|
||||
type: string
|
||||
label: Facet Add Operator
|
||||
search_remove_operator:
|
||||
type: string
|
||||
label: Facet Remove Operator
|
||||
facet_truncate:
|
||||
type: string
|
||||
label: Truncate Facet
|
||||
45
css/advanced_search.form.css
Normal file
45
css/advanced_search.form.css
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
.islandora-advanced-search-form .form-type-select {
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.islandora-advanced-search-form .form-type-select__select-wrapper {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.islandora-advanced-search-form .form-select {
|
||||
margin-right: 0.25em;
|
||||
}
|
||||
|
||||
input.islandora-advanced-search-form__add,
|
||||
input.islandora-advanced-search-form__remove {
|
||||
display: inline-block;
|
||||
background: none !important;
|
||||
border: none;
|
||||
box-shadow: none;
|
||||
color: #0c6170;
|
||||
padding: 0 !important;
|
||||
text-decoration: none;
|
||||
margin: 0 0 1rem;
|
||||
}
|
||||
|
||||
input.islandora-advanced-search-form__add:hover,
|
||||
input.islandora-advanced-search-form__add:focus,
|
||||
input.islandora-advanced-search-form__remove:hover,
|
||||
input.islandora-advanced-search-form__remove:focus {
|
||||
text-decoration: underline;
|
||||
color: #0c6170;
|
||||
outline: none;
|
||||
}
|
||||
|
||||
input.islandora-advanced-search-form__reset,
|
||||
input.islandora-advanced-search-form__search {
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.form-wrapper select {
|
||||
margin-bottom: 1.125rem;
|
||||
}
|
||||
|
||||
[id^="edit-terms"] {
|
||||
display: initial !important;
|
||||
}
|
||||
157
css/advanced_search.pager.css
Normal file
157
css/advanced_search.pager.css
Normal file
|
|
@ -0,0 +1,157 @@
|
|||
.advanced_search_result_pager .pager__summary {
|
||||
font-weight: 700;
|
||||
}
|
||||
|
||||
.advanced_search_result_pager .pager__group {
|
||||
margin: 1.25rem 0;
|
||||
padding: 1rem 0;
|
||||
border-top: 1px solid;
|
||||
border-bottom: 1px solid;
|
||||
border-color: #e5e5e5;
|
||||
display: flex;
|
||||
justify-content: flex-start;
|
||||
align-items: center;
|
||||
flex-flow: row wrap;
|
||||
}
|
||||
|
||||
@media all and (min-width: 45.063em) {
|
||||
.advanced_search_result_pager .pager__group {
|
||||
justify-content: flex-end;
|
||||
}
|
||||
.advanced_search_result_pager .pager__group > * {
|
||||
margin: 0.47214rem 0 0.47214rem 2.61803rem;
|
||||
}
|
||||
.advanced_search_result_pager .pager__group > *:first-child {
|
||||
margin-left: 0;
|
||||
}
|
||||
}
|
||||
|
||||
.advanced_search_result_pager .pager__group > * {
|
||||
margin: 0.47214rem 2rem 0.47214rem 0;
|
||||
}
|
||||
|
||||
.advanced_search_result_pager .pager__group > *:last-child {
|
||||
margin-right: 0;
|
||||
}
|
||||
|
||||
.advanced_search_result_pager .pager__group .item-list__list,
|
||||
.advanced_search_result_pager .pager__group .item-list__title,
|
||||
.advanced_search_result_pager .pager__group .item-list__item {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.advanced_search_result_pager .pager__group .item-list__title {
|
||||
font-size: initial;
|
||||
margin: 0.25rem;
|
||||
}
|
||||
|
||||
.pager {
|
||||
margin: initial;
|
||||
}
|
||||
|
||||
.pager__item {
|
||||
margin: 0.125rem;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.pager__items {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
@media all and (max-width: 45em) {
|
||||
.pager__items {
|
||||
text-align: center;
|
||||
}
|
||||
}
|
||||
|
||||
.pager__items__first-previous,
|
||||
.pager__items__num-pages,
|
||||
.pager__items__next-last {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.pager__items__first-previous,
|
||||
.pager__items__next-last {
|
||||
float: none;
|
||||
}
|
||||
|
||||
.pager__items__first-previous .pager__item,
|
||||
.pager__items__next-last .pager__item {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.pager .pager__link,
|
||||
.pager__results .pager__link {
|
||||
display: inherit;
|
||||
border-radius: 0.125em;
|
||||
border: 1px solid;
|
||||
transition: all, 0.2s, ease-in-out;
|
||||
min-width: 1.75em;
|
||||
padding: 0.125rem 0.4375rem 0;
|
||||
}
|
||||
|
||||
.pager .pager__link:focus,
|
||||
.pager .pager__link:hover,
|
||||
.pager__results .pager__link:focus,
|
||||
.pager__results .pager__link:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.pager__display .pager__link {
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
.pager__display .pager__link:hover,
|
||||
.pager__display .pager__link:focus {
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
.pager__link--is-active {
|
||||
text-decoration: underline !important;
|
||||
border: solid 2px #0d77b5;
|
||||
}
|
||||
|
||||
.view-grid .view-content .views-row {
|
||||
padding: 0px 20px 20px 0px !important;
|
||||
}
|
||||
|
||||
/* generalizing */
|
||||
.advanced_search_result_pager .pager__group .pager {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.advanced_search_result_pager .pager__group > * {
|
||||
margin: 0.47214rem 2rem 0.47214rem 0;
|
||||
display: flex;
|
||||
}
|
||||
|
||||
.advanced_search_result_pager .pager__group > *:last-child {
|
||||
margin-right: 0;
|
||||
}
|
||||
|
||||
.view-filters {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.pager__group .container {
|
||||
width: auto !important;
|
||||
padding-left: 0 !important;
|
||||
padding-right: 0 !important;
|
||||
}
|
||||
|
||||
.advanced_search_result_pager .pager__group nav {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.view-grid > .view-content {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(3, 1fr);
|
||||
/*margin: 0.47214rem 0 0.47214rem 2.61803rem;*/
|
||||
}
|
||||
|
||||
@media only screen and (max-width: 600px) {
|
||||
.view-grid > .view-content {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(1, 1fr);
|
||||
}
|
||||
}
|
||||
BIN
docs/advanced_search_block_settings.png
Normal file
BIN
docs/advanced_search_block_settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 327 KiB |
BIN
docs/advanced_search_settings.png
Normal file
BIN
docs/advanced_search_settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 89 KiB |
BIN
docs/basic-exposed-form.png
Normal file
BIN
docs/basic-exposed-form.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
BIN
docs/contextual_filter_settings.png
Normal file
BIN
docs/contextual_filter_settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 188 KiB |
BIN
docs/demo.gif
Normal file
BIN
docs/demo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 645 KiB |
BIN
docs/enable_index_hierarchy.png
Normal file
BIN
docs/enable_index_hierarchy.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
BIN
docs/enable_index_hierarchy_processor.png
Normal file
BIN
docs/enable_index_hierarchy_processor.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 66 KiB |
BIN
docs/exclude_facet_settings_exclude.png
Normal file
BIN
docs/exclude_facet_settings_exclude.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.1 KiB |
BIN
docs/exclude_facet_settings_url_alias.png
Normal file
BIN
docs/exclude_facet_settings_url_alias.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.7 KiB |
BIN
docs/facet_block_settings.png
Normal file
BIN
docs/facet_block_settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
BIN
docs/field_descendant_of.png
Normal file
BIN
docs/field_descendant_of.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
BIN
docs/include_exclude_facets.png
Normal file
BIN
docs/include_exclude_facets.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
BIN
docs/include_exclude_facets_settings.png
Normal file
BIN
docs/include_exclude_facets_settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
BIN
docs/include_subcollections.png
Normal file
BIN
docs/include_subcollections.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
BIN
docs/lucene_search_form.png
Normal file
BIN
docs/lucene_search_form.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 65 KiB |
BIN
docs/pager.png
Normal file
BIN
docs/pager.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
docs/pager_settings.png
Normal file
BIN
docs/pager_settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 78 KiB |
BIN
docs/simple_search_settings.png
Normal file
BIN
docs/simple_search_settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 99 KiB |
BIN
docs/sort_criteria.png
Normal file
BIN
docs/sort_criteria.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.7 KiB |
BIN
docs/view_advanced_setting.png
Normal file
BIN
docs/view_advanced_setting.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
113
js/advanced_search.admin.js
Normal file
113
js/advanced_search.admin.js
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
//# sourceURL=modules/contrib/advanced_search/js/islandora-advanced-search.admin.js
|
||||
/**
|
||||
* @file
|
||||
* Largely based on core/modules/blocks/js/blocks.js
|
||||
*
|
||||
* This file allows for moving rows between two regions in a table and have the
|
||||
* 'region' field update appropriately.
|
||||
*/
|
||||
(function ($, window, Drupal) {
|
||||
Drupal.behaviors.islandoraAdvancedSearchAdmin = {
|
||||
attach: function attach(context, settings) {
|
||||
if (typeof Drupal.tableDrag === 'undefined' || typeof Drupal.tableDrag['advanced-search-fields'] === 'undefined') {
|
||||
return;
|
||||
}
|
||||
|
||||
function checkEmptyRegions(table, rowObject) {
|
||||
table.find('tr.region-message').each(function () {
|
||||
var $this = $(this);
|
||||
|
||||
if ($this.prev('tr').get(0) === rowObject.element) {
|
||||
if (rowObject.method !== 'keyboard' || rowObject.direction === 'down') {
|
||||
rowObject.swap('after', this);
|
||||
}
|
||||
}
|
||||
|
||||
if ($this.next('tr').is(':not(.draggable)') || $this.next('tr').length === 0) {
|
||||
$this.removeClass('region-populated').addClass('region-empty');
|
||||
} else if ($this.is('.region-empty')) {
|
||||
$this.removeClass('region-empty').addClass('region-populated');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function updateLastPlaced(table, rowObject) {
|
||||
table.find('.color-success').removeClass('color-success');
|
||||
|
||||
var $rowObject = $(rowObject);
|
||||
if (!$rowObject.is('.drag-previous')) {
|
||||
table.find('.drag-previous').removeClass('drag-previous');
|
||||
$rowObject.addClass('drag-previous');
|
||||
}
|
||||
}
|
||||
|
||||
function updateFieldWeights(table, region) {
|
||||
var weight = -Math.round(table.find('.draggable').length / 2);
|
||||
|
||||
table.find('.region-' + region + '-message').nextUntil('.region-title').find('select.field-weight').val(function () {
|
||||
return ++weight;
|
||||
});
|
||||
}
|
||||
|
||||
var table = $('#advanced-search-fields');
|
||||
|
||||
var tableDrag = Drupal.tableDrag['advanced-search-fields'];
|
||||
|
||||
tableDrag.row.prototype.onSwap = function (swappedRow) {
|
||||
checkEmptyRegions(table, this);
|
||||
updateLastPlaced(table, this);
|
||||
};
|
||||
|
||||
tableDrag.onDrop = function () {
|
||||
var dragObject = this;
|
||||
var $rowElement = $(dragObject.rowObject.element);
|
||||
|
||||
var regionRow = $rowElement.prevAll('tr.region-message').get(0);
|
||||
var regionName = regionRow.className.replace(/([^ ]+[ ]+)*region-([^ ]+)-message([ ]+[^ ]+)*/, '$2');
|
||||
var regionField = $rowElement.find('select.field-display');
|
||||
|
||||
if (regionField.find('option[value=' + regionName + ']').length === 0) {
|
||||
window.alert(Drupal.t('The field cannot be placed in this region.'));
|
||||
|
||||
regionField.trigger('change');
|
||||
}
|
||||
|
||||
if (!regionField.is('.field-display-' + regionName)) {
|
||||
var weightField = $rowElement.find('select.field-weight');
|
||||
var oldRegionName = weightField[0].className.replace(/([^ ]+[ ]+)*field-weight-([^ ]+)([ ]+[^ ]+)*/, '$2');
|
||||
regionField.removeClass('field-display-' + oldRegionName).addClass('field-display-' + regionName);
|
||||
weightField.removeClass('field-weight-' + oldRegionName).addClass('field-weight-' + regionName);
|
||||
regionField.val(regionName);
|
||||
}
|
||||
|
||||
updateFieldWeights(table, regionName);
|
||||
};
|
||||
|
||||
$(once('field-display', 'select.field-display', context)).on('change', function (event) {
|
||||
var row = $(this).closest('tr');
|
||||
var select = $(this);
|
||||
|
||||
tableDrag.rowObject = new tableDrag.row(row[0]);
|
||||
var regionMessage = table.find('.region-' + select[0].value + '-message');
|
||||
var regionItems = regionMessage.nextUntil('.region-message, .region-title');
|
||||
if (regionItems.length) {
|
||||
regionItems.last().after(row);
|
||||
} else {
|
||||
regionMessage.after(row);
|
||||
}
|
||||
updateFieldWeights(table, select[0].value);
|
||||
|
||||
checkEmptyRegions(table, tableDrag.rowObject);
|
||||
|
||||
updateLastPlaced(table, row);
|
||||
|
||||
if (!tableDrag.changed) {
|
||||
$(Drupal.theme('tableDragChangedWarning')).insertBefore(tableDrag.table).hide().fadeIn('slow');
|
||||
tableDrag.changed = true;
|
||||
}
|
||||
|
||||
select.trigger('blur');
|
||||
});
|
||||
}
|
||||
};
|
||||
})(jQuery, window, Drupal);
|
||||
39
js/advanced_search.entityFields.js
Normal file
39
js/advanced_search.entityFields.js
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
(function ($, Drupal, drupalSettings) {
|
||||
Drupal.behaviors.advanceSearchEntityFields = {
|
||||
attach: function attach(context, settings) {
|
||||
let $searchSelectElement = $('#edit-terms-0-search');
|
||||
let originalSearchSelectOptions = $searchSelectElement.find('option').clone();
|
||||
$(document).on('change', '.advanced-search-form-entity', function() {
|
||||
console.log('change');
|
||||
let id = $(this).attr('id');
|
||||
let i = id.substring(11, 12);
|
||||
let $select = $('#' + id);
|
||||
let searchSelectId = 'edit-terms-' + i + '-search';
|
||||
console.log(searchSelectId);
|
||||
let selector = "[id^='" + searchSelectId + "']";
|
||||
console.log(selector);
|
||||
let $searchSelect = $(selector);
|
||||
console.log($searchSelect);
|
||||
if ($select.val() === 'ba419826c9014f40126565bf413f7a59') { // Auktion
|
||||
$searchSelect.empty();
|
||||
$searchSelect.append('<option value="label">Titel</option>');
|
||||
$searchSelect.append('<option value="ff8fb361d19f1fb4030605f87cb995ff">Auktionshaus</option>');
|
||||
$searchSelect.append('<option value="f4394d15487b58f49c719cf850f57e3a">Auktionskatalog</option>');
|
||||
$searchSelect.append('<option value="fd76aa80d3352b4ad8733552c8a10e7a">involvierte Institutionen</option>');
|
||||
$searchSelect.append('<option value="fa809b28c4e8b22e6a8f77722b04fae1">involvierte Personen</option>');
|
||||
} else if ($select.val() === 'b1d559f7b6af224a3f6f3b9a12e6b161') { // Institution
|
||||
$searchSelect.empty();
|
||||
$searchSelect.append('<option value="f838846307ea61a3d408df5022d498ba">Name</option>');
|
||||
$searchSelect.append('<option value="f53c209f6575fb5a7a0e7e7f424f7abd">Alternative Namen</option>');
|
||||
$searchSelect.append('<option value="field_mit_institution_verbundene">verbundene Orte</option>');
|
||||
} else if ($select.val() === 'alles') {
|
||||
$searchSelect.empty();
|
||||
$.each(originalSearchSelectOptions, function(i, option) {
|
||||
$searchSelect.append(option);
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
})(jQuery, Drupal, drupalSettings);
|
||||
202
js/advanced_search.form.js
Normal file
202
js/advanced_search.form.js
Normal file
|
|
@ -0,0 +1,202 @@
|
|||
//# sourceURL=modules/contrib/islandora/modules/advanced_search/js/islandora-advanced-search.form.js
|
||||
/**
|
||||
* @file
|
||||
* Handles Ajax submission / updating form action on url change, etc.
|
||||
*/
|
||||
(function ($, Drupal, drupalSettings) {
|
||||
// Replace Results per page html h3 tag with strong tag
|
||||
jQuery('h3:contains("Results per page")').replaceWith(function(){
|
||||
return jQuery("<strong />", {html: jQuery(this).html()});
|
||||
});
|
||||
|
||||
|
||||
// Gets current parameters minus ones provided by the form.
|
||||
function getParams(query_parameter, recurse_parameter) {
|
||||
const url_search_params = new URLSearchParams(window.location.search);
|
||||
const params = Object.fromEntries(url_search_params.entries());
|
||||
// Remove Advanced Search Query Parameters.
|
||||
const param_match = "query\\[\\d+\\]\\[.+\\]".replace("query", query_parameter);
|
||||
const param_regex = new RegExp(param_match, "g");
|
||||
for (const param in params) {
|
||||
if (param.match(param_regex)) {
|
||||
delete params[param];
|
||||
}
|
||||
}
|
||||
// Remove Recurse parameter.
|
||||
delete params[recurse_parameter];
|
||||
// Remove the page if set as submitting the form should always take
|
||||
// the user to the first page (facets do the same).
|
||||
delete params["page"];
|
||||
return params;
|
||||
}
|
||||
|
||||
// Groups form inputs by search term.
|
||||
function getTerms(inputs) {
|
||||
const input_regex = /terms\[(?<index>\d+)\]\[(?<component>.*)\]/;
|
||||
const terms = [];
|
||||
for (const input in inputs) {
|
||||
const name = inputs[input].name;
|
||||
const value = inputs[input].value;
|
||||
const found = name.match(input_regex);
|
||||
if (found) {
|
||||
const index = parseInt(found.groups.index);
|
||||
const component = found.groups.component;
|
||||
if (typeof terms[index] !== 'object') {
|
||||
terms[index] = {};
|
||||
}
|
||||
terms[index][component] = value;
|
||||
}
|
||||
}
|
||||
return terms;
|
||||
}
|
||||
|
||||
// Checks if the form user has set recursive to true in the form.
|
||||
function getRecurse(inputs) {
|
||||
for (const input in inputs) {
|
||||
const name = inputs[input].name;
|
||||
const value = inputs[input].value;
|
||||
if (name == "recursive" && value == "1") {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
function url(inputs, settings) {
|
||||
const terms = getTerms(inputs);
|
||||
const recurse = getRecurse(inputs);
|
||||
const params = getParams(settings.query_parameter, settings.recurse_parameter);
|
||||
for (const index in terms) {
|
||||
const term = terms[index];
|
||||
// Do not include terms with no value.
|
||||
if (term.value.length != 0) {
|
||||
for (const component in term) {
|
||||
const value = term[component];
|
||||
const param = "query[index][component]"
|
||||
.replace("query", settings.query_parameter)
|
||||
.replace("index", index)
|
||||
.replace("component", settings.mapping[component]);
|
||||
params[param] = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (recurse) {
|
||||
params[settings.recurse_parameter] = '1';
|
||||
}
|
||||
return window.location.href.split("?")[0] + "?" + $.param(params);
|
||||
}
|
||||
|
||||
function updateParam(urlstring, param, value) {
|
||||
var url = new URL(urlstring);
|
||||
var search_params = url.searchParams;
|
||||
|
||||
search_params.set(param, value);
|
||||
|
||||
url.search = search_params.toString();
|
||||
|
||||
return url.toString();
|
||||
}
|
||||
|
||||
Drupal.behaviors.advanced_search_form = {
|
||||
attach: function (context, settings) {
|
||||
if (settings.advanced_search_form.id !== 'undefined') {
|
||||
const $form = $(once('search-form', 'form#' + settings.advanced_search_form.id));
|
||||
if ($form.length > 0) {
|
||||
window.addEventListener("pushstate", function (e) {
|
||||
$form.attr('action', window.location.pathname + window.location.search);
|
||||
});
|
||||
window.addEventListener("popstate", function (e) {
|
||||
if (e.state != null) {
|
||||
$form.attr('action', window.location.pathname + window.location.search);
|
||||
}
|
||||
});
|
||||
|
||||
/* digitalutsc added */
|
||||
$("input[name*='[value]']").each(function () {
|
||||
// enable enter key trigger submit searching
|
||||
$(this).on("keypress", function (e) {
|
||||
|
||||
if (e.keyCode == 13) {
|
||||
// Cancel the default action on keypress event
|
||||
e.preventDefault();
|
||||
$form.submit();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
// Prevent form submission and push state instead.
|
||||
//
|
||||
// Logic server side / client side should match to generate the
|
||||
// appropriate URL with javascript enabled or disable.
|
||||
//
|
||||
// If a route is set for the view display that this form is derived
|
||||
// from, and we are not on the same page as that route, rely on the
|
||||
// normal submit which will redirect to the appropriate page.
|
||||
if (!settings.advanced_search_form.redirect) {
|
||||
$form.submit(function (e) {
|
||||
//e.preventDefault();
|
||||
e.stopPropagation();
|
||||
const inputs = $form.serializeArray();
|
||||
const href = url(inputs, settings.advanced_search_form);
|
||||
|
||||
/* digitalutsc added*/
|
||||
$("li.pager__item a.pager__itemsperpage").each(function( index ) {
|
||||
// update pager links - items per page
|
||||
var new_link = href;
|
||||
if (href.includes("items_per_page=") === false) {
|
||||
new_link = new_link + '&items_per_page=' + $(this).text().trim().toLowerCase();
|
||||
$( this ).attr("href", new_link);
|
||||
}
|
||||
else {
|
||||
// replace with new param
|
||||
new_link = updateParam(new_link, "items_per_page", $(this).text().trim().toLowerCase());
|
||||
$( this ).attr("href", new_link);
|
||||
}
|
||||
});
|
||||
|
||||
$("li.pager__item a.pager__display").each(function( index ) {
|
||||
// update pager links - display
|
||||
var new_link = href;
|
||||
if (href.includes("display=") === false) {
|
||||
new_link = new_link + '&display=' + $(this).text().trim().toLowerCase();
|
||||
$( this ).attr("href", new_link);
|
||||
}
|
||||
else {
|
||||
// replace with new param
|
||||
new_link = updateParam(new_link, "display", $(this).text().trim().toLowerCase());
|
||||
$( this ).attr("href", new_link);
|
||||
}
|
||||
});
|
||||
|
||||
window.history.pushState(null, document.title, href);
|
||||
});
|
||||
}
|
||||
// Reset should trigger refresh of AJAX Blocks / Views.
|
||||
$form.find('input[data-drupal-selector = "edit-reset"]').mousedown(function (e) {
|
||||
const inputs = [];
|
||||
const href = url(inputs, settings.advanced_search_form);
|
||||
window.history.pushState(null, document.title, href.split('?')[0] );
|
||||
|
||||
/* reset the url after reset button clicked */
|
||||
window.location.replace(href.split('?')[0]);
|
||||
});
|
||||
|
||||
// Handle the page summary
|
||||
$("#ajax-page-summary").hide();
|
||||
$( document ).ajaxComplete(function( event, request, settings ) {
|
||||
console.log('ajax complete');
|
||||
|
||||
$("#ajax-page-summary").hide();
|
||||
if (jQuery("#ajax-page-summary").length >0) {
|
||||
$(".pager__summary").html($("#ajax-page-summary").html());
|
||||
}
|
||||
else {
|
||||
$(".pager__summary").html("");
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
})(jQuery, Drupal, drupalSettings);
|
||||
265
js/facets/facets-views-ajax.js
Normal file
265
js/facets/facets-views-ajax.js
Normal file
|
|
@ -0,0 +1,265 @@
|
|||
//# sourceURL=modules/contrib/islandora/modules/advanced_search/js/facets/facets-view.ajax.js
|
||||
/**
|
||||
* @file
|
||||
* Overrides the facets-view-ajax.js behavior from the 'facets' module.
|
||||
*/
|
||||
(function ($, Drupal) {
|
||||
"use strict";
|
||||
|
||||
// Generate events on push state.
|
||||
(function (history) {
|
||||
var pushState = history.pushState;
|
||||
history.pushState = function (state, title, url) {
|
||||
var ret = pushState.apply(this, arguments);
|
||||
var event = new Event("pushstate");
|
||||
window.dispatchEvent(event);
|
||||
return ret;
|
||||
};
|
||||
})(window.history);
|
||||
|
||||
function parseQueryString( queryString ) {
|
||||
var params = {}, queries, temp, i, l;
|
||||
|
||||
// Split into key/value pairs
|
||||
queries = queryString.split("&");
|
||||
|
||||
// Convert the array of strings into an object
|
||||
for ( i = 0, l = queries.length; i < l; i++ ) {
|
||||
temp = queries[i].split('=');
|
||||
params[temp[0]] = temp[1];
|
||||
}
|
||||
|
||||
return params;
|
||||
};
|
||||
|
||||
function reload(url) {
|
||||
// Update View.
|
||||
if (drupalSettings && drupalSettings.views && drupalSettings.views.ajaxViews) {
|
||||
var view_path = drupalSettings.views.ajax_path;
|
||||
$.each(drupalSettings.views.ajaxViews, function (views_dom_id) {
|
||||
var views_parameters = Drupal.Views.parseQueryString(url);
|
||||
var views_arguments = Drupal.Views.parseViewArgs(url, "search");
|
||||
var views_settings = $.extend(
|
||||
{},
|
||||
Drupal.views.instances[views_dom_id].settings,
|
||||
views_arguments,
|
||||
views_parameters
|
||||
);
|
||||
var views_ajax_settings =
|
||||
Drupal.views.instances[views_dom_id].element_settings;
|
||||
views_ajax_settings.submit = views_settings;
|
||||
views_ajax_settings.url =
|
||||
view_path + "?" + $.param(Drupal.Views.parseQueryString(url));
|
||||
Drupal.ajax(views_ajax_settings).execute();
|
||||
});
|
||||
}
|
||||
|
||||
// Update items_per_page links in pager
|
||||
if (url.indexOf("items_per_page=") == -1) {
|
||||
// append items_per_page
|
||||
$("a.pager__itemsperpage").each(function( index ) {
|
||||
var newUrl = url + "&items_per_page=" + $(this).html();
|
||||
$(this).attr("href", newUrl);
|
||||
});
|
||||
}
|
||||
else {
|
||||
// replace existed items_per_page
|
||||
var params = parseQueryString(url.split("?")[1]);
|
||||
var newParams = [];
|
||||
var existingDateQuery = false; // true if a date query already exists
|
||||
|
||||
var links = {};
|
||||
// update publication date in url if previously queried
|
||||
for (var key in params) {
|
||||
if (!params[key]) { // no search parameters in url
|
||||
break;
|
||||
}
|
||||
|
||||
// check for items_per_page query
|
||||
if (!key.startsWith("items_per_page")) {
|
||||
newParams.push(key + "=" + params[key]);
|
||||
}
|
||||
}
|
||||
var newParamsUrl = newParams.join('&');
|
||||
$("a.pager__itemsperpage").each(function( index ) {
|
||||
$(this).attr("href", url.split("?")[0] + '?' + newParamsUrl + "&items_per_page=" + $(this).html());
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
// Update display mode links in pager
|
||||
if (url.indexOf("display=") == -1) {
|
||||
// append items_per_page
|
||||
$("a.pager__display").each(function( index ) {
|
||||
var newUrl = url + "&display=" + $(this).find(".display-mode").html().toLowerCase();
|
||||
$(this).attr("href", newUrl);
|
||||
});
|
||||
}
|
||||
else {
|
||||
// replace existed display
|
||||
var params = parseQueryString(url.split("?")[1]);
|
||||
var newParams = [];
|
||||
var existingDateQuery = false; // true if a date query already exists
|
||||
|
||||
var links = {};
|
||||
// update publication date in url if previously queried
|
||||
for (var key in params) {
|
||||
if (!params[key]) { // no search parameters in url
|
||||
break;
|
||||
}
|
||||
|
||||
// check for display query
|
||||
if (!key.startsWith("display")) {
|
||||
newParams.push(key + "=" + params[key]);
|
||||
}
|
||||
}
|
||||
var newParamsUrl = newParams.join('&');
|
||||
$("a.pager__display").each(function( index ) {
|
||||
|
||||
var value = $(this).find(".display-mode").html().toLowerCase();
|
||||
$(this).attr("href", url.split("?")[0] + '?' + newParamsUrl + "&display=" + value);
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
// Replace filter, pager, summary, and facet blocks.
|
||||
var blocks = {};
|
||||
$(
|
||||
"[class*='block-plugin-id--islandora-advanced-search-result-pager'], [class*='block-plugin-id--views-exposed-filter-block'], [class*='block-facets']"
|
||||
).each(function () {
|
||||
var id = $(this).attr("id");
|
||||
var block_id = id
|
||||
.slice("block-".length, id.length)
|
||||
.replace(/--.*$/g, "")
|
||||
.replace(/-/g, "_");
|
||||
blocks[block_id] = "#" + id;
|
||||
});
|
||||
Drupal.ajax({
|
||||
url: Drupal.url("islandora-advanced-search-ajax-blocks"),
|
||||
submit: {
|
||||
link: url,
|
||||
blocks: blocks,
|
||||
},
|
||||
}).execute();
|
||||
}
|
||||
|
||||
// On location change reload all the blocks / ajax view.
|
||||
window.addEventListener("pushstate", function (e) {
|
||||
reload(window.location.href);
|
||||
});
|
||||
|
||||
window.addEventListener("popstate", function (e) {
|
||||
if (e.state != null) {
|
||||
reload(window.location.href);
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Push state on form/pager/facet change.
|
||||
*/
|
||||
Drupal.behaviors.islandoraAdvancedSearchViewsAjax = {
|
||||
attach: function (context, settings) {
|
||||
window.historyInitiated = true;
|
||||
// Remove existing behavior from form.
|
||||
if (settings && settings.views && settings.views.ajaxViews) {
|
||||
$.each(settings.views.ajaxViews, function (index, settings) {
|
||||
var exposed_form = $(
|
||||
"form#views-exposed-form-" +
|
||||
settings.view_name.replace(/_/g, "-") +
|
||||
"-" +
|
||||
settings.view_display_id.replace(/_/g, "-")
|
||||
);
|
||||
$(once('exposed-form',
|
||||
"form#views-exposed-form-" +
|
||||
settings.view_name.replace(/_/g, "-") +
|
||||
"-" +
|
||||
settings.view_display_id.replace(/_/g, "-")))
|
||||
.find("input[type=submit], input[type=image]")
|
||||
.not("[data-drupal-selector=edit-reset]")
|
||||
.each(function (index) {
|
||||
$(this).unbind("click");
|
||||
$(this).click(function (e) {
|
||||
// Let ctrl/cmd click open in a new window.
|
||||
if (e.shiftKey || e.ctrlKey || e.metaKey) {
|
||||
return;
|
||||
}
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
var href = window.location.href;
|
||||
var params = Drupal.Views.parseQueryString(href);
|
||||
// Remove the page if set as submitting the form should always take
|
||||
// the user to the first page (facets do the same).
|
||||
delete params.page;
|
||||
// Include values from the form in the URL.
|
||||
$.each(exposed_form.serializeArray(), function () {
|
||||
params[this.name] = this.value;
|
||||
});
|
||||
href = href.split("?")[0] + "?" + $.param(params);
|
||||
window.history.pushState(null, document.title, href);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
if (window.location.search.includes("display=") === true) {
|
||||
|
||||
$("li.pager__item a.pager__display").each(function () {
|
||||
$(this).parent().removeClass("is-active");
|
||||
$(this).removeClass("pager__link--is-active");
|
||||
if ($(this).text().trim().toLowerCase() === getParam(window.location.search, "display").trim().toLowerCase()) {
|
||||
$(this).addClass("pager__link--is-active");
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
if (window.location.search.includes("items_per_page=") === true) {
|
||||
$("li.pager__item a.pager__itemsperpage").each(function() {
|
||||
$(this).parent().removeClass("is-active");
|
||||
$(this).removeClass("pager__link--is-active");
|
||||
if ($(this).text().trim().toLowerCase() === getParam(window.location.search, "items_per_page").trim().toLowerCase()) {
|
||||
$(this).addClass("pager__link--is-active");
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
function getParam(urlstring, param) {
|
||||
var searchparam = new URLSearchParams(urlstring);
|
||||
return searchparam.get(param);
|
||||
}
|
||||
|
||||
// Attach behavior to pager, summary, facet links.
|
||||
$(once("new-window", "[data-drupal-pager-id], [data-drupal-facets-summary-id], [data-drupal-facet-id]"))
|
||||
.find("a:not(.facet-item)")
|
||||
.click(function (e) {
|
||||
// Let ctrl/cmd click open in a new window.
|
||||
if (e.shiftKey || e.ctrlKey || e.metaKey) {
|
||||
return;
|
||||
}
|
||||
e.preventDefault();
|
||||
|
||||
// added to prevent page reload if a facet link is clicked (Ajax of view is enabled)
|
||||
e.stopImmediatePropagation();
|
||||
|
||||
window.history.pushState(null, document.title, $(this).attr("href"));
|
||||
});
|
||||
|
||||
// Trigger on sort change.
|
||||
$(once('params-sort', '[data-drupal-pager-id] select[name="order"], .pager__sort select[name="order"]'))
|
||||
.change(function () {
|
||||
var href = window.location.href;
|
||||
var params = Drupal.Views.parseQueryString(href);
|
||||
|
||||
var selection = $(this).val();
|
||||
var option = selection.split('_');
|
||||
params.sort_order = option[option.length - 1].toUpperCase();
|
||||
params.sort_by = selection.replace("_" + option[option.length - 1], "");
|
||||
href = href.split("?")[0] + "?" + $.param(params);
|
||||
window.history.pushState(null, document.title, href);
|
||||
});
|
||||
|
||||
},
|
||||
};
|
||||
})(jQuery, Drupal);
|
||||
74
js/facets/soft-limit.js
Normal file
74
js/facets/soft-limit.js
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
/**
|
||||
* @file
|
||||
* Provides the soft limit functionality.
|
||||
*/
|
||||
|
||||
(function ($) {
|
||||
|
||||
'use strict';
|
||||
|
||||
Drupal.behaviors.facetSoftLimit = {
|
||||
attach: function (context, settings) {
|
||||
if (settings.facets.softLimit !== 'undefined') {
|
||||
$.each(settings.facets.softLimit, function (facet, limit) {
|
||||
Drupal.facets.applySoftLimit(facet, limit, settings);
|
||||
});
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
Drupal.facets = Drupal.facets || {};
|
||||
|
||||
/**
|
||||
* Applies the soft limit UI feature to a specific facets list.
|
||||
*
|
||||
* @param {string} facet
|
||||
* The facet id.
|
||||
* @param {string} limit
|
||||
* The maximum amount of items to show.
|
||||
* @param {object} settings
|
||||
* Settings.
|
||||
*/
|
||||
Drupal.facets.applySoftLimit = function (facet, limit, settings) {
|
||||
var zero_based_limit = (limit - 1);
|
||||
var facet_id = facet;
|
||||
var facetsList = $('ul[data-drupal-facet-id="' + facet_id + '"]');
|
||||
|
||||
// In case of multiple instances of a facet, we need to key them.
|
||||
if (facetsList.length > 1) {
|
||||
facetsList.each(function (key, $value) {
|
||||
$(this).attr('data-drupal-facet-id', facet_id + '-' + key);
|
||||
});
|
||||
}
|
||||
|
||||
// Hide facets over the limit.
|
||||
facetsList.each(function () {
|
||||
$(once('applysoftlimit', $(this).children('li:gt(' + zero_based_limit + ')'))).hide();
|
||||
});
|
||||
|
||||
|
||||
// Add "Show more" / "Show less" links.
|
||||
facetsList.filter(function () {
|
||||
return ($(this).find('li').length > limit && $(this).parent().find('a.facets-soft-limit-link').length < 1);
|
||||
}).each(function () {
|
||||
var facet = $(this);
|
||||
var showLessLabel = settings.facets.softLimitSettings[facet_id].showLessLabel;
|
||||
var showMoreLabel = settings.facets.softLimitSettings[facet_id].showMoreLabel;
|
||||
$('<a href="#" class="facets-soft-limit-link"></a>')
|
||||
.text(showMoreLabel).attr("aria-expanded", "false")
|
||||
.on('click', function () {
|
||||
if (facet.find('li:hidden').length > 0) {
|
||||
facet.find('li:gt(' + zero_based_limit + ')').slideDown();
|
||||
facet.find('li:lt(' + (zero_based_limit + 2) + ') input').focus();
|
||||
$(this).addClass('open').text(showLessLabel).attr("aria-expanded", "true");
|
||||
}
|
||||
else {
|
||||
facet.find('li:gt(' + zero_based_limit + ')').slideUp();
|
||||
$(this).removeClass('open').text(showMoreLabel).attr("aria-expanded", "false");
|
||||
}
|
||||
return false;
|
||||
}).insertAfter($(this));
|
||||
});
|
||||
};
|
||||
|
||||
})(jQuery);
|
||||
446
src/AdvancedSearchQuery.php
Normal file
446
src/AdvancedSearchQuery.php
Normal file
|
|
@ -0,0 +1,446 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search;
|
||||
|
||||
use Drupal\block\Entity\Block;
|
||||
use Drupal\Core\EventSubscriber\MainContentViewSubscriber;
|
||||
use Drupal\Core\Form\FormBuilderInterface;
|
||||
use Drupal\Core\Url;
|
||||
use Drupal\advanced_search\Form\SettingsForm;
|
||||
use Drupal\advanced_search\Plugin\Block\AdvancedSearchBlock;
|
||||
use Drupal\search_api\Query\QueryInterface as DrupalQueryInterface;
|
||||
use Drupal\views\ViewExecutable;
|
||||
use Solarium\Core\Query\QueryInterface as SolariumQueryInterface;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
use Drupal\search_api_solr\Utility\Utility as SearchAPISolrUtility;
|
||||
|
||||
/**
|
||||
* Alter current search query / view from using URL parameters.
|
||||
*/
|
||||
class AdvancedSearchQuery {
|
||||
|
||||
use GetConfigTrait;
|
||||
|
||||
// User can set this configuration for the module.
|
||||
const DEFAULT_QUERY_PARAM = 'a';
|
||||
const DEFAULT_RECURSE_PARAM = 'r';
|
||||
|
||||
/**
|
||||
* The query parameter is how terms are passed to the query.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $queryParameter;
|
||||
|
||||
/**
|
||||
* The recurse parameter indicates the search should be recursive or not.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $recurseParameter;
|
||||
|
||||
/**
|
||||
* Constructs a FacetBlockAjaxController object.
|
||||
*
|
||||
* @param string $query_parameter
|
||||
* The field to search against.
|
||||
* @param string $recurse_parameter
|
||||
* The field that signifies the search should be recursive.
|
||||
*/
|
||||
public function __construct(string $query_parameter = self::DEFAULT_QUERY_PARAM, string $recurse_parameter = self::DEFAULT_RECURSE_PARAM) {
|
||||
$this->queryParameter = $query_parameter;
|
||||
$this->recurseParameter = $recurse_parameter;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the query parameter to use that stores the search terms.
|
||||
*
|
||||
* @return string
|
||||
* The query parameter to use that stores the search terms.
|
||||
*/
|
||||
public static function getQueryParameter() {
|
||||
return self::getConfig(SettingsForm::SEARCH_QUERY_PARAMETER, self::DEFAULT_QUERY_PARAM);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the query parameter to use that stores the search terms.
|
||||
*
|
||||
* @return string
|
||||
* The recurse parameter used to indicate that the search should be
|
||||
* recursive.
|
||||
*/
|
||||
public static function getRecurseParameter() {
|
||||
return self::getConfig(SettingsForm::SEARCH_RECURSIVE_PARAMETER, self::DEFAULT_RECURSE_PARAM);
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts a list of AdvancedSearchQueryTerms from the given request.
|
||||
*
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
* The request to parse terms from.
|
||||
*
|
||||
* @return \Drupal\advanced_search\AdvancedSearchQueryTerm[]
|
||||
* A list of search terms.
|
||||
*/
|
||||
public function getTerms(Request $request) {
|
||||
$terms = [];
|
||||
if ($request->query->has($this->queryParameter)) {
|
||||
$query_params = $request->query->all()[$this->queryParameter];
|
||||
if (is_array($query_params)) {
|
||||
foreach ($query_params as $params) {
|
||||
$terms[] = AdvancedSearchQueryTerm::fromQueryParams($params);
|
||||
}
|
||||
}
|
||||
}
|
||||
return array_filter($terms);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the query should recursively include sub-collections.
|
||||
*
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
* The request to parse.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the search should recurse FALSE otherwise.
|
||||
*/
|
||||
public function shouldRecurse(Request $request) {
|
||||
if ($request->query->has($this->recurseParameter)) {
|
||||
$recurse_param = $request->query->get($this->recurseParameter);
|
||||
return filter_var($recurse_param, FILTER_VALIDATE_BOOLEAN);
|
||||
}
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the all of the given terms are negations or not.
|
||||
*
|
||||
* @param \Drupal\advanced_search\AdvancedSearchQueryTerm[] $terms
|
||||
* The terms to search for.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if all terms are to be excluded otherwise FALSE.
|
||||
*/
|
||||
protected function negativeQuery(array $terms) {
|
||||
foreach ($terms as $term) {
|
||||
if ($term->getInclude()) {
|
||||
return FALSE;
|
||||
}
|
||||
}
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Alters the given query using search terms provided in the given request.
|
||||
*
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
* The request to parse terms from.
|
||||
* @param \Solarium\Core\Query\QueryInterface $solarium_query
|
||||
* The solr query to modify.
|
||||
* @param \Drupal\search_api\Query\QueryInterface $search_api_query
|
||||
* The search api query from which the solr query was build.
|
||||
*/
|
||||
public function alterQuery(Request $request, SolariumQueryInterface &$solarium_query, DrupalQueryInterface $search_api_query) {
|
||||
// Only apply if a Advanced Search Query was made.
|
||||
$terms = $this->getTerms($request);
|
||||
if (!empty($terms)) {
|
||||
$index = $search_api_query->getIndex();
|
||||
/** @var \Drupal\search_api_solr\Plugin\search_api\backend\SearchApiSolrBackend $backend */
|
||||
$backend = $index->getServerInstance()->getBackend();
|
||||
$language_ids = $search_api_query->getLanguages();
|
||||
$field_mapping = $backend->getSolrFieldNamesKeyedByLanguage($language_ids, $index);
|
||||
|
||||
// Disable for Lucene and wildcard
|
||||
// $q[] = "{!boost b=boost_document}";
|
||||
// Create a flag for active/inactive dismax.
|
||||
$config = \Drupal::config(SettingsForm::CONFIG_NAME);
|
||||
$isDismax = $config->get(SettingsForm::EDISMAX_SEARCH_FLAG);
|
||||
if (!isset($isDismax)) {
|
||||
$isDismax = TRUE;
|
||||
}
|
||||
$isSearchAllFields = FALSE;
|
||||
$fields_list = [];
|
||||
|
||||
if (!$isDismax) {
|
||||
// To support negative queries we must first bring in all documents.
|
||||
$q[] = $this->negativeQuery($terms) ? "*:*" : "";
|
||||
}
|
||||
|
||||
$term = array_shift($terms);
|
||||
$q[] = $term->toSolrQuery($field_mapping);
|
||||
|
||||
// New.
|
||||
$fields_list[] = $term->toSolrFields($field_mapping);
|
||||
|
||||
// Set edismax is enabled if the field set to "all".
|
||||
if ($term->getField() === "all") {
|
||||
$isSearchAllFields = TRUE;
|
||||
|
||||
}
|
||||
|
||||
// For multiple conditions.
|
||||
foreach ($terms as $term) {
|
||||
$q[] = $term->getConjunction();
|
||||
$q[] = $term->toSolrQuery($field_mapping);
|
||||
|
||||
// New.
|
||||
$fields_list[] = $term->toSolrFields($field_mapping);
|
||||
|
||||
// Set dismax is enabled if the field set to "all".
|
||||
if ($term->getField() === "all") {
|
||||
$isSearchAllFields = TRUE;
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
$q = implode(' ', $q);
|
||||
|
||||
// Limit extra processing if Luncene Search is enable.
|
||||
if ($isDismax) {
|
||||
|
||||
if ((strpos($q, "*") !== FALSE || strpos($q, "?") !== FALSE)) {
|
||||
// If the query string contain '*','?',a single world,enable wildcard.
|
||||
$tmp = str_replace('"', "", trim($q));
|
||||
$query_fields = [];
|
||||
|
||||
if ($isSearchAllFields) {
|
||||
foreach ($field_mapping as $key => $field) {
|
||||
foreach ($field as $f => $item) {
|
||||
// bs_ are boolean fields, do not work well with text search.
|
||||
if (substr($item, 0, 3) !== "bs_"
|
||||
&& !in_array($item, ['score', 'random', 'boost_document'])
|
||||
&& ((strpos($item, "sm_") === 0)
|
||||
|| (strpos($item, "tm_") === 0)
|
||||
|| (strpos($item, "sort_ss_") === 0)
|
||||
|| (strpos($item, "ts_") === 0)
|
||||
|| (strpos($item, "ss_") === 0)
|
||||
)) {
|
||||
array_push($query_fields, '(' . $item . ':' . $tmp . ')');
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
foreach ($fields_list as $f) {
|
||||
$parts = explode(" ", $f);
|
||||
foreach ($parts as $p) {
|
||||
array_push($query_fields, '(' . $p . ':' . $tmp . ')');
|
||||
}
|
||||
}
|
||||
}
|
||||
$q = implode(" ", array_unique($query_fields));
|
||||
}
|
||||
else {
|
||||
|
||||
// Enable dismax search query option.
|
||||
/** @var Solarium\QueryType\Select\Query\Component\DisMax $dismax */
|
||||
$dismax = $solarium_query->getEDisMax();
|
||||
$dismax->setQueryParser('edismax');
|
||||
$query_fields = [];
|
||||
|
||||
if ($isSearchAllFields) {
|
||||
foreach ($field_mapping as $key => $field) {
|
||||
foreach ($field as $f => $item) {
|
||||
// bs_ are boolean fields, do not work well with text search.
|
||||
if (substr($item, 0, 3) !== "bs_") {
|
||||
array_push($query_fields, $item);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
$query_fields = $fields_list;
|
||||
}
|
||||
|
||||
// Get the indexed fields from /admin/config/search/search-api/index/..../fields
|
||||
$boostedFields = [];
|
||||
foreach ($index->getFields() as $field_id => $field) {
|
||||
$boostedFields[$field_id] = $field->getBoost();
|
||||
}
|
||||
|
||||
$str_fields_with_boost = "";
|
||||
// Adding a boost number for each field)
|
||||
foreach($query_fields as $solr_field) {
|
||||
foreach($boostedFields as $indexed_field => $boostnum) {
|
||||
if(strpos($str_fields_with_boost, $indexed_field) == false && strpos($solr_field, $indexed_field) !== false) {
|
||||
$str_fields_with_boost .= $solr_field . "^" . $boostnum . " ";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$dismax->setQueryFields($str_fields_with_boost);
|
||||
}
|
||||
}
|
||||
|
||||
if ($backend->getConfiguration()['highlight_data']) {
|
||||
// Just highlight string and text fields to avoid Solr exceptions.
|
||||
$highlighted_fields = array_filter(array_unique($fields_list), function ($v) {
|
||||
return preg_match('/^t.*?[sm]_/', $v) || preg_match('/^s[sm]_/', $v);
|
||||
});
|
||||
|
||||
if (empty($highlighted_fields)) {
|
||||
$highlighted_fields = ['*'];
|
||||
}
|
||||
|
||||
$this->setHighlighting($solarium_query, $search_api_query, $highlighted_fields);
|
||||
|
||||
// The Search API Highlight processor checks if the 'keys' field of
|
||||
// the Search API Query is non-empty before creating an excerpt.
|
||||
// Since we are getting the highlighting result from Solr instead
|
||||
// of using the Search API processor to create one, we just need
|
||||
// make this field non-empty.
|
||||
//$search_api_query->keys("advanced search");
|
||||
}
|
||||
|
||||
$solarium_query->setQuery($q);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Alters the given view to be recursive if applicable.
|
||||
*
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
* The request to parse terms from.
|
||||
* @param \Drupal\views\ViewExecutable $view
|
||||
* The view to modify.
|
||||
* @param string $display_id
|
||||
* The view display to potentially alter.
|
||||
*/
|
||||
public function alterView(Request $request, ViewExecutable $view, $display_id) {
|
||||
$views = Utilities::getAdvancedSearchViewDisplays();
|
||||
// Only specify contextual filters for views which the advanced search
|
||||
// blocks are derived from.
|
||||
$block_id = array_search([$view->id(), $display_id], $views);
|
||||
if ($block_id !== FALSE) {
|
||||
$block = Block::load($block_id);
|
||||
$settings = $block->get('settings');
|
||||
// Ignore the immediate children contextual filter in the query to allow
|
||||
// for recursive search.
|
||||
if (isset($settings[AdvancedSearchBlock::SETTING_CONTEXTUAL_FILTER])) {
|
||||
$display = $view->getDisplay();
|
||||
$display_arguments = $display->getOption('arguments');
|
||||
$immediate_children_contextual_filter = $settings[AdvancedSearchBlock::SETTING_CONTEXTUAL_FILTER];
|
||||
$index = array_search($immediate_children_contextual_filter, array_keys($display_arguments));
|
||||
if ($this->shouldRecurse($request)) {
|
||||
// Change the argument to the exception value which should cause the
|
||||
// contextual filter to be ignored.
|
||||
$view->args[$index] = $display_arguments[$immediate_children_contextual_filter]['exception']['value'];
|
||||
}
|
||||
else {
|
||||
// Explicitly set the default argument for AJAX requests.
|
||||
// We need to restore the default as that functionality is currently
|
||||
// broken. @see https://www.drupal.org/project/drupal/issues/3173778
|
||||
//
|
||||
// We fake the current request from the refer only to set the default
|
||||
// argument in case it is build from the URL. If this is not an AJAX
|
||||
// request this logic can be ignored.
|
||||
if ($request->isXmlHttpRequest()) {
|
||||
$view->initHandlers();
|
||||
$request_stack = \Drupal::requestStack();
|
||||
$refer = Request::create($request->server->get('HTTP_REFERER'));
|
||||
$refer->getPathInfo();
|
||||
$refer->attributes->add(\Drupal::getContainer()->get('router')->matchRequest($refer));
|
||||
$request_stack->push($refer);
|
||||
if (isset($view->argument[$immediate_children_contextual_filter])) {
|
||||
$plugin = $view->argument[$immediate_children_contextual_filter]->getPlugin('argument_default');
|
||||
if ($plugin) {
|
||||
$view->args[$index] = $plugin->getArgument();
|
||||
}
|
||||
}
|
||||
$request_stack->pop();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get query parameter for all search terms.
|
||||
*
|
||||
* @return \Drupal\Core\Url
|
||||
* Url for the given request combined with search query parameters.
|
||||
*/
|
||||
public function toUrl(Request $request, array $terms, bool $recurse, $route = NULL) {
|
||||
$query_params = $request->query->all();
|
||||
if ($route) {
|
||||
$url = Url::fromRoute($route);
|
||||
// The form that built the url may use AJAX, but we are redirecting to a
|
||||
// new page, so it should be disabled.
|
||||
unset($query_params[FormBuilderInterface::AJAX_FORM_REQUEST]);
|
||||
unset($query_params[MainContentViewSubscriber::WRAPPER_FORMAT]);
|
||||
}
|
||||
else {
|
||||
$url = Url::createFromRequest($request);
|
||||
}
|
||||
unset($query_params[$this->queryParameter]);
|
||||
foreach ($terms as $term) {
|
||||
$query_params[$this->queryParameter][] = $term->toQueryParams();
|
||||
}
|
||||
if ($recurse) {
|
||||
$query_params[$this->recurseParameter] = '1';
|
||||
}
|
||||
else {
|
||||
unset($query_params[$this->recurseParameter]);
|
||||
}
|
||||
$url->setOptions(['query' => $query_params]);
|
||||
return $url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the highlighting parameters.
|
||||
*
|
||||
* @param \Solarium\Core\Query\QueryInterface $solarium_query
|
||||
* The Solarium select query object.
|
||||
* @param \Drupal\search_api\Query\QueryInterface $search_api_query
|
||||
* The query object.
|
||||
* @param array $highlighted_fields
|
||||
* (optional) The solr fields to be highlighted.
|
||||
*/
|
||||
protected function setHighlighting(SolariumQueryInterface $solarium_query, DrupalQueryInterface $search_api_query, array $highlighted_fields = []) {
|
||||
$index = $search_api_query->getIndex();
|
||||
$settings = SearchAPISolrUtility::getIndexSolrSettings($index);
|
||||
$highlighter = $settings['highlighter'];
|
||||
|
||||
$hl = $solarium_query->getHighlighting();
|
||||
$hl->setSimplePrefix('[HIGHLIGHT]');
|
||||
$hl->setSimplePostfix('[/HIGHLIGHT]');
|
||||
$hl->setSnippets($highlighter['highlight']['snippets']);
|
||||
$hl->setFragSize($highlighter['highlight']['fragsize']);
|
||||
$hl->setMergeContiguous($highlighter['highlight']['mergeContiguous']);
|
||||
$hl->setRequireFieldMatch($highlighter['highlight']['requireFieldMatch']);
|
||||
|
||||
// Overwrite Solr default values only if required to have shorter request
|
||||
// strings.
|
||||
if (51200 != $highlighter['maxAnalyzedChars']) {
|
||||
$hl->setMaxAnalyzedChars($highlighter['maxAnalyzedChars']);
|
||||
}
|
||||
if ('gap' !== $highlighter['fragmenter']) {
|
||||
$hl->setFragmenter($highlighter['fragmenter']);
|
||||
if ('regex' !== $highlighter['fragmenter']) {
|
||||
$hl->setRegexPattern($highlighter['regex']['pattern']);
|
||||
if (0.5 != $highlighter['regex']['slop']) {
|
||||
$hl->setRegexSlop($highlighter['regex']['slop']);
|
||||
}
|
||||
if (10000 != $highlighter['regex']['maxAnalyzedChars']) {
|
||||
$hl->setRegexMaxAnalyzedChars($highlighter['regex']['maxAnalyzedChars']);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (!$highlighter['usePhraseHighlighter']) {
|
||||
$hl->setUsePhraseHighlighter(FALSE);
|
||||
}
|
||||
if (!$highlighter['highlightMultiTerm']) {
|
||||
$hl->setHighlightMultiTerm(FALSE);
|
||||
}
|
||||
if ($highlighter['preserveMulti']) {
|
||||
$hl->setPreserveMulti(TRUE);
|
||||
}
|
||||
|
||||
foreach ($highlighted_fields as $highlighted_field) {
|
||||
// We must not set the fields at once using setFields() to not break
|
||||
// the altered queries.
|
||||
$hl->addField($highlighted_field);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
406
src/AdvancedSearchQueryTerm.php
Normal file
406
src/AdvancedSearchQueryTerm.php
Normal file
|
|
@ -0,0 +1,406 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search;
|
||||
|
||||
use Drupal\advanced_search\Form\AdvancedSearchForm;
|
||||
use Drupal\advanced_search\Form\SettingsForm;
|
||||
|
||||
/**
|
||||
* Defines a single search term.
|
||||
*
|
||||
* Used for parsing query parameters as well as form submission and generating
|
||||
* search queries.
|
||||
*/
|
||||
class AdvancedSearchQueryTerm {
|
||||
// Conjunctions.
|
||||
// @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#TheStandardQueryParser-BooleanOperatorsSupportedbytheStandardQueryParser
|
||||
const CONJUNCTION_AND = 'AND';
|
||||
const CONJUNCTION_OR = 'OR';
|
||||
|
||||
// Used for serializing / deserializing query parameters.
|
||||
// These are also hard-coded in advanced_search.form.js.
|
||||
const CONJUNCTION_QUERY_PARAMETER = 'c';
|
||||
const FIELD_QUERY_PARAMETER = 'f';
|
||||
const INCLUDE_QUERY_PARAMETER = 'i';
|
||||
const VALUE_QUERY_PARAMETER = 'v';
|
||||
|
||||
// Defaults.
|
||||
const DEFAULT_CONJUNCTION = self::CONJUNCTION_AND;
|
||||
const DEFAULT_INCLUDE = TRUE;
|
||||
|
||||
/**
|
||||
* The field to search.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $field;
|
||||
|
||||
/**
|
||||
* Include / exclude results where 'value' is in the 'search' term.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $include = TRUE;
|
||||
|
||||
/**
|
||||
* The value to filter with.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $value;
|
||||
|
||||
/**
|
||||
* The conjunction to use for the condition group – either 'AND' or 'OR'.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $conjunction;
|
||||
|
||||
/**
|
||||
* Constructs a FacetBlockAjaxController object.
|
||||
*
|
||||
* @param string $field
|
||||
* The field to search against.
|
||||
* @param string $value
|
||||
* The value to search the field with.
|
||||
* @param bool $include
|
||||
* Limit results to records whose field contains or does not contain the
|
||||
* given value.
|
||||
* @param string $conjunction
|
||||
* The conjunction to apply when combining this search term along with
|
||||
* others.
|
||||
*/
|
||||
public function __construct(string $field, string $value, bool $include = self::DEFAULT_INCLUDE, string $conjunction = self::DEFAULT_CONJUNCTION) {
|
||||
$this->field = $field;
|
||||
$this->value = $value;
|
||||
switch ($conjunction) {
|
||||
case self::CONJUNCTION_AND:
|
||||
case self::CONJUNCTION_OR:
|
||||
$this->conjunction = $conjunction;
|
||||
break;
|
||||
|
||||
default:
|
||||
throw new \InvalidArgumentException('Invalid value given for argument "conjunction": $conjunction');
|
||||
}
|
||||
if ($this->conjunction == self::CONJUNCTION_OR && !$include) {
|
||||
throw new \InvalidArgumentException('Excluding terms with the conjunction "OR" is not supported');
|
||||
}
|
||||
$this->include = $include;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate 'include' or fallback to default value.
|
||||
*
|
||||
* @param string $include
|
||||
* The value to cast to a boolean if possible.
|
||||
*
|
||||
* @return bool
|
||||
* The normalized input for 'include' or its default.
|
||||
*/
|
||||
protected static function normalizeInclude(string $include) {
|
||||
switch (strtoupper($include)) {
|
||||
case AdvancedSearchForm::IS_OP:
|
||||
return TRUE;
|
||||
|
||||
case AdvancedSearchForm::NOT_OP:
|
||||
return FALSE;
|
||||
|
||||
default:
|
||||
$include = filter_var($include, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
|
||||
// Ignore include parameter if invalid and fallback to the default.
|
||||
return is_bool($include) ? $include : self::DEFAULT_INCLUDE;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate 'conjunction' or fallback to default value.
|
||||
*
|
||||
* @param string $conjunction
|
||||
* The conjunction to validate.
|
||||
*
|
||||
* @return string
|
||||
* The normalized input for 'include' or its default.
|
||||
*/
|
||||
protected static function normalizeConjunction(string $conjunction) {
|
||||
switch (strtoupper($conjunction)) {
|
||||
case self::CONJUNCTION_AND:
|
||||
return self::CONJUNCTION_AND;
|
||||
|
||||
case self::CONJUNCTION_OR:
|
||||
return self::CONJUNCTION_OR;
|
||||
|
||||
default:
|
||||
return self::DEFAULT_CONJUNCTION;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a AdvancedSearchQueryTerm from the given parameters if possible.
|
||||
*
|
||||
* @param array $params
|
||||
* An array representing the query parameters for a single search term.
|
||||
*
|
||||
* @return \Drupal\advanced_search\AdvancedSearchQueryTerm|null
|
||||
* An object which represents a valid search term.
|
||||
*/
|
||||
public static function fromQueryParams(array $params) {
|
||||
// Field & value are required values. We do not check if field is a valid
|
||||
// value only that it is non-empty. All other fields will be cast to
|
||||
// defaults if they are not valid / missing.
|
||||
$has_required_params = isset($params[self::FIELD_QUERY_PARAMETER], $params[self::VALUE_QUERY_PARAMETER]);
|
||||
$search_value_empty = isset($params[self::VALUE_QUERY_PARAMETER]) && empty($params[self::VALUE_QUERY_PARAMETER]);
|
||||
if (!$has_required_params || $search_value_empty) {
|
||||
return NULL;
|
||||
}
|
||||
$field = $params[self::FIELD_QUERY_PARAMETER];
|
||||
$value = $params[self::VALUE_QUERY_PARAMETER];
|
||||
$include = isset($params[self::INCLUDE_QUERY_PARAMETER]) ?
|
||||
$include = self::normalizeInclude($params[self::INCLUDE_QUERY_PARAMETER]) :
|
||||
self::DEFAULT_INCLUDE;
|
||||
$conjunction = isset($params[self::CONJUNCTION_QUERY_PARAMETER]) ?
|
||||
self::normalizeConjunction($params[self::CONJUNCTION_QUERY_PARAMETER]) :
|
||||
self::DEFAULT_CONJUNCTION;
|
||||
return new self($field, $value, $include, $conjunction);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a AdvancedSearchQueryTerm from user submitted form values.
|
||||
*
|
||||
* @param array $input
|
||||
* An array representing the submitted form values for a single search term.
|
||||
*
|
||||
* @return \Drupal\advanced_search\AdvancedSearchQueryTerm|null
|
||||
* An object which represents a valid search term.
|
||||
*/
|
||||
public static function fromUserInput(array $input) {
|
||||
// Search field & value are required values we do not check if field is a
|
||||
// valid value only that it is non-empty. All other fields will use
|
||||
// defaults if they are not valid / missing.
|
||||
$has_required_inputs = isset($input[AdvancedSearchForm::SEARCH_FORM_FIELD], $input[AdvancedSearchForm::VALUE_FORM_FIELD]);
|
||||
$search_value_empty = isset($input[AdvancedSearchForm::VALUE_FORM_FIELD]) && empty($input[AdvancedSearchForm::VALUE_FORM_FIELD]);
|
||||
if (!$has_required_inputs || $search_value_empty) {
|
||||
return NULL;
|
||||
}
|
||||
$field = $input[AdvancedSearchForm::SEARCH_FORM_FIELD];
|
||||
$value = $input[AdvancedSearchForm::VALUE_FORM_FIELD];
|
||||
$include = self::DEFAULT_INCLUDE;
|
||||
$conjunction = self::DEFAULT_CONJUNCTION;
|
||||
if (isset($input[AdvancedSearchForm::CONJUNCTION_FORM_FIELD])) {
|
||||
switch ($input[AdvancedSearchForm::CONJUNCTION_FORM_FIELD]) {
|
||||
case AdvancedSearchForm::AND_OP:
|
||||
$conjunction = self::CONJUNCTION_AND;
|
||||
break;
|
||||
|
||||
case AdvancedSearchForm::OR_OP:
|
||||
$conjunction = self::CONJUNCTION_OR;
|
||||
break;
|
||||
}
|
||||
}
|
||||
// Only allow users to specify include when using 'AND' conjunction.
|
||||
if (
|
||||
$conjunction == self::CONJUNCTION_AND
|
||||
&& isset($input[AdvancedSearchForm::INCLUDE_FORM_FIELD])
|
||||
) {
|
||||
switch ($input[AdvancedSearchForm::INCLUDE_FORM_FIELD]) {
|
||||
case AdvancedSearchForm::IS_OP:
|
||||
$include = TRUE;
|
||||
break;
|
||||
|
||||
case AdvancedSearchForm::NOT_OP:
|
||||
$include = FALSE;
|
||||
break;
|
||||
}
|
||||
}
|
||||
return new self($field, $value, $include, $conjunction);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get query parameter representation of this search term.
|
||||
*
|
||||
* @return array
|
||||
* Representation of this search term which can be serialized to a query
|
||||
* parameter.
|
||||
*/
|
||||
public function toQueryParams() {
|
||||
$params = [
|
||||
self::FIELD_QUERY_PARAMETER => $this->field,
|
||||
self::VALUE_QUERY_PARAMETER => $this->value,
|
||||
];
|
||||
// No need to specify conjunction if it is equivalent to the default.
|
||||
if ($this->conjunction != self::DEFAULT_CONJUNCTION) {
|
||||
$params[self::CONJUNCTION_QUERY_PARAMETER] = $this->conjunction;
|
||||
}
|
||||
if ($this->include != self::DEFAULT_CONJUNCTION) {
|
||||
$params[self::INCLUDE_QUERY_PARAMETER] = $this->include ? '1' : '0';
|
||||
}
|
||||
return $params;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user input of search form representation of this search term.
|
||||
*
|
||||
* @return array
|
||||
* Representation of this search term which can be used as input to the
|
||||
* advanced search form.
|
||||
*/
|
||||
public function toUserInput() {
|
||||
return [
|
||||
AdvancedSearchForm::SEARCH_FORM_FIELD => $this->field,
|
||||
AdvancedSearchForm::VALUE_FORM_FIELD => $this->value,
|
||||
AdvancedSearchForm::INCLUDE_FORM_FIELD => $this->include ? AdvancedSearchForm::IS_OP : AdvancedSearchForm::NOT_OP,
|
||||
AdvancedSearchForm::CONJUNCTION_FORM_FIELD => $this->conjunction == self::CONJUNCTION_AND ? AdvancedSearchForm::AND_OP : AdvancedSearchForm::OR_OP,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets if this term should be included / excluded from results.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the term should be include in results, FALSE otherwise.
|
||||
*/
|
||||
public function getInclude() {
|
||||
return $this->include;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the conjunction for this term.
|
||||
*
|
||||
* @return string
|
||||
* The conjunction to use for this term.
|
||||
*/
|
||||
public function getConjunction() {
|
||||
return $this->conjunction;
|
||||
}
|
||||
|
||||
/**
|
||||
* Using the provided field mapping create a Solr Query string.
|
||||
*
|
||||
* @param array $solr_field_mapping
|
||||
* An array that maps search api fields to one or more solr fields.
|
||||
*
|
||||
* @return string
|
||||
* The conjunction to use for this term conjunction.
|
||||
*/
|
||||
public function toSolrQuery(array $solr_field_mapping) {
|
||||
$terms = [];
|
||||
$query_helper = \Drupal::service('solarium.query_helper');
|
||||
$value = $query_helper->escapePhrase(trim($this->value));
|
||||
|
||||
$config = \Drupal::config(SettingsForm::CONFIG_NAME);
|
||||
$isDismax = $config->get(SettingsForm::EDISMAX_SEARCH_FLAG);
|
||||
if (!isset($isDismax)) {
|
||||
$isDismax = TRUE;
|
||||
}
|
||||
|
||||
if ($isDismax || $this->field === "all") {
|
||||
|
||||
// Case 1: if keyword contains one word or a phrase.
|
||||
if (strpos(trim($value), ' ') !== FALSE) {
|
||||
// Add Or for the search case "scarborough bulletin" show no results.
|
||||
$isNot = $this->getInclude() ? "" : "-";
|
||||
if (substr_count($value, '\"') == 2) {
|
||||
$value = str_replace('\"', "", trim($value));
|
||||
return $isNot . $value;
|
||||
}
|
||||
else {
|
||||
return $isNot . "(" . $value . " OR " . str_replace('"', "", trim($value)) . ")";
|
||||
}
|
||||
}
|
||||
if (!$this->getInclude()) {
|
||||
$value = "!" . str_replace('"', "", trim($value));
|
||||
}
|
||||
else {
|
||||
// Case 2: keywords is one word
|
||||
// if there is quotation (with backslash) surrounded,.
|
||||
if (strpos(trim($value), '\"') !== FALSE) {
|
||||
$value = str_replace('\"', "", trim($value));
|
||||
}
|
||||
else {
|
||||
// If there is quotation (without backslash) surrounded.
|
||||
$value = str_replace('"', "", trim($value));
|
||||
}
|
||||
}
|
||||
// Fixed for https://github.com/digitalutsc/advanced_search/issues/4
|
||||
if ($this->field !== "all"){
|
||||
$search_fields = "";
|
||||
foreach ($solr_field_mapping[$this->field] as $field) {
|
||||
$search_fields .= " $field:$value";
|
||||
}
|
||||
return $search_fields;
|
||||
}
|
||||
return $value;
|
||||
}
|
||||
else {
|
||||
$isTitleSearch = FALSE;
|
||||
foreach ($solr_field_mapping[$this->field] as $field) {
|
||||
// If field fulltext title is selected.
|
||||
if (strpos($field, "fulltext_title") !== FALSE) {
|
||||
$isTitleSearch = TRUE;
|
||||
if (strpos(trim($value), " AND ") !== FALSE) {
|
||||
// Handle keyword with 'Orientation AND games'.
|
||||
$keyword = str_replace('"', '', $value);
|
||||
$keys = explode(" AND ", $keyword);
|
||||
$str = "(";
|
||||
$i = 0;
|
||||
foreach ($keys as $key) {
|
||||
|
||||
if ($i != count($keys) - 1) {
|
||||
$str .= $field . ':"' . $key . '" AND ';
|
||||
}
|
||||
else {
|
||||
$str .= $field . ':"' . $key . '")';
|
||||
}
|
||||
$i++;
|
||||
}
|
||||
$terms[] = $str;
|
||||
}
|
||||
else {
|
||||
if ($isTitleSearch) {
|
||||
$terms[] = 'tm_lowercase_title:' . $value;
|
||||
}
|
||||
else {
|
||||
$terms[] = "$field:$value";
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
else {
|
||||
$terms[] = "$field:$value";
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
$terms = implode(' ', $terms);
|
||||
return $this->include ? "($terms)" : "-($terms)";
|
||||
}
|
||||
|
||||
/**
|
||||
* Using the provided field mapping create a Solr Fields string.
|
||||
*
|
||||
* @param array $solr_field_mapping
|
||||
* An array that maps search api fields to one or more solr fields.
|
||||
*
|
||||
* @return string
|
||||
* The conjunction to use for this term conjunction.
|
||||
*/
|
||||
public function toSolrFields(array $solr_field_mapping) {
|
||||
$terms = [];
|
||||
$query_helper = \Drupal::service('solarium.query_helper');
|
||||
|
||||
if ($this->field !== "all") {
|
||||
foreach ($solr_field_mapping[$this->field] as $field) {
|
||||
$terms[] = "$field";
|
||||
}
|
||||
}
|
||||
$terms = implode(' ', $terms);
|
||||
return $terms;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Field search.
|
||||
*/
|
||||
public function getField() {
|
||||
return $this->field;
|
||||
}
|
||||
|
||||
}
|
||||
165
src/Controller/AjaxBlocksController.php
Normal file
165
src/Controller/AjaxBlocksController.php
Normal file
|
|
@ -0,0 +1,165 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Controller;
|
||||
|
||||
use Drupal\Core\Ajax\AjaxResponse;
|
||||
use Drupal\Core\Ajax\ReplaceCommand;
|
||||
use Drupal\Core\Controller\ControllerBase;
|
||||
use Drupal\Core\Path\CurrentPathStack;
|
||||
use Drupal\Core\PathProcessor\PathProcessorManager;
|
||||
use Drupal\Core\Render\RendererInterface;
|
||||
use Drupal\Core\Routing\CurrentRouteMatch;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
|
||||
use Symfony\Component\Routing\RouterInterface;
|
||||
|
||||
/**
|
||||
* Defines a controller to load a facet via AJAX.
|
||||
*/
|
||||
class AjaxBlocksController extends ControllerBase {
|
||||
|
||||
/**
|
||||
* The entity storage for block.
|
||||
*
|
||||
* @var \Drupal\Core\Entity\EntityStorageInterface
|
||||
*/
|
||||
protected $storage;
|
||||
|
||||
/**
|
||||
* The renderer.
|
||||
*
|
||||
* @var \Drupal\Core\Render\RendererInterface
|
||||
*/
|
||||
protected $renderer;
|
||||
|
||||
/**
|
||||
* The current path.
|
||||
*
|
||||
* @var \Drupal\Core\Path\CurrentPathStack
|
||||
*/
|
||||
protected $currentPath;
|
||||
|
||||
/**
|
||||
* The dynamic router service.
|
||||
*
|
||||
* @var \Symfony\Component\Routing\Matcher\RequestMatcherInterface
|
||||
*/
|
||||
protected $router;
|
||||
|
||||
/**
|
||||
* The path processor service.
|
||||
*
|
||||
* @var \Drupal\Core\PathProcessor\InboundPathProcessorInterface
|
||||
*/
|
||||
protected $pathProcessor;
|
||||
|
||||
/**
|
||||
* The current route match service.
|
||||
*
|
||||
* @var \Drupal\Core\Routing\CurrentRouteMatch
|
||||
*/
|
||||
protected $currentRouteMatch;
|
||||
|
||||
/**
|
||||
* The service container this instance should use.
|
||||
*
|
||||
* @var \Symfony\Component\DependencyInjection\ContainerInterface
|
||||
*/
|
||||
protected $container;
|
||||
|
||||
/**
|
||||
* Constructs a FacetBlockAjaxController object.
|
||||
*
|
||||
* @param \Drupal\Core\Render\RendererInterface $renderer
|
||||
* The renderer service.
|
||||
* @param \Drupal\Core\Path\CurrentPathStack $currentPath
|
||||
* The current path service.
|
||||
* @param \Symfony\Component\Routing\RouterInterface $router
|
||||
* The router service.
|
||||
* @param \Drupal\Core\PathProcessor\PathProcessorManager $pathProcessor
|
||||
* The path processor manager.
|
||||
* @param \Drupal\Core\Routing\CurrentRouteMatch $currentRouteMatch
|
||||
* The current route match service.
|
||||
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
|
||||
* The drupal container.
|
||||
*/
|
||||
final public function __construct(RendererInterface $renderer, CurrentPathStack $currentPath, RouterInterface $router, PathProcessorManager $pathProcessor, CurrentRouteMatch $currentRouteMatch, ContainerInterface $container) {
|
||||
$this->storage = $this->entityTypeManager()->getStorage('block');
|
||||
$this->renderer = $renderer;
|
||||
$this->currentPath = $currentPath;
|
||||
$this->router = $router;
|
||||
$this->pathProcessor = $pathProcessor;
|
||||
$this->currentRouteMatch = $currentRouteMatch;
|
||||
$this->container = $container;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function create(ContainerInterface $container) {
|
||||
return new static(
|
||||
$container->get('renderer'),
|
||||
$container->get('path.current'),
|
||||
$container->get('router'),
|
||||
$container->get('path_processor_manager'),
|
||||
$container->get('current_route_match'),
|
||||
$container
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads and renders the facet blocks via AJAX.
|
||||
*
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
* The current request object.
|
||||
*
|
||||
* @return \Drupal\Core\Ajax\AjaxResponse
|
||||
* The ajax response.
|
||||
*
|
||||
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
|
||||
* Thrown when the view was not found.
|
||||
*/
|
||||
public function respond(Request $request) {
|
||||
$response = new AjaxResponse();
|
||||
|
||||
// Rebuild the request and the current path, needed for facets.
|
||||
$path = $request->request->get('link');
|
||||
$blocks = $request->request->all('blocks');
|
||||
|
||||
// Make sure we are not updating blocks multiple times.
|
||||
$blocks = array_unique($blocks);
|
||||
|
||||
if (empty($path) || empty($blocks)) {
|
||||
throw new NotFoundHttpException('No facet link or facet blocks found.');
|
||||
}
|
||||
|
||||
$new_request = Request::create($path);
|
||||
$new_request->setSession($request->getSession());
|
||||
$request_stack = \Drupal::requestStack();
|
||||
$processed = $this->pathProcessor->processInbound($new_request->getPathInfo(), $new_request);
|
||||
|
||||
$this->currentPath->setPath($processed);
|
||||
$request->attributes->add($this->router->matchRequest($new_request));
|
||||
$this->currentRouteMatch->resetRouteMatch();
|
||||
$request_stack->push($new_request);
|
||||
$this->container->set('request_stack', $request_stack);
|
||||
|
||||
// Build the facets blocks found for the current request and update.
|
||||
foreach ($blocks as $block_id => $block_selector) {
|
||||
$block_entity = $this->storage->load($block_id);
|
||||
|
||||
if ($block_entity) {
|
||||
// Render a block, then add it to the response as a replace command.
|
||||
$block_view = $this->entityTypeManager
|
||||
->getViewBuilder('block')
|
||||
->view($block_entity);
|
||||
|
||||
$block_view = (string) $this->renderer->renderPlain($block_view);
|
||||
$response->addCommand(new ReplaceCommand($block_selector, $block_view));
|
||||
}
|
||||
}
|
||||
return $response;
|
||||
}
|
||||
|
||||
}
|
||||
43
src/EventSubscriber/PostConvertedQueryEventSubscriber.php
Normal file
43
src/EventSubscriber/PostConvertedQueryEventSubscriber.php
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\EventSubscriber;
|
||||
|
||||
use Drupal\advanced_search\AdvancedSearchQuery;
|
||||
use Drupal\search_api_solr\Event\PostConvertedQueryEvent;
|
||||
use Drupal\search_api_solr\Event\SearchApiSolrEvents;
|
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||
|
||||
/**
|
||||
* Subscribes to PostConvertedQueryEvents.
|
||||
*
|
||||
* @package Drupal\advanced_search\EventSubscriber
|
||||
*/
|
||||
class PostConvertedQueryEventSubscriber implements EventSubscriberInterface {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function getSubscribedEvents() {
|
||||
$events[SearchAPISolrEvents::POST_CONVERT_QUERY][] = ['alter'];
|
||||
|
||||
return $events;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Alter the query.
|
||||
*/
|
||||
public function alter(PostConvertedQueryEvent $event) {
|
||||
$search_api_query = $event->getSearchApiQuery();
|
||||
$solarium_query = $event->getSolariumQuery();
|
||||
|
||||
// We must modify the query itself rather than the representation the
|
||||
// search_api presents as it is not possible to use the 'OR' operator
|
||||
// with it as it converts conditions into separate filter queries.
|
||||
// Additionally filter queries do not affect the score so are not
|
||||
// suitable for use in the advanced search queries.
|
||||
$advanced_search_query = new AdvancedSearchQuery();
|
||||
$advanced_search_query->alterQuery(\Drupal::request(), $solarium_query, $search_api_query);
|
||||
}
|
||||
|
||||
}
|
||||
487
src/Form/AdvancedSearchForm.php
Normal file
487
src/Form/AdvancedSearchForm.php
Normal file
|
|
@ -0,0 +1,487 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Form;
|
||||
|
||||
use Drupal\Component\Utility\Html;
|
||||
use Drupal\Core\Form\FormBase;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\Routing\RouteMatchInterface;
|
||||
use Drupal\Core\StringTranslation\TranslatableMarkup;
|
||||
use Drupal\advanced_search\AdvancedSearchQuery;
|
||||
use Drupal\advanced_search\AdvancedSearchQueryTerm;
|
||||
use Drupal\advanced_search\GetConfigTrait;
|
||||
use Drupal\views\DisplayPluginCollection;
|
||||
use Drupal\views\Entity\View;
|
||||
use Drupal\views\Plugin\views\display\PathPluginBase;
|
||||
use Drupal\views\Views;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
|
||||
/**
|
||||
* Form for building and Advanced Search Query.
|
||||
*/
|
||||
class AdvancedSearchForm extends FormBase {
|
||||
use GetConfigTrait;
|
||||
|
||||
// Users can customize the operator to use font-awesome or some other icons.
|
||||
// Its a limitation in the use of `input type=submit` rather than buttons in
|
||||
// Drupal that we couldn't just rely on CSS.
|
||||
// This is exposed in the module settings.
|
||||
// @see https://www.drupal.org/project/drupal/issues/1671190
|
||||
const DEFAULT_ADD_OP = '+';
|
||||
const DEFAULT_REMOVE_OP = '-';
|
||||
|
||||
const AND_OP = 'AND';
|
||||
const IS_OP = 'IS';
|
||||
const NOT_OP = 'NOT';
|
||||
const OR_OP = 'OR';
|
||||
|
||||
// These are also hard-coded in advanced_search.form.js.
|
||||
const CONJUNCTION_FORM_FIELD = 'conjunction';
|
||||
const SEARCH_FORM_FIELD = 'search';
|
||||
const INCLUDE_FORM_FIELD = 'include';
|
||||
const VALUE_FORM_FIELD = 'value';
|
||||
|
||||
const AJAX_WRAPPER = 'advanced-search-ajax';
|
||||
|
||||
/**
|
||||
* The current request.
|
||||
*
|
||||
* @var \Symfony\Component\HttpFoundation\Request
|
||||
*/
|
||||
protected $request;
|
||||
|
||||
/**
|
||||
* The current route match.
|
||||
*
|
||||
* @var \Drupal\Core\Routing\RouteMatchInterface
|
||||
*/
|
||||
protected $currentRouteMatch;
|
||||
|
||||
/**
|
||||
* Class constructor.
|
||||
*/
|
||||
final public function __construct(Request $request, RouteMatchInterface $current_route_match) {
|
||||
$this->request = $request;
|
||||
$this->currentRouteMatch = $current_route_match;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function create(ContainerInterface $container) {
|
||||
return new static(
|
||||
$container->get('request_stack')->getMainRequest(),
|
||||
$container->get('current_route_match')
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'advanced_search_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the character to use for adding a facet to the query.
|
||||
*
|
||||
* @return string
|
||||
* The character to use for adding an facet to the query.
|
||||
*/
|
||||
public static function getAddOperator() {
|
||||
return self::getConfig(SettingsForm::SEARCH_ADD_OPERATOR, self::DEFAULT_ADD_OP);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the character to use for removing a facet from the query.
|
||||
*
|
||||
* @return string
|
||||
* The character to use for removing an facet to the query.
|
||||
*/
|
||||
public static function getRemoveOperator() {
|
||||
return self::getConfig(SettingsForm::SEARCH_REMOVE_OPERATOR, self::DEFAULT_REMOVE_OP);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get if Search All Fields checkbox is enabled or disable.
|
||||
*
|
||||
* @return bool
|
||||
* the enable or disable for Search All Fields checkbox
|
||||
*/
|
||||
public static function getSearchAllFields() {
|
||||
return self::getConfig(SettingsForm::SEARCH_ALL_FIELDS_FLAG, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get if Edismax Search checkbox is enabled or disable.
|
||||
*
|
||||
* @return bool
|
||||
* the enable or disable for Edismax Search checkbox
|
||||
*/
|
||||
public static function getEdismaxSearch() {
|
||||
return self::getConfig(SettingsForm::EDISMAX_SEARCH_FLAG, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the character to use for removing a facet from the query.
|
||||
*
|
||||
* @return string
|
||||
* The character to use for removing an facet to the query.
|
||||
*/
|
||||
public static function getEdismaxSearchLabel() {
|
||||
return self::getConfig(SettingsForm::EDISMAX_SEARCH_LABEL, "All");
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert the list of fields to select options.
|
||||
*
|
||||
* @param \Drupal\search_api\Item\FieldInterface[] $fields
|
||||
* The fields to convert to select options.
|
||||
*
|
||||
* @return array
|
||||
* Array of fields which can be searched where the key is the search field
|
||||
* identifier and the value is its human readable label.
|
||||
*/
|
||||
protected function fieldOptions(array $fields) {
|
||||
$options = [];
|
||||
foreach ($fields as $field) {
|
||||
$id = $field->getFieldIdentifier();
|
||||
$options[$id] = $field->getLabel();
|
||||
}
|
||||
return $options;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets possible include options for the given conjunction.
|
||||
*/
|
||||
protected function includeOptions(string $conjunction) {
|
||||
switch ($conjunction) {
|
||||
case self::AND_OP:
|
||||
return;
|
||||
|
||||
case self::OR_OP:
|
||||
return [
|
||||
self::IS_OP => $this->t('is'),
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Default values to for a term.
|
||||
*/
|
||||
protected function defaultTermValues(array $options) {
|
||||
return [
|
||||
self::CONJUNCTION_FORM_FIELD => self::AND_OP,
|
||||
// First item in list is default.
|
||||
self::SEARCH_FORM_FIELD => key($options),
|
||||
self::INCLUDE_FORM_FIELD => self::IS_OP,
|
||||
self::VALUE_FORM_FIELD => NULL,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Process input to the from either URL parameters or from the form input.
|
||||
*/
|
||||
protected function processInput(FormStateInterface $form_state, array $term_default_values) {
|
||||
$input = $form_state->getUserInput();
|
||||
$recursive = $input['recursive'] ?? NULL;
|
||||
$term_values = isset($input['terms']) && is_array($input['terms']) ? $input['terms'] : [];
|
||||
// Form was not submitted see if we can rebuild from query parameters.
|
||||
$advanced_search_query = new AdvancedSearchQuery();
|
||||
if (empty($term_values)) {
|
||||
$terms = $advanced_search_query->getTerms($this->request);
|
||||
foreach ($terms as $term) {
|
||||
$term_values[] = $term->toUserInput();
|
||||
}
|
||||
}
|
||||
if (!isset($input['recursive'])) {
|
||||
$recursive = $advanced_search_query->shouldRecurse($this->request);
|
||||
}
|
||||
// Form was submitted via +/- operators.
|
||||
$trigger = $form_state->getTriggeringElement();
|
||||
if ($trigger != NULL) {
|
||||
$term_index = $trigger['#term_index'] ?? 0;
|
||||
$value = $trigger['#value'] instanceof TranslatableMarkup ?
|
||||
$trigger['#value']->getUntranslatedString() :
|
||||
$trigger['#value'];
|
||||
switch ($value) {
|
||||
case $this->getAddOperator():
|
||||
// Insert after the term listed.
|
||||
array_splice($term_values, $term_index + 1, 0, [$term_default_values]);
|
||||
break;
|
||||
|
||||
case $this->getRemoveOperator():
|
||||
array_splice($term_values, $term_index, 1);
|
||||
break;
|
||||
|
||||
case "Reset":
|
||||
$recursive = FALSE;
|
||||
$term_values = [];
|
||||
break;
|
||||
|
||||
// Ignore unknown value for trigger.
|
||||
}
|
||||
// Place user input with updated values.
|
||||
$input['terms'] = $term_values;
|
||||
$input['recursive'] = $recursive;
|
||||
$form_state->setUserInput($input);
|
||||
}
|
||||
return [$recursive, $term_values];
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the route name for the view display used to derive this forms block.
|
||||
*
|
||||
* @return string|null
|
||||
* The route name for the view display that was used to create this
|
||||
* forms block.
|
||||
*/
|
||||
protected function getRouteName(FormStateInterface $form_state) {
|
||||
$view = $form_state->get('view');
|
||||
$display = $form_state->get('display');
|
||||
$display_handlers = new DisplayPluginCollection($view->getExecutable(), Views::pluginManager('display'));
|
||||
$display_handler = $display_handlers->get($display['id']);
|
||||
if ($display_handler instanceof PathPluginBase) {
|
||||
return $display_handler->getRouteName();
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildForm(array $form, FormStateInterface $form_state, View $view = NULL, array $display = [], array $fields = [], string $context_filter = NULL) {
|
||||
// Keep reference to view and display as the submit handler may use them
|
||||
// to redirect the user to the search page.
|
||||
$form_state->set('view', $view);
|
||||
$form_state->set('display', $display);
|
||||
$route_name = $this->getRouteName($form_state);
|
||||
$requires_redirect = $route_name ? $this->currentRouteMatch->getRouteName() !== $route_name : FALSE;
|
||||
|
||||
$form['#attached']['library'][] = 'advanced_search/advanced.search.form';
|
||||
$form['#attached']['drupalSettings']['advanced_search_form'] = [
|
||||
'id' => Html::getId($this->getFormId()),
|
||||
'redirect' => $requires_redirect,
|
||||
'query_parameter' => AdvancedSearchQuery::getQueryParameter(),
|
||||
'recurse_parameter' => AdvancedSearchQuery::getRecurseParameter(),
|
||||
'mapping' => [
|
||||
self::CONJUNCTION_FORM_FIELD => AdvancedSearchQueryTerm::CONJUNCTION_QUERY_PARAMETER,
|
||||
self::SEARCH_FORM_FIELD => AdvancedSearchQueryTerm::FIELD_QUERY_PARAMETER,
|
||||
self::INCLUDE_FORM_FIELD => AdvancedSearchQueryTerm::INCLUDE_QUERY_PARAMETER,
|
||||
self::VALUE_FORM_FIELD => AdvancedSearchQueryTerm::VALUE_QUERY_PARAMETER,
|
||||
],
|
||||
];
|
||||
|
||||
$options = (self::getEdismaxSearch() && self::getSearchAllFields()) ? ["all" => $this->t("@label", ["@label" => self::getEdismaxSearchLabel()])] + $this->fieldOptions($fields) : $this->fieldOptions($fields);
|
||||
$term_default_values = $this->defaultTermValues($options);
|
||||
[$recursive, $term_values] = $this->processInput($form_state, $term_default_values);
|
||||
$i = 0;
|
||||
$term_elements = [];
|
||||
$total_terms = count($term_values);
|
||||
$block_class_prefix = str_replace('_', '-', $this->getFormId());
|
||||
do {
|
||||
// Either specified by the user in the request or use the default.
|
||||
$first = $i == 0;
|
||||
$term_value = !empty($term_values) ? array_shift($term_values) : $term_default_values;
|
||||
$conjunction = $term_value[self::CONJUNCTION_FORM_FIELD] ?? $term_default_values[self::CONJUNCTION_FORM_FIELD];
|
||||
$term_elements[] = [
|
||||
// Only show on terms after the first.
|
||||
self::CONJUNCTION_FORM_FIELD => $first ? NULL : [
|
||||
'#type' => 'select',
|
||||
'#attributes' => [
|
||||
'aria-label' => $this->t("Select search condition"),
|
||||
],
|
||||
'#options' => [
|
||||
self::AND_OP => $this->t('and'),
|
||||
self::OR_OP => $this->t('or'),
|
||||
],
|
||||
'#default_value' => $conjunction,
|
||||
'#theme_wrappers' => [],
|
||||
],
|
||||
'entity' => [
|
||||
'#type' => 'select',
|
||||
'#attributes' => [
|
||||
'aria-label' => $this->t("Select Entity"),
|
||||
'class' => [$block_class_prefix . '-entity'],
|
||||
],
|
||||
'#options' => [
|
||||
'alles' => $this->t('Alles'),
|
||||
'b48556e79962e0a3c8d0041317c853b9' => $this->t('Archivalie'),
|
||||
'ba419826c9014f40126565bf413f7a59' => $this->t('Auktion'),
|
||||
'b1d559f7b6af224a3f6f3b9a12e6b161' => $this->t('Institution'),
|
||||
'b65c3a85d16724d84a5eb0d2268629a6' => $this->t('Objekt'),
|
||||
'b1afe1fa9a31c7622ab2ae8ef1d29673' => $this->t('Person'),
|
||||
],
|
||||
//'#default_value' => 'alles',
|
||||
],
|
||||
self::SEARCH_FORM_FIELD => [
|
||||
'#type' => 'select',
|
||||
'#attributes' => [
|
||||
'aria-label' => $this->t("Select search field"),
|
||||
],
|
||||
'#options' => $options,
|
||||
'#default_value' => $term_value[self::SEARCH_FORM_FIELD],
|
||||
'#theme_wrappers' => [],
|
||||
],
|
||||
self::INCLUDE_FORM_FIELD => [
|
||||
'#type' => 'select',
|
||||
'#attributes' => [
|
||||
'aria-label' => $this->t("Select search operator"),
|
||||
],
|
||||
'#options' => [
|
||||
self::IS_OP => $this->t('is'),
|
||||
self::NOT_OP => $this->t('is not'),
|
||||
],
|
||||
'#default_value' => $term_value[self::INCLUDE_FORM_FIELD],
|
||||
// Show only when conjunction is 'AND' as 'OR NOT' is not supported
|
||||
// by solr and will be converted to 'AND NOT'.
|
||||
'#states' => [
|
||||
'visible' => [
|
||||
':input[name="terms[' . $i . '][' . self::CONJUNCTION_FORM_FIELD . ']"]' => ['value' => self::AND_OP],
|
||||
],
|
||||
],
|
||||
'#theme_wrappers' => [],
|
||||
],
|
||||
// Just markup to show when 'include' is not alterable due to the
|
||||
// selected 'conjunction'. Hide for the first term.
|
||||
'is' => $first ? NULL : [
|
||||
'#type' => 'container',
|
||||
'#attributes' => ['style' => 'display:inline;'],
|
||||
'#states' => [
|
||||
'visible' => [
|
||||
':input[name="terms[' . $i . '][' . self::CONJUNCTION_FORM_FIELD . ']"]' => ['value' => self::OR_OP],
|
||||
],
|
||||
],
|
||||
/*'content' => [
|
||||
'#markup' => $this->t('is'),
|
||||
],*/
|
||||
'#theme_wrappers' => [],
|
||||
],
|
||||
self::VALUE_FORM_FIELD => [
|
||||
'#type' => 'textfield',
|
||||
'#attributes' => [
|
||||
'aria-label' => $this->t("Enter a search term"),
|
||||
],
|
||||
'#default_value' => $term_value[self::VALUE_FORM_FIELD],
|
||||
'#theme_wrappers' => [],
|
||||
],
|
||||
'actions' => [
|
||||
'#type' => 'container',
|
||||
'add' => [
|
||||
'#type' => 'button',
|
||||
'#value' => $this->getAddOperator(),
|
||||
'#name' => 'add-term-' . $i,
|
||||
'#term_index' => $i,
|
||||
'#attributes' => [
|
||||
'class' => [$block_class_prefix . '__add', 'fa'],
|
||||
],
|
||||
'#ajax' => [
|
||||
'callback' => [$this, 'ajaxCallback'],
|
||||
'wrapper' => self::AJAX_WRAPPER,
|
||||
'progress' => [
|
||||
'type' => 'none',
|
||||
],
|
||||
],
|
||||
],
|
||||
'remove' => $total_terms <= 1 ? NULL : [
|
||||
'#type' => 'button',
|
||||
'#value' => $this->getRemoveOperator(),
|
||||
'#name' => 'remove-term-' . $i,
|
||||
'#term_index' => $i,
|
||||
'#attributes' => [
|
||||
'class' => [$block_class_prefix . '__remove', 'fa'],
|
||||
'aria-label' => $this->t("Remove"),
|
||||
],
|
||||
'#ajax' => [
|
||||
'callback' => [$this, 'ajaxCallback'],
|
||||
'wrapper' => self::AJAX_WRAPPER,
|
||||
'progress' => [
|
||||
'type' => 'none',
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
];
|
||||
$i++;
|
||||
} while (!empty($term_values));
|
||||
|
||||
$form['ajax'] = [
|
||||
'#type' => 'container',
|
||||
'#attributes' => ['id' => self::AJAX_WRAPPER],
|
||||
'terms' => array_merge([
|
||||
'#tree' => TRUE,
|
||||
'#type' => 'container',
|
||||
], $term_elements),
|
||||
];
|
||||
|
||||
if ($context_filter != NULL) {
|
||||
$form['ajax']['recursive'] = [
|
||||
'#type' => 'checkbox',
|
||||
'#title' => $this->t('Include Sub-Collections'),
|
||||
'#default_value' => $recursive,
|
||||
];
|
||||
}
|
||||
$form['reset'] = [
|
||||
'#type' => 'button',
|
||||
'#value' => $this->t('Reset'),
|
||||
'#attributes' => [
|
||||
'class' => [$block_class_prefix . '__reset'],
|
||||
],
|
||||
'#ajax' => [
|
||||
'callback' => [$this, 'ajaxCallback'],
|
||||
'wrapper' => self::AJAX_WRAPPER,
|
||||
'progress' => [
|
||||
'type' => 'none',
|
||||
],
|
||||
],
|
||||
];
|
||||
$form['submit'] = [
|
||||
'#type' => 'submit',
|
||||
'#value' => $this->t('Search'),
|
||||
'#attributes' => [
|
||||
'class' => [$block_class_prefix . '__search'],
|
||||
],
|
||||
];
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds an Advanced Search Query Url from the submitted form values.
|
||||
*/
|
||||
protected function buildUrl(FormStateInterface $form_state) {
|
||||
$terms = [];
|
||||
$values = $form_state->getValues();
|
||||
foreach ($values['terms'] as $term) {
|
||||
$terms[] = AdvancedSearchQueryTerm::fromUserInput($term);
|
||||
}
|
||||
$terms = array_filter($terms);
|
||||
$recurse = filter_var($values['recursive'] ?? FALSE, FILTER_VALIDATE_BOOLEAN);
|
||||
$route = $this->getRouteName($form_state);
|
||||
$advanced_search_query = new AdvancedSearchQuery();
|
||||
return $advanced_search_query->toUrl($this->request, $terms, $recurse, $route);
|
||||
}
|
||||
|
||||
/**
|
||||
* Callback for adding / removing terms from the search.
|
||||
*/
|
||||
public function ajaxCallback(array &$form, FormStateInterface $form_state) {
|
||||
return $form['ajax'];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function submitForm(array &$form, FormStateInterface $form_state) {
|
||||
$trigger = (string) $form_state->getTriggeringElement()['#value'];
|
||||
switch ($trigger) {
|
||||
case $this->t('Search'):
|
||||
$form_state->setRedirectUrl($this->buildUrl($form_state));
|
||||
break;
|
||||
|
||||
default:
|
||||
$form_state->setRebuild();
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
120
src/Form/SearchForm.php
Normal file
120
src/Form/SearchForm.php
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Form;
|
||||
|
||||
use Drupal\block\Entity\Block;
|
||||
use Drupal\Core\Form\FormBase;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\Url;
|
||||
|
||||
/**
|
||||
* Form for building and Simple Search.
|
||||
*/
|
||||
class SearchForm extends FormBase {
|
||||
|
||||
/**
|
||||
* The Block ID.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $blockId;
|
||||
|
||||
/**
|
||||
* The constructor.
|
||||
*
|
||||
* @param string $block_id
|
||||
* Passing the block_id.
|
||||
*/
|
||||
public function __construct($block_id) {
|
||||
$this->blockId = $block_id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Block Id.
|
||||
*
|
||||
* @return mixed
|
||||
* Return the Block ID
|
||||
*/
|
||||
public function getBlockId() {
|
||||
return $this->blockId;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set Block ID.
|
||||
*
|
||||
* @param mixed $blockId
|
||||
* Set the block ID.
|
||||
*/
|
||||
public function setBlockId($blockId): void {
|
||||
$this->blockId = $blockId;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'search_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildForm(array $form, FormStateInterface $form_state) {
|
||||
$config = \Drupal::config(SettingsForm::CONFIG_NAME);
|
||||
|
||||
if (!$config->get(SettingsForm::SEARCH_ALL_FIELDS_FLAG)) {
|
||||
$form['search-attributes'][SettingsForm::SEARCH_ALL_FIELDS_FLAG] = [
|
||||
'#markup' => $this
|
||||
->t('<strong>This block is required to enable searching all fields for the Advanced Search.
|
||||
To proceed, please enable the Search All fields in
|
||||
<a href="/admin/config/search/advanced" target="_blank">Advanced Seach Configuration</a></strong>.'),
|
||||
];
|
||||
}
|
||||
else {
|
||||
$block = Block::load($this->blockId);
|
||||
|
||||
if ($block) {
|
||||
$settings = $block->get('settings');
|
||||
$view_machine_name = $settings['search_view_machine_name'];
|
||||
|
||||
}
|
||||
$form['search-textfield'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => (!empty($settings['search_textfield_label']) ? $settings['search_textfield_label'] : ''),
|
||||
'#attributes' => [
|
||||
'placeholder' => isset($settings['search_placeholder']) ? $this->t("@placeholder", ["@placeholder" => $settings['search_placeholder']]) : $this->t("Search collections"),
|
||||
'aria-label' => (isset($settings['search_textfield_label']) ? $this->t("@label", ["@label" => $settings['search_textfield_label']]) : $this->t('Enter Keyword')),
|
||||
],
|
||||
'#theme_wrappers' => [],
|
||||
];
|
||||
|
||||
$form['actions']['#type'] = 'actions';
|
||||
$form['actions']['submit'] = [
|
||||
'#type' => 'submit',
|
||||
'#value' => (!empty($settings['search_submit_label']) ? $settings['search_submit_label'] : 'Search'),
|
||||
'#button_type' => 'primary',
|
||||
];
|
||||
}
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function submitForm(array &$form, FormStateInterface $form_state) {
|
||||
$block = Block::load($this->blockId);
|
||||
if ($block) {
|
||||
$settings = $block->get('settings');
|
||||
$view_machine_name = $settings['search_view_machine_name'];
|
||||
}
|
||||
$url = Url::fromRoute($view_machine_name, [
|
||||
'a[0][f]' => 'all',
|
||||
'a[0][i]' => 'IS',
|
||||
'a[0][v]' => $form_state->getValues()['search-textfield'],
|
||||
|
||||
]);
|
||||
$form_state->setRedirectUrl($url);
|
||||
}
|
||||
|
||||
}
|
||||
218
src/Form/SettingsForm.php
Normal file
218
src/Form/SettingsForm.php
Normal file
|
|
@ -0,0 +1,218 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Form;
|
||||
|
||||
use Drupal\Core\Config\ConfigFactoryInterface;
|
||||
use Drupal\Core\Form\ConfigFormBase;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\advanced_search\AdvancedSearchQuery;
|
||||
use Drupal\advanced_search\GetConfigTrait;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
|
||||
/**
|
||||
* Config form for Islandora Advanced Search settings.
|
||||
*/
|
||||
class SettingsForm extends ConfigFormBase {
|
||||
|
||||
use GetConfigTrait;
|
||||
|
||||
const CONFIG_NAME = 'advanced_search.settings';
|
||||
const SEARCH_QUERY_PARAMETER = 'search_query_parameter';
|
||||
const SEARCH_RECURSIVE_PARAMETER = 'search_recursive_parameter';
|
||||
const SEARCH_ADD_OPERATOR = 'search_add_operator';
|
||||
const SEARCH_REMOVE_OPERATOR = 'search_remove_operator';
|
||||
const FACET_TRUNCATE = 'facet_truncate';
|
||||
const EDISMAX_SEARCH_FLAG = 'lucene_on_off';
|
||||
const EDISMAX_SEARCH_LABEL = 'lucene_label';
|
||||
const SEARCH_ALL_FIELDS_FLAG = 'all_fields_on_off';
|
||||
const DISPLAY_LIST_FLAG = 'list_on_off';
|
||||
const DISPLAY_GRID_FLAG = 'grid_on_off';
|
||||
const DISPLAY_DEFAULT = 'default-display-mode';
|
||||
|
||||
/**
|
||||
* Constructs a \Drupal\system\ConfigFormBase object.
|
||||
*
|
||||
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
|
||||
* The factory for configuration objects.
|
||||
*/
|
||||
final public function __construct(ConfigFactoryInterface $config_factory) {
|
||||
$this->setConfigFactory($config_factory);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function create(ContainerInterface $container) {
|
||||
return new static($container->get('config.factory'));
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getFormId() {
|
||||
return 'advanced_search_settings_form';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function getEditableConfigNames() {
|
||||
return [
|
||||
self::CONFIG_NAME,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function buildForm(array $form, FormStateInterface $form_state) {
|
||||
$form['eDisMax'] = [
|
||||
'#type' => 'fieldset',
|
||||
'#title' => $this->t('Advanced Search Block'),
|
||||
'#weight' => -1,
|
||||
];
|
||||
$form['eDisMax']['advanced-search-block-description'] = [
|
||||
'#markup' => $this->t("Advanced Search Blocks are available in the Blocks interface for each Search API view. When placing an Advanced Search Block, you can configure the fields that are used for field-based search and whether a “recursive” search is available. The following settings apply to all Advanced Search blocks."),
|
||||
'#weight' => -2,
|
||||
];
|
||||
|
||||
$isEDismax = \Drupal::config(SettingsForm::CONFIG_NAME)->get(self::EDISMAX_SEARCH_FLAG);
|
||||
$form['eDisMax'][self::EDISMAX_SEARCH_FLAG] = [
|
||||
'#type' => 'checkbox',
|
||||
'#title' => $this
|
||||
->t('Enable Extended DisMax Query.'),
|
||||
'#description' => $this->t('<ul> <li>When enabled, all queries using an Advanced Search Block use the Extended Dismax (eDisMax) query processor.</li>
|
||||
<li>This setting must be enabled for the “Simple Search Block” to function. </li>
|
||||
<li>If enabled, the “Simple Search Block”/”Advanced Search Blocks” support:
|
||||
<ul>
|
||||
<li>queries that include AND, OR, NOT, -, and + (user documentation needed)</li>
|
||||
<li>Wildcard operator *</li>
|
||||
<li>Words in query are treated as distinct words. They are combined using OR unless the user specifies using AND/NOT in their query.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>'),
|
||||
'#default_value' => $isEDismax ?? 1,
|
||||
];
|
||||
|
||||
$form['eDisMax']['textfields_container'] = [
|
||||
'#type' => 'container',
|
||||
'#attributes' => ['id' => 'edismax-container'],
|
||||
];
|
||||
|
||||
$form['eDisMax']['textfields_container'][self::SEARCH_ALL_FIELDS_FLAG] = [
|
||||
'#type' => 'checkbox',
|
||||
'#title' => $this
|
||||
->t('Enable searching all fields'),
|
||||
'#description' => $this->t('<ul>
|
||||
<li>This makes an additional option visible in all Advanced Search Blocks, which searches across all fields. Its label is configured below.</li>
|
||||
<li>This setting must be enabled for the “Simple Search Block” to function.</li>
|
||||
</ul>'),
|
||||
'#default_value' => self::getConfig(self::SEARCH_ALL_FIELDS_FLAG, 0),
|
||||
];
|
||||
$form['eDisMax']['textfields_container'][self::EDISMAX_SEARCH_LABEL] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('If enabled, set the label for the option of searching all fields'),
|
||||
'#description' => $this->t('E.g. keyword.'),
|
||||
'#default_value' => self::getConfig(self::EDISMAX_SEARCH_LABEL, "Keyword"),
|
||||
];
|
||||
|
||||
$form['display-mode'] = [
|
||||
'#type' => 'fieldset',
|
||||
'#title' => $this->t("Pager Block"),
|
||||
];
|
||||
$form['display-mode']['pager-block-description'] = [
|
||||
'#markup' => $this->t("Pager blocks are available in the Blocks interface for each Search API view. The following settings apply for all Pager blocks."),
|
||||
];
|
||||
|
||||
$form['display-mode'][self::DISPLAY_LIST_FLAG] = [
|
||||
'#type' => 'checkbox',
|
||||
'#title' => $this
|
||||
->t('Expose "List view" option.'),
|
||||
'#default_value' => self::getConfig(self::DISPLAY_LIST_FLAG, 0),
|
||||
];
|
||||
|
||||
$form['display-mode'][self::DISPLAY_GRID_FLAG] = [
|
||||
'#type' => 'checkbox',
|
||||
'#title' => $this
|
||||
->t('Expose "Grid view" option.'),
|
||||
'#default_value' => self::getConfig(self::DISPLAY_GRID_FLAG, 0),
|
||||
];
|
||||
|
||||
$form['display-mode'][self::DISPLAY_DEFAULT] = [
|
||||
'#type' => 'select',
|
||||
'#title' => $this
|
||||
->t('Default view mode:'),
|
||||
'#options' => [
|
||||
'list' => 'List',
|
||||
'grid' => 'Grid',
|
||||
],
|
||||
'#default_value' => self::getConfig(self::DISPLAY_DEFAULT, 'grid'),
|
||||
];
|
||||
|
||||
$form += [
|
||||
'search' => [
|
||||
'#type' => 'fieldset',
|
||||
'#title' => $this->t('Advanced Search'),
|
||||
self::SEARCH_QUERY_PARAMETER => [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Search Query Parameter'),
|
||||
'#description' => $this->t('The url parameter in which the advanced search query is stored.'),
|
||||
'#default_value' => AdvancedSearchQuery::getQueryParameter(),
|
||||
],
|
||||
self::SEARCH_RECURSIVE_PARAMETER => [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Recurse Query Parameter'),
|
||||
'#description' => $this->t('The url parameter which can toggle recursive search.'),
|
||||
'#default_value' => AdvancedSearchQuery::getRecurseParameter(),
|
||||
],
|
||||
self::SEARCH_ADD_OPERATOR => [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Facet Add Operator'),
|
||||
'#description' => $this->t('Users can customize the operator for adding facets to use font-awesome or some other icon, etc.'),
|
||||
'#default_value' => AdvancedSearchForm::getAddOperator(),
|
||||
],
|
||||
self::SEARCH_REMOVE_OPERATOR => [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Facet Remove Operator'),
|
||||
'#description' => $this->t('Users can customize the operator for removing facets to use font-awesome or some other icon, etc.'),
|
||||
'#default_value' => AdvancedSearchForm::getRemoveOperator(),
|
||||
],
|
||||
],
|
||||
'facets' => [
|
||||
'#type' => 'fieldset',
|
||||
'#title' => $this->t('Facets'),
|
||||
self::FACET_TRUNCATE => [
|
||||
'#type' => 'number',
|
||||
'#title' => $this->t('Truncate Facet'),
|
||||
'#description' => $this->t('Optionally truncate the length of facets titles in the display. If unspecified they will not be truncated.'),
|
||||
'#default_value' => self::getConfig(self::FACET_TRUNCATE, 32),
|
||||
'#min' => 1,
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
return parent::buildForm($form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function submitForm(array &$form, FormStateInterface $form_state) {
|
||||
$config = $this->configFactory->getEditable(self::CONFIG_NAME);
|
||||
$config
|
||||
->set(self::SEARCH_QUERY_PARAMETER, $form_state->getValue(self::SEARCH_QUERY_PARAMETER))
|
||||
->set(self::SEARCH_RECURSIVE_PARAMETER, $form_state->getValue(self::SEARCH_RECURSIVE_PARAMETER))
|
||||
->set(self::SEARCH_ADD_OPERATOR, $form_state->getValue(self::SEARCH_ADD_OPERATOR))
|
||||
->set(self::SEARCH_REMOVE_OPERATOR, $form_state->getValue(self::SEARCH_REMOVE_OPERATOR))
|
||||
->set(self::FACET_TRUNCATE, $form_state->getValue(self::FACET_TRUNCATE))
|
||||
->set(self::EDISMAX_SEARCH_FLAG, $form_state->getValue(self::EDISMAX_SEARCH_FLAG))
|
||||
->set(self::EDISMAX_SEARCH_LABEL, $form_state->getValue(self::EDISMAX_SEARCH_LABEL))
|
||||
->set(self::SEARCH_ALL_FIELDS_FLAG, $form_state->getValue(self::SEARCH_ALL_FIELDS_FLAG))
|
||||
->set(self::DISPLAY_LIST_FLAG, $form_state->getValue(self::DISPLAY_LIST_FLAG))
|
||||
->set(self::DISPLAY_GRID_FLAG, $form_state->getValue(self::DISPLAY_GRID_FLAG))
|
||||
->set(self::DISPLAY_DEFAULT, $form_state->getValue(self::DISPLAY_DEFAULT))
|
||||
->save();
|
||||
parent::submitForm($form, $form_state);
|
||||
}
|
||||
|
||||
}
|
||||
24
src/GetConfigTrait.php
Normal file
24
src/GetConfigTrait.php
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search;
|
||||
|
||||
use Drupal\advanced_search\Form\SettingsForm;
|
||||
|
||||
/**
|
||||
* Simple trait for accessing this modules configuration.
|
||||
*/
|
||||
trait GetConfigTrait {
|
||||
|
||||
/**
|
||||
* Get a config setting or returns a default.
|
||||
*
|
||||
* @return string
|
||||
* The config setting or default value.
|
||||
*/
|
||||
protected static function getConfig($config, $default) {
|
||||
$settings = \Drupal::config(SettingsForm::CONFIG_NAME);
|
||||
$value = $settings->get($config);
|
||||
return !empty($value) ? $value : $default;
|
||||
}
|
||||
|
||||
}
|
||||
394
src/Plugin/Block/AdvancedSearchBlock.php
Normal file
394
src/Plugin/Block/AdvancedSearchBlock.php
Normal file
|
|
@ -0,0 +1,394 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\Block;
|
||||
|
||||
use Drupal\Core\Block\BlockBase;
|
||||
use Drupal\Core\Form\FormBuilderInterface;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
|
||||
use Drupal\search_api\Display\DisplayPluginManager;
|
||||
use Drupal\views\Entity\View;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
|
||||
/**
|
||||
* Provides an Islandora Advanced Search block.
|
||||
*
|
||||
* @Block(
|
||||
* id = "advanced_search_block",
|
||||
* deriver = "Drupal\advanced_search\Plugin\Block\AdvancedSearchBlockDeriver",
|
||||
* admin_label = @Translation("Islandora Advanced Search"),
|
||||
* category = @Translation("Islandora"),
|
||||
* )
|
||||
*/
|
||||
class AdvancedSearchBlock extends BlockBase implements ContainerFactoryPluginInterface {
|
||||
use ViewAndDisplayIdentifiersTrait;
|
||||
|
||||
// CSS classes used to bind table-drag behavior to.
|
||||
const WEIGHT_FIELD_CLASS = 'field-weight';
|
||||
const DISPLAY_FIELD_CLASS = 'field-display';
|
||||
|
||||
// Regions in the table which denote if a given field
|
||||
// is visible in the Advanced Search Form or not.
|
||||
const REGION_VISIBLE = 'visible';
|
||||
const REGION_HIDDEN = 'hidden';
|
||||
|
||||
// Keys for settings.
|
||||
const SETTING_FIELDS = 'fields';
|
||||
const SETTING_CONTEXTUAL_FILTER = 'context_filter';
|
||||
|
||||
/**
|
||||
* The display plugin manager.
|
||||
*
|
||||
* @var \Drupal\search_api\Display\DisplayPluginManager
|
||||
*/
|
||||
protected $displayPluginManager;
|
||||
|
||||
/**
|
||||
* The clone of the current request object.
|
||||
*
|
||||
* @var \Symfony\Component\HttpFoundation\Request
|
||||
*/
|
||||
protected $request;
|
||||
|
||||
/**
|
||||
* The view this block affects.
|
||||
*
|
||||
* @var \Drupal\views\Entity\View
|
||||
*/
|
||||
protected $view;
|
||||
|
||||
/**
|
||||
* The view display this block affects.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $display;
|
||||
|
||||
/**
|
||||
* Form Builder.
|
||||
*
|
||||
* @var \Drupal\Core\Form\FormBuilderInterface
|
||||
*/
|
||||
protected $formBuilder;
|
||||
|
||||
/**
|
||||
* Construct a AdvancedSearchBlock instance.
|
||||
*
|
||||
* @param array $configuration
|
||||
* A configuration array containing information about the plugin instance.
|
||||
* @param string $plugin_id
|
||||
* The plugin_id for the plugin instance.
|
||||
* @param string $plugin_definition
|
||||
* The plugin implementation definition.
|
||||
* @param \Drupal\search_api\Display\DisplayPluginManager $display_plugin_manager
|
||||
* The display plugin manager.
|
||||
* @param \Drupal\Core\Form\FormBuilderInterface $form_builder
|
||||
* The form builder service used to build the search form.
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
* A request object for the current request.
|
||||
*/
|
||||
final public function __construct(array $configuration, $plugin_id, $plugin_definition, DisplayPluginManager $display_plugin_manager, FormBuilderInterface $form_builder, Request $request) {
|
||||
parent::__construct($configuration, $plugin_id, $plugin_definition);
|
||||
$this->displayPluginManager = $display_plugin_manager;
|
||||
[$view_id, $display_id] = preg_split('/__/', $this->getDerivativeId(), 2);
|
||||
$this->view = View::Load($view_id);
|
||||
$this->display = $this->view->getDisplay($display_id);
|
||||
$this->formBuilder = $form_builder;
|
||||
$this->request = clone $request;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
|
||||
return new static(
|
||||
$configuration,
|
||||
$plugin_id,
|
||||
$plugin_definition,
|
||||
$container->get('plugin.manager.search_api.display'),
|
||||
$container->get('form_builder'),
|
||||
$container->get('request_stack')->getMainRequest()
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function defaultConfiguration() {
|
||||
return [
|
||||
self::SETTING_FIELDS => [],
|
||||
self::SETTING_CONTEXTUAL_FILTER => NULL,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Fields which can be enabled / disabled for display in the search form.
|
||||
*
|
||||
* @return \Drupal\search_api\Item\FieldInterface[]
|
||||
* The $fields sorted by label.
|
||||
*/
|
||||
protected function getFields() {
|
||||
$fields = $this->getIndex()->getFields();
|
||||
// First pass sort on label, secondary sort will be used
|
||||
// when looking at existing configuration for this block.
|
||||
uasort($fields, function ($a, $b) {
|
||||
return strcmp($a->getLabel(), $b->getLabel());
|
||||
});
|
||||
return $fields;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get regions of table to display.
|
||||
*
|
||||
* @return array
|
||||
* The properties of each region used for building the table of fields.
|
||||
*/
|
||||
protected function getRegions() {
|
||||
// Classes for select fields like 'weight' and 'display' are hard-coded
|
||||
// and used in js/islandora-advanced-search.admin.js.
|
||||
return [
|
||||
'visible' => [
|
||||
'title' => $this->t('Visible'),
|
||||
'invisible' => TRUE,
|
||||
'message' => $this->t('No search field is visible.'),
|
||||
'weight' => self::WEIGHT_FIELD_CLASS . '-visible',
|
||||
'display' => self::DISPLAY_FIELD_CLASS . '-visible',
|
||||
],
|
||||
'hidden' => [
|
||||
'title' => $this->t('Hidden'),
|
||||
'invisible' => FALSE,
|
||||
'message' => $this->t('No search field is hidden.'),
|
||||
'weight' => self::WEIGHT_FIELD_CLASS . '-hidden',
|
||||
'display' => self::DISPLAY_FIELD_CLASS . '-hidden',
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Options for field display derived from the available regions.
|
||||
*
|
||||
* @return array
|
||||
* Display select field options.
|
||||
*/
|
||||
protected function getDisplayOptions() {
|
||||
$options = [];
|
||||
foreach ($this->getRegions() as $region => $settings) {
|
||||
$options[$region] = $settings['title'];
|
||||
}
|
||||
return $options;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function blockForm($form, FormStateInterface $form_state) {
|
||||
// At most we will have one row per field.
|
||||
$fields = $this->getFields();
|
||||
$weight_delta = round(count($fields) / 2);
|
||||
|
||||
// Group each field into a region given our current configuration.
|
||||
$visible_fields = $this->configuration[self::SETTING_FIELDS];
|
||||
$regions = $this->getRegions();
|
||||
$display_options = $this->getDisplayOptions();
|
||||
|
||||
// Field rows are grouped by the region in which they are displayed.
|
||||
$field_rows = array_fill_keys(array_keys($regions), []);
|
||||
foreach ($fields as $field) {
|
||||
// If a field exists in the blocks configuration than it is 'visible' and
|
||||
// its weight is equivalent to its order in the configuration,
|
||||
// i.e. its index.
|
||||
$identifier = $field->getFieldIdentifier();
|
||||
$weight = array_search($identifier, $visible_fields);
|
||||
$visible = $weight !== FALSE;
|
||||
$region = $visible ? self::REGION_VISIBLE : self::REGION_HIDDEN;
|
||||
$field_rows[$region][$identifier] = [
|
||||
'#attributes' => [
|
||||
'class' => ['draggable'],
|
||||
],
|
||||
'label' => ['#plain_text' => $field->getLabel()],
|
||||
'identifier' => ['#plain_text' => $identifier],
|
||||
'weight' => [
|
||||
'#type' => 'weight',
|
||||
'#title' => $this->t('Weight'),
|
||||
'#title_display' => 'invisible',
|
||||
'#default_value' => $visible ? $weight : 0,
|
||||
'#delta' => $weight_delta,
|
||||
'#attributes' => [
|
||||
'class' => [self::WEIGHT_FIELD_CLASS, $regions[$region]['weight']],
|
||||
],
|
||||
],
|
||||
'display' => [
|
||||
'#type' => 'select',
|
||||
'#title' => $this->t('Display'),
|
||||
'#title_display' => 'invisible',
|
||||
'#options' => $display_options,
|
||||
'#default_value' => $region,
|
||||
'#attributes' => [
|
||||
'class' => [self::DISPLAY_FIELD_CLASS, $regions[$region]['display']],
|
||||
],
|
||||
],
|
||||
];
|
||||
}
|
||||
// Sort the visible rows by their weight.
|
||||
uasort($field_rows[self::REGION_VISIBLE], function ($a, $b) {
|
||||
$a = $a['weight']['#default_value'];
|
||||
$b = $b['weight']['#default_value'];
|
||||
if ($a == $b) {
|
||||
return 0;
|
||||
}
|
||||
return ($a < $b) ? -1 : 1;
|
||||
});
|
||||
|
||||
// Build Rows.
|
||||
$rows = [];
|
||||
$table_drag = [];
|
||||
foreach ($regions as $region => $properties) {
|
||||
$rows += [
|
||||
// Conditionally display region title as a row.
|
||||
"region-$region" => $properties['invisible'] ? NULL : [
|
||||
'#attributes' => [
|
||||
'class' => ['region-title', "region-title-$region"],
|
||||
],
|
||||
'label' => [
|
||||
'#plain_text' => $properties['title'],
|
||||
'#wrapper_attributes' => [
|
||||
'colspan' => 4,
|
||||
],
|
||||
],
|
||||
],
|
||||
// Will dynamically display if the region has fields or not controlled
|
||||
// by Drupal behaviors in js/islandora-advanced-search.admin.js.
|
||||
"region-$region-message" => [
|
||||
'#attributes' => [
|
||||
'class' => [
|
||||
'region-message',
|
||||
"region-$region-message",
|
||||
empty($field_rows[$region]) ? 'region-empty' : 'region-populated',
|
||||
],
|
||||
],
|
||||
'message' => [
|
||||
'#markup' => '<em>' . $properties['message'] . '</em>',
|
||||
'#wrapper_attributes' => [
|
||||
'colspan' => 4,
|
||||
],
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
// Include field rows in this region.
|
||||
$rows += $field_rows[$region];
|
||||
|
||||
// Configure order by weight field in region.
|
||||
$table_drag[] = [
|
||||
'action' => 'order',
|
||||
'relationship' => 'sibling',
|
||||
'group' => self::WEIGHT_FIELD_CLASS,
|
||||
'subgroup' => $properties['weight'],
|
||||
'source' => self::WEIGHT_FIELD_CLASS,
|
||||
];
|
||||
|
||||
// Configure drag action for display field in region.
|
||||
$table_drag[] = [
|
||||
'action' => 'match',
|
||||
'relationship' => 'sibling',
|
||||
'group' => self::DISPLAY_FIELD_CLASS,
|
||||
'subgroup' => $properties['display'],
|
||||
'source' => self::DISPLAY_FIELD_CLASS,
|
||||
];
|
||||
}
|
||||
|
||||
$form[self::SETTING_FIELDS] = [
|
||||
'#type' => 'table',
|
||||
'#attributes' => [
|
||||
// Identifier is hard-coded and used in
|
||||
// js/islandora-advanced-search.admin.js.
|
||||
'id' => 'advanced-search-fields',
|
||||
],
|
||||
'#header' => [
|
||||
$this->t('Label'),
|
||||
$this->t('Field'),
|
||||
$this->t('Weight'),
|
||||
$this->t('Display'),
|
||||
],
|
||||
'#empty' => $this->t('No search fields, please check search index configuration.'),
|
||||
'#tabledrag' => $table_drag,
|
||||
] + $rows;
|
||||
|
||||
// If there is contextual filters associated with the display that means
|
||||
// we can filter on collection / sub-collection. Allow the user to choose
|
||||
// which filters collections.
|
||||
$id = NULL;
|
||||
$field = NULL;
|
||||
$options = [];
|
||||
if (isset($this->display['display_options']['arguments'])) {
|
||||
foreach ($this->display['display_options']['arguments'] as $context_filter) {
|
||||
$id = $context_filter['id'];
|
||||
$field = $context_filter['field'];
|
||||
if (isset($fields[$field])) {
|
||||
$options[$id] = $fields[$field]->getLabel() . ':' . $id;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (count($options) > 0) {
|
||||
$form[self::SETTING_CONTEXTUAL_FILTER] = [
|
||||
'#type' => 'select',
|
||||
'#title' => $this->t('Context Filter'),
|
||||
'#description' => $this->t('If more than one <strong>Context Filter</strong> is defined, specify which is used to <strong>include</strong> only <strong>direct children</strong> of the Collection as it will disabled to allow recursive searching.'),
|
||||
'#options' => $options,
|
||||
'#default_value' => $this->configuration[self::SETTING_CONTEXTUAL_FILTER],
|
||||
'#multiple' => FALSE,
|
||||
'#required' => FALSE,
|
||||
'#size' => count($options) + 1,
|
||||
];
|
||||
}
|
||||
$form['#attributes']['class'][] = 'clearfix';
|
||||
$form['#attached']['library'][] = 'advanced_search/advanced.search.admin';
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function blockSubmit($form, FormStateInterface $form_state) {
|
||||
$values = $form_state->getValues();
|
||||
$fields = array_filter($values[self::SETTING_FIELDS], function ($field) {
|
||||
return $field['display'] == 'visible';
|
||||
});
|
||||
uasort($fields, '\Drupal\Component\Utility\SortArray::sortByWeightElement');
|
||||
$this->configuration[self::SETTING_FIELDS] = array_keys($fields);
|
||||
if (isset($values[self::SETTING_CONTEXTUAL_FILTER])) {
|
||||
$this->configuration[self::SETTING_CONTEXTUAL_FILTER] = $values[self::SETTING_CONTEXTUAL_FILTER];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function build() {
|
||||
$fields = $this->getIndex()->getFields();
|
||||
$configured_fields = [];
|
||||
foreach ($this->configuration[self::SETTING_FIELDS] as $identifier) {
|
||||
$configured_fields[$identifier] = $fields[$identifier];
|
||||
}
|
||||
return $this->formBuilder->getForm('Drupal\advanced_search\Form\AdvancedSearchForm', $this->view, $this->display, $configured_fields, $this->configuration[self::SETTING_CONTEXTUAL_FILTER]);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getCacheMaxAge() {
|
||||
// The block cannot be cached, because it must always match the current
|
||||
// search results.
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Search Index.
|
||||
*/
|
||||
protected function getIndex() {
|
||||
$id = $this->getDerivativeId();
|
||||
return $this->displayPluginManager->createInstance("views_{$this->display['display_plugin']}:{$id}")->getIndex();
|
||||
}
|
||||
|
||||
}
|
||||
17
src/Plugin/Block/AdvancedSearchBlockDeriver.php
Normal file
17
src/Plugin/Block/AdvancedSearchBlockDeriver.php
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\Block;
|
||||
|
||||
/**
|
||||
* Deriver for AdvancedSearchBlock.
|
||||
*/
|
||||
class AdvancedSearchBlockDeriver extends SearchApiDisplayBlockDeriver {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function label() {
|
||||
return $this->t('Advanced Search');
|
||||
}
|
||||
|
||||
}
|
||||
102
src/Plugin/Block/SearchApiDisplayBlockDeriver.php
Normal file
102
src/Plugin/Block/SearchApiDisplayBlockDeriver.php
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\Block;
|
||||
|
||||
use Drupal\Component\Plugin\PluginBase;
|
||||
use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
|
||||
use Drupal\Core\StringTranslation\StringTranslationTrait;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
|
||||
/**
|
||||
* This deriver creates a block for every search_api.display.
|
||||
*/
|
||||
abstract class SearchApiDisplayBlockDeriver implements ContainerDeriverInterface {
|
||||
|
||||
use StringTranslationTrait;
|
||||
|
||||
/**
|
||||
* List of derivative definitions.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $derivatives = [];
|
||||
|
||||
/**
|
||||
* The entity storage for the view.
|
||||
*
|
||||
* @var \Drupal\Core\Entity\EntityStorageInterface
|
||||
*/
|
||||
protected $storage;
|
||||
|
||||
/**
|
||||
* The display manager for the search_api.
|
||||
*
|
||||
* @var \Drupal\search_api\Display\DisplayPluginManager
|
||||
*/
|
||||
protected $displayPluginManager;
|
||||
|
||||
/**
|
||||
* Label for the SearchApiDisplayBlockDriver.
|
||||
*/
|
||||
abstract protected function label();
|
||||
|
||||
/**
|
||||
* The constructor.
|
||||
*/
|
||||
final public function __construct(ContainerInterface $container, $base_plugin_id) {}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function create(ContainerInterface $container, $base_plugin_id) {
|
||||
$deriver = new static($container, $base_plugin_id);
|
||||
$deriver->storage = $container->get('entity_type.manager')->getStorage('view');
|
||||
$deriver->displayPluginManager = $container->get('plugin.manager.search_api.display');
|
||||
return $deriver;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getDerivativeDefinition($derivative_id, $base_plugin_definition) {
|
||||
$derivatives = $this->getDerivativeDefinitions($base_plugin_definition);
|
||||
return $derivatives[$derivative_id] ?? NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getDerivativeDefinitions($base_plugin_definition) {
|
||||
$base_plugin_id = $base_plugin_definition['id'];
|
||||
|
||||
if (!isset($this->derivatives[$base_plugin_id])) {
|
||||
$plugin_derivatives = [];
|
||||
|
||||
foreach ($this->displayPluginManager->getDefinitions() as $display_definition) {
|
||||
$view_id = $display_definition['view_id'];
|
||||
$view_display = $display_definition['view_display'];
|
||||
// The derived block needs both the view / display identifiers to
|
||||
// construct the pager.
|
||||
$machine_name = "{$view_id}__{$view_display}";
|
||||
|
||||
/** @var \Drupal\views\ViewEntityInterface $view */
|
||||
$view = $this->storage->load($view_id);
|
||||
$display = $view->getDisplay($view_display);
|
||||
|
||||
$plugin_derivatives[$machine_name] = [
|
||||
'id' => $base_plugin_id . PluginBase::DERIVATIVE_SEPARATOR . $machine_name,
|
||||
'label' => $this->label(),
|
||||
'admin_label' => $this->t(':view: :label for :display', [
|
||||
':view' => $view->label(),
|
||||
':label' => $this->label(),
|
||||
':display' => $display['display_title'],
|
||||
]),
|
||||
] + $base_plugin_definition;
|
||||
}
|
||||
|
||||
$this->derivatives[$base_plugin_id] = $plugin_derivatives;
|
||||
}
|
||||
return $this->derivatives[$base_plugin_id];
|
||||
}
|
||||
|
||||
}
|
||||
107
src/Plugin/Block/SearchBlock.php
Normal file
107
src/Plugin/Block/SearchBlock.php
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\Block;
|
||||
|
||||
use Drupal\advanced_search\Form\SearchForm;
|
||||
use Drupal\Core\Block\BlockBase;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
use Drupal\advanced_search\Form\SettingsForm;
|
||||
|
||||
/**
|
||||
* Provides a 'SearchBlock' block.
|
||||
*
|
||||
* @Block(
|
||||
* id = "search_block",
|
||||
* admin_label = @Translation("Search"),
|
||||
* )
|
||||
*/
|
||||
class SearchBlock extends BlockBase {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function defaultConfiguration() {
|
||||
return [] + parent::defaultConfiguration();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function blockForm($form, FormStateInterface $form_state) {
|
||||
$config = \Drupal::config(SettingsForm::CONFIG_NAME);
|
||||
$form['search-attributes'] = [
|
||||
'#type' => 'fieldset',
|
||||
'#title' => $this->t('Configure Search Block'),
|
||||
];
|
||||
|
||||
if (!$config->get(SettingsForm::SEARCH_ALL_FIELDS_FLAG)) {
|
||||
$form['search-attributes'][SettingsForm::SEARCH_ALL_FIELDS_FLAG] = [
|
||||
'#markup' => $this
|
||||
->t('<strong>This block is required to enable searching all fields for the Advanced Search.
|
||||
To proceed, please enable "Enable searching all fields" in
|
||||
<a href="/admin/config/search/advanced" target="_blank">Advanced Seach Configuration</a></strong>.'),
|
||||
];
|
||||
}
|
||||
else {
|
||||
$views = \Drupal::EntityTypeManager()->getStorage('view')->loadMultiple();
|
||||
$options = [];
|
||||
foreach ($views as $view_name => $view) {
|
||||
$displays = $view->get("display");
|
||||
foreach ($displays as $display) {
|
||||
if ($display['display_plugin'] === "page") {
|
||||
$options["view.$view_name" . "." . $display['id']] = "view.$view_name" . "." . $display['id'];
|
||||
}
|
||||
}
|
||||
}
|
||||
$form['search-attributes']['view_machine_name'] = [
|
||||
'#type' => 'select',
|
||||
'#title' => $this->t('Select the machine name of Search Results Page:'),
|
||||
'#default_value' => $this->configuration['search_view_machine_name'],
|
||||
'#options' => $options,
|
||||
];
|
||||
$form['search-attributes']['search_textfield'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Search Keyword Text field label:'),
|
||||
'#default_value' => $this->configuration['search_textfield_label'],
|
||||
'#maxlength' => 255,
|
||||
];
|
||||
$form['search-attributes']['search_placeholder_textfield'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Search Keyword text field placeholder:'),
|
||||
'#default_value' => $this->configuration['search_placeholder'],
|
||||
'#maxlength' => 255,
|
||||
];
|
||||
|
||||
$form['search-attributes']['search_submit'] = [
|
||||
'#type' => 'textfield',
|
||||
'#title' => $this->t('Search Button Label:'),
|
||||
'#default_value' => $this->configuration['search_submit_label'],
|
||||
'#maxlength' => 255,
|
||||
];
|
||||
}
|
||||
|
||||
return $form;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function blockSubmit($form, FormStateInterface $form_state) {
|
||||
$this->configuration['block_id'] = $form_state->getBuildInfo()['callback_object']->getEntity()->id();
|
||||
$this->configuration['search_view_machine_name'] = $form_state->getValues()['search-attributes']['view_machine_name'];
|
||||
$this->configuration['search_textfield_label'] = $form_state->getValues()['search-attributes']['search_textfield'];
|
||||
$this->configuration['search_placeholder'] = $form_state->getValues()['search-attributes']['search_placeholder_textfield'];
|
||||
$this->configuration['search_submit_label'] = $form_state->getValues()['search-attributes']['search_submit'];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function build() {
|
||||
$config = $this->getConfiguration();
|
||||
$blockId = $config['block_id'];
|
||||
$searchForm = new SearchForm($blockId);
|
||||
return \Drupal::formBuilder()->getForm($searchForm);
|
||||
}
|
||||
|
||||
}
|
||||
328
src/Plugin/Block/SearchResultsPagerBlock.php
Normal file
328
src/Plugin/Block/SearchResultsPagerBlock.php
Normal file
|
|
@ -0,0 +1,328 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\Block;
|
||||
|
||||
use Drupal\Core\Block\BlockBase;
|
||||
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
|
||||
use Drupal\Core\Render\Markup;
|
||||
use Drupal\Core\Url;
|
||||
use Drupal\advanced_search\AdvancedSearchQuery;
|
||||
use Drupal\views\Entity\View;
|
||||
use Drupal\views\Plugin\views\pager\SqlBase;
|
||||
use Drupal\views\ViewExecutable;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
use Drupal\advanced_search\Form\SettingsForm;
|
||||
|
||||
/**
|
||||
* Provides a 'AjaxViewBlock' block.
|
||||
*
|
||||
* @Block(
|
||||
* id = "advanced_search_result_pager",
|
||||
* deriver = "Drupal\advanced_search\Plugin\Block\SearchResultsPagerBlockDeriver",
|
||||
* admin_label = @Translation("Search Results Pager"),
|
||||
* category = @Translation("Islandora"),
|
||||
* )
|
||||
*/
|
||||
class SearchResultsPagerBlock extends BlockBase implements ContainerFactoryPluginInterface {
|
||||
use ViewAndDisplayIdentifiersTrait;
|
||||
|
||||
/**
|
||||
* The clone of the current request object.
|
||||
*
|
||||
* @var \Symfony\Component\HttpFoundation\Request
|
||||
*/
|
||||
protected $request;
|
||||
|
||||
/**
|
||||
* Construct a FacetBlock instance.
|
||||
*
|
||||
* @param array $configuration
|
||||
* A configuration array containing information about the plugin instance.
|
||||
* @param string $plugin_id
|
||||
* The plugin_id for the plugin instance.
|
||||
* @param string $plugin_definition
|
||||
* The plugin implementation definition.
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
* A request object for the current request.
|
||||
*/
|
||||
final public function __construct(array $configuration, $plugin_id, $plugin_definition, Request $request) {
|
||||
parent::__construct($configuration, $plugin_id, $plugin_definition);
|
||||
$this->request = clone $request;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
|
||||
return new static(
|
||||
$configuration,
|
||||
$plugin_id,
|
||||
$plugin_definition,
|
||||
$container->get('request_stack')->getMainRequest()
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function build() {
|
||||
$id = $this->getDerivativeId();
|
||||
[$view_id, $display_id] = $this->getViewAndDisplayIdentifiers();
|
||||
$view = View::Load($view_id);
|
||||
$view_executable = $view->getExecutable();
|
||||
$view_executable->setDisplay($display_id);
|
||||
// Allow advanced search to alter the query.
|
||||
$advanced_search_query = new AdvancedSearchQuery();
|
||||
$advanced_search_query->alterView($this->request, $view_executable, $display_id);
|
||||
$view_executable->execute();
|
||||
$pager = $view_executable->getPager();
|
||||
$exposed_input = $view_executable->getExposedInput();
|
||||
$query_parameters = $this->request->query->all();
|
||||
$build = [
|
||||
'#attached' => [
|
||||
'drupalSettings' => [
|
||||
'advanced_search_pager_views_ajax' => [
|
||||
$id => [
|
||||
'view_id' => $view_id,
|
||||
'current_display_id' => $display_id,
|
||||
'ajax_path' => '/views/ajax',
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
'#attributes' => [
|
||||
'class' => ['advanced_search_result_pager'],
|
||||
'data-drupal-pager-id' => $id,
|
||||
],
|
||||
'result_summary' => $this->buildResultsSummary($view_executable),
|
||||
'container' => [
|
||||
'#prefix' => '<div class="pager__group">',
|
||||
'#suffix' => '</div>',
|
||||
'results_per_page_links' => $this->buildResultsPerPageLinks($pager, $query_parameters),
|
||||
'display_links' => $this->buildDisplayLinks($query_parameters),
|
||||
'sort_by' => $this->buildSortByForm($view_executable->sort, $query_parameters),
|
||||
'pager' => array_merge($pager->render($exposed_input), ['#wrapper_attributes' => ['class' => ['container']]]),
|
||||
],
|
||||
];
|
||||
return $build;
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the results summary portion of the pager.
|
||||
*
|
||||
* @param Drupal\views\ViewExecutable $view_executable
|
||||
* The view to build the summary for.
|
||||
*
|
||||
* @return array
|
||||
* A renderable array that represents the current page, and number of
|
||||
* results in the view.
|
||||
*/
|
||||
protected function buildResultsSummary(ViewExecutable $view_executable) {
|
||||
$current_page = (int) $view_executable->getCurrentPage() + 1;
|
||||
$per_page = (int) $view_executable->getItemsPerPage();
|
||||
$total = $view_executable->total_rows ?? count($view_executable->result);
|
||||
// If there is no result the "start" and "current_record_count" should be
|
||||
// equal to 0. To have the same calculation logic, we use a "start offset"
|
||||
// to handle all the cases.
|
||||
$start_offset = empty($total) ? 0 : 1;
|
||||
if ($per_page === 0) {
|
||||
$start = $start_offset;
|
||||
$end = $total;
|
||||
}
|
||||
else {
|
||||
$total_count = $current_page * $per_page;
|
||||
if ($total_count > $total) {
|
||||
$total_count = $total;
|
||||
}
|
||||
$start = ($current_page - 1) * $per_page + $start_offset;
|
||||
$end = $total_count;
|
||||
}
|
||||
if (!empty($total)) {
|
||||
// Return as render array.
|
||||
return [
|
||||
'#prefix' => '<div class="pager__summary">',
|
||||
'#suffix' => '</div>',
|
||||
'#markup' => $this->t('Displaying @start - @end of @total', [
|
||||
'@start' => $start,
|
||||
'@end' => $end,
|
||||
'@total' => $total,
|
||||
]),
|
||||
];
|
||||
}
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the results per page portion of the pager.
|
||||
*
|
||||
* @param Drupal\views\Plugin\views\pager\SqlBase $pager
|
||||
* The pager for the view.
|
||||
* @param array $query_parameters
|
||||
* The query parameters used to change the number of results per page.
|
||||
*
|
||||
* @return array
|
||||
* A renderable array representing the results per page portion of pager.
|
||||
*/
|
||||
protected function buildResultsPerPageLinks(SqlBase $pager, array $query_parameters) {
|
||||
$active_items_per_page = $query_parameters['items_per_page'] ?? $pager->options['items_per_page'];
|
||||
$items_per_page_options = array_map(function ($value) {
|
||||
return trim($value);
|
||||
}, explode(',', $pager->options['expose']['items_per_page_options']));
|
||||
$items = [];
|
||||
foreach ($items_per_page_options as $items_per_page) {
|
||||
$url = Url::fromRoute('<current>', [], [
|
||||
// When changing the number of items displayed always return the user
|
||||
// to the first page.
|
||||
'query' => array_merge($query_parameters, [
|
||||
'items_per_page' => $items_per_page,
|
||||
'page' => 0,
|
||||
]),
|
||||
'absolute' => TRUE,
|
||||
]);
|
||||
$active = $items_per_page == $active_items_per_page;
|
||||
$items[] = [
|
||||
'#type' => 'link',
|
||||
'#url' => $url,
|
||||
'#title' => $items_per_page,
|
||||
'#attributes' => [
|
||||
'aria-label' => $this->t("@item items per page", ["@item" => $items_per_page]),
|
||||
'class' => $active ?
|
||||
['pager__link', 'pager__link--is-active', 'pager__itemsperpage'] :
|
||||
['pager__link', 'pager__itemsperpage'],
|
||||
],
|
||||
'#wrapper_attributes' => [
|
||||
'class' => $active ? ['pager__item', 'is-active'] : ['pager__item'],
|
||||
],
|
||||
];
|
||||
}
|
||||
return [
|
||||
'#theme' => 'item_list',
|
||||
'#title' => $this->t('Results per page'),
|
||||
'#list_type' => 'ul',
|
||||
'#items' => $items,
|
||||
'#attributes' => [],
|
||||
'#wrapper_attributes' => ['class' => ['pager__results', 'container']],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the display links portion of the pager (list/grid).
|
||||
*
|
||||
* @param array $query_parameters
|
||||
* The query parameters used to change the display format.
|
||||
*
|
||||
* @return array
|
||||
* A renderable array representing the display links portion of pager.
|
||||
*/
|
||||
protected function buildDisplayLinks(array $query_parameters) {
|
||||
$config = \Drupal::config(SettingsForm::CONFIG_NAME);
|
||||
$display_options = [];
|
||||
|
||||
if ($config->get(SettingsForm::DISPLAY_LIST_FLAG) == 1) {
|
||||
$display_options['list'] = [
|
||||
'icon' => 'fa-list',
|
||||
'title' => $this->t('List'),
|
||||
];
|
||||
}
|
||||
|
||||
if ($config->get(SettingsForm::DISPLAY_GRID_FLAG) == 1) {
|
||||
$display_options['grid'] = [
|
||||
'icon' => 'fa-th',
|
||||
'title' => $this->t('Grid'),
|
||||
];
|
||||
}
|
||||
|
||||
$active_display = $query_parameters['display'] ?? $config->get(SettingsForm::DISPLAY_DEFAULT);
|
||||
$items = [];
|
||||
foreach ($display_options as $display => $options) {
|
||||
$url = Url::fromRoute('<current>', [], [
|
||||
'query' => array_merge($query_parameters, ['display' => $display]),
|
||||
'absolute' => TRUE,
|
||||
]);
|
||||
$text = "<i class='fa {$options['icon']}' aria-hidden='true'> </i><span class='display-mode'>{$options['title']}</span>";
|
||||
$active = $active_display == $display;
|
||||
$items[] = [
|
||||
'#type' => 'link',
|
||||
'#url' => $url,
|
||||
'#title' => Markup::create($text),
|
||||
'#attributes' => [
|
||||
'class' => $active ?
|
||||
['pager__link', 'pager__link--is-active', 'pager__display'] :
|
||||
['pager__link', 'pager__display'],
|
||||
'aria-label' => $this->t("Display as @link", ["@link" => Markup::create($text)]),
|
||||
],
|
||||
'#wrapper_attributes' => [
|
||||
'class' => $active ? ['pager__item', 'is-active'] : ['pager__item'],
|
||||
],
|
||||
];
|
||||
}
|
||||
return [
|
||||
'#theme' => 'item_list',
|
||||
'#list_type' => 'ul',
|
||||
'#items' => $items,
|
||||
'#attributes' => [],
|
||||
'#wrapper_attributes' => ['class' => ['pager__display', 'container']],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the sort by portion of the pager.
|
||||
*
|
||||
* @param array $sort_criteria
|
||||
* The search fields which can be sorted.
|
||||
* @param array $query_parameters
|
||||
* The query parameters used to change the display format.
|
||||
*
|
||||
* @return array
|
||||
* A renderable array representing the sort by portion of pager.
|
||||
*/
|
||||
protected function buildSortByForm(array $sort_criteria, array $query_parameters) {
|
||||
$default_order = $query_parameters['sort_order'] ?? 'DESC';
|
||||
$default_sort_by = $query_parameters['sort_by'] ?? 'search_api_relevance';
|
||||
$default_value = $default_sort_by . '_' . strtolower($default_order);
|
||||
$options = [];
|
||||
$options_attributes = [];
|
||||
// Not sure if this will work without defining a sort per direction.
|
||||
foreach ($sort_criteria as $sort) {
|
||||
if ($sort->options['exposed'] == TRUE) {
|
||||
$id = $sort->options['id'];
|
||||
// Label should be translated via views already.
|
||||
$label = $sort->options['expose']['label'];
|
||||
$asc = "{$id}_asc";
|
||||
$desc = "{$id}_desc";
|
||||
$options[$asc] = "{$label} ↓";
|
||||
$options[$desc] = "{$label} ↑";
|
||||
$options_attributes[$asc] = [
|
||||
'data-sort_by' => $id,
|
||||
'data-sort_order' => 'ASC',
|
||||
];
|
||||
$options_attributes[$desc] = [
|
||||
'data-sort_by' => $id,
|
||||
'data-sort_order' => 'DESC',
|
||||
];
|
||||
}
|
||||
}
|
||||
return [
|
||||
'#type' => 'select',
|
||||
'#title' => 'Sort',
|
||||
'#title_display' => 'invisible',
|
||||
'#options' => $options,
|
||||
'#options_attributes' => $options_attributes,
|
||||
'#attributes' => ['autocomplete' => 'off', "aria-label" => "Sort By"],
|
||||
'#wrapper_attributes' => ['class' => ['pager__sort', 'container']],
|
||||
'#name' => 'order',
|
||||
'#value' => $default_value,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getCacheMaxAge() {
|
||||
// The block cannot be cached, because it must always match the current
|
||||
// search results.
|
||||
return 0;
|
||||
}
|
||||
|
||||
}
|
||||
17
src/Plugin/Block/SearchResultsPagerBlockDeriver.php
Normal file
17
src/Plugin/Block/SearchResultsPagerBlockDeriver.php
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\Block;
|
||||
|
||||
/**
|
||||
* This deriver creates a block for every search_api.display.
|
||||
*/
|
||||
class SearchResultsPagerBlockDeriver extends SearchApiDisplayBlockDeriver {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function label() {
|
||||
return $this->t('Search Results Pager');
|
||||
}
|
||||
|
||||
}
|
||||
30
src/Plugin/Block/ViewAndDisplayIdentifiersTrait.php
Normal file
30
src/Plugin/Block/ViewAndDisplayIdentifiersTrait.php
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\Block;
|
||||
|
||||
/**
|
||||
* Gets the view and display identifiers used to create this block.
|
||||
*
|
||||
* @see Drupal\Component\Plugin\Discovery\DiscoveryInterface
|
||||
*/
|
||||
trait ViewAndDisplayIdentifiersTrait {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
abstract public function getDerivativeId();
|
||||
|
||||
/**
|
||||
* Gets the View and View Display identifiers used to derive this block.
|
||||
*
|
||||
* @return string[]
|
||||
* Returns an array of two strings where the first is the View identifier
|
||||
* and the second is the View Display identifier associated with the view
|
||||
* used to derive this block.
|
||||
*/
|
||||
public function getViewAndDisplayIdentifiers() {
|
||||
$id = $this->getDerivativeId();
|
||||
return preg_split('/__/', $id, 2);
|
||||
}
|
||||
|
||||
}
|
||||
63
src/Plugin/Field/FieldFormatter/EntityReferenceCountFormatter.php
Executable file
63
src/Plugin/Field/FieldFormatter/EntityReferenceCountFormatter.php
Executable file
|
|
@ -0,0 +1,63 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\Field\FieldFormatter;
|
||||
|
||||
use Drupal\Core\Field\FieldItemListInterface;
|
||||
use Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
|
||||
/**
|
||||
* Plugin implementation of the 'entity reference ID' formatter.
|
||||
*
|
||||
* @FieldFormatter(
|
||||
* id = "entity_reference_url_title",
|
||||
* label = @Translation("Children Entity Count, Label."),
|
||||
* description = @Translation("Children Entity Count, Label."),
|
||||
* field_types = {
|
||||
* "entity_reference"
|
||||
* }
|
||||
* )
|
||||
*/
|
||||
class EntityReferenceCountFormatter extends EntityReferenceFormatterBase {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function defaultSettings() {
|
||||
return [
|
||||
'label' => 'Items in Collection',
|
||||
] + parent::defaultSettings();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function settingsForm(array $form, FormStateInterface $form_state) {
|
||||
$elements['separator'] = [
|
||||
'#title' => $this->t("Text to appear next to the children's count"),
|
||||
'#type' => 'textfield',
|
||||
'#default_value' => $this->getSetting('label'),
|
||||
];
|
||||
return $elements;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function settingsSummary(): array {
|
||||
$summary = [];
|
||||
$summary[] = $this->getSetting('label') ? 'Label : ' . $this->getSetting('label') : $this->t('No label');
|
||||
return $summary;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function viewElements(FieldItemListInterface $items, $langcode): array {
|
||||
$element = [];
|
||||
$total_items = count($this->getEntitiesToView($items, $langcode));
|
||||
$element[] = ['#markup' => "<span class='collection_children__total_count'>{$total_items}<span>" . ' ' . $this->formatPlural($total_items, '1 Item in Collection', '@count Items in Collection')];
|
||||
return $element;
|
||||
}
|
||||
|
||||
}
|
||||
100
src/Plugin/Field/FieldFormatter/SearchableEntityFormatter.php
Normal file
100
src/Plugin/Field/FieldFormatter/SearchableEntityFormatter.php
Normal file
|
|
@ -0,0 +1,100 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\Field\FieldFormatter;
|
||||
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Field\FieldItemListInterface;
|
||||
use Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceLabelFormatter;
|
||||
use Drupal\Core\Form\FormStateInterface;
|
||||
|
||||
/**
|
||||
* Plugin implementation of the 'searchable_entity_formatter' formatter.
|
||||
*
|
||||
* @FieldFormatter(
|
||||
* id = "searchable_entity_formatter",
|
||||
* label = @Translation("Searchable entity formatter"),
|
||||
* field_types = {
|
||||
* "entity_reference"
|
||||
* }
|
||||
* )
|
||||
*/
|
||||
class SearchableEntityFormatter extends EntityReferenceLabelFormatter {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public static function defaultSettings() {
|
||||
return [
|
||||
'search_link' => 'search?f[0]',
|
||||
'search_var' => 'all_subjects',
|
||||
'search_term' => FALSE,
|
||||
] + parent::defaultSettings();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function settingsForm(array $form, FormStateInterface $form_state) {
|
||||
$elements['search_link'] = [
|
||||
'#title' => t('Search base path'),
|
||||
'#type' => 'textfield',
|
||||
'#required' => TRUE,
|
||||
'#default_value' => $this->getSetting('search_link'),
|
||||
];
|
||||
$elements['search_var'] = [
|
||||
'#title' => t('Search variable'),
|
||||
'#type' => 'textfield',
|
||||
'#required' => TRUE,
|
||||
'#default_value' => $this->getSetting('search_var'),
|
||||
];
|
||||
$elements['search_term'] = [
|
||||
'#title' => t('Use label as search term'),
|
||||
'#type' => 'checkbox',
|
||||
'#default_value' => $this->getSetting('search_term'),
|
||||
];
|
||||
return $elements;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function settingsSummary() {
|
||||
$summary = [];
|
||||
$summary[] = t('Search path: @search_link', ['@search_link' => $this->getSetting('search_link')]);
|
||||
$summary[] = t('Variable: @search_var', ['@search_var' => $this->getSetting('search_var')]);
|
||||
$summary[] = $this->getSetting('search_term') ? t('Use label as search term') : t('Use ID as search term');
|
||||
return $summary;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function viewElements(FieldItemListInterface $items, $langcode) {
|
||||
$par_elements = parent::viewElements($items, $langcode);
|
||||
foreach ($this->getEntitiesToView($items, $langcode) as $delta => $entity) {
|
||||
$search_var = $this->getSetting('search_var');
|
||||
$search_term = $this->getSetting('search_term');
|
||||
|
||||
if ($search_term == TRUE) {
|
||||
$param = $par_elements[$delta]['#title'];
|
||||
}
|
||||
else {
|
||||
$param = $entity->id();
|
||||
}
|
||||
|
||||
$url = \Drupal::service('facets.utility.url_generator')->getUrl([$search_var => [$param]]);
|
||||
|
||||
$par_elements[$delta]['#url'] = $url;
|
||||
|
||||
}
|
||||
return $par_elements;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function checkAccess(EntityInterface $entity) {
|
||||
return $entity->access('view label', NULL, TRUE);
|
||||
}
|
||||
|
||||
}
|
||||
42
src/Plugin/facets_summary/processor/ResetRemovePage.php
Normal file
42
src/Plugin/facets_summary/processor/ResetRemovePage.php
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\facets_summary\processor;
|
||||
|
||||
use Drupal\facets_summary\FacetsSummaryInterface;
|
||||
use Drupal\facets_summary\Processor\BuildProcessorInterface;
|
||||
|
||||
/**
|
||||
* Reset should also remove the page query attribute.
|
||||
*
|
||||
* @SummaryProcessor(
|
||||
* id = "reset_remove_page",
|
||||
* label = @Translation("Remove page from query when resetting facets/query."),
|
||||
* description = @Translation("Remove page from query when resetting facets/query."),
|
||||
* stages = {
|
||||
* "build" = 45
|
||||
* }
|
||||
* )
|
||||
*/
|
||||
class ResetRemovePage extends ShowSearchQueryProcessor implements BuildProcessorInterface {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function build(FacetsSummaryInterface $facets_summary, array $build, array $facets) {
|
||||
// This processor is weighted to occur after the reset facets link.
|
||||
// Which leaves two cases:
|
||||
// - No facets selected so no reset link (we must add one).
|
||||
// - Reset link exists at the top of the list (we must remove the
|
||||
// search term from the link as well).
|
||||
$reset_index = $this->getResetLinkIndex($build);
|
||||
if ($reset_index !== NULL) {
|
||||
$reset = &$build['#items'][$reset_index];
|
||||
// Remove query from reset url as well.
|
||||
$query_params = $reset['#url']->getOption('query');
|
||||
unset($query_params['page']);
|
||||
$reset['#url']->setOption('query', $query_params);
|
||||
}
|
||||
return $build;
|
||||
}
|
||||
|
||||
}
|
||||
89
src/Plugin/facets_summary/processor/ShowActiveFacets.php
Normal file
89
src/Plugin/facets_summary/processor/ShowActiveFacets.php
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\facets_summary\processor;
|
||||
|
||||
use Drupal\Core\Link;
|
||||
use Drupal\facets_summary\FacetsSummaryInterface;
|
||||
use Drupal\facets_summary\Processor\BuildProcessorInterface;
|
||||
use Drupal\facets_summary\Processor\ProcessorPluginBase;
|
||||
use Drupal\facets\FacetInterface;
|
||||
use Drupal\facets\Result\ResultInterface;
|
||||
|
||||
/**
|
||||
* Provides a processor that shows the search query.
|
||||
*
|
||||
* @SummaryProcessor(
|
||||
* id = "show_active_facets",
|
||||
* label = @Translation("Shows active hidden facets."),
|
||||
* description = @Translation("When checked, undoes 'hide_active_items_processor', etc."),
|
||||
* stages = {
|
||||
* "build" = 20
|
||||
* }
|
||||
* )
|
||||
*/
|
||||
class ShowActiveFacets extends ProcessorPluginBase implements BuildProcessorInterface {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function build(FacetsSummaryInterface $facets_summary, array $build, array $facets) {
|
||||
// Rebuild list of results, add back ones that have been removed.
|
||||
$facet_manager = \Drupal::service('facets.manager');
|
||||
$facet_source_id = $facets_summary->getFacetSourceId();
|
||||
$facet_manager->updateResults($facet_source_id);
|
||||
$facet_manager->processFacets($facet_source_id);
|
||||
$facets_config = $facets_summary->getFacets();
|
||||
foreach ($facets as $facet) {
|
||||
$processors = $facet->getProcessors();
|
||||
/** @var \Drupal\facets\Processor\BuildProcessorInterface $url_handler */
|
||||
$url_handler = $processors['url_processor_handler'];
|
||||
$results = $url_handler->build($facet, $facet->getResults());
|
||||
foreach ($results as $result) {
|
||||
if ($result->isActive() && $this->resultMissing($facet, $result, $build['#items'])) {
|
||||
$item = [
|
||||
'#theme' => 'facets_result_item__summary',
|
||||
'#value' => $result->getDisplayValue(),
|
||||
'#show_count' => $facets_config[$facet->id()]['show_count'],
|
||||
'#count' => $result->getCount(),
|
||||
'#is_active' => TRUE,
|
||||
'#facet' => $result->getFacet(),
|
||||
'#raw_value' => $result->getRawValue(),
|
||||
];
|
||||
$item = (new Link($item, $result->getUrl()))->toRenderable();
|
||||
$item['#wrapper_attributes'] = [
|
||||
'class' => [
|
||||
'facet-summary-item--facet',
|
||||
],
|
||||
];
|
||||
$build['#items'][] = $item;
|
||||
}
|
||||
}
|
||||
}
|
||||
return $build;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the results are missing for the given facet.
|
||||
*
|
||||
* @param \Drupal\facets\FacetInterface $facet
|
||||
* The facet to check.
|
||||
* @param \Drupal\facets\Result\ResultInterface $result
|
||||
* The result of the facet to check.
|
||||
* @param array $items
|
||||
* The already completed render array of facets to check against.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the result is missing FALSE otherwise.
|
||||
*/
|
||||
protected function resultMissing(FacetInterface $facet, ResultInterface $result, array $items) {
|
||||
foreach ($items as $item) {
|
||||
$item_facet = $item['#title']['#facet'];
|
||||
$raw_value = $item['#title']['#raw_value'];
|
||||
if ($item_facet === $facet && $raw_value === $result->getRawValue()) {
|
||||
return FALSE;
|
||||
}
|
||||
}
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
}
|
||||
67
src/Plugin/facets_summary/processor/ShowFacetsTrait.php
Normal file
67
src/Plugin/facets_summary/processor/ShowFacetsTrait.php
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\facets_summary\processor;
|
||||
|
||||
use Drupal\Core\Link;
|
||||
use Drupal\Core\Url;
|
||||
use Drupal\facets\FacetInterface;
|
||||
|
||||
/**
|
||||
* Common logic to toggle the display of facets given a condition.
|
||||
*/
|
||||
trait ShowFacetsTrait {
|
||||
|
||||
/**
|
||||
* Checks if the facet should be shown or not.
|
||||
*/
|
||||
abstract protected function condition(FacetInterface $facet);
|
||||
|
||||
/**
|
||||
* Classes to include on the shown facet.
|
||||
*/
|
||||
abstract protected function classes();
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function buildHelper(array $build, array $facets) {
|
||||
$request = \Drupal::request();
|
||||
$query_params = $request->query->all();
|
||||
foreach ($facets as $facet) {
|
||||
if ($this->condition($facet)) {
|
||||
$url_alias = $facet->getUrlAlias();
|
||||
$filter_key = $facet->getFacetSourceConfig()->getFilterKey() ?: 'f';
|
||||
$active_items = $facet->getActiveItems();
|
||||
foreach ($active_items as $active_item) {
|
||||
$url = Url::createFromRequest($request);
|
||||
$modified_query_params = $query_params;
|
||||
$modified_query_params[$filter_key] = array_filter($query_params[$filter_key], function ($query_param) use ($url_alias, $active_item) {
|
||||
$pos = strpos($query_param, ':');
|
||||
$alias = substr($query_param, 0, $pos);
|
||||
$value = substr($query_param, $pos + 1);
|
||||
return !($alias == $url_alias && $value == $active_item);
|
||||
});
|
||||
$url->setOption('query', $modified_query_params);
|
||||
$item = [
|
||||
'#theme' => 'facets_result_item__summary',
|
||||
'#value' => $active_item,
|
||||
// We do not have counts for excluded/missing facets...
|
||||
'#show_count' => FALSE,
|
||||
// Do not know the count.
|
||||
'#count' => 0,
|
||||
'#is_active' => TRUE,
|
||||
'#facet' => $facet,
|
||||
'#raw_value' => $active_item,
|
||||
];
|
||||
$item = (new Link($item, $url))->toRenderable();
|
||||
$item['#wrapper_attributes'] = [
|
||||
'class' => $this->classes(),
|
||||
];
|
||||
$build['#items'][] = $item;
|
||||
}
|
||||
}
|
||||
}
|
||||
return $build;
|
||||
}
|
||||
|
||||
}
|
||||
47
src/Plugin/facets_summary/processor/ShowMissingFacets.php
Normal file
47
src/Plugin/facets_summary/processor/ShowMissingFacets.php
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\facets_summary\processor;
|
||||
|
||||
use Drupal\facets_summary\FacetsSummaryInterface;
|
||||
use Drupal\facets_summary\Processor\BuildProcessorInterface;
|
||||
use Drupal\facets_summary\Processor\ProcessorPluginBase;
|
||||
use Drupal\facets\FacetInterface;
|
||||
|
||||
/**
|
||||
* Provides a processor that shows the search query.
|
||||
*
|
||||
* @SummaryProcessor(
|
||||
* id = "show_missing_facets",
|
||||
* label = @Translation("Shows facets from the url that are missing from the results."),
|
||||
* description = @Translation("When checked, show facets not included in the solr result but specified in the URL."),
|
||||
* stages = {
|
||||
* "build" = 20
|
||||
* }
|
||||
* )
|
||||
*/
|
||||
class ShowMissingFacets extends ProcessorPluginBase implements BuildProcessorInterface {
|
||||
|
||||
use ShowFacetsTrait;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function condition(FacetInterface $facet) {
|
||||
return !$facet->getExclude() && empty($facet->getResults());
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function classes() {
|
||||
return ['facet-summary-item--facet'];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function build(FacetsSummaryInterface $facets_summary, array $build, array $facets) {
|
||||
return $this->buildHelper($build, $facets);
|
||||
}
|
||||
|
||||
}
|
||||
101
src/Plugin/facets_summary/processor/ShowSearchQueryProcessor.php
Normal file
101
src/Plugin/facets_summary/processor/ShowSearchQueryProcessor.php
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search\Plugin\facets_summary\processor;
|
||||
|
||||
use Drupal\Core\Link;
|
||||
use Drupal\Core\Url;
|
||||
use Drupal\facets_summary\FacetsSummaryInterface;
|
||||
use Drupal\facets_summary\Processor\BuildProcessorInterface;
|
||||
use Drupal\facets_summary\Processor\ProcessorPluginBase;
|
||||
|
||||
/**
|
||||
* Provides a processor that shows the search query.
|
||||
*
|
||||
* @SummaryProcessor(
|
||||
* id = "show_search_query",
|
||||
* label = @Translation("Show the current search query"),
|
||||
* description = @Translation("When checked, this facet will show the search query."),
|
||||
* stages = {
|
||||
* "build" = 40
|
||||
* }
|
||||
* )
|
||||
*/
|
||||
class ShowSearchQueryProcessor extends ProcessorPluginBase implements BuildProcessorInterface {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function build(FacetsSummaryInterface $facets_summary, array $build, array $facets) {
|
||||
$request = \Drupal::request();
|
||||
$query_params = $request->query->all();
|
||||
if (!empty($query_params['search_api_fulltext'])) {
|
||||
$text = $query_params['search_api_fulltext'];
|
||||
unset($query_params['search_api_fulltext']);
|
||||
$url = Url::createFromRequest($request);
|
||||
$url->setOption('query', $query_params);
|
||||
$item = [
|
||||
'#theme' => 'facets_result_item__summary',
|
||||
'#is_active' => FALSE,
|
||||
'#value' => $text,
|
||||
'#show_count' => FALSE,
|
||||
];
|
||||
$item = Link::fromTextAndUrl($item, $url)->toRenderable();
|
||||
$item['#wrapper_attributes'] = [
|
||||
'class' => [
|
||||
'facet-summary-item--query',
|
||||
],
|
||||
];
|
||||
// This processor is weighted to occur after the reset facets link.
|
||||
// Which leaves two cases:
|
||||
// - No facets selected so no reset link (we must add one).
|
||||
// - Reset link exists at the top of the list (we must remove the search
|
||||
// term from the link as well).
|
||||
$reset_index = $this->getResetLinkIndex($build);
|
||||
if ($reset_index !== NULL) {
|
||||
$reset = $build['#items'][$reset_index];
|
||||
// Remove query from reset url as well.
|
||||
$query_params = $reset['#url']->getOption('query');
|
||||
unset($query_params['search_api_fulltext']);
|
||||
$reset['#url']->setOption('query', $query_params);
|
||||
array_splice($build['#items'], $reset_index + 1, 0, [$item]);
|
||||
}
|
||||
else {
|
||||
array_unshift($build['#items'], $item);
|
||||
$text = $this->t('Reset');
|
||||
if (isset($facets_summary->getProcessorConfigs()['reset_facets']['settings']['link_text'])) {
|
||||
$text = $facets_summary->getProcessorConfigs()['reset_facets']['settings']['link_text'];
|
||||
}
|
||||
$reset = Link::fromTextAndUrl($text, $url)->toRenderable();
|
||||
$reset['#wrapper_attributes'] = [
|
||||
'class' => [
|
||||
'facet-summary-item--clear',
|
||||
],
|
||||
];
|
||||
array_unshift($build['#items'], $reset);
|
||||
}
|
||||
return $build;
|
||||
}
|
||||
return $build;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the index in the $build render array of the reset link.
|
||||
*
|
||||
* @param array $build
|
||||
* The render array of the FacetSummary block.
|
||||
*
|
||||
* @return mixed|null
|
||||
* The index of the reset link the $build render array.
|
||||
*/
|
||||
protected function getResetLinkIndex(array $build) {
|
||||
if (isset($build['#items'])) {
|
||||
foreach ($build['#items'] as $index => $item) {
|
||||
if (isset($item['#wrapper_attributes']['class']) && in_array('facet-summary-item--clear', $item['#wrapper_attributes']['class'])) {
|
||||
return $index;
|
||||
}
|
||||
}
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
}
|
||||
63
src/Utilities.php
Normal file
63
src/Utilities.php
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\advanced_search;
|
||||
|
||||
use Drupal\advanced_search\Plugin\Block\AdvancedSearchBlock;
|
||||
use Drupal\advanced_search\Plugin\Block\SearchResultsPagerBlock;
|
||||
|
||||
/**
|
||||
* Helper functions.
|
||||
*/
|
||||
class Utilities {
|
||||
|
||||
/**
|
||||
* Gets the list of views for which pager blocks have been created.
|
||||
*
|
||||
* @return array
|
||||
* List of view and display ids which have that have been used to
|
||||
* derive a SearchResultsPagerBlock.
|
||||
*/
|
||||
public static function getPagerViewDisplays() {
|
||||
$views = &drupal_static(__FUNCTION__);
|
||||
if (!isset($views)) {
|
||||
$block_storage = \Drupal::entityTypeManager()->getStorage('block');
|
||||
$active_theme = \Drupal::theme()->getActiveTheme();
|
||||
$views = [];
|
||||
/** @var \Drupal\block\Entity\Block $block */
|
||||
foreach ($block_storage->loadByProperties(['theme' => $active_theme->getName()]) as $block) {
|
||||
$plugin = $block->getPlugin();
|
||||
if ($plugin instanceof SearchResultsPagerBlock) {
|
||||
[$view_id, $display_id] = $plugin->getViewAndDisplayIdentifiers();
|
||||
$views[$block->id()] = [$view_id, $display_id];
|
||||
}
|
||||
}
|
||||
}
|
||||
return $views;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the list of views for which advanced search blocks have been created.
|
||||
*
|
||||
* @return array
|
||||
* List of view and display ids which have that have been used to
|
||||
* derive a SearchResultsPagerBlock.
|
||||
*/
|
||||
public static function getAdvancedSearchViewDisplays() {
|
||||
$views = &drupal_static(__FUNCTION__);
|
||||
if (!isset($views)) {
|
||||
$block_storage = \Drupal::entityTypeManager()->getStorage('block');
|
||||
$active_theme = \Drupal::theme()->getActiveTheme();
|
||||
$views = [];
|
||||
/** @var \Drupal\block\Entity\Block $block */
|
||||
foreach ($block_storage->loadByProperties(['theme' => $active_theme->getName()]) as $block) {
|
||||
$plugin = $block->getPlugin();
|
||||
if ($plugin instanceof AdvancedSearchBlock) {
|
||||
[$view_id, $display_id] = $plugin->getViewAndDisplayIdentifiers();
|
||||
$views[$block->id()] = [$view_id, $display_id];
|
||||
}
|
||||
}
|
||||
}
|
||||
return $views;
|
||||
}
|
||||
|
||||
}
|
||||
20
templates/facets/facets-result-item--summary.html.twig
Normal file
20
templates/facets/facets-result-item--summary.html.twig
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
{#
|
||||
/**
|
||||
* @file
|
||||
* Default theme implementation of a facet result item.
|
||||
*
|
||||
* Available variables:
|
||||
* - value: The item value.
|
||||
* - raw_value: The raw item value.
|
||||
* - show_count: If this facet provides count.
|
||||
* - count: The amount of results.
|
||||
* - is_active: The item is active.
|
||||
* - facet: The facet for this result item.
|
||||
* - id: the machine name for the facet.
|
||||
* - label: The facet label.
|
||||
*
|
||||
* @ingroup themeable
|
||||
*/
|
||||
#}
|
||||
<span class="facet-item__value">{{ value }}</span>
|
||||
<span class="fa fa-remove"></span>
|
||||
Loading…
Add table
Add a link
Reference in a new issue