Revisions for whups/lib/api.php

Add phpdoc where missing for Whups API methods

Tags: WHUPS_1_0, WHUPS_1_0_RC2

Limit Robert's copyright to the years of his contributions. We should really find him.

Tags: WHUPS_1_0_RC1

Add form replies.

both branches here use the $queues variable

Try to get browse method into better shape. Still not working properly though,
but getting there.

Add per-queue permission to manually set the ticket requester.

Deal with queue vs. admin permissions more consistently.

Reverse order of versions, newest first.

Add addAttachment().

Reorder.

Rename API methods not following camelCase naming conventions.

[cjh] Use pretty URLs if Horde is configured for them (Request #5922).

Standardize on the same ctor signature for both ticket forms.

[cjh] Include attribute values in ticket emails, including "diffs" for changes
(Bug #1083).

This is already referenced as $GLOBALS['whups_driver'] in the code.
Remove redundant global statement.

Revert this "fix" that was actually an issue with PHP xmlrpc library.

Fix -whups_listQueues() to actually return the queueId along with the queue name

fix args

Add api method for adding new versions to an existing queue.

extra validation

Add an addComment API method.

stub of an addComment api method

This is my proposal for the listTimeObjects api -
listTimeObjectCategories methods to go along with the call that return
a list of keys and names; the keys that are wanted are then passed to
listTimeObjects.

This isn't actually implemented yet; most applications still need to
filter on $categories, and Kronolith needs to do something with the
data. But this should keep the API from changing after alpha releases.

don't use create_function

need timestamps to compare to

Fix variable name.

Fix signature, skip dates out of bounds.

Fix signatures.

- Return recurrence information with listTimeObjects results and calculate
recurrence in Kronolith
- Return datetime information with listTimeOjbects results as ISO strings
- Skip due dates outside requested time period in Nag

Rename $GLOBALS['whups'] references to $GLOBALS['whups_driver']

Rename $whups to $whups_driver

We don't pass a category to listTimeObjects() at the moment.

No need for a gettext here.

Include the basic ticket data as a tooltip.

Remove queue subjectlists.

[cjh] Always use Summary for the ticket summary.

Fix continue scope.

Fix invalid SOAP datatypes.
Bug: 4187
Submitted By: Ben Klang <ben@alkaloid.net>

label: [#] summary for calendar titles

- Add listTimeCategories, which isn't used yet.
- Add several different kinds of returns to listTimeObjects, defaulting to by
due date. When Kronolith can show these as individual calendars, the default
will be removed (and yes, the listTimeObjects API is changing for this).

I'd be happy to get some feedback on where to put the kind of listing (Due,
Created, etc) in the title or tooltip of the event.

this wasn't done yet, my bad.

[cjh] Show the requester in search results (rodion (at) nezna (dot) com,
Bug #2820).
[cjh] Show either the Comment or Update tabs depending on permissions,
but not both.
[cjh] Report the last-updated date for tickets (Bug #2396).
[cjh] Tickets now have an optional due date field.

remove admin_list from whups as well.

Add listTimeObjects handling to Kronolith and calls to Nag and Whups, with
the commented-out birthdays code moving to a comment in Turba's api.php for
turning into a listTimeObjects call. All relatively untested by me and not
much changed from Duck's patches. Support for old-style nag task listing is
all mine and also untested.

Move the admin forms to lib/Forms and the admin script to admin/; goal
is to break it into smaller scripts eventually.

[cjh] New updateTicket API call (Ben Klang <ben@alkaloid.net>, Bug #4101).

- use the useToken() method instead of setting private variables directly
(Ben Klang <ben@alkaloid.net>, Bug #4099).
- remove a few unnecessary references while I'm at it.

[cjh] Check permissions when setting ticket attributes through an API call
(Ben Klang <ben@alkaloid.net>, Bug #4098).

use the same ticket name that we do for titles in whups itself.

Add CAPTCHA support to the Add Comment and Create Ticket forms.

Add a show method for tickets.

Fix permission check.

Fix permission checks.
Bug: 2629, 2635

Fix listing versions for administrators.

Fix the getQueueDetails() api method for administrators.
Bug: 2527

Allow other applications to provide versions.

How was this ever supposed to work?

* If the user has a custom ticket attribute "Estimated Time", use it to return
hour estimates for ticket-based cost objects.

Add overloaded example.

Add listQueues API method and wrap Driver::getQueue and Driver::getQueues through the registry.

Drop getAllQueueInfo().

* Export tickets as cost objects so we can track time against them.

Fix signatures, and create better readable error messages.

More reference fixes.

A bunch of fixes for the add_tickets API method, and a new addTicket method for adding one ticket at a time.

Fix api signatures.

[cjh] Add explicit permissions for assigning and updating tickets
(tmerritt@email.arizona.edu, Bug #1955).

Fix a bunch of places where we were either unnecessarily calling
isValid() in addition to validate(), or where we weren't checking
validate() at all.

[cjh] Queries are stored as Horde_Share objects with full permissions.
(Bug #1481).
[cjh] Delete queue permissions when deleting a queue (Bug #1462).

Try to use the same format for attributes in whups_add_tickets and in whups_set_ticket_attributes (#1227)

Fix setAttributes() calls (#1227)

need to be able to set the whups:admin permission (Mathieu CLABAUT <mathieu.clabaut@free.fr>).

Shorter names

first lot being moved from gif to png

change getParam('graphics') to getImageDir()

Since it's currently not working anyway, I'm going to go ahead and
commit this removal of the clients code from Whups. This way we'll
have a clean slate going forward.

The object browser has a functional UI now. Still need to hook it up
to a selection method for actually returning what object was browsed
to.

avoid starting property names/sql aliases with '_' characters.

Bug: 595

Some of the Links removal. Lots of stuff to sort out here.

Use the smaller bug icon as a template for more Whups icons, including
an admin icon, all 16x16.

Ticket creation is now wrapped in lib/Ticket.php too. No ticket email
is sent inside the SQL driver anymore; all email notification will be
handled by Whups_Ticket::. At the moment, no email will be
sent. Adding emails back is the next step.

More progress, cleanup, slimming, and updates. This is getting closer
to finished, but still isn't really tested. Need to get it into CVS so
I can hack at it on other machines, though.

More work on re-organizing Whups and moving towards the new whups_logs
format. This still isn't complete, but I'm trying to get myself to
finish it so I'm getting it to another machine.

linkParameters() isn't needed.

Don't add comments in setAttributeValues(); comments were being added
that weren't related to any whups_log entries, so they were lost.

_whups_list_tickets() wasn't used anywhere outside of the summary block, so
make it a class method.

Block APIs are now exposed globally by the Horde API.
Some blocks probably have yet to be fixed because we don't include
lib/base.php anymore.

Blocks are no longer defined by the applications' api.php files or
registry.php. Instead we scan all application/lib/Block directories for blocks
once per session now.

use new stringArray type instead of 'array.' The argument types look sane,
but some of the return types aren't quite right yet, mostly the block API
calls, which return Horde_Block objects.

Add 2 new blocks for showing queries and searches. Lots of possibilities
for blocks here...

filterTicketsByClient() is no longer used

This *should* finish off the Module -> Queue conversion, including in
the SQL. Needs to be tested and ironed out before being ported to
dev.horde.org and marked done, though.

Advertise module permisisons and the hiddenComments permission in via the
perms api.

Use Queue instead of Module. Database fields have not been
touched. I've tested this, but it's also possible that some forms may
need to be tweaked to work, and that the UI may still say "module" in
some places.

* Delete Horde_Form_Vars::, use Variables:: instead.
* Delete Horde_Form_Renderer_rows::, was only used by Hermes and depends on
Horde_Form_Vars:: cruft.

* Remove Whups_Driver::getClients() and move back into Whups::.  This is not
driver-specific.

These are by no means private constants. Remove the weird leading _
(it was my idea in the first place, for the record. Dunno why).

Rework the Links driver to use categories instead of a custom sql table,
from Bo Daley <bo@tilda.com.au>

Big patch, some things may break/need to be tweaked. Here's Bo's description:

Attached is a first shot at reworking the Links API to use categories instead of
its own SQL driver. I haven't yet taken this as far as it can go, but already
it has resulted in a significant performance improvement for pages in my system
with large numbers of linked clients. (some of the pages that were previously
taking 20-30 seconds -- eg. the Whups search page -- are now down to about 5
seconds, which makes them a bit more usable).

Things that should be noted before this gets committed:

* I modified Turba so that the backend's read() function returns an array of
contact objects rather than just a single object (which speeds up handling of
large lists of objects). I don't know any ldap so this change will break the
ldap backend unless someone can make the same change to
turba/lib/Driver/ldap.php

* I've included a script (migrate_links.php) that creates links in the new
structure for people who were using clients in Whups. It doesn't update links
for other apps that might have been using Links but I can probably add that in
too if anyone needs it.

* reverse links don't seem to be working just yet. I'll get onto this soon.

more soon... hopefully i haven't missed anything else..(!!)

PHP 5 fixes.

Another chunk of Blocks work:

- move all parameter listing into block getParams() methods
- remove unused parameters from the _blocks() arrays
- make sure that all apps that have getParams() blocks have
a defineBlock() method.

Still need to move parameters for the Horde (applet) blocks, and
clean up registry.php.

- Block::isEditable() isn't used and isn't needed
- Make classnames consistent in all applications
- Make block instantiation consistent in most applications.

Move Whups completely over to using 'tickets' and providing that registry
api; have Thor provide the projects api instead.