Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ongr-io/routerbundle
Bundle for ONGR routing.
https://github.com/ongr-io/routerbundle
Last synced: about 1 month ago
JSON representation
Bundle for ONGR routing.
- Host: GitHub
- URL: https://github.com/ongr-io/routerbundle
- Owner: ongr-io
- License: mit
- Created: 2014-10-29T15:20:02.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-05-04T06:11:58.000Z (over 7 years ago)
- Last Synced: 2024-10-29T18:47:23.963Z (about 2 months ago)
- Language: PHP
- Size: 189 KB
- Stars: 6
- Watchers: 17
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ONGR Router Bundle
Router Bundle allows to define and match URLs for elasticsearch documents.
At url matching phase it additionaly searches for elasticsearch documents with specified url.
This can be used for generating/matching nice URLs for any document.
Beautiful URLs help SEO and improve user's usability experience.
If you have any questions, don't hesitate to ask them on [](https://gitter.im/ongr-io/support)
chat, or just come to say Hi ;).
[](https://travis-ci.org/ongr-io/RouterBundle)
[](https://coveralls.io/github/ongr-io/RouterBundle?branch=master)
[](https://packagist.org/packages/ongr/router-bundle)
[](https://scrutinizer-ci.com/g/ongr-io/RouterBundle/?branch=master)
## Documentation
The online documentation of the bundle is [here](Resources/doc/index.md)
For contribution rules take a look at [contribute](Resources/doc/contribute.md) topic.
## Setup the bundle
> This bundle strongly uses [ONGR Elasticsearch Bundle](https://github.com/ongr-io/ElasticsearchBundle).
> We assume that you are familiar with it and it already suits your needs.
#### Step 1: Install Router bundle
Router bundle is installed using [Composer](https://getcomposer.org).
```bash
composer require ongr/router-bundle "~1.0"
```
Enable Router and Elasticsearch bundles in your AppKernel:
```php
// app/AppKernel.php
public function registerBundles()
{
$bundles = [
// ...
new ONGR\ElasticsearchBundle\ONGRElasticsearchBundle(),
new ONGR\RouterBundle\ONGRRouterBundle(),
];
}
```
Yep, that's it, **1 step** installation. All the next steps are demonstration how to setup product document with SEO URLs. So look below how easy it is and adapt it for your needs.
#### Step 2: Add configuration
Add minimal configuration for Router and Elasticsearch bundles.
```yaml
# app/config/config.yml
ongr_elasticsearch:
analysis:
analyzer:
urlAnalyzer:
type: custom
tokenizer: keyword
filter: [lowercase]
connections:
default:
index_name: acme
managers:
default:
connection: default
mappings:
- AppBundle
ongr_router:
#disable_alias: true # defaults to false
#router_priority: 1000 # defaults to -100
manager: es.manager.default
seo_routes:
'AppBundle:Product': AppBundle:Product:document
# ...
```
> WARNING: If SeoAwareTrait is used you must implement `urlAnalyzer` analyzer, otherwise there will be a fatal error on index create.
In the configuration of the bundle you need to specify the `es.manager` to use and under the `seo_routes` you have to specify documents that will have seo_routes as keys and the controller action that will handle the request as a values.
`urlAnalyzer` at `ongr_elasticsearch` configuration defines how all url fields are analyzed by Elasticsearch.
If you are using another third party bundle that also has an aliased Symfony router, you may set `disable_alias` to `true`. This
prevents possible conflicts.
`router_priority` parameter defines the priority with which the `ONGR` dynamic router
is set to the chain router. It defaults to -100 in order to be called after the standard Symfony router
but this value can be changed depending on your projects' need.
Check [Elasticsearch bundle mappings docs](http://docs.ongr.io/ElasticsearchBundle/mapping) for more information about the configuration.
## Usage example
#### Step 1: Create a Product document
Lets create a `Product` document class. We assume that we have an AppBundle installed.
```php
// src/AppBundle/Document/Product.php
namespace AppBundle\Document;
use ONGR\ElasticsearchBundle\Annotation as ES;
use ONGR\RouterBundle\Document\SeoAwareTrait;
use ONGR\RouterBundle\Document\SeoAwareInterface;
/**
* @ES\Document()
*/
class Product implements SeoAwareInterface
{
use SeoAwareTrait; // <- Trait for URL's
/**
* @ES\Property(type="keyword")
*/
public $title;
// ...
}
```
In favor to support friendly URLs, the bundle provides `SeoAwareTrait` with predefined mapping.
#### Step 2: Create controller and action for the product page
```php
// src/AppBundle/Controller/ProductController.php
namespace AppBundle\Controller;
use AppBundle\Document\Product;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Response;
class ProductController extends Controller
{
public function documentAction(Product $document)
{
return new Response("Product: " . $document->title);
}
}
```
#### Step 3: Create index and insert demo product
Create an elasticsearch index by running this command in your terminal:
```bash
app/console ongr:es:index:create
```
> More info about all commands can be found in the [Elasticsearch bundle commands chapter](http://docs.ongr.io/ElasticsearchBundle/commands).
Also, run the following curl command in your terminal to insert a product for this demonstration.
```bash
curl -XPOST 'http://localhost:9200/acme/product?pretty=1' -d '{"title":"Acoustic Guitar", "url":"/music/electric-guitar"}'
```
#### Step 4: Check if it works
Just visit `/music/electric-guitar` page and you should see a title of the product that you inserted in **step 3**.
## License
This bundle is under the MIT license. Please, see the complete license
in the bundle [`LICENSE`](LICENSE) file.