Issue Details (XML | Word | Printable)

Key: MDL-13434
Type: Sub-task Sub-task
Status: Resolved Resolved
Resolution: Fixed
Priority: Major Major
Assignee: Mathieu Petit-Clair
Reporter: Mathieu Petit-Clair
Votes: 0
Watchers: 2
Operations

Add/Edit UI Mockup to this issue
If you were logged in you would be able to see more operations.
Moodle
MDL-13404

clean up the public api

Created: 12/Feb/08 07:33 PM   Updated: 18/Mar/08 05:41 PM
Return to search
Component/s: Tags
Affects Version/s: 1.9, 2.0
Fix Version/s: 1.9

File Attachments: 1. File taglib.php (3 kB)


Participants: Mathieu Petit-Clair
Security Level: None
Resolved date: 18/Mar/08
Affected Branches: MOODLE_19_STABLE, MOODLE_20_STABLE
Fixed Branches: MOODLE_19_STABLE


 Description  « Hide
The current API for tags isn't optimal. Some operations are done in tag/lib.php, some in blog/lib.php, some in blocks/... This aims to clean up the current API, makit it easier to expend the tags functions in moodle.

I'm sending a first file, containing only documentation and prototypes. I'm trying to come up with something that does the job, but is as minimal as possible.

Missing from this file are:
 * tag_selection_box(...): a function to display the "tag selection box", so that all forms display the same interface to the user (which is currently not the case: user interests and blog posts have different ways of getting tags)
 * tag_get_links(...): a function to return the tags along with the html links to them
 * ...?


 All   Comments   Change History   Version Control      Sort Order: Ascending order - Click to sort in descending order
Mathieu Petit-Clair added a comment - 13/Feb/08 04:34 PM
Petr, to answer your question (and if I understand correctly) - is the tag string case normalised? ... yes it is, I'll be re-using part of the same code as is already in cvs.

Though, while on the subject, I was thinking that it might eventually be an option not to normalize it and let users use whatever they want as tag.


Mathieu Petit-Clair added a comment - 18/Mar/08 05:41 PM
I'm closing this issue : the public API is now stable. It's possible that changes will be done to "private" functions. More specifically, any function receiving an "array $record" might change to "string $record_type, int $record_id", but there are only very few of them left, and they shouldn't be used outside of the tag library itself.