Download the PHP package helsingborg-stad/algolia-index without Composer
On this page you can find all versions of the php package helsingborg-stad/algolia-index. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download helsingborg-stad/algolia-index
More information about helsingborg-stad/algolia-index
Files in helsingborg-stad/algolia-index
Download helsingborg-stad/algolia-index
More information about helsingborg-stad/algolia-index
Files in helsingborg-stad/algolia-index
Vendor helsingborg-stad
Package algolia-index
Short Description Index wordpress site content to algolia.
License MIT
Package algolia-index
Short Description Index wordpress site content to algolia.
License MIT
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package algolia-index
Algolia Index
Manages algolia index (with ms-support and mixed indexes). This is intended to be used by delvelopers. This plugin provide the following set of features:
- Replaces algolia search on the front-end with algolia.
- Index all public searchable posts on post update or creation.
- WpCLI jobs to bulk index all posts on the site.
- Support mixed indices (multiple wordpress sites in the same index).
- Large record splitting (content field).
-
Implements "needs update" check before querying algolia, to save costly updates. The functionality is not implemented on split records.
Installation
- Install with: "composer require helsingborg-stad/algolia-index"
- Run composer install inside the plugin.
- Add required definitions of constants.
- Run wp-cli job "wp algolia-index build"
Constants
- define('ALGOLIAINDEX_APPLICATION_ID', 'ALGOLIAAPPID'); - REQUIRED
- define('ALGOLIAINDEX_API_KEY', 'ALGOLIAAPIKEY'); - REQUIRED
- define('ALGOLIAINDEX_INDEX_NAME', 'INDEX'); - OPTIONAL
- define('ALGOLIAINDEX_PUBLIC_API_KEY', 'INDEX'); - OPTIONAL, Required by js searchpage addon
Filters
- AlgoliaIndex/ShouldIndex: Add more rules to the should index function (removal not possible).
- AlgoliaIndex/Record: What data to send to algolia.
- AlgoliaIndex/Compare: What fields to compare to determine if a post has been updated.
- AlgoliaIndex/SearchableAttributes: What attriubutes in record to be searchable.
- AlgoliaIndex/GeneratedIndexName: Filter for the autogenerated index name.
- AlgoliaIndex/RecordToLarge: Turn off record to large repoting by returning false. To disable record splitting. Only compatbile with business plans, not reccommended!.
- AlgoliaIndex/IndexablePostTypes: What posttypes to index.
- AlgoliaIndex/HitsPerPage: Number of hits per page.
- AlgoliaIndex/AttributesToSnippet: What attributes to snippet.
- AlgoliaIndex/SnippetEllipsisText: Suffix for snippet.
- AlgoliaIndex/BackendSearchActive: Send false to disable backend search.
- AlgoliaIndex/IndexablePostStatuses: What post statuses to allow for index.
Actions
- AlgoliaIndex/IndexPostId: Trigger reindex on a post id.
- AlgoliaIndex/SendSettings: Send settings.
WP CLI
- wp algolia-index build: Index all pages/posts on site.
WP CLI Arguments
- To clear index* before build, add flag --clearindex=true.
- To send required search configuration before build, add flag --settings=true.
Example
wp site list --field=url --public=1 --archived=0 --deleted=0 --allow-root | xargs -n1 -I % wp algolia-index build --settings=true --url=% --allow-root
- This action is not fully compatible with multiple sites in one shared index! Sites that share the same index will be cleared but not reindexed.
All versions of algolia-index with dependencies
PHP Build Version
Package Version
Requires
algolia/algoliasearch-client-php Version
3.3
The package helsingborg-stad/algolia-index contains the following files
Loading the files please wait ....