Refactoring hook callback methods

[ghost]

Remove duplications on OJS/OPS metrics visualization. Rename variables to be more generic, instead of OJS specific terms (article).

Turn methods articleMainCallback and preprintMainCallback into publicationMainCallback.
Update variable 'article' to 'publication'.

[pablovp86]

I'm in doubt about the $_publicationNoun variable name.

It's used to decide between article or preprint, and me and @iudiz were inspired on the $submissionNoun variable from PdfJsViewerPlugin.

Any suggestion of a better name for this variable?

[asmecher]

The correct generic term for article is submission; publication is something entirely different -- a submission consists of several publications, and these reflect the different versions of the submission.

[pablovp86]

Thanks @asmecher.

What would be the most appropriate name for the attribute? $_submissionNoun or $_submissionType?

[asmecher]

Either is sensible to me!

[diegoabadan]

Alec,

Today we have these hooks:

Templates::Article::Main
Templates::Catalog::Book::Main
Templates::Preprint::Main

It would be interesting to have an alternative to simplify the plugins that use these mentioned, for example:
https://github.com/pkp/usageStats/blob/f2eaa334ba1719bd95bc43982ae6e3b0ad9c3c73/UsageStatsPlugin.inc.php#L162

and

paperbuzz/PaperbuzzPlugin.inc.php

Lines 45 to 47 in c6a9133

	HookRegistry::register('Templates::Article::Main', array($this, 'articleMainCallback'));
	// Add visualization to preprint view page
	HookRegistry::register('Templates::Preprint::Main', array(&$this, 'preprintMainCallback'));

Do you think of a good way to avoid these repetitions? For example, a generic hook that can be used instead of one per application?

If you find it interesting, we can send you a PR.

[pablovp86]

Either is sensible to me!

We did the commit, renaming the variable.

[asmecher]

Do you think of a good way to avoid these repetitions? For example, a generic hook that can be used instead of one per application?

Yes, this would be good to do -- a generic hook for all 3 applications -- but we haven't done that yet because if we just rename the hook it'll be painful for 3rd-party users of the existing hooks to discover why parts of their plugins suddenly stopped working.

One approach that could work would be to add a new application-independent hook and then mark the current hooks in the code as deprecated. We can document the deprecation in the Release Notebook. If you'd like to give that a crack, it would be welcome!