NGSTACK-570 add interfaces, modify typehints

[leohajder]

Add interfaces and modify typehints to enable easy service injection. Typehint to interfaces instead of classes.

[emodric]

Adding interfaces for the sake of adding interfaces seems counterproductive to me. It only complicates reading the code.

We do not expect ever having a different InformationCollected class. When and if we do, then we can add an interface, not before.

As for FactoryInterface, adding an empty interface also does not make sense. Interfaces are supposed to define what a class does, or rather, what features it supports. An empty interface tells us nothing.

Btw, how does adding interfaces enable easy service injection? :)

[leohajder]

Ok, sure. Do you have any input on how to solve these and similar errors:

Class Netgen\Bundle\InformationCollectionAkismetIntegrationBundle\InformationCollection\Action\EmailAction requires \Netgen\Bundle\InformationCollectionBundle\Factory\EmailDataFactory, Netgen\Bundle\InformationCollectionAkismetIntegrationBundle\InformationCollection\Factory\EmailDataFactory given

when trying to override NetgenInformationCollectionBundle services in another custom bundle (NetgenInformationCollectionAkismetIntegrationBundle in this case)?

Also, NetgenInformationCollectionBundle already has empty interfaces for typehinting purposes.

[leohajder]

In another project, there are custom infocollector actions, and some are created just to substitute the action data factory. So that results in having to copy and paste the whole action code just to change the typehint on the data factory class, and change the config to use the custom action, etc. Wouldn't it be cleaner if you could just override the data factory service and be done with it? So, having interfaces enables easier service injection, or override I should have said.

[leohajder]

And finally, yes we do expect to have DelayedInformationCollected class in NetgenInformationCollectionAkismetIntegrationBundle. Maybe I should have started with that.

I've integrated the Akismet anti-spam API into infocollector, needed for several projects:

• override the infocollector controller to make a request to Akismet
• if Akismet says a submission is clean, everything resumes as expected
• otherwise, the submission is saved to collected information and other actions are stopped
• you get a button 'Mark as safe' or 'Mark as spam' in collected information administration
• this feeds Akismet's learning algorithm
• if you mark a submission as safe (which has previously been marked as spam) all action flows should be recreated, dispatched and executed (except the database action, because we do not wand duplicate entries)

So I've created NetgenInformationCollectionAkismetIntegrationBundle which overrides the necessary sevices and introcuces the DeleyedInformationCollected event, which is dispatched on marking a submission as safe.

Maybe this makes things clearer.

[emodric]

Let me get back to you on this tomorrow 🙂

[emodric]

Thanks @leohajder !