deblan/FOSElasticaBundle
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

tweaked the callback handling

Browse source
This commit is contained in:
Lukas Kahwe Smith 2013-04-22 20:02:12 +02:00
parent 8a9a9686ba
commit 800e38f8aa
4 changed files with 43 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
DependencyInjection/Configuration.php
View file

@ -37,7 +37,7 @@ class Configuration implements ConfigurationInterface
->arrayNode('serializer')
->treatNullLike(array())
->children()
->scalarNode('callback')->defaultValue('fos_elastica.serializer.callback.class')->end()
->scalarNode('callback_class')->defaultValue('FOS\ElasticaBundle\Serializer\Callback')->end()
->scalarNode('serializer')->defaultValue('serializer')->end()
->end()
->end()

17
DependencyInjection/FOSElasticaExtension.php
View file

@ -180,22 +180,21 @@ class FOSElasticaExtension extends Extension
$typeDef->setFactoryService($indexId);
$typeDef->setFactoryMethod('getType');
if ($serializerConfig) {
$callbackDef = new Definition($serializerConfig['callback_class']);
$callbackId = sprintf('%s.%s.serializer.callback', $indexId, $name);
$serializerDef = new Definition("%{$serializerConfig['callback']}%");
$serializerId = sprintf('%s.%s.serializer.callback', $indexId, $name);
$typeDef->addMethodCall('setSerializer', array(array(new Reference($serializerId), 'serialize')));
$serializerDef->addMethodCall('setSerializer', array(new Reference($serializerConfig['serializer'])));
$typeDef->addMethodCall('setSerializer', array(array(new Reference($callbackId), 'serialize')));
$callbackDef->addMethodCall('setSerializer', array(new Reference($serializerConfig['serializer'])));
if (isset($type['serializer']['groups'])) {
$serializerDef->addMethodCall('setGroups', array($type['serializer']['groups']));
$callbackDef->addMethodCall('setGroups', array($type['serializer']['groups']));
}
if (isset($type['serializer']['version'])) {
$serializerDef->addMethodCall('setVersion', array($type['serializer']['version']));
$callbackDef->addMethodCall('setVersion', array($type['serializer']['version']));
}
$container->setDefinition($serializerId, $serializerDef);
$container->setDefinition($callbackId, $callbackDef);
$typeDef->addMethodCall('setSerializer', array(array(new Reference($serializerId), 'serialize')));
$typeDef->addMethodCall('setSerializer', array(array(new Reference($callbackId), 'serialize')));
}
$container->setDefinition($typeId, $typeDef);
if (isset($type['_source'])) {

36
README.md
View file

@ -68,10 +68,12 @@ Elastica can handle objects instead of data arrays if a serializer callable is c
clients:
default: { host: localhost, port: 9200 }
serializer:
callback: callback
callback_class: callback_class
serializer: serializer
``callback`` is the name of a parameter defining a class having a public method serialize($object).
``callback_class`` is the name of a class having a public method serialize($object) and should
extends from ``FOS\ElasticaBundle\Serializer\Callback``.
``serializer`` is the service id for the actual serializer, e.g. ``serializer`` if you're using
JMSSerializerBundle. If this is configured you can use ``\Elastica\Type::addObject`` instead of
``\Elastica\Type::addDocument`` to add data to the index. The bundle provides a default implementation
@ -90,7 +92,7 @@ Most of the time, you will need only one.
clients:
default: { host: localhost, port: 9200 }
serializer:
callback: %classname%
callback_class: FOS\ElasticaBundle\Serializer\Callback
id: serializer
indexes:
website:
@ -123,7 +125,7 @@ Elasticsearch type is comparable to Doctrine entity repository.
clients:
default: { host: localhost, port: 9200 }
serializer:
callback: %classname%
callback_class: FOS\ElasticaBundle\Serializer\Callback
id: serializer
indexes:
website:
@ -147,7 +149,7 @@ per type.
clients:
default: { host: localhost, port: 9200 }
serializer:
callback: %classname%
callback_class: %classname%
id: serializer
indexes:
website:
@ -168,7 +170,7 @@ per type.
clients:
default: { host: localhost, port: 9200 }
serializer:
callback: %classname%
callback_class_class: FOS\ElasticaBundle\Serializer\Callback
id: serializer
indexes:
website:
@ -186,7 +188,7 @@ per type.
clients:
default: { host: localhost, port: 9200 }
serializer:
callback: %classname%
callback_class: FOS\ElasticaBundle\Serializer\Callback
id: serializer
indexes:
website:
@ -224,7 +226,7 @@ some configuration will let ElasticaBundle do it for us.
clients:
default: { host: localhost, port: 9200 }
serializer:
callback: %classname%
callback_class: FOS\ElasticaBundle\Serializer\Callback
id: serializer
indexes:
website:
@ -345,7 +347,7 @@ Declare that you want a Doctrine/Propel finder in your configuration:
clients:
default: { host: localhost, port: 9200 }
serializer:
callback: %classname%
callback_class: FOS\ElasticaBundle\Serializer\Callback
id: serializer
indexes:
website:
@ -575,28 +577,28 @@ You can also choose to only listen for some of the events:
If you use listeners to update your index, you may need to validate your
entities before you index them (e.g. only index "public" entities). Typically,
you'll want the listener to be consistent with the provider's query criteria.
This may be achieved by using the `is_indexable_callback` config parameter:
This may be achieved by using the `is_indexable_callback_class` config parameter:
persistence:
listener:
is_indexable_callback: "isPublic"
is_indexable_callback_class: "isPublic"
If `is_indexable_callback` is a string and the entity has a method with the
If `is_indexable_callback_class` is a string and the entity has a method with the
specified name, the listener will only index entities for which the method
returns `true`. Additionally, you may provide a service and method name pair:
persistence:
listener:
is_indexable_callback: [ "%custom_service_id%", "isIndexable" ]
is_indexable_callback_class: [ "%custom_service_id%", "isIndexable" ]
In this case, the callback will be the `isIndexable()` method on the specified
In this case, the callback_class will be the `isIndexable()` method on the specified
service and the object being considered for indexing will be passed as the only
argument. This allows you to do more complex validation (e.g. ACL checks).
As you might expect, new entities will only be indexed if the callback returns
As you might expect, new entities will only be indexed if the callback_class returns
`true`. Additionally, modified entities will be updated or removed from the
index depending on whether the callback returns `true` or `false`, respectively.
The delete listener disregards the callback.
index depending on whether the callback_class returns `true` or `false`, respectively.
The delete listener disregards the callback_class.
> **Propel** doesn't support this feature yet.

23
Serializer/Callback.php
View file

@ -16,16 +16,31 @@ class Callback
public function setSerializer($serializer)
{
$this->serializer = $serializer;
if (!method_exists($this->serializer, 'serialize')) {
throw new \RuntimeException('The serializer must have a "serialize" method.');
}
}
public function setGroups(array $groups)
{
$this->groups = $groups;
if ($this->groups) {
if (!$this->serializer instanceof SerializerInterface) {
throw new \RuntimeException('Setting serialization groups requires using "JMS\Serializer\Serializer".');
}
}
}
public function setVersion($version)
{
$this->version = $version;
if ($this->version) {
if (!$this->serializer instanceof SerializerInterface) {
throw new \RuntimeException('Setting serialization version requires using "JMS\Serializer\Serializer".');
}
}
}
public function serialize($object)
@ -33,18 +48,10 @@ class Callback
$context = $this->serializer instanceof SerializerInterface ? new SerializationContext() : array();
if ($this->groups) {
if (!$context) {
throw new \RuntimeException('Setting serialization groups requires using "JMS\Serializer\Serializer"');
}
$context->setGroups($this->groups);
}
if ($this->version) {
if (!$context) {
throw new \RuntimeException('Setting serialization version requires using "JMS\Serializer\Serializer"');
}
$context->setVersion($this->version);
}