added some comments and dokus

This commit is contained in:
Marc Wäckerlin
2015-07-15 13:54:52 +00:00
parent 6ac39269ac
commit 28a943f4eb
15 changed files with 2888 additions and 195 deletions

View File

@@ -1,10 +1,34 @@
<?php
/// Send Error To Client
/** @return error message from server to client
Function calls exit to terminate.
Message format is json:
@code
{
success: false,
txt: 'error message string';
}
@endcode */
function error($txt) {
echo json_encode(array('success' => false, 'txt' => $txt));
exit;
}
/// Send Success To Client
/** @return success message from server to client
Function calls exit to terminate.
Message format is json:
@code
{
success: true,
txt: 'success message string';
}
@endcode */
function success($txt) {
echo json_encode(array('success' => true, 'txt' => $txt));
exit;