[MAGNOLIA-2872] Further improve/consolidate Link api Created: 22/Sep/09 Updated: 11/Feb/13 Resolved: 02/Nov/12 |
|
| Status: | Closed |
| Project: | Magnolia |
| Component/s: | core |
| Affects Version/s: | None |
| Fix Version/s: | 5.0 |
| Type: | Improvement | Priority: | Minor |
| Reporter: | Magnolia International | Assignee: | Ondrej Chytil |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||||||||||||||||||
| Template: |
|
||||||||||||||||||||||||||||||||||||
| Acceptance criteria: |
Empty
|
||||||||||||||||||||||||||||||||||||
| Task DoD: |
[ ]*
Doc/release notes changes? Comment present?
[ ]*
Downstream builds green?
[ ]*
Solution information and context easily available?
[ ]*
Tests
[ ]*
FixVersion filled and not yet released
[ ] 
Architecture Decision Record (ADR)
|
||||||||||||||||||||||||||||||||||||
| Description |
|
There are some places in the Link api that could be improved; the methods exposed by LinkFactory are inconsistent, for instance. (some of the methods take String parameters and fetch a node in the repository from that, others take a node - as a consequence, client code (or LinkFactory itself) gets messy - on some occasions, it has to use both methods, and exception handling gets messy, too. The fetching of nodes should be entirely handled by either LinkFactory itself - or the client code. There are other little quirks of the same sort that could use a little review/cleanup/rename - think testability and separation of concerns. Additionally, we should remove/review usage of deprecated classes (info.magnolia.cms.link.*) in our own code! Some context: info.magnolia.module.fckeditor.dialogs.FckEditorDialog#convertToView and its usage of info.magnolia.link.LinkUtil#convertLinksFromUUIDPattern - this is a usecase where you don't want the exceptions to bubble up. The input might have multiple links, and depending on the use case (editor, rendering, ...) one might want to render the "broken" links (i.e <a href="/fallbackHandle">my link</a>) or just the link description (my link, no surrounding <a>), or let an exception be thrown at the first broken link. (this is not something the api is currently target for, since LinkTransformer does not take html into account, and Link does not have a notion of it's content/description) Another similar case for improvements: info.magnolia.freemarker.models.NodeDataModelFactory - if we replace the call to LinkUtil.convertUUIDsToLinks() by LinkUtil.convertLinksFromUUIDPattern(), like the deprecation of the former suggests, we realize we have to handle the LinkException; how? Ideally, unconvertible links should be handled within LinkUtil (some exception handler interface) - in some cases, we'll want to get "some" of the text back: with uuid links in certain cases, or in a html-cleaned up way in some others (strip the complete <a> tag?) |