PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of kiran  >  Kanboard Subtask Date  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Kanboard Subtask Date
Kanboard plugin to add due date to sub-tasks
Author: By
Last change:
Date: 9 months ago
Size: 3,546 bytes
 

Contents

Class file image Download

SubTask Due Date

  • Adds a new due date field for subtasks.
  • Adds Calendar Events for Subtasks to User and Project Calendars.
  • Adds API Procedures for subtask due date field, createSubtaskdd & updateSubtaskdd
  • Adds filter `subtask_due` - Chain-able, i.e. `subtask_due:today subtask:assignee:name` will filter for subtasks due `today`, assigned to `name`

Filter

Search by the due date

Attribute: subtask_due

  • Search tasks due today: ``subtask_due:today``
  • Search tasks due tomorrow: ``subtask_due:tomorrow``
  • Search tasks due yesterday: ``subtask_due:yesterday``
  • Search tasks due with the exact date: ``subtask_due:2015-06-29``
  • Search tasks without a due date: ``subtask_due:none``

The date must use the ISO 8601 format: YYYY-MM-DD.

All string formats supported by the `strtotime()` function are supported, for example `next Thursday,-2 days,+2 months`, `tomorrow`, etc.

Operators supported with a date:

  • Greater than: subtask_due:>2015-06-29
  • Lower than: subtask_due:<2015-06-29
  • Greater than or equal: subtask_due:>=2015-06-29
  • Lower than or equal: subtask_due:<=2015-06-29

API

createSubtaskdd

  • Purpose: Create a new subtask
  • Parameters:

    - task_id (integer, required) - title (integer, required) - user_id (int, optional) - time_estimated (int, optional) - time_spent (int, optional) - status (int, optional) - due_date (int, optional)

  • Result on success: subtask_id
  • Result on failure: false

Request example:

{
    "jsonrpc": "2.0",
    "method": "createSubtaskdd",
    "id": 2041554661,
    "params": {
        "task_id": 1,
        "title": "Subtask #1",
        "due_date": 1523998125
    }
}

Response example:

{
    "jsonrpc": "2.0",
    "id": 2041554661,
    "result": 45
}

updateSubtaskdd

  • Purpose: Update a subtask
  • Parameters:

    - id (integer, required) - task_id (integer, required) - title (integer, optional) - user_id (integer, optional) - time_estimated (integer, optional) - time_spent (integer, optional) - status (integer, optional) - due_date (int, optional)

  • Result on success: true
  • Result on failure: false

Request example:

.. code:: json

{
    "jsonrpc": "2.0",
    "method": "updateSubtaskdd",
    "id": 191749979,
    "params": {
        "id": 1,
        "task_id": 1,
        "status": 1,
        "time_spent": 5,
        "user_id": 1,
        "due_date": 1523998125
    }
}

Response example:

.. code:: json

{
    "jsonrpc": "2.0",
    "id": 191749979,
    "result": true
}

Authors

  • Manuel Raposo / Craig Crosby
  • License MIT

Requirements

  • Kanboard >= 1.0.34
  • PHP >= 5.3.3

PS: _(This is automatic for Subtaskdate versions >= 1.1.1)_ - Commented dashboard hook to work with versions >=1.0.41, if you are using a version prior to that, just uncomment lines 33 and 34

Installation

You have the choice between 3 methods:

  1. Install the plugin from the Kanboard plugin manager in one click (not yet)
  2. Download the zip file and decompress everything under the directory `plugins/Subtaskdate`
  3. Clone this repository into the folder `plugins/Subtaskdate`

Note: Plugin folder is case-sensitive.

For more information send a message to info at phpclasses dot org.