We already know how to install the Fatfree framework and prepare for creating the sample from the previous article. So lets start with the magic.
Sample Creation: Creating the Template
Create a template file in the template folder and name it Comparison.htm. This generates a web page with a form for entering the necessary data such as user ID, private key and the file GUIDs for the two files that will be compared. The user can also enter a callback URL. How to get this data you can find out in the documentation.
This code block shows the data the user entered. Here you can see code like this: \{\{@userId\}\}. In the Fatfree framework you must call a variable declared in the controller for the template.
<br/><p>You entered:
<p>ClientID = {{@userId}}
<p>PrivateKey = {{@privateKey}}
<p>Source file Id = {{@sourceFileId}}
<p>Target file Id = {{@targetFileId}}
<p>Call back url = {{@callbackURL}}
The next step in the template file creates a div block with the form for entering data:
Let’s explain some key moments for this code. In the Fatfree framework, the form is creation using a simple HTML code which does not need explaining: everything is as usual. But in the value of the input’s we transfer the value of variables from the controller – \{\{@userId\}\} – in order that the user data stays in the values when the user clicks Make request. Also you can see here the input named CallbackURL. In this field, the user can enter a URL which will be executed by the server after the comparison is done. A callback is something like an action for a form. It can be a PHP file which is triggered by the server. All of these fields are required except for the callbackURL field.
This div block shows the results of a comparison. As you can see, it’s simple HTML too but the iframe source and parameters we get from the controller. As part of the controller operation, we check that all the parameters have been entered. If a parameter doesn’t have a value, an error is returned. So, depending on what we receive from the server, we return either the iframe or an error message. The form looks like this:
Sample Creation: Creating the Controller
Go to the inc_samples folder and create controller file called Comparison.php. This file will contain this code:
<?php
//<i>This sample will show how to use <b>Compare</b> method from ComparisonApi to return a URL representing a single page of a Document</i>
//###Set variables and get POST data
F3::set('userId', '');
F3::set('privateKey', '');
f3::set('result', "");
$clientId = F3::get('POST["client_id"]');
$privateKey = F3::get('POST["private_key"]');
$sourceFileId = f3::get('POST["sourceFileId"]');
$targetFileId = f3::get('POST["targetFileId"]');
$callbackUrl = f3::get('POST["callbackUrl"]');
$basePath = f3::get('POST["server_type"]');
function Compare($clientId, $privateKey, $sourceFileId, $targetFileId, $callbackUrl, $basePath)
{
//### Check clientId, privateKey and fileGuId
if (empty($clientId) || empty($privateKey) || empty($sourceFileId) || empty($targetFileId)) {
throw new Exception('Please enter all required parameters');
} else {
//Set variables for Viewer
F3::set('userId', $clientId);
F3::set('privateKey', $privateKey);
//###Create Signer, ApiClient and Storage Api objects
//Create signer object
$signer = new GroupDocsRequestSigner($privateKey);
//Create apiClient object
$apiClient = new APIClient($signer);
//Create ComparisonApi object
$CompareApi = new ComparisonApi($apiClient);
$CompareApi->setBasePath($basePath);
//###Make request to ComparisonApi using user id
//Comparison of documents where: $clientId - user GuId, $sourceFileId - source file Guid in which will be provided compare,
//$targetFileId - file GuId with wich will compare sourceFile, $callbackUrl - Url which will be executed after compare,
$info = $CompareApi->Compare($clientId, $sourceFileId, $targetFileId, $callbackUrl);
//###Example of handling callback request:
// You can handle callback request in separate php file or in the same one. Our service will post JSON data via post request.
//In PHP you should get raw data like this:
// $json = file_get_contents("php://input"); - get callback data
// $fp = fopen(__DIR__ . '/../../temp/signature_request_log.txt', 'a'); - open file for data write
// fwrite($fp, $json . "\r\n"); - write data to the file
// fclose($fp); - close file
//Check request status
if($info->status == "Ok") {
//Create AsyncApi object
$asyncApi = new AsyncApi($apiClient);
$asyncApi->setBasePath($basePath);
//### Check job status
for ($i = 0; $i <= 5; $i++) {
//Delay necessary that the inquiry would manage to be processed
sleep(5);
//Make request to api for get document info by job id
$jobInfo = $asyncApi->GetJobDocuments($clientId, $info->result->job_id);
//Check job status, if status is Completed or Archived exit from cycle
if ($jobInfo->result->job_status == "Completed" || $jobInfo->result->job_status == "Archived") {
break;
//If job status Postponed throw exception with error
} elseif ($jobInfo->result->job_status == "Postponed") {
throw new Exception('Job is failure');
}
}
//Get file guid
$guid = $jobInfo->result->outputs[0]->guid;
// Construct iframe using fileId
if($basePath == "https://api.groupdocs.com/v2.0") {
$iframe = 'https://apps.groupdocs.com/document-viewer/embed/' . $guid . ' frameborder="0" width="800" height="650"';
//iframe to dev server
} elseif($basePath == "https://dev-api.groupdocs.com/v2.0") {
$iframe = 'https://dev-apps.groupdocs.com/document-viewer/embed/' . $guid . ' frameborder="0" width="500" height="650"';
//iframe to test server
} elseif($basePath == "https://stage-api.groupdocs.com/v2.0") {
$iframe = 'https://stage-apps.groupdocs.com/document-viewer/embed/' . $guid . ' frameborder="0" width="500" height="650"';
}
}
//If request was successfull - set url variable for template
return F3::set('iframe', $iframe);
}
}
try {
Compare($clientId, $privateKey, $sourceFileId, $targetFileId, $callbackUrl, $basePath);
} catch(Exception $e) {
$error = 'ERROR: ' . $e->getMessage() . "\n";
f3::set('error', $error);
}
//Process template
f3::set('sourceFileId', $sourceFileId);
f3::set('targetFileId', $targetFileId);
f3::set('callbackURL', $callbackUrl);
// f3::set('result', $result);
echo Template::serve('comparison.htm');
The Controller Code Explained
Now the code explanation: First of all we must get a posted data from form. In Fatfree framework we can do it with this code:
F3::get is a framework method to call to the global associative array of variables passed to the current script via the HTTP POST method. Now we can declare empty variables for template.
f3::set is one more framework method similar to f3::get but it transfers data to the template. The first parameter is a name of a variable in the template. The second parameter is the data that associated with this variable. Right now, it’s a empty string.
Creating the Compare Function
Let’s create a function named Compare which takes the entered data and runs a comparison. First, what this function does is to check that all data has been entered by the user:
function Compare($clientId, $privateKey, $sourceFileId, $targetFileId, $callbackUrl, $basePath)
{
if (empty($clientId) || empty($privateKey) || empty($sourceFileId) || empty($targetFileId)) {
throw new Exception('Please enter all required parameters');
The checks are standard checks for empty values. If the user entered all the required data, the controller continues its operation:
} else {
//Set variables for Viewer
F3::set('userId', $clientId);
F3::set('privateKey', $privateKey);
//###Create Signer, ApiClient and Storage Api objects
//Create signer object
$signer = new GroupDocsRequestSigner($privateKey);
//Create apiClient object
$apiClient = new APIClient($signer);
//Create ComparisonApi object
$CompareApi = new ComparisonApi($apiClient);
This block sets data to the template variables userId and privateKey, which was empty. After that they contain user entered data. Next create the Signer, ApiClient and Comparison API objects for making request to the server.
The Comparison
And now the comparison magic:
//Comparison of documents where: $clientId - user GuId, $sourceFileId - source file Guid in which will be provided compare,
//$targetFileId - file GuId with wich will compare sourceFile, $callbackUrl - Url which will be executed after compare,
$info = $CompareApi->Compare($clientId, $sourceFileId, $targetFileId, $callbackUrl);
Expected the comparison segment to be bigger? Sorry if you’re disappointed. The document comparison is only one line of code: all you need to do is call the Compare method from the PHP SDK and transfer the proper data to it. Data such as the client ID (user id), the GUIDs for the two files that will be compared (the source and target file IDs) and, finally, the callback URL which can be an empty string. The next step is a check of the comparison results:
if($info->status == "Ok") {
//Create AsyncApi object
$asyncApi = new AsyncApi($apiClient);
//### Check job status
for ($i = 0; $i <= 5; $i++) {
//Delay necessary that the inquiry would manage to be processed
sleep(5);
//Make request to api for get document info by job id
$jobInfo = $asyncApi->GetJobDocuments($clientId, $info->result->job_id);
//Check job status, if status is Completed or Archived exit from cycle
if ($jobInfo->result->job_status == "Completed" || $jobInfo->result->job_status == "Archived") {
break;
//If job status Postponed throw exception with error
} elseif ($jobInfo->result->job_status == "Postponed") {
throw new Exception('Job is failure');
}
}
//Get file guid
$guid = $jobInfo->result->outputs[0]->guid;
// Construct iframe using fileId
$iframe = 'https://apps.groupdocs.com/document-viewer/embed/' . $guid . ' frameborder="0" width="800" height="650"';
}
Here we check what status of request was returned. If it’s “Ok”, we can continue and get all the necessary data for an iframe, such as result file GUID, from the returned job ID. In the server response of the Compare method, we have only the request status and job ID which is why we must create an AsyncApi object ($asyncApi = new AsyncApi($apiClient); and call the GetJobDocuments method from this object. This method uses the job ID to get all the info of this job. Now we must check the job status from $jobInfo->result. If it is “Completed” or “Archived”, all is well and we continue. But before we do this check we must allow the server to fulfill the inquiry having established a delay in 5 sec: sleep(5);. After job status check, we can get the result file GUID. It will be in the outputs array: $guid = $jobInfo->result->outputs[0]->guid;. So now we have real file GUID and we can generate an iframe: $iframe = 'https:**//apps.groupdocs.com/document-viewer/embed/' . $guid . ' frameborder="0" width="800" height="650"';
In this block we call our function with user data and a catch exception (in case there is an exception). The exception contains all possible errors. And we can set variables for the template and send them to it: f3::set('sourceFileId', $sourceFileId);. As I’ve already mentioned, this sets variables for the template and this line of code, echo Template::serve('comparison.htm'); calls template and send data to it. The iframe, complete with results, looks like this:
