PHPackages acdh-oeaw/aksearch-ext - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. acdh-oeaw/aksearch-ext ActiveLibrary[API Development](/categories/api) acdh-oeaw/aksearch-ext ====================== A sample extension module for VuFind/AkSearch 2.7.4(2mo ago)0698MITPHPPHP >=7 Since Feb 4Pushed 2mo ago5 watchersCompare [ Source](https://github.com/acdh-oeaw/AkSearchExtend)[ Packagist](https://packagist.org/packages/acdh-oeaw/aksearch-ext)[ Docs](https://github.com/acdh-oeaw/AkSearchExtend)[ RSS](/packages/acdh-oeaw-aksearch-ext/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (1)Versions (92)Used By (0) AkSearchExtend ============== [](#aksearchextend) Extensions of the VuFind/AkSearch for the [ACDH deployment of AkSearch](https://github.com/acdh-oeaw/AkSearchWeb). Can also serve as an example of extending VuFind with your own module being loaded using Composer (see intstructions below). What is being added by this module ---------------------------------- [](#what-is-being-added-by-this-module) - Tuned version of the SolrMarc class (`aksearchExt\SolrMarc`) - Tuned version of the ILS driver class (`aksearchExt\Alma`) - Additional record view tab (`aksearchExt\RecordTab\Exemplarspezifika`) - Tuned version of the `VuFindSearch\Backend\Solr\LuceneSyntaxHelper` class resolving the [search with slash](https://redmine.acdh.oeaw.ac.at/issues/20174) issue. - As it can't be easily overriden with a new code, it is copied to `{FuVindDir}/module/VuFindSearch/src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php`by the [Dockerfile](https://github.com/acdh-oeaw/AkSearchWeb/blob/main/Dockerfile) creating the deployment docker image (which is admitedly very ugly but avoids overriding of the whole VuFind/AkSearch Solr search backend classes stack). - Tuned version of the `VuFind\Service\HttpServiceFactory` which is capable of initializing no proxy hosts regex. The detailed description of particular features is included in the `docs` folder. How does it work? ----------------- [](#how-does-it-work) Remark - description below applies to the current AkSearch which is based on VuFind 6. Some stuff will change with Vufind >= 7 which migrated from Zend2 to Laminas. ### Making the code loadable by Zend2 [](#making-the-code-loadable-by-zend2) VuFind/AkSearch are written using Zend2 framework and extending/adjusting them goes down to implementation of you own Zend2 module(s). To get your code recognized and properly loaded by a Zend2 you must: - Choose your module name (here it's `aksearchExt`). - Implement a `{my module name}\Module` class implementing `getAutoloaderConfig()` and `getConfig()` methods. - The `getAutoloaderConfig()` should just return an empty array (as composer will deal with autoloading for us and we don't need Zend2 for that). - The `getConfig()` class should return a Zend2/VuFind module configuration (an empty one is perfectly valid for starters). - The minimal implementation of the `aksearchExt` module (making it Zend2-loadable but nothing more than that) would look as follows: ``` class aksearchExt\Module { public function getAutoloaderConfig() { return []; } public function getConfig() { return []; } } ``` - Create a `composer.json` for your module so you can publish it as a composer package. Don't forget to define autoloading properly. If you need an example, just look at the `composer.json` in this repo root (it publishes this module as a `acdh-oeaw/aksearch-ext` composer package). - Publish your code as a composer package (put it into a publicly reachable git repo and then publish on ). ### Setting up VuFind/AkSearch to actually load your code [](#setting-up-vufindaksearch-to-actually-load-your-code) This is done by adjusting the [AkSearchWeb](https://github.com/acdh-oeaw/AkSearchWeb) repository content. - If you didn't to it so far, clone the repository. - Add your composer package to the list of composer dependencies either by running `composer require your-organization/your-composer-package-name` in the repository's root directory or adding your package name to the `require` section of the `composer.json` manually. - Include your Zend2 module name in the list of modules being loaded by the VuFind/AkSearch. - Append your module's name (namespace) at the end of the `VUFIND_LOCAL_MODULES` environment variable defined in the last line of the `Dockerfile` in the repository root directory. - Append your module's name (namespace) at the end of the `VUFIND_LOCAL_MODULES` environment variable in the `docker-compose.yaml` in the repository root directory (so people deploying with just `docker-compose up` have it as well). - Try to build the image locally by running `docker build -t acdhch/aksearch-web .` in the repository root directory and then try to deploy with `docker-composer up`. Finally check if everything stil works by opening in your browser. - If everything's fine, commit changes and push the repository to the GitHub. Congratulations! Now your module is deployed along with the [AkSearchWeb](https://github.com/acdh-oeaw/AkSearchWeb)and will be used (or not) depending on the `VUFIND_LOCAL_MODULES` runtime environment variable value (precisely if its name is included in the env var value). ### Overriding actual VuFind/AkSearch code [](#overriding-actual-vufindaksearch-code) The most tricky part is to find out the right place to plug in your own adjustment. The good thing is it's all done by adjusting what your module's `Module::getConfig()` method returns (denoted below as `$cfg`). The difficult part is you can plug your code in hundreds of places. See e.g. all class mappings provided in [VuFind's main module config](https://biapps.arbeiterkammer.at/gitlab/open/aksearch/aksearch/blob/aksearch/module/VuFind/config/module.config.php) or overrides defined by [AkSearch's AkSearch module config](https://gitlab.com/acdh-oeaw/oeaw-resources/module-core/-/blob/master/config/module.config.php). **Be aware** that despite providing a class alias you may also need to define factories and/or delegators for your class - see just mentioned examples and the `src/aksearchExt/Module.php` file in this repository. Live development ---------------- [](#live-development) To be able to live test your module: - Include it into the AkSearchWeb deployment as described in the *How does it work?* section above. - Run the aksearch-web container with: - Your module's code mounted under `/usr/local/vufind/vendor/{your-organization}/{your-composer-package-name}`. - `APPLICATION_ENV` set to `development` (which would turn off Zend2 classmap caching and save you a lot of headache). ### Health Score 49 — FairBetter than 95% of packages Maintenance86 Actively maintained with recent releases Popularity15 Limited adoption so far Community12 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 53.4% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~20 days Recently: every ~65 days Total 90 Last Release 69d ago Major Versions 0.2.0 → 1.0.02021-10-12 1.11.4 → 2.0.02022-04-22 ### Community Maintainers ![](https://www.gravatar.com/avatar/f1f662e3acb95efd9208cdcd2c97437db366044aea705985251760efcbd23070?d=identicon)[zozlak](/maintainers/zozlak) --- Top Contributors [![zozlak](https://avatars.githubusercontent.com/u/6503177?v=4)](https://github.com/zozlak "zozlak (79 commits)")[![nczirjak-acdh](https://avatars.githubusercontent.com/u/20183307?v=4)](https://github.com/nczirjak-acdh "nczirjak-acdh (61 commits)")[![ctot-nondef](https://avatars.githubusercontent.com/u/13985903?v=4)](https://github.com/ctot-nondef "ctot-nondef (8 commits)") ### Code Quality Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/acdh-oeaw-aksearch-ext/health.svg) ``` [![Health](https://phpackages.com/badges/acdh-oeaw-aksearch-ext/health.svg)](https://phpackages.com/packages/acdh-oeaw-aksearch-ext) ``` ### Alternatives [stripe/stripe-php Stripe PHP Library 4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax Google API Core for PHP 263103.1M454](/packages/google-gax) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)