Skip to content

Issue #89 feat: Category plugin enhancements #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
manojLondhe merged 2 commits into from
Jan 10, 2019
Merged

Issue #89 feat: Category plugin enhancements #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3db78b3
Issue #89 feat: Category plugin enhancements
manojLondhe Jan 3, 2019
bfef900
Issue #89 feat: Fix return types
manojLondhe Jan 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 48 additions & 32 deletions categories/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,57 @@
API to create and get Joomla categories

## Create / Update Category
## Get Single Category

```http
POST /index.php?option=com_api&app=categories&resource=categories&format=raw
GET /index.php?option=com_api&app=categories&resource=category&format=raw&id=:id
```
OR update an existing category

Alternatively, you can call this API as follow (assuming you have created a menu with alias as 'api' for com_api)

```http
POST /index.php?option=com_api&app=categories&resource=categories&format=raw&id=:id
GET /api/categories/category/:id
```

#### Request Params

| Param Name | Required | Type | Comment |
| ---------- | -------- | ------- | :---- |
| title | YES | STRING | |
| alias | NO | STRING | URL alias. Will be generated based on title if kept empty |
| description | NO | STRING | |
| published | NO | INT | 1 = Published (Default) / 0 = Unpublished |
| parent_id | NO | INT | Specify a parent category id if you wish to create a subcategory |
| language | NO | STRING | Will use the site's default language if none provided. |
| extension | YES | STRING | Since Joomla supports using the categories extension for 3rd party components, this field specifies the extension name. Use com_content for article categories. |
| access | NO | INT | Access Level for Category |
| Param Name | Required | Comment |
| ---------- | -------- | :------ |
| fields | NO | Defaults to id, title, created_time |


#### Response Params

| Param Name | Comment |
| ---------- | :------ |
| success | true if the category was created, false if there was a problem |
| Param Name | Comment |
| ---------- | :------- |
| success | true if the API call succeeds, false if there was a problem |
| message | Error mesage in case success is false |
| data.results | Array containing a single [Category Object](#category-object) in case of success. Empty array in case of failure. |

## Get Categories List

```http
GET /index.php?option=com_api&app=categories&resource=categories&format=raw
```

Alternatively, you can call this API as follow (assuming you have created a menu with alias as 'api' for com_api)

```http
GET /api/categories/categories
Copy link
Member

@coolbung coolbung Jan 3, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be /categories/all/:extension. The value of extension will be available in the id param. Not ideal, but that makes the sef URL semantic.

Copy link
Member Author

@manojLondhe manojLondhe Jan 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need router support here as well as described at https://github.com/techjoomla/com_api-plugins/pull/90/files#r245647296 @coolbung

```

#### Request Params

| Param Name | Required | Comment |
| ---------- | -------- | :------ |
| limit | NO | Defaults to 20 |
| limitstart | NO | Defaults to 0 |
| filters | NO | Key value pairs of values to filter on |
| search | NO | search key for searching category titles |
| fields | NO | Defaults to id, title, created_time |

| limit | NO | Defaults to 20 |
| limitstart | NO | Defaults to 0 |
| search | NO | search key for searching category titles |
| filters[access] | NO | Access level |
| filters[extension] | NO | Defaults to 'com_content' |
| filters[language] | NO | eg: hi-IN for Hindi |
| filters[level] | NO | eg: 1 for top level |
| filters[published] | NO | 1 / 0, defaults to 1 |
| fields (not implemented yet) | NO | Defaults to id, title, created_time |

#### Response Params

Expand All @@ -55,28 +61,38 @@ GET /index.php?option=com_api&app=categories&resource=categories&format=raw
| message | Error mesage in case success is false |
| data.results | Array of [Category Objects](#category-object) in case of success. Empty array in case of failure. |

## Create / Update Category

## Get Single Category
```http
GET /index.php?option=com_api&app=categories&resource=categories&format=raw&id=:id
POST /index.php?option=com_api&app=categories&resource=categories&format=raw
```
OR update an existing category
```http
POST /index.php?option=com_api&app=categories&resource=categories&format=raw&id=:id
```

#### Request Params

| Param Name | Required | Comment |
| ---------- | -------- | :------ |
| fields | NO | Defaults to id, title, created_time |
| Param Name | Required | Type | Comment |
| ---------- | -------- | ------- | :---- |
| title | YES | STRING | |
| alias | NO | STRING | URL alias. Will be generated based on title if kept empty |
| description | NO | STRING | |
| published | NO | INT | 1 = Published (Default) / 0 = Unpublished |
| parent_id | NO | INT | Specify a parent category id if you wish to create a subcategory |
| language | NO | STRING | Will use the site's default language if none provided. |
| extension | YES | STRING | Since Joomla supports using the categories extension for 3rd party components, this field specifies the extension name. Use com_content for article categories. |
| access | NO | INT | Access Level for Category |


#### Response Params

| Param Name | Comment |
| ---------- | :------- |
| success | true if the API call succeeds, false if there was a problem |
| Param Name | Comment |
| ---------- | :------ |
| success | true if the category was created, false if there was a problem |
| message | Error mesage in case success is false |
| data.results | Array containing a single [Category Object](#category-object) in case of success. Empty array in case of failure. |


## Category Object
The actual contents of the category object will vary based on which fields are requested, however the below is the list of all possible fields.

Expand Down
35 changes: 25 additions & 10 deletions categories/categories.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,36 @@
<?php
/**
* @package API plugins
* @copyright Copyright (C) 2009 2014 Techjoomla, Tekdi Technologies Pvt. Ltd. All rights reserved.
* @license GNU GPLv2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
* @link http://www.techjoomla.com
*/
* @package API
* @subpackage com_api
*
* @author Techjoomla <extensions@techjoomla.com>
* @copyright Copyright (C) 2009 - 2019 Techjoomla, Tekdi Technologies Pvt. Ltd. All rights reserved.
* @license GNU GPLv2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
*/

defined('_JEXEC') or die( 'Restricted access' );
// No direct access.
defined('_JEXEC') or die('Restricted access');

jimport('joomla.plugin.plugin');

class plgAPICategories extends ApiPlugin
/**
* Category API plugin class
*
* @package API
* @since 1.6.0
*/
class PlgAPICategories extends ApiPlugin
{
/**
* Constructor.
*
* @param object &$subject The object to observe.
* @param array $config An optional associative array of configuration settings.
*
* @since 1.6.0
*/
public function __construct(&$subject, $config = array())
{
parent::__construct($subject, $config = array());

ApiResource::addIncludePath(dirname(__FILE__).'/categories');
ApiResource::addIncludePath(dirname(__FILE__) . '/categories');
}
}
17 changes: 8 additions & 9 deletions categories/categories.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,17 @@
<copyright>Techjoomla. All rights reserved.</copyright>
<license>http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL</license>
<description>This plugin is for content Request</description>
<files>
<filename plugin="categories">categories.php</filename>
<files>
<filename plugin="categories">categories.php</filename>
<folder>categories</folder>
</files>
<languages>
<language tag="en-GB">en-GB.plg_api_categories.ini</language>
<language tag="en-GB">en-GB.plg_api_categories.sys.ini</language>
</languages>
</files>
<languages>
<language tag="en-GB">en-GB.plg_api_categories.ini</language>
<language tag="en-GB">en-GB.plg_api_categories.sys.ini</language>
</languages>
<config>
<fields name="params">
<fieldset name="basic">
</fieldset>
<fieldset name="basic" />
</fields>
</config>
</extension>
Loading