PLANLABELS: manages plan's labels. More...

Functions
	post_labels ($t_conn_res)
	Inserts/removes label data to the database. More...

	get_labels ($t_conn_res)
	Returns labels data. More...

Variables
	$response = array("errors" => array())
	Prepare default response array with no errors. More...

Detailed Description

PLANLABELS: manages plan's labels.

Client perspective:

GET METHOD --> returns labels data
POST METHOD --> add or removes a label

Description

This script sets the returned content type to JSON, includes the db_connection.php script

It is used to connect to MySQL and execute basic SELECT queries

and then defines the response array.

Two functions are defined:

 post_labels()

Inserts/removes label data to the database.

 get_labels()

Returns labels data

If the script isn't included it tries to connect to the database, and checks the request method:

if the method is GET it calls the get_labels() function
if the method is POST it calls the post_labels() function

When the called function ends the connection to the DB gets terminated, and data (or errors) is collected inside the response array. The response array gets echoed to the client in JSON format

Errors list:

1100 - main: Method not supported by the target resource
1101 - main: No data but also No errors
1110 - post_labels(): No rows affected (maybe the same values where sent?)
1111 - post_labels(): Unable to execute INSERT/UPDATE query
1112 - post_labels(): Couldn't remove the label, no rows affected
1113 - post_labels(): Unable to execute DELETE query
1114 - post_labels(): the required parameters are not set in the request
1115 - post_labels(): There is an error in the SQL instruction
1120 - get_labels(): Error during query execution

Since: 01_01

Author: Stefano Zenaro (https://github.com/mario33881)

Copyright: MIT

Function Documentation

◆ get_labels()

get_labels ( $t_conn_res )

Returns labels data.

The function executes a SELECT query to select the labels data.

Since: 01_01

Parameters

array $t_conn_res array with the DB connection object

Returns: array $action_res array with errors or data

◆ post_labels()

post_labels ( $t_conn_res )

Inserts/removes label data to the database.

The function checks if all the parameters have been passed inside the request.

Then it tries to insert the data and if the data is a duplicate, it updates the old data.

If the client sends only an id and a remove parameter, the function tries to remove the label from the table

Parameters

array $t_conn_res array with the DB connection object

Returns: array $action_res array with errors or data

Todo:

should log the SQL error to a file... (should also log everything else)

the "error" 1110 should be a warning

Variable Documentation

◆ $response

$response = array("errors" => array())

Prepare default response array with no errors.

Functions