Download the PHP package locomotivemtl/charcoal-contrib-search without Composer
On this page you can find all versions of the php package locomotivemtl/charcoal-contrib-search. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download locomotivemtl/charcoal-contrib-search
More information about locomotivemtl/charcoal-contrib-search
Files in locomotivemtl/charcoal-contrib-search
Package charcoal-contrib-search
Short Description Charcoal search module.
License MIT
Homepage https://locomotivemtl.github.io/charcoal-contrib-search/
Informations about the package charcoal-contrib-search
Charcoal Search
A Charcoal service provider my cool feature.
Table of Contents
- Installation
- Dependencies
- Configuration
- Usage
- Development
- API Documentation
- Development Dependencies
- Coding Style
- Credits
- License
Installation
The preferred (and only supported) method is with Composer:
Dependencies
Required
- PHP 5.6+: PHP 7 is recommended.
- guzzlehttp/guzzle: 6 or 7
- charcoal-admin: >=0.14
- charcoal-contrib-sitemap: >=0.1.5
Configuration
In your project's config file, require the search module :
Usage
The module adds a search
route action using GET. You may access http://project-url.com/search?keyword=[keyword].
You won't get any results until you run the IndexContent Script.
Before running the script, you need to setup
Each object of the sitemap to index must include data.id
and data.objType
to be indexable:
Parameters
-u
(--url
) Website URL. Necessary as this is run in a cron script.-c
(--config
) Sitemap builder key (Defaults toxml
).-n
(--no_index_class
) Class to filter out content from the crawled pages. Defaults tophp-no_index
.-i
(--index_element_id
) ID of the element to be indexed in the crawled page. Defaults to entire page body.
Development
API Documentation
- The auto-generated
phpDocumentor
API documentation is available at:
https://locomotivemtl.github.io/charcoal-contrib-search/docs/master/ - The auto-generated
apigen
API documentation is available at:
https://codedoc.pub/locomotivemtl/charcoal-contrib-search/master/
Development Dependencies
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
Coding Style
The charcoal-contrib-search module follows the Charcoal coding-style:
- PSR-1
- PSR-2
- PSR-4, autoloading is therefore provided by Composer.
- phpDocumentor comments.
- .editorconfig for coding standards.
Coding style validation / enforcement can be performed with
composer phpcs
. An auto-fixer is also available withcomposer phpcbf
.
Credits
License
Charcoal is licensed under the MIT license. See LICENSE for details.
All versions of charcoal-contrib-search with dependencies
locomotivemtl/charcoal-contrib-sitemap Version >=0.2
guzzlehttp/guzzle Version ^6.0 || ^7.0