How to Upload PHP Project to Heroku? – Advanced Steps

In the previous article, we learned how to create a new PHP project on Heroku. But sometimes our project requires additional extensions that do not exist in the Heroku PHP configuration. So we need to find out how to create and install extensions for PHP on Heroku.

In this post, I'll show you these advanced steps, and create a PHP project on Heroku with the GroupDocs PHP SDK Api Samples application.

Preparation

All required preparation are described in previous article. Also, we need two PHP extensions such as Curl and Sockets that are used in our PHP Samples application.

Build an extension on Heroku.

This can be done by opening a Heroku console, download the PHP source-code and compile the extension, then copying it over.

To create the Curl extension:

Open console and cd to root folder of your API.
>heroku run bash
$ mkdir tmp
$cd tmp
git clonehttps://github.com/php/php-src.git
$cd php-src
$ cd ext/curl
$ /app/php/bin/phpize
$ ./configure --with-php-config=/app/php/bin/php-config
$ make
$ cd modules

To create the Sockets extension, take the same steps.

Don't close the console. We will use it for the next steps.

Download lib from Heroku.

Now we have compiled the extension, but this file is on the Heroku server and we need it in our API.

To get the file from the server and add it to the API, we can create an empty repo on GitHub and clone it to the temp folder in which we compile the extension. Then copy the extension file and push it to GitHub. After that, you can download it from GitHub to the lib folder and push it to Heroku.

Lets see this logic in practical steps by adding the Curl extension:

In the mudel folder, $ ssh-keygen -t rsa
$ cat /app/.ssh/id_rsa.pub
This command shows your ssh key file content in the console. Copy it.
Add your SSH key to GitHub.
$ git clone yourreposshurl
$ mv curl.so cloned folder name
$ cd cloned folder
$ git add .
$ git commit -m "adding extension"
$ git push origin master
$ exit

Now we have our extension file in the GitHub repository and we can download it.

To add the Sockets extension, take the same steps.

Add lib and php.ini file to your app and upload them to Heroku

In the root folder of the API, create a lib folder and save the downloaded file there. And there's only one thing left to do: create a php.ini file in the root folder of the API that points to that extension. The changes are committed. To do all this open console and:

cd to the API root folder
>mkdir lib
cd to the folder where the downloaded extension folder is.
>mv curl.so rootfolderapi/lib
cd to the API root folder.
$ echo extension = /app/www/lib/curl.so > php.ini
$ git add .
$ git commit -m "adding extension"
$ git push origin master

That's all, your new PHP application is ready to use on Heroku. Enjoy!

Signing Off,

The GroupDocs Marketplace Team

How to upload PHP project to Heroku?

Heroku is a great opportunity for developers to try and test their code in a production environment. Originally created for Ruby projects, Heroku now supports Ruby, Java, Python and even PHP. Heroku's PHP project support is an undocumented feature so some additional skills are required do deploy such a project.

In this post, I'll show you the methods to create a PHP project on Heroku with the GroupDocs PHP SDK Api Samples application.

Preparation

To get the PHP samples, you first need to clone the entire PHP SDK repository:
$ git clone git://github.com/groupdocs/groupdocs-php.git

Then go to the examples directory ($ cd groupdocs-php/examples) and copy the api-samples folder to the location where you want to create a Heroku project.

Note: Before uploading PHP API samples to Heroku, you need to update the PHP SDK in the API Samples project. You can check out our previous posts to find information on how to do this, for example, How to use GroupDocs PHP SDK with Composer or a Built-in Autoloader.

Creating a Heroku project

To create a Heroku project, create a local repository with git (the example below assumes that you have Heroku toolbelt installed).

$ cd api-samples
$ git init
$ heroku create yourapplicationname

$ cd api-samples

$ git init

$ heroku create yourapplicationname

Note that in some guides, you might see the option -stack cedar in the heroku create command. This option is not required anymore. -stack cedar is now the default for new apps on Heroku.

If you've done everything correctly, Heroku creates a new application and adds a new remote (with the same name – heroku) to your local repository. You can check this with the command:
$ git remote --v

You should see Heroku remote records with remote URLs for pull and push.

Now you can push your local repository to Heroku:

$ git push heroku master

1	$ git push heroku master

All your commits from the local repository are pushed to Heroku. Heroku detects the type of your application – PHP project in our case – and starts the appropriate server to host the app.

If you use only standard PHP libraries, you can immediately start working with your new application on Heroku:

$ heroku apps open

1	$ heroku apps open

But if your project/app requires a non-standard library (like the PHP API samples project), then you'll have problems with Heroku if you try to use it immediately. To be able to use such extensions, you need to perform additional steps:

Build an extension on Heroku.
Download lib from Heroku.
Add lib and php.ini file to your app and upload them to Heroku.

I'll show you how to perform those advanced steps in the next blog post.

Signing Off,

The GroupDocs Marketplace Team

GroupDocs Newsletter May 2013: GroupDocs Comparison CMS Integration and GroupDocs Viewer for .NET

GroupDocs extended the reach of its powerful Comparison app to a whole host of CMSs last month, in addition to enhancing its app UIs.

May is an exciting month for GroupDocs as we're about to launch GroupDocs Viewer for .NET, a downloadable version of our online document viewer for the .NET platform. This lets you use GroupDocs Viewer as part of your .NET systems.

Tabular data merging in Assembly and a pressure-sensitive signing pad for GroupDocs Signature are in the offing. In addition, you can expect more enhancements to all of our app UIs in the coming weeks.

This month, we've made enhancements to several GroupDocs apps, launched various plugins for CMSs and updated the GroupDocs SDKs.

Usability enhancements.

Cursor based real-time pointer improvements.

WYSIWYG support for questionnaire answers and enhanced integration options.

Addition of embedded comparison results.
Roll-out of Comparison v2.0 with results summary list.

Embedded signature enhancements to support automatically adding fields to positions within documents.

New document post-upload progress indicator.
Various optimizations to improve usability.

Support for serving document images directly from Windows Azure, Google Storage and Amazon S3.
File system security enhancements.

Expect these exciting features soon:

GroupDocs Viewer for .NET - Install GroupDocs Viewer as part of your platform and .NET apps.
GroupDocs Viewer plugin for FireFox.
GroupDocs Viewer plugin for Google Chrome.

GroupDocs Assembly v2.0 - Support for merging tabular data.
GroupDocs Assembly v2.0 - Enhanced and streamlined UI.

GroupDocs Signature v2.0 - New high-fidelity pressure-sensitive signing pad and improved UI.
Publish Signature plugin for Moodle.
Publish Signature plugin for CMSMS.
GroupDocs Signature plugin for Gmail (Chrome).

GroupDocs Comparison v2.0 - Improved UI.

Following are some of the popular blog posts in the month of March:

Thank you for choosing GroupDocs.

The GroupDocs Team

How to merge data fields from a DOCX file with a data source and output to PDF

This article explains how to get the fields from a template DOCX file, fill them with data and merge to new PDF file using GroupDocs.

Requirements

PHP 5.3
Apache ModRewrite
PHP Curl extension
PHP Sockets extension (php_sockets.dll)
GroupDocs PHP SDK
composer.phar (Download from http://getcomposer.org/download/ or use the included version.)
FatFree framework (https://github.com/bcosca/fatfree)

We already know how to install the Fatfree framework and prepare for creating the sample from the previous article. The sample that we create in this article is not much different from other sample with Fatfree. We need a template file with a form and a controller file to process entered data.

Sample creation

The template file is the same as in the previous article. Because of this, I will not explain the template file but just show the code.

Template file code

<!DOCTYPE html>
<html lang="en">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
	<title>Powered by {{ @VERSION }}</title>
	<style type="text/css">
		{{ Web::minify('templates/',array('style.css'),FALSE) }}
	</style>
</head>
<body>
<h3 style="text-align:center;"><a href="/index.php">GroupDocs PHP SDK Samples</a> - Merge fields</h3>

<div class='samplecontent' style="padding:10px;">
   <span class="description"><i>This sample will show how to merge data fields in docx file with data source and get result file as PDF file using PHP SDK</i></span> <br/>
    <br />
   <p>You entered:
   <p>ClientID = {{@userId}}
   <p>PrivateKey = {{@privateKey}}
   <p>File Id = {{@fileId}}

   <p><font color="red">{{@error}}</font>
   <div id="requestForm" style="padding:20px; border:1px solid black;">
   <p> Enter data for request and press "Make request" button </p>
        <form action="controller" method = "post" enctype = 'multipart/form-data'>
            <br />
            <label for='client_id'>GroupDocs Client ID</label>
            <br />
            <input type='text' name='client_id' value="{{@userId}}" />
            <br />
            <label for='private_key'>GroupDocs PrivateKey</label>
            <br />
            <input type='text' name='private_key'  value="{{@privateKey}}" />
            <br />
            <br />
            <input type="radio" name="sourse" value="guid" id="id" onClick="display('guid');" checked>File ID (GUID) </input>
            <br />
            <input type="radio" name="sourse" value="local" id="localField" onClick="display('local');" >Upload local file </input>
            <br />
            <input type="radio" name="sourse" value="url" id="urlField" onClick="display('url');" >Upload file from URL </input>
            <br />

            <label for='private_key' id="guid">GroupDocs fileID</label>
            <br />
            <input type='text' name='fileId' id="guidfield" value="{{@fileId}}" />

            <label for='file' id="file" style="display:none;">Local file</label>
            <br />
            <input type='file' name='file' id="filefield" style="display:none;" />

            <label for='private_key' style="display:none;" id="url">File URL</label>
            <br />
            <input type='text' name='url'  value="" id="urlfield" style="display:none;" />
            <br />
            <input type='submit' value='Make Request'/>
        </form>
   </div>
   <div  style="padding:20px; border:1px solid black;">
        <font color="green">{{@message}}</font>
        <iframe frameborder="0" width="500" height="650" src="{{@url}}"></iframe>
   </div>
   <br/>
</div>

 <include href="links.htm" />
<script type="text/javascript">

    function display(_element_id) {

             if (_element_id == "guid") {
                 var element1 = document.getElementById("file");
                 var element2 = document.getElementById("filefield");
                 var element3 = document.getElementById("url");
                 var element4 = document.getElementById("urlfield");
                 var element5 = document.getElementById("guid");
                 var element6 = document.getElementById("guidfield");
                 element1.style.display = "none";
                 element2.style.display = "none";
                 element3.style.display = "none";
                 element4.style.display = "none";
                 element5.style.display = "inline";
                 element6.style.display = "inline";

             }

             if (_element_id == "local") {
                 var element1 = document.getElementById("file");
                 var element2 = document.getElementById("filefield");
                 var element3 = document.getElementById("url");
                 var element4 = document.getElementById("urlfield");
                 var element5 = document.getElementById("guid");
                 var element6 = document.getElementById("guidfield");
                 element1.style.display = "inline";
                 element2.style.display = "inline";
                 element3.style.display = "none";
                 element4.style.display = "none";
                 element5.style.display = "none";
                 element6.style.display = "none";

             }

             if (_element_id == "url") {
                 var element1 = document.getElementById("url");
                 var element2 = document.getElementById("urlfield");
                 var element3 = document.getElementById("file");
                 var element4 = document.getElementById("filefield");
                 var element5 = document.getElementById("guid");
                 var element6 = document.getElementById("guidfield");
                 element1.style.display = "inline";
                 element2.style.display = "inline";
                 element3.style.display = "none";
                 element4.style.display = "none";
                 element5.style.display = "none";
                 element6.style.display = "none";
             }

         }
</script>
</body>
</html>

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

<!DOCTYPE html>

<head>

<title>Powered by {{ @VERSION }}</title>

</style>

</head>

<body>

<h3 style="text-align:center;"><a href="/index.php">GroupDocs PHP SDK Samples</a> - Merge fields</h3>

<span class="description"><i>This sample will show how to merge data fields in docx file with data source and get result file as PDF file using PHP SDK</i></span> <br/>

<br />

<p>You entered:

<p>ClientID = {{@userId}}

<p>PrivateKey = {{@privateKey}}

<p>File Id = {{@fileId}}

<p><font color="red">{{@error}}</font>

<p> Enter data for request and press "Make request" button </p>

<br />

<label for='client_id'>GroupDocs Client ID</label>

<br />

<br />

<label for='private_key'>GroupDocs PrivateKey</label>

<br />

<br />

<br />

<input type="radio" name="sourse" value="local" id="localField" onClick="display('local');" >Upload local file </input>

<br />

<input type="radio" name="sourse" value="url" id="urlField" onClick="display('url');" >Upload file from URL </input>

<br />

<label for='private_key' id="guid">GroupDocs fileID</label>

<br />

<label for='file' id="file" style="display:none;">Local file</label>

<br />

<br />

<br />

</form>

</div>

<font color="green">{{@message}}</font>

</div>

<br/>

</div>

function display(_element_id) {

if (_element_id == "guid") {

var element1 = document.getElementById("file");

var element2 = document.getElementById("filefield");

var element3 = document.getElementById("url");

var element4 = document.getElementById("urlfield");

var element5 = document.getElementById("guid");

var element6 = document.getElementById("guidfield");

element1.style.display = "none";

element2.style.display = "none";

element3.style.display = "none";

element4.style.display = "none";

element5.style.display = "inline";

element6.style.display = "inline";

}

if (_element_id == "local") {

var element1 = document.getElementById("file");

var element2 = document.getElementById("filefield");

var element3 = document.getElementById("url");

var element4 = document.getElementById("urlfield");

var element5 = document.getElementById("guid");

var element6 = document.getElementById("guidfield");

element1.style.display = "inline";

element2.style.display = "inline";

element3.style.display = "none";

element4.style.display = "none";

element5.style.display = "none";

element6.style.display = "none";

}

if (_element_id == "url") {

var element1 = document.getElementById("url");

var element2 = document.getElementById("urlfield");

var element3 = document.getElementById("file");

var element4 = document.getElementById("filefield");

var element5 = document.getElementById("guid");

var element6 = document.getElementById("guidfield");

element1.style.display = "inline";

element2.style.display = "inline";

element3.style.display = "none";

element4.style.display = "none";

element5.style.display = "none";

element6.style.display = "none";

}

</script>

</body>

</html>

OK, what's happening with the template file clear so lets take a look at the controller file.

Controller file

We already know how to create this file. If you're unsure, look at a previous post that explains how.

Below, I'll show you the complete controller code and then explain how it works.

<?php
    //<i>This sample will show how to merge data fields in docx file with data source and get result file as PDF file</i>

    //###Set variables and get POST data
    F3::set('userId', '');
    F3::set('privateKey', '');
    $clientId = F3::get('POST["client_id"]');
    $privateKey = F3::get('POST["private_key"]');

    function mergeFields($clientId, $privateKey, $basePath)
    {
        //###Check if user entered all parameters
        if (empty($clientId) || empty($privateKey)) {
            throw new Exception('Please enter FILE ID');
        } else {
            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 Doc Api object
            $docApi = new DocApi($apiClient);
            //Create Storage Api object
            $apiStorage = new StorageApi($apiClient);
            //Create AsyncApi object
            $api = new AsyncApi($apiClient);
            $mergApi = new MergeApi($apiClient);
            //Get entered by user data
            $url = F3::get('POST["url"]');
            $file = $_FILES['file'];
            $fileId = f3::get('POST["fileId"]');
            //Check if user choose upload file from URL
            if ($url != "") {
                //Upload file from URL
                $uploadResult = $apiStorage->UploadWeb($clientId, $url);
                //Check is file uploaded
                if ($uploadResult->status == "Ok") {
                    //Get file GUID
                    $fileGuId = $uploadResult->result->guid;
                    $fileId = "";
                //If it isn't uploaded throw exception to template
                } else {
                    throw new Exception($uploadResult->error_message);
                }
            }
            //Check is user choose upload local file
            if ($_FILES['file']["name"] != "") {
                //Temp name of the file
                $tmp_name = $file['tmp_name'];
                //Original name of the file
                $name = $file['name'];
                //Creat file stream
                $fs = FileStream::fromFile($tmp_name);
                //###Make a request to Storage API using clientId
                //Upload file to current user storage
                $uploadResult = $apiStorage->Upload($clientId, $name, 'uploaded', "", $fs);

                //###Check if file uploaded successfully
                if ($uploadResult->status == "Ok") {
                    //Get file GUID
                    $fileGuId = $uploadResult->result->guid;
                    $fileId = "";

                //If it isn't uploaded throw exception to template
                } else {
                    throw new Exception($uploadResult->error_message);
                }
            }
            //Check is user choose file GUID
            if ($fileId != "") {
                //Get entered by user file GUID
                $fileGuId = $fileId;
            }
            //Get feilds from template
            $fields = $docApi->GetTemplateFields($clientId, $fileGuId);
            //Check status
            if ($fields->status == "Ok") {
                //Create new Datasource object
                $dataSource = new Datasource();
                //Create empty array
                $array = array();
                //Loop for fields creataion
                for ($i = 0; $i < count($fields->result->fields); $i++) {
                    //Create new DatasourceField object
                    $field = new DatasourceField();
                    //Set DatasourceFiled data
                    $field->name = $fields->result->fields[$i]->name;
                    $field->type = "text";
                    $field->values = array("value1", "value2");
                    //Push DatasourceField to array
                    array_push($array, $field);
                }
                //Set array feilds array to the Datasourc
                $dataSource->fields = $array;
                //Add Datasource to GroupDocs
                $addDataSource = $mergApi->AddDataSource($clientId, $dataSource);
                //Check status
                if ($addDataSource->status == "Ok") {
                    //If status ok merge Datasource to new pdf file
                    $job = $mergApi->MergeDatasource($clientId, $fileGuId, $addDataSource->result->datasource_id, "pdf", null);
                    //Check status
                    if ($job->status == "Ok") {
                        //### Check job status
                         for ($n = 0; $n <= 5; $n++) {
                             //Delay necessary that the inquiry would manage to be processed
                             sleep(5);
                             //Make request to api for get document info by job id
                             $jobInfo = $api->GetJobDocuments($clientId, $job->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 failed");

                             }
                         }
                         //Get file guid
                         $guid = $jobInfo->result->inputs[0]->outputs[0]->guid;
                          //Get file name
                         $name = $jobInfo->result->inputs[0]->outputs[0]->name;
                         //Local path to the downloads folder
                         $downloadFolder = dirname(__FILE__). '/../downloads';
                         //Check is folder exist
                         if (!file_exists($downloadFolder)) {
                             //If folder don't exist create it
                             mkdir($downloadFolder);
                         }
                         //Obtaining file stream of downloading file and definition of folder where to download file
                         $outFileStream =  FileStream::fromHttp($downloadFolder, $name);
                         //Download file from GroupDocs.
                         $download = $apiStorage->GetFile($clientId, $guid, $outFileStream);
                         f3::set("message", "File was converted and downloaded to the " . $downloadFolder . "/" . $name);
                         //### If request was successfull
                         //Generation of iframe URL using $pageImage->result->guid
                         $iframe = 'https://apps.groupdocs.com/document-viewer/embed/' . $guid;

                    } else {
                        throw new Exception($job->error_message);
                    }
                } else {
                    throw new Exception($addDataSource->error_message);
                }
            } else {
                throw new Exception($fields->error_message);
            }

            //Set variable with results for template

            return f3::set('url', $iframe);
        }
    }

    try {
        mergeFields($clientId, $privateKey, $basePath);
    } catch(Exception $e) {
        $error = 'ERROR: ' .  $e->getMessage() . "\n";
        f3::set('error', $error);
    }
    //Process template
    echo Template::serve('template.htm');

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

<?php

//<i>This sample will show how to merge data fields in docx file with data source and get result file as PDF file</i>

//###Set variables and get POST data

F3::set('userId', '');

F3::set('privateKey', '');

$clientId = F3::get('POST["client_id"]');

$privateKey = F3::get('POST["private_key"]');

function mergeFields($clientId, $privateKey, $basePath)

{

//###Check if user entered all parameters

if (empty($clientId) || empty($privateKey)) {

throw new Exception('Please enter FILE ID');

} else {

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 Doc Api object

$docApi = new DocApi($apiClient);

//Create Storage Api object

$apiStorage = new StorageApi($apiClient);

//Create AsyncApi object

$api = new AsyncApi($apiClient);

$mergApi = new MergeApi($apiClient);

//Get entered by user data

$url = F3::get('POST["url"]');

$file = $_FILES['file'];

$fileId = f3::get('POST["fileId"]');

//Check if user choose upload file from URL

if ($url != "") {

//Upload file from URL

$uploadResult = $apiStorage->UploadWeb($clientId, $url);

//Check is file uploaded

if ($uploadResult->status == "Ok") {

//Get file GUID

$fileGuId = $uploadResult->result->guid;

$fileId = "";

//If it isn't uploaded throw exception to template

} else {

throw new Exception($uploadResult->error_message);

}

//Check is user choose upload local file

if ($_FILES['file']["name"] != "") {

//Temp name of the file

$tmp_name = $file['tmp_name'];

//Original name of the file

$name = $file['name'];

//Creat file stream

$fs = FileStream::fromFile($tmp_name);

//###Make a request to Storage API using clientId

//Upload file to current user storage

$uploadResult = $apiStorage->Upload($clientId, $name, 'uploaded', "", $fs);

//###Check if file uploaded successfully

if ($uploadResult->status == "Ok") {

//Get file GUID

$fileGuId = $uploadResult->result->guid;

$fileId = "";

//If it isn't uploaded throw exception to template

} else {

throw new Exception($uploadResult->error_message);

}

//Check is user choose file GUID

if ($fileId != "") {

//Get entered by user file GUID

$fileGuId = $fileId;

}

//Get feilds from template

$fields = $docApi->GetTemplateFields($clientId, $fileGuId);

//Check status

if ($fields->status == "Ok") {

//Create new Datasource object

$dataSource = new Datasource();

//Create empty array

$array = array();

//Loop for fields creataion

for ($i = 0; $i < count($fields->result->fields); $i++) {

//Create new DatasourceField object

$field = new DatasourceField();

//Set DatasourceFiled data

$field->name = $fields->result->fields[$i]->name;

$field->type = "text";

$field->values = array("value1", "value2");

//Push DatasourceField to array

array_push($array, $field);

}

//Set array feilds array to the Datasourc

$dataSource->fields = $array;

//Add Datasource to GroupDocs

$addDataSource = $mergApi->AddDataSource($clientId, $dataSource);

//Check status

if ($addDataSource->status == "Ok") {

//If status ok merge Datasource to new pdf file

$job = $mergApi->MergeDatasource($clientId, $fileGuId, $addDataSource->result->datasource_id, "pdf", null);

//Check status

if ($job->status == "Ok") {

//### Check job status

for ($n = 0; $n <= 5; $n++) {

//Delay necessary that the inquiry would manage to be processed

sleep(5);

//Make request to api for get document info by job id

$jobInfo = $api->GetJobDocuments($clientId, $job->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 failed");

}

//Get file guid

$guid = $jobInfo->result->inputs[0]->outputs[0]->guid;

//Get file name

$name = $jobInfo->result->inputs[0]->outputs[0]->name;

//Local path to the downloads folder

$downloadFolder = dirname(__FILE__). '/../downloads';

//Check is folder exist

if (!file_exists($downloadFolder)) {

//If folder don't exist create it

mkdir($downloadFolder);

}

//Obtaining file stream of downloading file and definition of folder where to download file

$outFileStream = FileStream::fromHttp($downloadFolder, $name);

//Download file from GroupDocs.

$download = $apiStorage->GetFile($clientId, $guid, $outFileStream);

f3::set("message", "File was converted and downloaded to the " . $downloadFolder . "/" . $name);

//### If request was successfull

//Generation of iframe URL using $pageImage->result->guid

$iframe = 'https://apps.groupdocs.com/document-viewer/embed/' . $guid;

} else {

throw new Exception($job->error_message);

}

} else {

throw new Exception($addDataSource->error_message);

}

} else {

throw new Exception($fields->error_message);

}

//Set variable with results for template

return f3::set('url', $iframe);

}

try {

mergeFields($clientId, $privateKey, $basePath);

} catch(Exception $e) {

$error = 'ERROR: ' . $e->getMessage() . "\n";

f3::set('error', $error);

}

//Process template

echo Template::serve('template.htm');

That's the controller: open your mind and plunge in.

First of all, we get all the data transfered from the form by POST to the controller. This block of code does that:

  //###Set variables and get POST data
    F3::set('userId', '');
    F3::set('privateKey', '');
    $clientId = F3::get('POST["client_id"]');
    $privateKey = F3::get('POST["private_key"]');

//###Set variables and get POST data

F3::set('userId', '');

F3::set('privateKey', '');

$clientId = F3::get('POST["client_id"]');

$privateKey = F3::get('POST["private_key"]');

As you can see, we use the Fatfree method F3::set to initially set the template variables and then the F3::get method to get the posted data. We have all necessary data to create API objects; the rest of the data we will get later.

Let's create a function that takes this data, checks it and does the rest of the magic. The function is called mergeFields and a definition looks like this: function mergeFields($clientId, $privateKey). The mergeFields function takes two parameters - client ID and private key. This data is most important because without it, we can't send a request to the API. That's why we check that it's been entered with this code:

if (empty($clientId) || empty($privateKey)) {
            throw new Exception('Please enter FILE ID');
        } else {
            F3::set('userId', $clientId);
            F3::set('privateKey', $privateKey);

if (empty($clientId) || empty($privateKey)) {

throw new Exception('Please enter FILE ID');

} else {

F3::set('userId', $clientId);

F3::set('privateKey', $privateKey);

Then, if the client ID and private key have been entered we proceed with API objects creation. I expect you already know how to do this.

Next, we check whether the user wants to upload a local file, one from the web, or a file already in the GroupDocs account. We can work with documents through the file GUID. We dont have this data, but that's not a problem - lets get it. Simply use the Fatfree method F3::get to get the client ID and private key.

Get the rest of the data:

 //Get entered by user data
            $url = F3::get('POST["url"]');
            $file = $_FILES['file'];
            $fileId = f3::get('POST["fileId"]');

//Get entered by user data

$url = F3::get('POST["url"]');

$file = $_FILES['file'];

$fileId = f3::get('POST["fileId"]');

Since this data are simple strings - with the exception of $file - check which of them are chosen by elementary verification on an empty string: if ($url != "") or if ($fileId != "").

If you wonder what to do if a user selects to upload a local file, how to check it. It's not a problem. In the global variable which consist of the local file we have an array of file data such as file name, temp name and file content. To check if a user has selected a local file, simply check if the file name is empty. This array field consist of string data and we can check it for empty string: if ($_FILES['file']["name"] != "").

According to which check returns "true", we know whether to use an entered file GUID or upload a file in three different ways. How to do this you can read in last weeks post: Two ways to upload files.

The most interesting part, and culmination of this example, is to get the field from template DOCX file and merge them to a PDF file. To do this, we need this GroupDocs PHP SDK methods:

From DocApi GetTemplateFields
From MergeApi AddDataSource and MergeDatasource
From AsyncApi GetJobDocuments
And from StorageApi GetFile

First, let's take a look at the code which will do all this work and use our methods:

//Get fields from template
            $fields = $docApi->GetTemplateFields($clientId, $fileGuId);
            //Check status
            if ($fields->status == "Ok") {
                //Create new Datasource object
                $dataSource = new Datasource();
                //Create empty array
                $array = array();
                //Loop for fields creataion
                for ($i = 0; $i < count($fields->result->fields); $i++) {
                    //Create new DatasourceField object
                    $field = new DatasourceField();
                    //Set DatasourceFiled data
                    $field->name = $fields->result->fields[$i]->name;
                    $field->type = "text";
                    $field->values = array("value1", "value2");
                    //Push DatasourceField to array
                    array_push($array, $field);
                }
                //Set array feilds array to the Datasourc
                $dataSource->fields = $array;
                //Add Datasource to GroupDocs
                $addDataSource = $mergApi->AddDataSource($clientId, $dataSource);
                //Check status
                if ($addDataSource->status == "Ok") {
                    //If status ok merge Datasource to new pdf file
                    $job = $mergApi->MergeDatasource($clientId, $fileGuId, $addDataSource->result->datasource_id, "pdf", null);
                    //Check status
                    if ($job->status == "Ok") {
                        //### Check job status
                         for ($n = 0; $n <= 5; $n++) {
                             //Delay necessary that the inquiry would manage to be processed
                             sleep(5);
                             //Make request to api for get document info by job id
                             $jobInfo = $api->GetJobDocuments($clientId, $job->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 failed");

                             }
                         }
                         //Get file guid
                         $guid = $jobInfo->result->inputs[0]->outputs[0]->guid;
                          //Get file name
                         $name = $jobInfo->result->inputs[0]->outputs[0]->name;
                         //Local path to the downloads folder
                         $downloadFolder = dirname(__FILE__). '/../downloads';
                         //Check is folder exist
                         if (!file_exists($downloadFolder)) {
                             //If folder don't exist create it
                             mkdir($downloadFolder);
                         }
                         //Obtaining file stream of downloading file and definition of folder where to download file
                         $outFileStream =  FileStream::fromHttp($downloadFolder, $name);
                         //Download file from GroupDocs.
                         $download = $apiStorage->GetFile($clientId, $guid, $outFileStream);

//Get fields from template

$fields = $docApi->GetTemplateFields($clientId, $fileGuId);

//Check status

if ($fields->status == "Ok") {

//Create new Datasource object

$dataSource = new Datasource();

//Create empty array

$array = array();

//Loop for fields creataion

for ($i = 0; $i < count($fields->result->fields); $i++) {

//Create new DatasourceField object

$field = new DatasourceField();

//Set DatasourceFiled data

$field->name = $fields->result->fields[$i]->name;

$field->type = "text";

$field->values = array("value1", "value2");

//Push DatasourceField to array

array_push($array, $field);

}

//Set array feilds array to the Datasourc

$dataSource->fields = $array;

//Add Datasource to GroupDocs

$addDataSource = $mergApi->AddDataSource($clientId, $dataSource);

//Check status

if ($addDataSource->status == "Ok") {

//If status ok merge Datasource to new pdf file

$job = $mergApi->MergeDatasource($clientId, $fileGuId, $addDataSource->result->datasource_id, "pdf", null);

//Check status

if ($job->status == "Ok") {

//### Check job status

for ($n = 0; $n <= 5; $n++) {

//Delay necessary that the inquiry would manage to be processed

sleep(5);

//Make request to api for get document info by job id

$jobInfo = $api->GetJobDocuments($clientId, $job->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 failed");

}

//Get file guid

$guid = $jobInfo->result->inputs[0]->outputs[0]->guid;

//Get file name

$name = $jobInfo->result->inputs[0]->outputs[0]->name;

//Local path to the downloads folder

$downloadFolder = dirname(__FILE__). '/../downloads';

//Check is folder exist

if (!file_exists($downloadFolder)) {

//If folder don't exist create it

mkdir($downloadFolder);

}

//Obtaining file stream of downloading file and definition of folder where to download file

$outFileStream = FileStream::fromHttp($downloadFolder, $name);

//Download file from GroupDocs.

$download = $apiStorage->GetFile($clientId, $guid, $outFileStream);

The logic is simple.

First, we get all the fields from the template DOCX file with the GetTemplateFields method. It takes the parameters client ID and template DOCX file GUID. The method returns an object with fields.
Now, create a DataSource object in which one of the parameters is a DataSourceFields array which we must create. We will put the field we get from template DOCX file into this array. This action occurs in this peace of code:

//Create empty array
                $array = array();
                //Loop for fields creataion
                for ($i = 0; $i < count($fields->result->fields); $i++) {
                    //Create new DatasourceField object
                    $field = new DatasourceField();
                    //Set DatasourceFiled data
                    $field->name = $fields->result->fields[$i]->name;
                    $field->type = "text";
                    $field->values = array("value1", "value2");
                    //Push DatasourceField to array
                    array_push($array, $field);
                }
                //Set array feilds array to the Datasourc
                $dataSource->fields = $array;

//Create empty array

$array = array();

//Loop for fields creataion

for ($i = 0; $i < count($fields->result->fields); $i++) {

//Create new DatasourceField object

$field = new DatasourceField();

//Set DatasourceFiled data

$field->name = $fields->result->fields[$i]->name;

$field->type = "text";

$field->values = array("value1", "value2");

//Push DatasourceField to array

array_push($array, $field);

}

//Set array feilds array to the Datasourc

$dataSource->fields = $array;

As you can see, the DataSourceFields object has a values parameter. Into this parameter we put an array of strings or only string which will be added to the field as content.

After creating the DataSource object, the next step is to add DataSource to GroupDocs for the convertion to PDF. This trick can be done as follows:

//Add Datasource to GroupDocs
                $addDataSource = $mergApi->AddDataSource($clientId, $dataSource);

1 2	//Add Datasource to GroupDocs $addDataSource = $mergApi->AddDataSource($clientId, $dataSource);

In response to this we get the datasource ID by which we can both merge it and convert to PDF, thus killing two birds with one stone.

Take the client ID, datasource ID, the original DOCX file GUID and put all of this into the MergeDatasource method. This request in code:

$job = $mergApi->MergeDatasource($clientId, $fileGuId, $addDataSource->result->datasource_id, "pdf", null);

1	$job = $mergApi->MergeDatasource($clientId, $fileGuId, $addDataSource->result->datasource_id, "pdf", null);

As you see, one of the input parameters is a string with type of the result file. When the API gets this request, it creates a new PDF file with merged fields.

Phew, we merged our fields to a new PDF file and now we can download it and see it in an iframe. The MergeDatasource method returns Job id using which in the GetJobDocuments method we get all the info about the new PDF file that we need, such is GUID and name.

To download it, create a FileStream which contains a local path for downloading the file:

//Obtaining file stream of downloading file and definition of folder where to download file
                         $outFileStream =  FileStream::fromHttp($downloadFolder, $name);

1 2	//Obtaining file stream of downloading file and definition of folder where to download file $outFileStream = FileStream::fromHttp($downloadFolder, $name);

After that use the GetFile method to download it: $download = $apiStorage->GetFile($clientId, $guid, $outFileStream);

You already know how to generate an iframe.

The only thing left is to call our function and return the new PDF file GUID to the template to show in the browser as an iframe. You already know how to do this too, if you've followed this article series.

And we're done!

Screenshots

Here are two screenshots that show the input form and the output file so you can see the process in action.

The input form

The output PDF

Two ways of uploading files into a GroupDocs account

Working with GroupDocs SDK we usually need a GUID to work with a document. But it's not very comfortable for users to work with GUIDs. So in your app, you can use two methods to upload a file to a GroupDocs account and get it's GUID programmatically.

Requirements

PHP 5.3
Apache ModRewrite
PHP Curl extension
PHP Sockets extension (php_sockets.dll)
GroupDocs PHP SDK
composer.phar (Download from http://getcomposer.org/download/ or use the included version.)
FatFree framework (https://github.com/bcosca/fatfree)

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.

Theory

Upload local file

To upload a local file we need an actual file. You can view many types to word processing documents (DOC, DOCX, TXT, RTF, ODT), presentations (PPT, PPTX), spreadsheets (XLS, XLSX), portable files (PDF), and image files (JPG, BMP, GIF, TIFF).

From GroupDocs PHP SDK we will need the following methods:

Upload
FileStream::fromFile

The template is simply an HTML form of the "multipart/form-data" type. This form sends date entered by the user (the client ID, private key and local file data) to the controller. The controller, in turn, gets the data, prepares it for an API request, makes the API request and receives the upload results from the API with info about the uploaded file.

Upload file from web

If you think this is going to be complicated, I have to disappoint you. With GroupDocs PHP SDK it's really simple than upload a local file.

To upload a file from the web, we need a direct link to the file. Everything else is the same as when uploading a local file, with the exception of the upload method. To do this trick we need only one method: uploadWeb. The logic of web uploading is the same as for local file upload.

Since the logic is the same we'll use same template and controller.

Practice

As before, create a template file in the template folder and a controller file in the inc_samples folder.

Template file code

<!DOCTYPE html>
<html lang="en">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
	<title>Upload</title>
	<style type="text/css">
		{{ Web::minify('templates/',array('style.css'),FALSE) }}
	</style>
</head>
<body>
<h3 style="text-align:center;"><a href="/index.php">GroupDocs PHP SDK Samples</a> - Upload</h3>

<div class='samplecontent' style="padding:10px;">
   <span class="description"><i>This sample will show how to upload file to GroupDocs using PHP SDK</i></span> <br/>
    <br />

   <br/><p>You entered:
   <p>ClientID = {{@userId}}
   <p>PrivateKey = {{@privateKey}}
   <p><font color="red">{{@error}}</font>
   <div id="requestForm" style="padding:20px; border:1px solid black;">

   <form action="controller" method = "post" enctype = 'multipart/form-data'>
       <label for='client_id'>GroupDocs ClientID</label>
       <br />
       <input type='text' name='client_id' value="{{@userId}}" />
       <br />
       <label for='private_key'>GroupDocs PrivateKey</label>
       <br />
       <input type='text' name='private_key'  value="{{@privateKey}}" />
       <br />
       <input type="radio" name="sourse" value="local" id="localField" onClick="display('local');" >Upload local file </input>
       <br />
       <input type="radio" name="sourse" value="url" id="urlField" onClick="display('url');" >Upload file from URL </input>
       <br />

       <label for='private_key' style="display:none;" id="url">Upload file from URL</label>
        <br />
        <input type='text' name='url'  value="" id="urlfield" style="display:none;" />

        <label for='file' id="file" style="display:none;">Upload local file</label>
        <br />
        <input type='file' name='file' id="filefield" style="display:none;" />
        <br />
       <label for='private_key'>Folder in which you want to copy file</label>
       <br />
       <input type='text' name='destPath'  value="{{@folder}}" />
       <br />
       <input type='submit' value='Make Request'/>
   </form>
   </div>
   <h4><font color="green">{{@message}}</font></h4>
   <br/>
 </div>

 <include href="links.htm" />
 <script type="text/javascript">
    function display(_element_id) {

             if (_element_id == "local") {
                 var element1 = document.getElementById("file");
                 var element2 = document.getElementById("filefield");
                 var element3 = document.getElementById("url");
                 var element4 = document.getElementById("urlfield");
                 element1.style.display = "inline";
                 element2.style.display = "inline";
                 element3.style.display = "none";
                 element4.style.display = "none";

             }

             if (_element_id == "url") {
                 var element1 = document.getElementById("url");
                 var element2 = document.getElementById("urlfield");
                 var element3 = document.getElementById("file");
                 var element4 = document.getElementById("filefield");
                 element1.style.display = "inline";
                 element2.style.display = "inline";
                 element3.style.display = "none";
                 element4.style.display = "none";

             }

         }
</script>
</body>
</html>

<!DOCTYPE html>

<head>

<title>Upload</title>

</style>

</head>

<body>

<h3 style="text-align:center;"><a href="/index.php">GroupDocs PHP SDK Samples</a> - Upload</h3>

<span class="description"><i>This sample will show how to upload file to GroupDocs using PHP SDK</i></span> <br/>

<br />

<br/><p>You entered:

<p>ClientID = {{@userId}}

<p>PrivateKey = {{@privateKey}}

<p><font color="red">{{@error}}</font>

<label for='client_id'>GroupDocs ClientID</label>

<br />

<br />

<label for='private_key'>GroupDocs PrivateKey</label>

<br />

<br />

<input type="radio" name="sourse" value="local" id="localField" onClick="display('local');" >Upload local file </input>

<br />

<input type="radio" name="sourse" value="url" id="urlField" onClick="display('url');" >Upload file from URL </input>

<br />

<label for='private_key' style="display:none;" id="url">Upload file from URL</label>

<br />

<label for='file' id="file" style="display:none;">Upload local file</label>

<br />

<br />

<label for='private_key'>Folder in which you want to copy file</label>

<br />

<br />

</form>

</div>

<h4><font color="green">{{@message}}</font></h4>

<br/>

</div>

function display(_element_id) {

if (_element_id == "local") {

var element1 = document.getElementById("file");

var element2 = document.getElementById("filefield");

var element3 = document.getElementById("url");

var element4 = document.getElementById("urlfield");

element1.style.display = "inline";

element2.style.display = "inline";

element3.style.display = "none";

element4.style.display = "none";

}

if (_element_id == "url") {

var element1 = document.getElementById("url");

var element2 = document.getElementById("urlfield");

var element3 = document.getElementById("file");

var element4 = document.getElementById("filefield");

element1.style.display = "inline";

element2.style.display = "inline";

element3.style.display = "none";

element4.style.display = "none";

}

</script>

</body>

</html>

Let's investigate this code. This is a simple HTML document with JavaScript. To select the file source (local or web) we've added a switch:

<input type="radio" name="sourse" value="local" id="localField" onClick="display('local');" >Upload local file </input>

1	<input type="radio" name="sourse" value="local" id="localField" onClick="display('local');" >Upload local file </input>

This switch calls the JavaScript function display. This function receives one parameter which specifies the source of the file: local or web. Where local = upload local file and url = upload file from web. Toggling the switch displays the corresponding input field.

OK, it's clear how the template works - it's simple enough. Let's take a look at the controller.

Controller code

//###Set variables and get POST data
    F3::set('userId', '');
    F3::set('privateKey', '');
    $clientId = F3::get('POST["client_id"]');
    $privateKey = F3::get('POST["private_key"]');
    $width = f3::get('POST["width"]');
    $height = f3::get('POST["height"]');

    function upload($clientId, $privateKey, $width='400', $height='650')
    {
        //###Check fileGuId
        if (empty($clientId) || empty($privateKey)) {
            throw new Exception('Please enter all required parameters');
        } else {
            F3::set('userId', $clientId);
            F3::set('privateKey', $privateKey);
            //Get base path
            $basePath = f3::get('POST["server_type"]');
            //Get entered by user data
            $fileGuId = "";
            $url = F3::get('POST["url"]');
            $file = $_FILES['file'];
            //###Create Signer, ApiClient and Storage Api objects

            //Create signer object
            $signer = new GroupDocsRequestSigner($privateKey);
            //Create apiClient object
            $apiClient = new APIClient($signer);
            //Create Storage Api object
            $api = new StorageApi($apiClient);
            //Check if user choose upload file from URL
            if ($url != "") {
                //Upload file from URL
                $uploadResult = $api->UploadWeb($clientId, $url);
                //Check is file uploaded
                if ($uploadResult->status == "Ok") {
                    //Get file GUID
                    $fileGuId = $uploadResult->result->guid;

                //If it isn't uploaded throw exception to template
                } else {
                    throw new Exception($uploadResult->error_message);
                }
            }
            //Check is user choose upload local file
            if ($_FILES['file']["name"] != "") {
                //Temp name of the file
                $tmp_name = $file['tmp_name'];
                //Original name of the file
                $name = $file['name'];
                //Creat file stream
                $fs = FileStream::fromFile($tmp_name);
                //###Make a request to Storage API using clientId
                //Upload file to current user storage
                $uploadResult = $api->Upload($clientId, $name, 'uploaded', "", $fs);

                //###Check if file uploaded successfully
                if ($uploadResult->status == "Ok") {
                    //Get file GUID
                    $fileGuId = $uploadResult->result->guid;

                //If it isn't uploaded throw exception to template
                } else {
                    throw new Exception($uploadResult->error_message);
                }
            }
            //Generation of iframe URL using fileGuId
            $iframe = 'http://apps.groupdocs.com/document-viewer/embed/' . $fileGuId . '?frameborder="0" width=' . $width . 'height=' . $height;
            //If request was successfull - set url variable for template
            f3::set('fileId', $fileGuId);
            return f3::set('url', $iframe);
        }
    }

    try {
        upload($clientId, $privateKey, $width, $height);
    } catch(Exception $e) {
        $error = 'ERROR: ' .  $e->getMessage() . "\n";
        f3::set('error', $error);
    }
    //Process template
    F3::set('userId', $clientId);
    F3::set('privateKey', $privateKey);
    F3::set('width', $width);
    F3::set('height', $height);

    echo Template::serve('template.htm');

//###Set variables and get POST data

F3::set('userId', '');

F3::set('privateKey', '');

$clientId = F3::get('POST["client_id"]');

$privateKey = F3::get('POST["private_key"]');

$width = f3::get('POST["width"]');

$height = f3::get('POST["height"]');

function upload($clientId, $privateKey, $width='400', $height='650')

{

//###Check fileGuId

if (empty($clientId) || empty($privateKey)) {

throw new Exception('Please enter all required parameters');

} else {

F3::set('userId', $clientId);

F3::set('privateKey', $privateKey);

//Get base path

$basePath = f3::get('POST["server_type"]');

//Get entered by user data

$fileGuId = "";

$url = F3::get('POST["url"]');

$file = $_FILES['file'];

//###Create Signer, ApiClient and Storage Api objects

//Create signer object

$signer = new GroupDocsRequestSigner($privateKey);

//Create apiClient object

$apiClient = new APIClient($signer);

//Create Storage Api object

$api = new StorageApi($apiClient);

//Check if user choose upload file from URL

if ($url != "") {

//Upload file from URL

$uploadResult = $api->UploadWeb($clientId, $url);

//Check is file uploaded

if ($uploadResult->status == "Ok") {

//Get file GUID

$fileGuId = $uploadResult->result->guid;

//If it isn't uploaded throw exception to template

} else {

throw new Exception($uploadResult->error_message);

}

//Check is user choose upload local file

if ($_FILES['file']["name"] != "") {

//Temp name of the file

$tmp_name = $file['tmp_name'];

//Original name of the file

$name = $file['name'];

//Creat file stream

$fs = FileStream::fromFile($tmp_name);

//###Make a request to Storage API using clientId

//Upload file to current user storage

$uploadResult = $api->Upload($clientId, $name, 'uploaded', "", $fs);

//###Check if file uploaded successfully

if ($uploadResult->status == "Ok") {

//Get file GUID

$fileGuId = $uploadResult->result->guid;

//If it isn't uploaded throw exception to template

} else {

throw new Exception($uploadResult->error_message);

}

//Generation of iframe URL using fileGuId

$iframe = 'http://apps.groupdocs.com/document-viewer/embed/' . $fileGuId . '?frameborder="0" width=' . $width . 'height=' . $height;

//If request was successfull - set url variable for template

f3::set('fileId', $fileGuId);

return f3::set('url', $iframe);

}

try {

upload($clientId, $privateKey, $width, $height);

} catch(Exception $e) {

$error = 'ERROR: ' . $e->getMessage() . "\n";

f3::set('error', $error);

}

//Process template

F3::set('userId', $clientId);

F3::set('privateKey', $privateKey);

F3::set('width', $width);

F3::set('height', $height);

echo Template::serve('template.htm');

Now let's analyze the blocks of code we have here.

    F3::set('userId', '');
    F3::set('privateKey', '');
    $clientId = F3::get('POST["client_id"]');
    $privateKey = F3::get('POST["private_key"]');
    $width = f3::get('POST["width"]');
    $height = f3::get('POST["height"]');

F3::set('userId', '');

F3::set('privateKey', '');

$clientId = F3::get('POST["client_id"]');

$privateKey = F3::get('POST["private_key"]');

$width = f3::get('POST["width"]');

$height = f3::get('POST["height"]');

In this block we get the data from the form transfered by the POST method with the Fatfree method F3::get which gives access to the global arrays such as POST, GET, FILE and SERVER. When we have collected the entered data, we can create a function which will do the job and we will have the ability to check every steps and get errors if there are any. Our function will get four parameters: client ID, private key, width and height (we need width and height for the iframe that will show the uploaded file).

function upload($clientId, $privateKey, $width='400', $height='650')

1	function upload($clientId, $privateKey, $width='400', $height='650')

First of all, we must check whether the client ID and private key are entered. Without this data we can't do anything. Check it with this code:

 if (empty($clientId) || empty($privateKey)) {
            throw new Exception('Please enter all required parameters');

1 2	if (empty($clientId) \|\| empty($privateKey)) { throw new Exception('Please enter all required parameters');

If we have this data, we can proceed to the next code block:

F3::set('userId', $clientId);
F3::set('privateKey', $privateKey)
//Get base path
$basePath = f3::get('POST["server_type"]');
//Get entered by user data
$fileGuId = "";
$url = F3::get('POST["url"]');
$file = $_FILES['file'];
//###Create Signer, ApiClient and Storage Api objects

F3::set('userId', $clientId);

F3::set('privateKey', $privateKey)

//Get base path

$basePath = f3::get('POST["server_type"]');

//Get entered by user data

$fileGuId = "";

$url = F3::get('POST["url"]');

$file = $_FILES['file'];

//###Create Signer, ApiClient and Storage Api objects

Here we set user data for template and get the rest of the entered data from the form, such as the URL of a web file and the location of the local file. Later, we will check which fields are chosen by this data. Now we must create objects which will set up the relationships with the GroupDocs API and user account. This code does that:

//Create signer object
 $signer = new GroupDocsRequestSigner($privateKey);
 //Create apiClient object
 $apiClient = new APIClient($signer);
 //Create Storage Api object
 $api = new StorageApi($apiClient);

//Create signer object

$signer = new GroupDocsRequestSigner($privateKey);

//Create apiClient object

$apiClient = new APIClient($signer);

//Create Storage Api object

$api = new StorageApi($apiClient);

So we can check from where we're about to upload the file and then upload it. To check if the user choose to upload a file from the web, and to upload the file, use this code:

//Check if user choose upload file from URL
            if ($url != "") {
                //Upload file from URL
                $uploadResult = $api->UploadWeb($clientId, $url);
                //Check is file uploaded
                if ($uploadResult->status == "Ok") {
                    //Get file GUID
                    $fileGuId = $uploadResult->result->guid;

                //If it isn't uploaded throw exception to template
                } else {
                    throw new Exception($uploadResult->error_message);
                }
            }

//Check if user choose upload file from URL

if ($url != "") {

//Upload file from URL

$uploadResult = $api->UploadWeb($clientId, $url);

//Check is file uploaded

if ($uploadResult->status == "Ok") {

//Get file GUID

$fileGuId = $uploadResult->result->guid;

//If it isn't uploaded throw exception to template

} else {

throw new Exception($uploadResult->error_message);

}

This block does all the magic uploading a file from the web. As you can see we check whether $url is an empty string. If it is not empty, the user has selected to upload a file from the web and we use the URL. To upload the file, we make a request to the UploadWeb method with the client ID and the URL for the file:

$uploadResult = $api->UploadWeb($clientId, $url);

1	$uploadResult = $api->UploadWeb($clientId, $url);

Thats all for web uploading. Simple, yes?

OK in response to this method we have an object with an array of all the info for this file such as the GUID, name, type and so on. To show this file in an iframe, we only need the GUID. We can get GUID easily:

$fileGuId = $uploadResult->result->guid;

1	$fileGuId = $uploadResult->result->guid;

If uploadWeb fails we get an error message:

$uploadResult->error_message

1	$uploadResult->error_message

But what if the user wants to upload a local file? We can check if they do, and if so upload the local file with this code:

//Check is user choose upload local file
            if ($_FILES['file']["name"] != "") {
                //Temp name of the file
                $tmp_name = $file['tmp_name'];
                //Original name of the file
                $name = $file['name'];
                //Creat file stream
                $fs = FileStream::fromFile($tmp_name);
                //###Make a request to Storage API using clientId
                //Upload file to current user storage
                $uploadResult = $api->Upload($clientId, $name, 'uploaded', "", $fs);

                //###Check if file uploaded successfully
                if ($uploadResult->status == "Ok") {
                    //Get file GUID
                    $fileGuId = $uploadResult->result->guid;

                //If it isn't uploaded throw exception to template
                } else {
                    throw new Exception($uploadResult->error_message);
                }
            }

//Check is user choose upload local file

if ($_FILES['file']["name"] != "") {

//Temp name of the file

$tmp_name = $file['tmp_name'];

//Original name of the file

$name = $file['name'];

//Creat file stream

$fs = FileStream::fromFile($tmp_name);

//###Make a request to Storage API using clientId

//Upload file to current user storage

$uploadResult = $api->Upload($clientId, $name, 'uploaded', "", $fs);

//###Check if file uploaded successfully

if ($uploadResult->status == "Ok") {

//Get file GUID

$fileGuId = $uploadResult->result->guid;

//If it isn't uploaded throw exception to template

} else {

throw new Exception($uploadResult->error_message);

}

To upload a local file we must get its name, assign it a temporary name and convert it to a FileStream. The first two we can get as usual for multipart/form-data:

//Temp name of the file
                $tmp_name = $file['tmp_name'];
                //Original name of the file
                $name = $file['name'];

//Temp name of the file

$tmp_name = $file['tmp_name'];

//Original name of the file

$name = $file['name'];

And to convert the file to FileStream in the GroupDocs PHP SDK we have very cool thing: FileStream::fromFile. This function gets the file's temp name and returns a FileStream. Now we can send request to the GroupDocs API to upload the local file. The Upload file method get such parameters as client ID, local file name, description(string), callback URL (in this sample we'll use an empty string but if you want to, you can specify it) and FileStream. In the response object for the UploadWeb method we get info about the uploaded file. If the request failed, we get an error message.

Displaying the file

We've finished the upload and now we have only to generate an iframe and call our function.

//Generation of iframe URL using fileGuId
            $iframe = 'http://apps.groupdocs.com/document-viewer/embed/' . $fileGuId . '?frameborder="0" width=' . $width . 'height=' . $height;
            //If request was successfull - set url variable for template
            f3::set('fileId', $fileGuId);
            return f3::set('url', $iframe);
        }
    }

    try {
        upload($clientId, $privateKey, $width, $height);
    } catch(Exception $e) {
        $error = 'ERROR: ' .  $e->getMessage() . "\n";
        f3::set('error', $error);
    }
    //Process template
    F3::set('userId', $clientId);
    F3::set('privateKey', $privateKey);
    F3::set('width', $width);
    F3::set('height', $height);

    echo Template::serve('template.htm');

//Generation of iframe URL using fileGuId

$iframe = 'http://apps.groupdocs.com/document-viewer/embed/' . $fileGuId . '?frameborder="0" width=' . $width . 'height=' . $height;

//If request was successfull - set url variable for template

f3::set('fileId', $fileGuId);

return f3::set('url', $iframe);

}

try {

upload($clientId, $privateKey, $width, $height);

} catch(Exception $e) {

$error = 'ERROR: ' . $e->getMessage() . "\n";

f3::set('error', $error);

}

//Process template

F3::set('userId', $clientId);

F3::set('privateKey', $privateKey);

F3::set('width', $width);

F3::set('height', $height);

echo Template::serve('template.htm');

The code in action

Thats all. Below are a couple of screenshots that show how it looks in action.

The input form

The iframe showing the uploaded document

GroupDocs Apps v2.4 – Features and Fixes

We’ve implemented a few new features as well as fixed some major & minor bugs lately. Let’s have a detailed look:

GroupDocs Annotation

GroupDocs Annotation is an online document annotation app that lets you easily annotate documents and perform document collaboration simply using your browser. Using GroupDocs’ efficient document annotation app, you can annotate and collaborate on Word, PDF, or Excel documents, just to name a few.

Features Implemented

Major

[ANNOTATION-232] Broadcast of horizontal scroll, broadcast of window size percentage when scaling, and support for master and slaves in real-time mode.

Bugs fixed

Critical:

[ANNOTATION-220] If a user is registered as a reviewer for multiple documents, he will receive all broadcasted operations into each open document.
[ANNOTATION-226] Export "Normal" raises an error.
[ANNOTATION-230] Downloading an annotated document by using a direct file link fails.

Major:

[ANNOTATION-225] The background color of the pages and thumbnails is transparent, which creates flashes when they are being loaded.
[ANNOTATION-228] Annotation v.2. The document should expand when the RHS toolbar is collapsed.
[ANNOTATION-223] Annotation v.2. An iPhone-styled button for switching between broadcast and screen drag, disable pinch to shrink and pullout to magnify, and a setting for removing the toolbar completely.
[ANNOTATION-222] Annotation 2. Search doesn't find the searched text.

Minor

[ANNOTATION-224] Text selection is shifted 1 pixel to the right and 1-2 pixels up from the correct position.
[ANNOTATION-227] The "standard header is always shown" option.

GroupDocs Viewer

GroupDocs Viewer is an efficient online document viewer that lets you view documents online simply using a browser. Since GroupDocs Viewer supports all common and business file formats, it can be used as a PDF viewer, Word viewer, Excel viewer, amongst many others.

Features Implemented

Major

[WEB-346] Client side code for the installable Viewer.
[WEB-347] JavaScript-based NavigationWidget.
[WEB-348] JavaScript-based ZoomingWidget.
[WEB-351] Installable Viewer: JS document viewer adapter without user ID / private key dependencies, working when some widgets are disabled.

Minor
- [WEB-342] Update document viewer 1.0 header.
- [WEB-352] The PortalService for the installable Viewer.

Bugs fixed

Minor

[WEB-343] Document print doesn't work in the embedded viewer.

GroupDocs Assembly

GroupDocs Assembly is an efficient document automation and document assembly app that lets you perform document assembly in a jiffy. With GroupDocs Assembly, you can prepare a document for document assembly by adding questionnaires to it and then send out this document to collect responses. Your customers can then add answers to the questionnaires and perform document assembly easily. Document automation and document assembly using GroupDocs Assembly lets you save your time and effort.

Features Implemented

Major

[DA-144] WYSIWYG support for questionnaire answers.
[DA-148] Web hook for the document assembly job.

Bugs fixed

Major:

[DA-145] Long questions and answers word-wrap.

GroupDocs Signature

GroupDocs Signature is an efficient digital signature service, which is completely web-based. GroupDocs' easy-to-use digital signature service lets you collect digital signatures with no administrative overhead of printing, envelope stuffing and posting.

Features Implemented

[SIGN-967] - Signature2: Signed view for envelopes.
[SIGN-968] - Signature 2: Signed embedded view for envelopes.

Improvements

[SIGN-942] - Signature 2: New status icons for envelopes and forms.
[SIGN-949] - Implement async signing of the signature envelopes.
[SIGN-950] - Adopt signed screen and signed embedded screen to work with async envelope signing process.
[SIGN-956] - Signature 2: Implement envelope-embed signing.
[SIGN-957] - Signature 2: Improve the user experience after clicking "New Envelope" in the envelopes dashboard.
[SIGN-961] - Signature 2: Improve the user experience after clicking "New Form" in the forms dashboard.
[SIGN-980] - Implement changes in envelope.create and envelope.modify
[SIGN-981] - New settings while preparing envelope in signature 1 and signature 2.
[SIGN-983] - Signature 2: Implement embed signed screen.
[SIGN-995] - Implement create envelope from envelope in signature 1 and signature 2.
[SIGN-999] - Increase recipient name's length for envelopes.
[SIGN-1005] - Default value for "Include embed link .." settings for envelope should be true.
[SIGN-940] - Signature 2: Implement template preparation wizard.
[SIGN-969] - Signature 2: Forms: recheck that the forms signing is working and apply fixes if not.
[SIGN-998] - Display error messages in embedded signature as a popup.
[SIGN-1014] - Signatrure 1: From archived envelopes, the user should be able to copy the envelope and start over.
[SIGN-1015] - Signature 1: Ensure that recipients with role CC are not included in the recipients' dropdown list in fields preparation.
[SIGN-1016] - Signature 1: For CC recipients, show the embed link button in envelopes dashboard only when envelope is completed.
[SIGN-1018] - Signature 1: Do not show embed link button in envelopes dash board for envelopes with status expired and draft.
[SIGN-1019] - Signature 1: In forms dashboard, add Publish Form in the context menu for draft forms.
[SIGN-1027] - Signature 2: Envelopes: Do not show fields summary on step 6 in envelope preparation wizard.

Bugs fixed

[SIGN-853] When envelope is signed from the embeddable view, the notification to callback url is not sent.
[SIGN-919] - Demo performance.
[SIGN-927] - Signature 2: Envelopes dashboard, and statuses overlaps the envelope name.
[SIGN-935] - Forms: Form preparation wizard, fields settings: remove all jquery selectors.
[SIGN-944] - Signature 2: Envelopes dashboard, the paging on scrolling does not work properly.
[SIGN-945] - Fix template.recipient.add and template.recipient api methods response.
[SIGN-946] - Sign embed requires login.
[SIGN-947] - Demo signature on send envelope shows error message.
[SIGN-951] - Create public API method to retrieve envelope details.
[SIGN-952] - Fix the signatureEnvelopeDetails widget to use public API method if the viewing mode is public.
[SIGN-953] - Clear the signed document thumbnails, so the most recent pages to be shown in the viewer.
[SIGN-954] - Signature 2: In the sign envelope screen, in the signature creation popup, the font for written signature are not initialized correctly.
[SIGN-955] - Signature 2: If we close the signature popup with ESC key, it can't be shown anymore.
[SIGN-962] - Signature 2: If archived forms list is empty, the select all checkbox is selected.
[SIGN-963] - AddContactIntegration raises error.
[SIGN-964] - Add drop-down field doesn't set acceptableValues and defaultValue.
[SIGN-966] - Inconsistency in signature API boolean parameters.
[SIGN-970] - Comparing word files with revisions information in them is failing.
[SIGN-971] - Cannot add two files with the same name, but different extension to envelope.
[SIGN-972] - If there is drop-down field without list with values, the envelope should not be able to be send.
[SIGN-973] - If there is a drop-down field without list with values, the form should not be able to be published
[SIGN-974] - Drop-down value is reset to the default value on reload even if there is already-set user's value.
[SIGN-975] - If envelope is with status completed, the URL in embed popup should lead to signed envelope.
[SIGN-976] - Signature 1: Incorrect behavior of tab key in signing screen.
[SIGN-978] - Signature 2: Ensure that if error is returned from the web service, the corresponded error message will be displayed.
[SIGN-979] - Extend audit logging to log send and sign events.
[SIGN-982] - Cleanup code in the signature 1 and signature 2 controllers.
[SIGN-984] - Forms: Incorrect document displayed after signing.
[SIGN-985] - Incorrect full name calculation.
[SIGN-986] - CreateSignatureTemplate multiple issues.
[SIGN-987] - AddSignatureTemplateRecipient returns null in template identifier.
[SIGN-988] - Signature 1: Broken layout in templates dashboard if there are no any templates.
[SIGN-989] - DeleteSignatureTemplateDocument raises error.
[SIGN-990] - Upload file in create template wizard fails.
[SIGN-991] - Signature 2: After confirm signing, the user is redirected to login screen if not logged in before.
[SIGN-992] - After the envelope is sent, the owner is included as signer even if it was not set as signer while preparing the nvelope.
[SIGN-993] - UpdateSignatureFormFromTemplate raises error.
[SIGN-994] - Typo in signature envelope API methods.
[SIGN-996] - The final email notification for signed envelope is not send at all.
[SIGN-997] - The owner of the envelope could not see the signed documents if he is not in the signers list.
[SIGN-1000] - Embed signature is not working in IE8.
[SIGN-1001] - Document viewer in signature 2 throws javascript error.
[SIGN-1002] - After envelope deletion, files associated with the envelope are staying.
[SIGN-1003] - After template deletion, files associated with the template are staying.
[SIGN-1004] - After form deletion, files associated with the form are staying.
[SIGN-1007] - Replace using of GetTempFileName with GetRandomFileName.
SIGN-1013] - Signature 1: Audit log layout is broken.
[SIGN-1017] - Signature 1: Embed sign: Always shows the error popup, even if no error.
[SIGN-1020] - Notification emails are not send to the recipient with role CC.
[SIGN-1021] - Change the title of the audit log popup.
[SIGN-1022] - Signature 2: Javascript error in the signed envelope page.
[SIGN-1031] - Do not include the recipients that have role canSign false at the last page of the signed document.
[SIGN-1033] - Fixes in embed signing.
[SIGN-1034] - Signature template API: fields should not be assigned to the recipient with role CC.
[SIGN-1036] - Fix the viewer in signature 1.
[SIGN-1037] - Signature 2: Embed sign screen shows start button on each page.
[SIGN-1038] - Signature 2: Embed signed screen is not working in IE 8.
[SIGN-1039] - All dashboards in signature do not work IE8.

GroupDocs Comparison

GroupDocs Comparison is an online document comparison app that allows you to easily compare documents online. This way, you can monitor changes, consolidate different document versions and confirm that your documents are up to date. GroupDocs Comparison combines the two documents and highlights the difference in redline.

Features Implemented

[DOCOMPARE-200] - Embeddable comparison result.

Improvements

[DOCOMPARE-211] - Confirm and embed dialog design update in comparison 2.

Bugs fixed

[DOCOMPARE-202] - Doc files comparison fails when there are embed images and ole objects.
[DOCOMPARE-204] - After first comparison, the GetChanges method is called multiple times.
[DOCOMPARE-205] - Can't load the output document after comparison is completed and the UI is blocked.
[DOCOMPARE-206] - Add embed button in comparison 2.
[DOCOMPARE-208] - Fixing issues in comparison 2 embed link generation and display.
[DOCOMPARE-212] - Comparing two different docx files fails.
[DOCOMPARE-213] - Comparing simple Excel files fails.
[DOCOMPARE-214] - Comparing pdf files fails.
[DOCOMPARE-215] - Comparing html files fails.
[DOCOMPARE-216] - Calling job-output API method with empty or null jobId should not be possible.
[DOCOMPARE-217] - Comparison 1: After the comparison completion, the results are not displayed.
[DOCOMPARE-219] - Comparison viewer not working because of changes in the viewer adapter.

Platform

Features Implemented

Major

[CORE-859] Asynchronous PDF to XML conversion.
[CORE-858] Reusable file open dialog.
[CORE-873] Web hook trigger for the document viewing job.

Minor

[CORE-885] Integration with Aspose forums.

Bugs fixed

Critical

[CORE-884] Multiple instances of explorer plug-in do not work on the same page.
[CORE-892] Server-side processing fails for non-pdf file formats.

Minor
- [CORE-853] Custom-embedded logo cannot be reset.

Dashboard

Features Implemented

Major
- [CORE-831] Document post-upload processing indicator.

Bugs fixed

Major:

[CORE-840] Google Cloud. Dashboard convert redirects to null.
[CORE-882] "Upgrade" link points to old profile settings page.

Minor

[CORE-733] Folder lacks "Archive" context menu entry.
[CORE-793] Context menu for the last file is not full visible.
[CORE-844] Dashboard. Cannot cancel conversion.
[CORE-887] Chrome drag & drop fail to upload multiple files.

API

Features Implemented

[CORE-838] Dynabic subscription cancellation event handler.
[CORE-833] Pulling document pages image out of a 3rd-party storage.
[CORE-865] Generic prices for subscription plans support.
[CORE-869] Random file name generation function for storage providers.
[CORE-888] Document version number for document page image URL.
[CORE-889] Path.GetTempFileName replacement.
[CORE-893] Access level validation for file system folders.

Bugs fixed

[CORE-855] Large file uploads to Amazon S3 fails.
[CORE-866] Cannot upload PDF file.
[CORE-837] CSV file cannot be viewed.
[CORE-839] Update account user method creates users those already exist in the system.
[CORE-861] Number of users is not updated for Enterprise subscriptions.
[CORE-864] Thumbnails are not uploaded to Amazon when switching udf-pdf option on/off.
[CORE-871] Output document format is wrong for assembly jobs.
[CORE-872] Free space is improperly calculated on documents upload.
[CORE-387] datasource.remove returns 400 Bad Request
[CORE-389] doc.questionnaire.remove returns 400 Bad Request

We'll bring you latest news on "Features & Fixes" upon each new release, so stay tuned!

How to perform Callbacks with GroupDocs PHP SDK

This article explains the basics of using PHP SDK callbacks. In this article I'll use the Convert API. Find information about other methods in the Swagger explorer.

Requirements

PHP 5.3
Apache ModRewrite
PHP Curl extension
PHP Sockets extension (php_sockets.dll)
GroupDocs PHP SDK
composer.phar (Download from http://getcomposer.org/download/ or use the included version)
FatFree framework (https://github.com/bcosca/fatfree)

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.

Theory

First of all let's familiarize ourselves with Callback and the logic we will implement.

Callback

A callback is something like "Action" in HTML forms, a URL that will be executed by the server when a job is done. In this article we will use the Convert API and Convert method to convert a file from DOC to PDF. One of parameters of this method is a callback URL.

The logic

User enters data into the form.
The data is transfered by POST to the controller.
The controller processes the received data (converts the file) and writes the user ID and private key to the text file for the Callback handler. After that, the controller returns the converted file GUID to the template.
After conversion, the server calls the callback handler.
The callback handler reads the user ID and private key from text file and makes a request to the Storage API to download the converted file.
At same time that the server calls the callback URL, the template file shows the conversion results in an iframe and sends an Ajax request to the Ajax handler.
The Ajax handler checks the "downloads" folder for the downloaded file. If file is there, handler gets the file name and returns it to the template.
If file was downloaded, Ajax also sends a request to the download file handler to generate the download file dialog.

Practice

Now we must create our files:

The first file is the template file in the template folder.
The second file is the controller which is saved to the inc_samples folder.
THe other two files live in the callbacks subfolder in the inc_samples folder.

The structure looks like this:

As you can see from screenshot we must create five files:

template.htm
controller.php
convert_callback.php
check_file.php
download_file.php

So let's start in stages.

template.html

In the template folder, create the template.htm file. This file shows the page with the input form and performs an Ajax request. Now put in this code:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>Powered by {{ @VERSION }}</title>
    <style type="text/css">
        {{ Web::minify('templates/',array('style.css'),FALSE) }}
    </style>
	<script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js" ></script>
</head>
<body>

<h3 style="text-align:center;"><a href="/index.php">GroupDocs PHP SDK Samples</a> - Convert</h3>

<div class='samplecontent' style="padding:10px;">
    <span class="description"><i>This sample will show how to convert Doc to Docx, Docx to Doc, Docx and DOC to PDF and PPT to PDF, HTML to DOC and DOCX using PHP SDK</i></span> <br/>
    <br />
    <span class="documentation"><a href="/docs/sample18.html">Docs for this sample</a></span>
    <br />
    <p><font color="green">You entered: </font></p>
		<p>ClientID = {{@userId}}</p>
		<p>Private Key = {{@privateKey}}</p>
		<p>File Id = {{@fileId}} </p>
		<p>Convert type = {{@convert_type}}</p>
    <br />
    <p><font color="red">{{@error}}</font>
    <div id="requestForm" style="padding:20px; border:1px solid black;">
        <p> Enter data for request and press "Make request" button </p>
        <form action="/controller" method = "post" enctype = 'multipart/form-data'>
            <label for='client_id'>GroupDocs Client ID</label>
            <br />
            <input type='text', name='client_id' value="{{@userId}}" />
            <br />
            <label for='private_key'>GroupDocs Private Key</label>
            <br />
            <input type='text', name='private_key'  value="{{@privateKey}}" />
            <br />
            <label for='private_key' id="guid">GroupDocs fileID</label>
            <br />
            <input type='text', name='fileId' id="guidfield" value="{{@fileId}}" />
            <br />
            <label for='callbackUrl'>callbackUrl<span class="optional">(Optional)</span></label>
            <br />
            <input type='text', name='callbackUrl'  value="{{@callbackUrl}}" />
            <br />
            <input type='submit' value='Make Request'/>
            <select name="convert_type" id="convert_type">
                            <option value="doc">Doc</option>
                            <option value="pdf">PDF</option>
                            <option value="docx">Docx</option>
                            <option value="ppt">PPT</option>
            </select>
            <span id="results_status" style="color:red;display:none;"> (Please wait for ajax response) </span>
            <div id="link"></div>
        </form>
        <br />
        <iframe id="downloadframe" style="display:none"></iframe>
    </div>
    <div  id="result" style="padding:20px; border:1px solid black;">
        <p> Results: </p>
        <p><font color="red">{{@error_message}}</font>
        <iframe src="{{ @iframe }}"></iframe>
    </div>
</div>

 <script type="text/javascript">
     $(document).ready(setTimeout(check, 5000));

         function check() {

             if (($("input[name=callbackUrl]").val() != "") && (document.getElementById("result") != null)) {
                 $('#results_status').fadeIn("slow");
                 form = document.forms.form;
                 $.ajax({
                     type: 'POST',
                     url: '/callbacks/check_file',
                     success: function (data) {
                         $('#results_status').fadeOut("slow");
                         div = document.getElementById("link");
                         p = document.createElement("p");
                         p.innerHTML = "<br /> File " + data + " was downloaded.";
                         div.appendChild(p);
                         $("#downloadframe").attr("src", "/callbacks/download_file?FileName=" + data);
                     },
                     dataType: "text"
                 });
             }
         }

</script>
</body>
</html>

<!DOCTYPE html>

<head>

<title>Powered by {{ @VERSION }}</title>

</style>

</head>

<body>

<h3 style="text-align:center;"><a href="/index.php">GroupDocs PHP SDK Samples</a> - Convert</h3>

<span class="description"><i>This sample will show how to convert Doc to Docx, Docx to Doc, Docx and DOC to PDF and PPT to PDF, HTML to DOC and DOCX using PHP SDK</i></span> <br/>

<br />

<span class="documentation"><a href="/docs/sample18.html">Docs for this sample</a></span>

<br />

<p><font color="green">You entered: </font></p>

<p>ClientID = {{@userId}}</p>

<p>Private Key = {{@privateKey}}</p>

<p>File Id = {{@fileId}} </p>

<p>Convert type = {{@convert_type}}</p>

<br />

<p><font color="red">{{@error}}</font>

<p> Enter data for request and press "Make request" button </p>

<label for='client_id'>GroupDocs Client ID</label>

<br />

<br />

<label for='private_key'>GroupDocs Private Key</label>

<br />

<br />

<label for='private_key' id="guid">GroupDocs fileID</label>

<br />

<br />

<label for='callbackUrl'>callbackUrl<span class="optional">(Optional)</span></label>

<br />

<br />

</select>

<span id="results_status" style="color:red;display:none;"> (Please wait for ajax response) </span>

</form>

<br />

</div>

<p> Results: </p>

<p><font color="red">{{@error_message}}</font>

</div>

$(document).ready(setTimeout(check, 5000));

function check() {

if (($("input[name=callbackUrl]").val() != "") && (document.getElementById("result") != null)) {

$('#results_status').fadeIn("slow");

form = document.forms.form;

$.ajax({

type: 'POST',

url: '/callbacks/check_file',

success: function (data) {

$('#results_status').fadeOut("slow");

div = document.getElementById("link");

p = document.createElement("p");

p.innerHTML = "<br /> File " + data + " was downloaded.";

div.appendChild(p);

$("#downloadframe").attr("src", "/callbacks/download_file?FileName=" + data);

dataType: "text"

});

}

</script>

</body>

</html>

I will not explain the HTML part of this code since it is a usual HTML document. But we have a JavaScript so let's take a look at that.

First we must include a Jquery library for Ajax requests. This code in the "Head" is responsible for this:

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js" ></script>

1	<script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js" ></script>

After that we can use Ajax. Now the Ajax code:

<script type="text/javascript">
     $(document).ready(setTimeout(check, 5000)); //Wait 5 sec. after page loaded and run "check" function

         function check() {

             if (($("input[name=callbackUrl]").val() != "") && (document.getElementById("result") != null)) { //Check is this first time page loaded
                 $('#results_status').fadeIn("slow"); //Chow message

                //Ajax request
               $.ajax({
                     type: 'POST',                     //Set ajax request type to POST
                     url: '/callbacks/check_file',     //Action to which send request
                     success: function (data) {        //If request success exeсute function
                         $('#results_status').fadeOut("slow");     //Show result status
                         div = document.getElementById("link");    //Get element with id "link"
                         p = document.createElement("p");          //Create new HTML element
                         p.innerHTML = "<br /> File " + data + " was downloaded.";          //Set content for new HTML element
                         div.appendChild(p);                                               //Add new element to the element with id "link"
                         $("#downloadframe").attr("src", "/callbacks/download_file?FileName=" + data);  //Make request to download file_file controller
                     },
                     dataType: "text"               //Set data type which will get ajax request from controller

                 });
             }
         }

</script>

$(document).ready(setTimeout(check, 5000)); //Wait 5 sec. after page loaded and run "check" function

function check() {

if (($("input[name=callbackUrl]").val() != "") && (document.getElementById("result") != null)) { //Check is this first time page loaded

$('#results_status').fadeIn("slow"); //Chow message

//Ajax request

$.ajax({

type: 'POST', //Set ajax request type to POST

url: '/callbacks/check_file', //Action to which send request

success: function (data) { //If request success exeсute function

$('#results_status').fadeOut("slow"); //Show result status

div = document.getElementById("link"); //Get element with id "link"

p = document.createElement("p"); //Create new HTML element

p.innerHTML = "<br /> File " + data + " was downloaded."; //Set content for new HTML element

div.appendChild(p); //Add new element to the element with id "link"

$("#downloadframe").attr("src", "/callbacks/download_file?FileName=" + data); //Make request to download file_file controller

dataType: "text" //Set data type which will get ajax request from controller

});

}

</script>

As Jquery is a JavaScript library we must use the <script></script> tag's. This code starts work 5 sec. after the page is loaded. The delay is necessary in order that the iframe with results is loaded. First of all we must check if this is first time the page is loaded. For this reason we use this check:

 if (($("input\[name=callbackUrl\]").val() \!= "") && (document.getElementById("result") \!= null)) {

1	if (($("input\[name=callbackUrl\]").val() \!= "") && (document.getElementById("result") \!= null)) {

After this check, the script shows message and receives all elements from the document. Then the script builds and sends an Ajax request to the check_file controller. When the controller returns the downloaded file name, Ajax sends it to the download_file controller.

controller.php

Now lets do the next step and see what our base controller looks like. In the inc_samples folder, create a file _controller.php file. This file gets form data from the template and makes requests to the Async API to convert the file. Also this controller creates a text file with the user ID and private key for the callback controllers because we can't send this data any other way and the callback controller will be requested only by the server by the callback URL.

Now I'll show you the controller.php code. Put it in:

<?php
    //### This sample will show how to insert Assembly questionnaire into webpage using PHP SDK

    //### Set variables and get POST data
    F3::set('userId', '');
    F3::set('privateKey', '');
    F3::set('fileId', '');
    F3::set('convert_type', '');
    $clientId = F3::get('POST["client_id"]');
    $privateKey = F3::get('POST["private_key"]');
    $convert_type = F3::get('POST["convert_type"]');
    $fileGuId = f3::get('POST["fileId"]');

    function Convert($clientId, $privateKey, $convert_type, $fileGuId) {
        if (empty($clientId)|| empty($privateKey) || empty($convert_type) || empty($fileGuId)) {
            throw new Exception('Please enter all required parameters');
        } else {
            //path to settings file - temporary save userId and apiKey like to property file
            $infoFile = fopen(__DIR__ . '/../user_info.txt', 'w');
            fwrite($infoFile, $clientId . "\r\n" . $privateKey);
            fclose($infoFile);
             //check if Downloads folder exists and remove it to clean all old files
            if (file_exists(__DIR__ . '/../downloads')) {
                delFolder(__DIR__ . '/../downloads/');
            }
             //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 AsyncApi object
            $api = new AsyncApi($apiClient);
            //Create Storage Api object
            $apiStorage = new StorageApi($apiClient);
            //Get entered callback url
            $callbackUrl = f3::get('POST["callbackUrl"]');
            F3::set("callbackUrl", $callbackUrl);
            //Make request to api for convert file
            $convert = $api->Convert($clientId, $fileGuId, null, null, null, $callbackUrl, $convert_type);
            //Check request status
            if($convert->status == "Ok") {
                //Delay necessary that the inquiry would manage to be processed
                sleep(5);
                //Make request to api for get document info by job id
                $jobInfo = $api->GetJobDocuments($clientId, $convert->result->job_id, "");
                if ($jobInfo->result->inputs[0]->outputs[0]->guid != "") {
                    //Get file guid
                    $guid = $jobInfo->result->inputs[0]->outputs[0]->guid;
                } else {
                    throw new Exception('File GuId is empty');
                }
                //Generation of iframe URL using fileGuId
                $iframe = 'http://apps.groupdocs.com/document-viewer/embed/' . $guid . '" frameborder="0" width="100%" height="600"';
            } else {
                $error_message = $convert->error_message;
                return f3::set('error_message', $error_message);
            }
            //If request was successfull - set url variable for template
            F3::set('fileId', $fileId);
            return F3::set('iframe', $iframe);
        }
    }
    //### Delete downloads folder and all files in this folder
    function delFolder($path) {
        $item = array();
        //Get all items fron folder
        $item = scandir($path);
        //Remove from array "." and ".."
        $item = array_slice($item, 2);
        //Check is there was files
        if (count($item) > 0) {
            //Delete files from folder
            for ($i = 0; $i < count($item); $i++) {
                $next = $path . "\\" . $item[$i];
                if (file_exists($next)) {
                    unlink($next);
                }
            }
        }
        //Delete folder
        rmdir($path);
    }

    try {
        Convert($clientId, $privateKey, $convert_type, $fileGuId);
    } catch (Exception $e) {
        $error = 'ERROR: ' .  $e->getMessage() . "\n";
        f3::set('error', $error);
    }
    F3::set('userId', $clientId);
    F3::set('privateKey', $privateKey);
    F3::set('convert_type', $convert_type);
    // Process template
    echo Template::serve('template.htm');

<?php

//### This sample will show how to insert Assembly questionnaire into webpage using PHP SDK

//### Set variables and get POST data

F3::set('userId', '');

F3::set('privateKey', '');

F3::set('fileId', '');

F3::set('convert_type', '');

$clientId = F3::get('POST["client_id"]');

$privateKey = F3::get('POST["private_key"]');

$convert_type = F3::get('POST["convert_type"]');

$fileGuId = f3::get('POST["fileId"]');

function Convert($clientId, $privateKey, $convert_type, $fileGuId) {

if (empty($clientId)|| empty($privateKey) || empty($convert_type) || empty($fileGuId)) {

throw new Exception('Please enter all required parameters');

} else {

//path to settings file - temporary save userId and apiKey like to property file

$infoFile = fopen(__DIR__ . '/../user_info.txt', 'w');

fwrite($infoFile, $clientId . "\r\n" . $privateKey);

fclose($infoFile);

//check if Downloads folder exists and remove it to clean all old files

if (file_exists(__DIR__ . '/../downloads')) {

delFolder(__DIR__ . '/../downloads/');

}

//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 AsyncApi object

$api = new AsyncApi($apiClient);

//Create Storage Api object

$apiStorage = new StorageApi($apiClient);

//Get entered callback url

$callbackUrl = f3::get('POST["callbackUrl"]');

F3::set("callbackUrl", $callbackUrl);

//Make request to api for convert file

$convert = $api->Convert($clientId, $fileGuId, null, null, null, $callbackUrl, $convert_type);

//Check request status

if($convert->status == "Ok") {

//Delay necessary that the inquiry would manage to be processed

sleep(5);

//Make request to api for get document info by job id

$jobInfo = $api->GetJobDocuments($clientId, $convert->result->job_id, "");

if ($jobInfo->result->inputs[0]->outputs[0]->guid != "") {

//Get file guid

$guid = $jobInfo->result->inputs[0]->outputs[0]->guid;

} else {

throw new Exception('File GuId is empty');

}

//Generation of iframe URL using fileGuId

$iframe = 'http://apps.groupdocs.com/document-viewer/embed/' . $guid . '" frameborder="0" width="100%" height="600"';

} else {

$error_message = $convert->error_message;

return f3::set('error_message', $error_message);

}

//If request was successfull - set url variable for template

F3::set('fileId', $fileId);

return F3::set('iframe', $iframe);

}

//### Delete downloads folder and all files in this folder

function delFolder($path) {

$item = array();

//Get all items fron folder

$item = scandir($path);

//Remove from array "." and ".."

$item = array_slice($item, 2);

//Check is there was files

if (count($item) > 0) {

//Delete files from folder

for ($i = 0; $i < count($item); $i++) {

$next = $path . "\\" . $item[$i];

if (file_exists($next)) {

unlink($next);

}

//Delete folder

rmdir($path);

}

try {

Convert($clientId, $privateKey, $convert_type, $fileGuId);

} catch (Exception $e) {

$error = 'ERROR: ' . $e->getMessage() . "\n";

f3::set('error', $error);

}

F3::set('userId', $clientId);

F3::set('privateKey', $privateKey);

F3::set('convert_type', $convert_type);

// Process template

echo Template::serve('template.htm');

I won't go through the code in detail: each line is explained in the comments. But I'll explain briefly what the code doing.

We have two functions, Convert and delFolder, which do all the work. First of all, we receive POST data from the template and check if all the required fields are filled in. If they are, the controller creates a text file and writes the user ID and private key to it. After that follows the creation of the GroupDocsRequestSigner, APIClient and Async API objects so that we can send request to the API. So we have created all the objects and now we can convert the file. To do this we only need to call the convert method and transfer to it the:

user ID,
GUID of the file in the GroupDocs account which will be converted
callback URL
format to convert the file to.

Now we have converted the file but we need the GUID of the converted file and only the job ID is returned from the converted method. No problem, lets take 5 sec. to rest. The 5 sec. delay is necessary so that the inquiry can be be processed. After the delay, we take the returned job ID and make new request to the Async API but now with GetJobDocuments which returns all the info we need by job ID. Now we have the GUID for the converted file and can give this GUID to the iframe URL and return the URL to the template which will use it in the iframe source.

The second function checks the downloads folder for old files and deletes them.

convert_callback.php

Next, let's take a look at the callback controller, convert_callback.php. This file gets the callback from server, takes the data the server sends and downloads the converted file.

<?php
    //Local path to the text file with user data
    $userInfo = file(__DIR__ . '/../../user_info.txt');
    //Get user data from text file
    $clientId = $userInfo[0];
    $privateKey = $userInfo[1];
    //Get raw data
    $json = file_get_contents("php://input");
    //Decode json with raw data to array
	$callBack_data = json_decode($json, true);
    //Get job id from array
	$jobId = $callBack_data["SourceId"];

    //Create signer object
    $signer = new GroupDocsRequestSigner(trim($privateKey));
    //Create apiClient object
    $apiClient = new APIClient($signer);
    //Create AsyncApi object
    $api = new AsyncApi($apiClient);
    //Create Storage Api object
    $apiStorage = new StorageApi($apiClient);
	sleep(5);
    //Make request to Async API to get job info
	$jobInfo = $api->GetJobDocuments(trim($clientId), $jobId, "");
	if ($jobInfo->status == "Ok") {
		   //Get file guid
            $guid = $jobInfo->result->inputs[0]->outputs[0]->guid;
            //Get file name
            $name = $jobInfo->result->inputs[0]->outputs[0]->name;

    }
    //Local path to the downloads folder
    $downloadFolder = dirname(__FILE__). '/../../downloads';
    //Check is folder exist
    if (!file_exists($downloadFolder)) {
        //If folder don't exist create it
        mkdir($downloadFolder);
    }
    //Obtaining file stream of downloading file and definition of folder where to download file
    $outFileStream =  FileStream::fromHttp($downloadFolder, $name);
    //Download file from GroupDocs.
    $download = $apiStorage->GetFile(trim($clientId), $guid, $outFileStream);

?>

<?php

//Local path to the text file with user data

$userInfo = file(__DIR__ . '/../../user_info.txt');

//Get user data from text file

$clientId = $userInfo[0];

$privateKey = $userInfo[1];

//Get raw data

$json = file_get_contents("php://input");

//Decode json with raw data to array

$callBack_data = json_decode($json, true);

//Get job id from array

$jobId = $callBack_data["SourceId"];

//Create signer object

$signer = new GroupDocsRequestSigner(trim($privateKey));

//Create apiClient object

$apiClient = new APIClient($signer);

//Create AsyncApi object

$api = new AsyncApi($apiClient);

//Create Storage Api object

$apiStorage = new StorageApi($apiClient);

sleep(5);

//Make request to Async API to get job info

$jobInfo = $api->GetJobDocuments(trim($clientId), $jobId, "");

if ($jobInfo->status == "Ok") {

//Get file guid

$guid = $jobInfo->result->inputs[0]->outputs[0]->guid;

//Get file name

$name = $jobInfo->result->inputs[0]->outputs[0]->name;

}

//Local path to the downloads folder

$downloadFolder = dirname(__FILE__). '/../../downloads';

//Check is folder exist

if (!file_exists($downloadFolder)) {

//If folder don't exist create it

mkdir($downloadFolder);

}

//Obtaining file stream of downloading file and definition of folder where to download file

$outFileStream = FileStream::fromHttp($downloadFolder, $name);

//Download file from GroupDocs.

$download = $apiStorage->GetFile(trim($clientId), $guid, $outFileStream);

This controller reads the user ID and private key from the text file. Then it gets the raw data from the server inquiry. In this raw data we have the job ID. Use this like in the previous controller to get the converted file. To do this we must create all the objects again: GroupDocsRequestSigner, APIClient and Async API. After that we can make a request using the GetJobDocuments method to get the file GUID and name. Use this data for the GetFile method to download the converted file to the downloads folder.

check_file.php

At the same time that the convert_callback controller is working, we see that the page is reloaded and shows the iframe with the converted file. When the iframe is loaded, Ajax sends its request to the check_file controller.

The check_file controller looks like this:

<?php

    $result = "";
    //counter to not wait forever
    $counter = 0;
    //Local path to the downloads folder
    $downloadFolder = __DIR__ . '/../../downloads';
	//Check folder for downloaded file
    do {
        //Set max. iterations
        if ($counter >= 10) {
            $result = "Error";
            break;
        }
        sleep(5);
        //Check is downloads folder exist
        if (!file_exists($downloadFolder)) {
            //If folder don't exist create it
            $di = mkdir($downloadFolder);
        }
        //Open downloads folder
        $filePaths = opendir($downloadFolder);
        //Get all elements from folder
        while (($file = readdir($filePaths)) !== false) {
            //Get downloaded file name
            if ($file != "." && $file != "..") {
                $name = $file;
            }
        }
        //Close folder
        closedir($filePaths);
        //Check is file downloaded
        if ($name == "") {
            //If file don't downloaded yet do one mor itaretion
            $counter++;
            continue;
        //If file downloaded get file name and break.
        } else {

            $result = $name; //get the name of the fist file in the directory
            break;
        }
    } while (true);
    //Check result
    if ($result == "Error") {
         return "File was not found. Looks like something went wrong.";
    }
	//Return file name to the template for ajax
    echo $result;
?>

<?php

$result = "";

//counter to not wait forever

$counter = 0;

//Local path to the downloads folder

$downloadFolder = __DIR__ . '/../../downloads';

//Check folder for downloaded file

do {

//Set max. iterations

if ($counter >= 10) {

$result = "Error";

break;

}

sleep(5);

//Check is downloads folder exist

if (!file_exists($downloadFolder)) {

//If folder don't exist create it

$di = mkdir($downloadFolder);

}

//Open downloads folder

$filePaths = opendir($downloadFolder);

//Get all elements from folder

while (($file = readdir($filePaths)) !== false) {

//Get downloaded file name

if ($file != "." && $file != "..") {

$name = $file;

}

//Close folder

closedir($filePaths);

//Check is file downloaded

if ($name == "") {

//If file don't downloaded yet do one mor itaretion

$counter++;

continue;

//If file downloaded get file name and break.

} else {

$result = $name; //get the name of the fist file in the directory

break;

}

} while (true);

//Check result

if ($result == "Error") {

return "File was not found. Looks like something went wrong.";

}

//Return file name to the template for ajax

echo $result;

This controller opens the downloads folder and gets all files from it. If there are no files, the controller waits for 5 sec. and checks again. When the file is downloaded and appear in the folder, the controller get the name and returns it to Ajax which sends the file name to the download_file controller.

download_file.php

The download_file generates the download dialog.

<?php
//Get downloaded file
$file = (dirname(__FILE__) . '/../../downloads/' . $_GET["FileName"]);
//Set data for download dialog
header ("Content-Type: application/octet-stream");
header ("Accept-Ranges: bytes");
header ("Content-Length: ".filesize($file));
header ("Content-Disposition: attachment; filename=".$_GET["FileName"]);
//Download file
readfile($file);
?>

<?php

//Get downloaded file

$file = (dirname(__FILE__) . '/../../downloads/' . $_GET["FileName"]);

//Set data for download dialog

header ("Content-Type: application/octet-stream");

header ("Accept-Ranges: bytes");

header ("Content-Length: ".filesize($file));

header ("Content-Disposition: attachment; filename=".$_GET["FileName"]);

//Download file

readfile($file);

Here we take full local path to the downloaded file and transfers it to the download dialog.

Program in action

On that we are finished! Let me show you what it looks like in action:

The input form

Ajax message

Iframe with converted file

Download dialog (FireFox)

Signing Off,

The GroupDocs Marketplace Team

How to Streamline Your Document Signing Using Online Signature?

A steady document signing process is the back bone of any contract-oriented organization. Conventional signing process leaves you with piles of signed documents, difficult to handle and archive. Also, the documents are passed around different departments, either getting lost or eating up too much time delaying the signing process. Online signature is the answer to all these concerns.

Save your time and effort with GroupDocs’ online signature

Say good bye to lost signed documents and tons of paper piling up in your office! Embrace GroupDocs Signature, an efficient online signature service, to streamline your entire signing process. GroupDocs’ online signature service lets you easily prepare & send documents to signers, and collect signatures online.

Get peace of mind by tracking the signing process

Track the document signing process from a centralized location. As soon as the documents are signed, they are automatically archived and available for retrieval when required. This completely avoids the chance of documents getting lost in mountains of signed contracts. In addition, there is no need to follow up your signers regularly through phone calls or emails. You can simply set a reminder while creating a new envelope (while preparing the document for signature) so that the signers get notifications automatically till the reminder expires.

Efficient work flow walks you through the entire process

The work flow for preparing the documents for signing and sending it is so simple that even novice people can do it without the help of any documentation. GroupDocs Signature walks you through the entire process step by step. The workflow is designed in such a way that you go to the next step only after finishing the present one. This will make sure that you perform the process correctly.

Procedure for preparing and sending a document for online signature

Now, lets see the simple steps for preparing a document for e-signature and sending them out to collect signatures:

Go to Signature dashboard and start creating a new envelope.
Step 1 - Choose a File:

Here you have three options to choose a file. Use one of them to select your preferred document:
1. Drag and drop the file in the DROP FILES HERE area.
2. Use the Upload button and select a file from your computer.
3. Use the Add from Library button to select a file from your GroupDocs repository.
Step 2 - Add Recipients:
- Add your signers or recipients here.
Step 3 - Add Info (optional):
- Add more details to the envelope. You can also add a watermark to your documents. This step is optional.
Step 4 - Add Reminders (optional):
- Add reminder, deadline and document expiry in this step. This too is optional.
Step 5 - Add Fields:
- Drag and drop fields to the required location on the uploaded document.
Step 6 - Summary (optional):
- Review the envelope one final time and send the document to the signer(s).
- The signers can then easily sign documents online just using a browser. Type, draw, or upload the signature.

All related partied are notified as soon as the documents are signed.
Stay tuned for a step-by-step video tutorial on how to prepare and send a document for online signature, it's in the pipeline. So why wait! go green with this efficient e-signature service.

How to Compare Files with GroupDocs PHP SDK

This article explains the basics of using PHP SDK classes and methods. In this article I'll use the Comparison API and show how to compare two documents from a GroupDocs account. Find information about other methods in the Swagger explorer.

Requirements

PHP 5.3
Apache ModRewrite
PHP Curl extension
PHP Sockets extension (php_sockets.dll)
GroupDocs PHP SDK
composer.phar (Download from http://getcomposer.org/download/ or use the included version)
FatFree framework (https://github.com/bcosca/fatfree)

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.

<!DOCTYPE html>
<html lang="en">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
	<title>Powered by {{ @VERSION }}</title>
	<style type="text/css">
		{{ Web::minify('templates/',array('style.css'),FALSE) }}
	</style>
</head>
<body>
<h3 style="text-align:center;"><a href="/index.php">GroupDocs PHP SDK Samples</a> - Comparison</h3>

<div class='samplecontent' style="padding:10px;">
   <i>This sample will show how to Compare documents using PHP SDK</i> <br/>

   <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}}

   <div id="requestForm" style="padding:20px; border:1px solid black;">
   <p> Enter data for request and press "Make request" button </p>
        <form action="/comparison" method = "post" enctype = 'multipart/form-data'>
            <label for='client_id'>GroupDocs ClientID</label>
            <br />
            <input type='text', name='client_id' value="{{@userId}}" />
            <br />
            <label for='private_key'>GroupDocs PrivateKey</label>
            <br />
            <input type='text', name='private_key'  value="{{@privateKey}}" />
            <br />
            <label for='sourceFileId'>sourceFileId</label>
            <br />
            <input type='text', name='sourceFileId'  value="{{@sourceFileId}}" />
            <br />
            <label for='targetFileId'>targetFileId</label>
            <br />
            <input type='text', name='targetFileId'  value="{{@targetFileId}}" />
            <br />
            <label for='callbackUrl'>callbackUrl</label>
            <br />
            <input type='text', name='callbackUrl'  value="{{@callbackURL}}" />
            <br />
            <input type='submit' value='Make Request'/>
        </form>
   </div>
   <div  style="padding:20px; border:1px solid black;">
        <p> Results: </p>
        <iframe src={{@iframe}}></iframe>
   </div>
   <br/>
</div>

</body>
</html>

<!DOCTYPE html>

<head>

<title>Powered by {{ @VERSION }}</title>

</style>

</head>

<body>

<h3 style="text-align:center;"><a href="/index.php">GroupDocs PHP SDK Samples</a> - Comparison</h3>

<i>This sample will show how to Compare documents using PHP SDK</i> <br/>

<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}}

<p> Enter data for request and press "Make request" button </p>

<label for='client_id'>GroupDocs ClientID</label>

<br />

<br />

<label for='private_key'>GroupDocs PrivateKey</label>

<br />

<br />

<label for='sourceFileId'>sourceFileId</label>

<br />

<br />

<label for='targetFileId'>targetFileId</label>

<br />

<br />

<label for='callbackUrl'>callbackUrl</label>

<br />

<br />

</form>

</div>

<p> Results: </p>

</div>

<br/>

</div>

</body>

</html>

The Template Code Explained

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}}

<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:

<div id="requestForm" style="padding:20px; border:1px solid black;">
   <p> Enter data for request and press "Make request" button </p>
        <form action="/sample19" method = "post" enctype = 'multipart/form-data'>
            <label for='client_id'>GroupDocs ClientID</label>
            <br />
            <input type='text', name='client_id' value="{{@userId}}" />
            <br />
            <label for='private_key'>GroupDocs PrivateKey</label>
            <br />
            <input type='text', name='private_key'  value="{{@privateKey}}" />
            <br />
            <label for='sourceFileId'>sourceFileId</label>
            <br />
            <input type='text', name='sourceFileId'  value="{{@sourceFileId}}" />
            <br />
            <label for='targetFileId'>targetFileId</label>
            <br />
            <input type='text', name='targetFileId'  value="{{@targetFileId}}" />
            <br />
            <label for='callbackUrl'>callbackUrl</label>
            <br />
            <input type='text', name='callbackUrl'  value="{{@callbackURL}}" />
            <br />
            <input type='submit' value='Make Request'/>
        </form>
   </div>

<p> Enter data for request and press "Make request" button </p>

<label for='client_id'>GroupDocs ClientID</label>

<br />

<br />

<label for='private_key'>GroupDocs PrivateKey</label>

<br />

<br />

<label for='sourceFileId'>sourceFileId</label>

<br />

<br />

<label for='targetFileId'>targetFileId</label>

<br />

<br />

<label for='callbackUrl'>callbackUrl</label>

<br />

<br />

</form>

</div>

Callbacks

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.

Displaying the Comparison Results

The next code block in the template file is:

<div  style="padding:20px; border:1px solid black;">
        <p> Results: </p>
           <p><font color="red">{{@error}}</font>           <iframe src={{@iframe}}></iframe>
   </div>
   <br/>
</div>

<p> Results: </p>

<p><font color="red">{{@error}}</font> <iframe src={{@iframe}}></iframe>

</div>

<br/>

</div>

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');

100

<?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:

$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"]');

$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"]');

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('userId', '');
    F3::set('privateKey', '');
    f3::set('result', "");

F3::set('userId', '');

F3::set('privateKey', '');

f3::set('result', "");

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');

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);

} 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);

//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"';

            }

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"';

Calling the Function

And one last code block:

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');

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');

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:

With this, I am finished. That is all. Peace.

Signing Off,

The GroupDocs Marketplace Team

How to Create GroupDocs Plugin for Contao CMS

This article explains the basics of creating a plugin for the Contao CMS using the Contao Viewer plugin as an example. You can download the completed plugin from Contao.

Requirements

Contao CMS
PHP 5.3
JavaScript

Preparation

To create a GroupDocs Viewer plugin for Contao CMS:

Install Contao CMS. The installation of this CMS is a simple.
Allow GroupDocs <iframe> to appear go to Admin > Setting > Security settings > Allowed HTML tags and just add <iframe> at the end.
Create a folder to hold future plugin files in the root/system/modules directory of the Contao CMS installation and name it groupdocs_viewer.

Creating the Plugin

This plugin adds a button to the Admin side of the CMS above the editing block of any article. When users click the button a dialog appears. Here, users enter the file GUID from their GroupDocs account to embed and iframe with this file.

OK. Let's start creating a Viewer plugin. All operations are in the groupdocs_viewer folder.

First of all, create a ModuleGroupdocsViewer.php file. This file will contain the plugin's installation and uninstallation logic. Enter this code into the file:

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**
 * GroupDocs
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, please visit the Free
 * Software Foundation website at http://www.gnu.org/licenses/.
 *
 * PHP version 5
 * @copyright  2012
 * @author     support@groupdocs.com
 * @license    GPL
 */

 /**
 * @package    Controller
 */
class ModuleGroupdocsViewer extends Module
{

	/**
	 * Template
	 * @var string
	 */
	protected $strTemplate = 'mod_groupdocsviewer';

	/**
	 * Display a wildcard in the back end
	 * @return string
	 */
	public function generate()
	{
		if (TL_MODE == 'BE')
		{
			$objTemplate = new BackendTemplate('be_wildcard');

			$objTemplate->wildcard = '### GROUPDOCS VIEWER LIST ###';
			$objTemplate->title = $this->headline;
			$objTemplate->id = $this->id;
			$objTemplate->link = $this->name;
			$objTemplate->href = 'contao/main.php?do=themes&amp;table=tl_module&amp;act=edit&amp;id=' . $this->id;

			return $objTemplate->parse();
		}

		return parent::generate();
	}

	/**
	 * Generate module
	 */
	protected function compile()
	{

/*
		$this->Template->gdv = $arrGdv;
		$this->Template->width = $objCategory->width;
		$this->Template->height = $objCategory->height;
		$this->Template->categories = $arrCategories;
*/
	}

}

?>

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**

* GroupDocs

* This program is free software: you can redistribute it and/or

* modify it under the terms of the GNU Lesser General Public

* License as published by the Free Software Foundation, either

* version 2.1 of the License, or (at your option) any later version.

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

* Lesser General Public License for more details.

* You should have received a copy of the GNU Lesser General Public

* License along with this program. If not, please visit the Free

* Software Foundation website at http://www.gnu.org/licenses/.

* PHP version 5

* @author support@groupdocs.com

* @license GPL

/**

* @package Controller

class ModuleGroupdocsViewer extends Module

{

/**

* Template

* @var string

protected $strTemplate = 'mod_groupdocsviewer';

/**

* Display a wildcard in the back end

* @return string

public function generate()

{

if (TL_MODE == 'BE')

{

$objTemplate = new BackendTemplate('be_wildcard');

$objTemplate->wildcard = '### GROUPDOCS VIEWER LIST ###';

$objTemplate->title = $this->headline;

$objTemplate->id = $this->id;

$objTemplate->link = $this->name;

$objTemplate->href = 'contao/main.php?do=themes&table=tl_module&act=edit&id=' . $this->id;

return $objTemplate->parse();

}

return parent::generate();

}

/**

* Generate module

protected function compile()

{

$this->Template->gdv = $arrGdv;

$this->Template->width = $objCategory->width;

$this->Template->height = $objCategory->height;

$this->Template->categories = $arrCategories;

}

The Code Line by Line

Let's take a look at the code we inserted.

The first line

if (!defined('TL_ROOT')) die('You can not access this file directly!');

1	if (!defined('TL_ROOT')) die('You can not access this file directly!');

says that if TL_ROOT has not been defined, the user can't access the file. This line must be in all plugin files as first line.

The next, commented, block contains information about the plugin.

Now create a basic class of our plugin which will extend the Contao CMS's Module class. This is necessary for Contao to understand that this is a module and give us access to the CMS's functions.

class ModuleGroupdocsViewer extends Module

1	class ModuleGroupdocsViewer extends Module

That creates the class. Then we have the magic that installs and uninstalls the plugin. For this purpose we create some functions. All code explanations are on the same lines of the code in the section below.

protected $strTemplate = 'mod_groupdocsviewer'; // Creation of the protected variable which declare a template with module name

	/**
	 * Display a wildcard in the back end
	 * @return string
	 */
	public function generate() //This function is describe an insertion of plugin info to the CMS.
                                  //For this purpose we use a variables of the basic Module class which we expanded by our class
	{
		if (TL_MODE == 'BE')
		{
			$objTemplate = new BackendTemplate('be_wildcard');

			$objTemplate->wildcard = '### GROUPDOCS VIEWER LIST ###';
			$objTemplate->title = $this->headline;
			$objTemplate->id = $this->id;
			$objTemplate->link = $this->name;
			$objTemplate->href = 'contao/main.php?do=themes&amp;table=tl_module&amp;act=edit&amp;id=' . $this->id;

			return $objTemplate->parse();
		}

		return parent::generate();
	}

	/**
	 * Generate module
	 */
	protected function compile() //In this function we transfer our plugin data to the template such as button position and in which area to insert our button.
	{

/*
		$this->Template->gdv = $arrGdv;
		$this->Template->width = $objCategory->width;
		$this->Template->height = $objCategory->height;
		$this->Template->categories = $arrCategories;
*/
	}

protected $strTemplate = 'mod_groupdocsviewer'; // Creation of the protected variable which declare a template with module name

/**

* Display a wildcard in the back end

* @return string

public function generate() //This function is describe an insertion of plugin info to the CMS.

//For this purpose we use a variables of the basic Module class which we expanded by our class

{

if (TL_MODE == 'BE')

{

$objTemplate = new BackendTemplate('be_wildcard');

$objTemplate->wildcard = '### GROUPDOCS VIEWER LIST ###';

$objTemplate->title = $this->headline;

$objTemplate->id = $this->id;

$objTemplate->link = $this->name;

$objTemplate->href = 'contao/main.php?do=themes&table=tl_module&act=edit&id=' . $this->id;

return $objTemplate->parse();

}

return parent::generate();

}

/**

* Generate module

protected function compile() //In this function we transfer our plugin data to the template such as button position and in which area to insert our button.

{

$this->Template->gdv = $arrGdv;

$this->Template->width = $objCategory->width;

$this->Template->height = $objCategory->height;

$this->Template->categories = $arrCategories;

}

So far, we've created the basic plugin file but the plugin doesn't do anything yet. So let's add some functionality.

Completing the Plugin Declaration

Before adding functionality to the plugin, we need to set up some files and file structures.

First, create a Template folder and add an empty template file to it. The Contao CMS will write data that we declare for the template to this file. The file name for is mod_groupdocsviewer - the same that we called our protected variable.
Create a languages folder in the plugin's root folder and, in this folder, create one an en folder. In the enfolder, create two files which will contain a string declaration of all titles and messages for our plugin.

modules.php

The first file is named modules.php and contain basic data such as the plugin name:

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**
 * GroupDocs
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, please visit the Free
 * Software Foundation website at http://www.gnu.org/licenses/.
 *
 * PHP version 5
 * @copyright  2012
 * @author     support@groupdocs.com
 * @license    GPL
 */

/**
 * Back end modules
 */
$GLOBALS['TL_LANG']['MOD']['groupdocs_viewer'] = array('GroupDocs Viewer', 'Module name');

/**
 * Front end modules
 */
//$GLOBALS['TL_LANG']['FMD']['groupdocs_viewer'] = array('GDV List', 'Module list');

?>

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**

* GroupDocs

* This program is free software: you can redistribute it and/or

* modify it under the terms of the GNU Lesser General Public

* License as published by the Free Software Foundation, either

* version 2.1 of the License, or (at your option) any later version.

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

* Lesser General Public License for more details.

* You should have received a copy of the GNU Lesser General Public

* License along with this program. If not, please visit the Free

* Software Foundation website at http://www.gnu.org/licenses/.

* PHP version 5

* @author support@groupdocs.com

* @license GPL

/**

* Back end modules

$GLOBALS['TL_LANG']['MOD']['groupdocs_viewer'] = array('GroupDocs Viewer', 'Module name');

/**

* Front end modules

//$GLOBALS['TL_LANG']['FMD']['groupdocs_viewer'] = array('GDV List', 'Module list');

As you can see, even in language files there has to be a plugin info block and a line of code that limits access. So in this file we have only one line of code which declares an array with the plugin name and transfers it to the CMS's global data.

tl_gdv.php

The second language file is named tl_gdv.php and contains all local names, titles and messages for our plugin:

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**
 * GroupDocs
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, please visit the Free
 * Software Foundation website at http://www.gnu.org/licenses/.
 *
 * PHP version 5
 * @copyright  2012
 * @author     support@groupdocs.com
 * @license    GPL
 */

/**
 * Table tl_gdv
 */
$GLOBALS['TL_DCA']['tl_gdv'] = array
(

	// Config
	'config' => array
	(
		'dataContainer'               => 'Table',
		//'ptable'                      => 'tl_gdv',
	),

	// List
	'list' => array
	(
		'global_operations' => array
		(
			'all' => array
			(
				'label'               => &$GLOBALS['TL_LANG']['MSC']['all'],
				'href'                => 'act=select',
				'class'               => 'header_edit_all',
				'attributes'          => 'onclick="Backend.getScrollOffset();"',
				'button_callback'			=> array('GrouDocs_Details', 'groupdocs_owner'),
			)
		),
		'operations' => array
        (
            'edit' => array
            (
                'label'               => &$GLOBALS['TL_LANG']['tl_gdv']['edit'],
                'href'                => 'act=edit',
                'icon'                => 'edit.gif'
            ),
            'copy' => array
            (
                'label'               => &$GLOBALS['TL_LANG']['tl_gdv']['copy'],
                'href'                => 'act=copy',
                'icon'                => 'copy.gif'
            ),
            'delete' => array
            (
                'label'               => &$GLOBALS['TL_LANG']['tl_gdv']['delete'],
                'href'                => 'act=delete',
                'icon'                => 'delete.gif',
                'attributes'          => 'onclick="if (!confirm(\'' . $GLOBALS['TL_LANG']['MSC']['deleteConfirm'] . '\')) return false; Backend.getScrollOffset();"'
            ),
            'show' => array
            (
                'label'               => &$GLOBALS['TL_LANG']['tl_gdv']['show'],
                'href'                => 'act=show',
                'icon'                => 'show.gif'
            )
        )

	),

	// Palettes
	'palettes' => array
	(
		'default'                     => '{title_legend},apiKey,clientId,width,height;'
	),

	// Fields
	'fields' => array
	(
        'id' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['id'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true)
        ),
        'apiKey' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['apiKey'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true, 'maxlength'=>128, 'tl_class'=>'w50')
        ),
        'clientId' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['clientId'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true, 'maxlength'=>128, 'tl_class'=>'w50')
        ),
        'width' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['width'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true, 'maxlength'=>4, 'tl_class'=>'w50')
        ),
        'height' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['height'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true, 'maxlength'=>4, 'tl_class'=>'w50')
        ),
		/*
        'image' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['image'],
            'inputType'               => 'fileTree',
            'eval'                    => array('files'=>true, 'filesOnly'=>true, 'fieldType'=>'radio')
        ),*/
	)
);

/**
 @calss GrouDocs_Details
 groupdocs_owner() - method manipulate
*/
class GrouDocs_Details{
	function groupdocs_owner(){
	print "<script>";
	// admin interface
	echo "
	setTimeout(function(){
			var GroupDocsAcc = document.getElementsByClassName('tl_file_list');
			GroupDocsAcc[0].innerHTML = 'GroupDocs Details';
	},500);
		 ";
	print "</script>";
}}

?>

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**

* GroupDocs

* This program is free software: you can redistribute it and/or

* modify it under the terms of the GNU Lesser General Public

* License as published by the Free Software Foundation, either

* version 2.1 of the License, or (at your option) any later version.

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

* Lesser General Public License for more details.

* You should have received a copy of the GNU Lesser General Public

* License along with this program. If not, please visit the Free

* Software Foundation website at http://www.gnu.org/licenses/.

* PHP version 5

* @author support@groupdocs.com

* @license GPL

/**

* Table tl_gdv

$GLOBALS['TL_DCA']['tl_gdv'] = array

(

// Config

'config' => array

(

'dataContainer' => 'Table',

//'ptable' => 'tl_gdv',

// List

'list' => array

(

'global_operations' => array

(

'all' => array

(

'label' => &$GLOBALS['TL_LANG']['MSC']['all'],

'href' => 'act=select',

'class' => 'header_edit_all',

'attributes' => 'onclick="Backend.getScrollOffset();"',

'button_callback' => array('GrouDocs_Details', 'groupdocs_owner'),

)

'operations' => array

(

'edit' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['edit'],

'href' => 'act=edit',

'icon' => 'edit.gif'

'copy' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['copy'],

'href' => 'act=copy',

'icon' => 'copy.gif'

'delete' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['delete'],

'href' => 'act=delete',

'icon' => 'delete.gif',

'attributes' => 'onclick="if (!confirm(\'' . $GLOBALS['TL_LANG']['MSC']['deleteConfirm'] . '\')) return false; Backend.getScrollOffset();"'

'show' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['show'],

'href' => 'act=show',

'icon' => 'show.gif'

)

// Palettes

'palettes' => array

(

'default' => '{title_legend},apiKey,clientId,width,height;'

// Fields

'fields' => array

(

'id' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['id'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true)

'apiKey' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['apiKey'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true, 'maxlength'=>128, 'tl_class'=>'w50')

'clientId' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['clientId'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true, 'maxlength'=>128, 'tl_class'=>'w50')

'width' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['width'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true, 'maxlength'=>4, 'tl_class'=>'w50')

'height' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['height'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true, 'maxlength'=>4, 'tl_class'=>'w50')

'image' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['image'],

'inputType' => 'fileTree',

'eval' => array('files'=>true, 'filesOnly'=>true, 'fieldType'=>'radio')

),*/

)

);

/**

@calss GrouDocs_Details

groupdocs_owner() - method manipulate

class GrouDocs_Details{

function groupdocs_owner(){

print "<script>";

// admin interface

echo "

setTimeout(function(){

var GroupDocsAcc = document.getElementsByClassName('tl_file_list');

GroupDocsAcc[0].innerHTML = 'GroupDocs Details';

},500);

print "</script>";

}}

Remember that all data is declared as arrays and transferred to the CMS's Global arrays. Also in this file we have JavaScript code which gets a list of sidebar elements and adds links to our plugin details:

class GrouDocs_Details{
	function groupdocs_owner(){
	print "<script>";
	// admin interface
	echo "
	setTimeout(function(){
			var GroupDocsAcc = document.getElementsByClassName('tl_file_list');
			GroupDocsAcc[0].innerHTML = 'GroupDocs Details';
	},500);
		 ";
	print "</script>";
}}

class GrouDocs_Details{

function groupdocs_owner(){

print "<script>";

// admin interface

echo "

setTimeout(function(){

var GroupDocsAcc = document.getElementsByClassName('tl_file_list');

GroupDocsAcc[0].innerHTML = 'GroupDocs Details';

},500);

print "</script>";

}}

You must write the JavaScript code as a simple text by using the 'echo' command. Also in this language file we declare all dependences and includes such as icons etc. That's the last step of the plugin declaration. Now we will add some useful functionality.

Adding Functionality

Create three folders: html, config and dca.
Place an icon .gif file, 16x16 pixels, in the html folder. That's all we need to do with the html folder.
In the dcafolder, create two files:

htaccess

order deny,allow
deny from all

1 2	order deny,allow deny from all

That's all. This code gave access to this folder from ather web pages of Admin side where user can bee.

tl_gdv.php

The code for the second file:

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**
 * GroupDocs
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, please visit the Free
 * Software Foundation website at http://www.gnu.org/licenses/.
 *
 * PHP version 5
 * @copyright  2012
 * @author     support@groupdocs.com
 * @license    GPL
 */

/**
 * Table tl_gdv
 */
$GLOBALS['TL_DCA']['tl_gdv'] = array
(

	// Config
	'config' => array
	(
		'dataContainer'               => 'Table',
		//'ptable'                      => 'tl_gdv',
	),

	// List
	'list' => array
	(
		'global_operations' => array
		(
			'all' => array
			(
				'label'               => &$GLOBALS['TL_LANG']['MSC']['all'],
				'href'                => 'act=select',
				'class'               => 'header_edit_all',
				'attributes'          => 'onclick="Backend.getScrollOffset();"',
				'button_callback'			=> array('GrouDocs_Details', 'groupdocs_owner'),
			)
		),
		'operations' => array
        (
            'edit' => array
            (
                'label'               => &$GLOBALS['TL_LANG']['tl_gdv']['edit'],
                'href'                => 'act=edit',
                'icon'                => 'edit.gif'
            ),
            'copy' => array
            (
                'label'               => &$GLOBALS['TL_LANG']['tl_gdv']['copy'],
                'href'                => 'act=copy',
                'icon'                => 'copy.gif'
            ),
            'delete' => array
            (
                'label'               => &$GLOBALS['TL_LANG']['tl_gdv']['delete'],
                'href'                => 'act=delete',
                'icon'                => 'delete.gif',
                'attributes'          => 'onclick="if (!confirm(\'' . $GLOBALS['TL_LANG']['MSC']['deleteConfirm'] . '\')) return false; Backend.getScrollOffset();"'
            ),
            'show' => array
            (
                'label'               => &$GLOBALS['TL_LANG']['tl_gdv']['show'],
                'href'                => 'act=show',
                'icon'                => 'show.gif'
            )
        )

	),

	// Palettes
	'palettes' => array
	(
		'default'                     => '{title_legend},apiKey,clientId,width,height;'
	),

	// Fields
	'fields' => array
	(
        'id' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['id'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true)
        ),
        'apiKey' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['apiKey'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true, 'maxlength'=>128, 'tl_class'=>'w50')
        ),
        'clientId' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['clientId'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true, 'maxlength'=>128, 'tl_class'=>'w50')
        ),
        'width' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['width'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true, 'maxlength'=>4, 'tl_class'=>'w50')
        ),
        'height' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['height'],
            'inputType'               => 'text',
            'search'                  => false,
            'eval'                    => array('mandatory'=>true, 'maxlength'=>4, 'tl_class'=>'w50')
        ),
		/*
        'image' => array
        (
            'label'                   => &$GLOBALS['TL_LANG']['tl_gdv']['image'],
            'inputType'               => 'fileTree',
            'eval'                    => array('files'=>true, 'filesOnly'=>true, 'fieldType'=>'radio')
        ),*/
	)
);

/**
 @calss GrouDocs_Details
 groupdocs_owner() - method manipulate
*/
class GrouDocs_Details{
	function groupdocs_owner(){
	print "<script>";
	// admin interface
	echo "
	setTimeout(function(){
			var GroupDocsAcc = document.getElementsByClassName('tl_file_list');
			GroupDocsAcc[0].innerHTML = 'GroupDocs Details';
	},500);
		 ";
	print "</script>";
}}

?>

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**

* GroupDocs

* This program is free software: you can redistribute it and/or

* modify it under the terms of the GNU Lesser General Public

* License as published by the Free Software Foundation, either

* version 2.1 of the License, or (at your option) any later version.

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

* Lesser General Public License for more details.

* You should have received a copy of the GNU Lesser General Public

* License along with this program. If not, please visit the Free

* Software Foundation website at http://www.gnu.org/licenses/.

* PHP version 5

* @author support@groupdocs.com

* @license GPL

/**

* Table tl_gdv

$GLOBALS['TL_DCA']['tl_gdv'] = array

(

// Config

'config' => array

(

'dataContainer' => 'Table',

//'ptable' => 'tl_gdv',

// List

'list' => array

(

'global_operations' => array

(

'all' => array

(

'label' => &$GLOBALS['TL_LANG']['MSC']['all'],

'href' => 'act=select',

'class' => 'header_edit_all',

'attributes' => 'onclick="Backend.getScrollOffset();"',

'button_callback' => array('GrouDocs_Details', 'groupdocs_owner'),

)

'operations' => array

(

'edit' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['edit'],

'href' => 'act=edit',

'icon' => 'edit.gif'

'copy' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['copy'],

'href' => 'act=copy',

'icon' => 'copy.gif'

'delete' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['delete'],

'href' => 'act=delete',

'icon' => 'delete.gif',

'attributes' => 'onclick="if (!confirm(\'' . $GLOBALS['TL_LANG']['MSC']['deleteConfirm'] . '\')) return false; Backend.getScrollOffset();"'

'show' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['show'],

'href' => 'act=show',

'icon' => 'show.gif'

)

// Palettes

'palettes' => array

(

'default' => '{title_legend},apiKey,clientId,width,height;'

// Fields

'fields' => array

(

'id' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['id'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true)

'apiKey' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['apiKey'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true, 'maxlength'=>128, 'tl_class'=>'w50')

'clientId' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['clientId'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true, 'maxlength'=>128, 'tl_class'=>'w50')

'width' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['width'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true, 'maxlength'=>4, 'tl_class'=>'w50')

'height' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['height'],

'inputType' => 'text',

'search' => false,

'eval' => array('mandatory'=>true, 'maxlength'=>4, 'tl_class'=>'w50')

'image' => array

(

'label' => &$GLOBALS['TL_LANG']['tl_gdv']['image'],

'inputType' => 'fileTree',

'eval' => array('files'=>true, 'filesOnly'=>true, 'fieldType'=>'radio')

),*/

)

);

/**

@calss GrouDocs_Details

groupdocs_owner() - method manipulate

class GrouDocs_Details{

function groupdocs_owner(){

print "<script>";

// admin interface

echo "

setTimeout(function(){

var GroupDocsAcc = document.getElementsByClassName('tl_file_list');

GroupDocsAcc[0].innerHTML = 'GroupDocs Details';

},500);

print "</script>";

}}

This second file is a copy of the language file with the same name - tl_gdv.php. We do this in order that Contao CMS will have access to this file from any Admin side page where user edit the content of this page.

The Config Folder

The most important and interesting files are placed in the Config folder:

.htaccess
config.php
database.sql

Create these three files in the config folder.
The .htaccess file is a copy of .htaccess file created in the dca folder. We need this file here for the same purposes.
The config.php file contains all the plugin's usefull logic. You'll find the code below.

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**
 * GroupDocs
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, please visit the Free
 * Software Foundation website at http://www.gnu.org/licenses/.
 *
 * PHP version 5
 * @copyright  2012
 * @author     support@groupdocs.com
 * @license    GPL
 */

array_insert($GLOBALS['BE_MOD']['content'], 3, array
(
	'groupdocs_viewer' => array
	(
		'tables' => array('tl_gdv'),
		'icon'   => 'system/modules/groupdocs_viewer/html/groupdocs.gif'
	)
));

// Just add JS to Back End where using TinyMCE
$GLOBALS['TL_HOOKS']['outputBackendTemplate'][] = array('ArticleAddGroupDocs', 'javaScriptFileID');
class ArticleAddGroupDocs{
public function javaScriptFileID($strContent, $strTemplate)
{
    if ($strTemplate == 'be_main')
    {
		if($_GET['do']=='article' && $_GET['act']=='edit')
			print "<script>
					//build GroupDocs Button just above Text Editor
				setTimeout(function(){
					var place_for_but = document.getElementById('pal_text_legend');
					var leg = place_for_but.getElementsByTagName('legend')[0];
					var btn=document.createElement('input');
					btn.type = 'button';
					btn.id = 'groupdocsv'
					btn.value = 'Embed GroupDocs Viewer';
					btn.onclick = function() { insertGroupDocsIframe(); };
					insertAfter(leg, btn);
				},500);

				function insertGroupDocsIframe(){
						// Enter GroupDocs File ID
						var ans=prompt('Enter GroupDocs File ID:','');
						if(ans.length<50) { alert('Sorry, but this File ID is too short'); return false; }
						if(ans.length>70) { alert('Sorry, but this File ID is too big'); return false; }
						// all good continue
                        var CMSNAME = 'Contao'
                        var CMSVERSION = '2.11.6'
						var iframe = '<iframe src=\"https://apps.groupdocs.com/document-viewer/embed/'+ans+'?&referer='+CMSNAME+'/'+CMSVERSION+'\" frameborder=\"0\" width=\"600\" height=\"400\"></iframe>';
						var tinyMceContent = tinyMCE.activeEditor.getContent();
						// set content
						tinyMCE.activeEditor.setContent(tinyMceContent+iframe);
				}
				// as in jquery .after()
				function insertAfter(referenceNode, newNode) {
					referenceNode.parentNode.insertBefore(newNode, referenceNode.nextSibling);
				}
			</script>";
    }

}

}
?>

<?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**

* GroupDocs

* This program is free software: you can redistribute it and/or

* modify it under the terms of the GNU Lesser General Public

* License as published by the Free Software Foundation, either

* version 2.1 of the License, or (at your option) any later version.

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

* Lesser General Public License for more details.

* You should have received a copy of the GNU Lesser General Public

* License along with this program. If not, please visit the Free

* Software Foundation website at http://www.gnu.org/licenses/.

* PHP version 5

* @author support@groupdocs.com

* @license GPL

array_insert($GLOBALS['BE_MOD']['content'], 3, array

(

'groupdocs_viewer' => array

(

'tables' => array('tl_gdv'),

'icon' => 'system/modules/groupdocs_viewer/html/groupdocs.gif'

)

));

// Just add JS to Back End where using TinyMCE

$GLOBALS['TL_HOOKS']['outputBackendTemplate'][] = array('ArticleAddGroupDocs', 'javaScriptFileID');

class ArticleAddGroupDocs{

public function javaScriptFileID($strContent, $strTemplate)

{

if ($strTemplate == 'be_main')

{

if($_GET['do']=='article' && $_GET['act']=='edit')

print "<script>

//build GroupDocs Button just above Text Editor

setTimeout(function(){

var place_for_but = document.getElementById('pal_text_legend');

var leg = place_for_but.getElementsByTagName('legend')[0];

var btn=document.createElement('input');

btn.type = 'button';

btn.id = 'groupdocsv'

btn.value = 'Embed GroupDocs Viewer';

btn.onclick = function() { insertGroupDocsIframe(); };

insertAfter(leg, btn);

},500);

function insertGroupDocsIframe(){

// Enter GroupDocs File ID

var ans=prompt('Enter GroupDocs File ID:','');

if(ans.length<50) { alert('Sorry, but this File ID is too short'); return false; }

if(ans.length>70) { alert('Sorry, but this File ID is too big'); return false; }

// all good continue

var CMSNAME = 'Contao'

var CMSVERSION = '2.11.6'

var iframe = '<iframe src=\"https://apps.groupdocs.com/document-viewer/embed/'+ans+'?&referer='+CMSNAME+'/'+CMSVERSION+'\" frameborder=\"0\" width=\"600\" height=\"400\"></iframe>';

var tinyMceContent = tinyMCE.activeEditor.getContent();

// set content

tinyMCE.activeEditor.setContent(tinyMceContent+iframe);

}

// as in jquery .after()

function insertAfter(referenceNode, newNode) {

referenceNode.parentNode.insertBefore(newNode, referenceNode.nextSibling);

}

</script>";

}

As you already know, we have the basic plugin info block. Then let's take a look at the code. This block inserts the icon file:

array_insert($GLOBALS['BE_MOD']['content'], 3, array
(
	'groupdocs_viewer' => array
	(
		'tables' => array('tl_gdv'),
		'icon'   => 'system/modules/groupdocs_viewer/html/groupdocs.gif'
	)
));

array_insert($GLOBALS['BE_MOD']['content'], 3, array

(

'groupdocs_viewer' => array

(

'tables' => array('tl_gdv'),

'icon' => 'system/modules/groupdocs_viewer/html/groupdocs.gif'

)

));

Contao uses the TinyMCE editor so we can use this as the starting point to get the position for where to place our button, and recognize if a user turns on page editing or not. Here is the code:

// Just add JS to Back End where using TinyMCE
$GLOBALS['TL_HOOKS']['outputBackendTemplate'][] = array('ArticleAddGroupDocs', 'javaScriptFileID');
class ArticleAddGroupDocs{
public function javaScriptFileID($strContent, $strTemplate)
{
    if ($strTemplate == 'be_main')
    {
		if($_GET['do']=='article' && $_GET['act']=='edit')
			print "<script>
					//build GroupDocs Button just above Text Editor
				setTimeout(function(){
					var place_for_but = document.getElementById('pal_text_legend');
					var leg = place_for_but.getElementsByTagName('legend')[0];
					var btn=document.createElement('input');
					btn.type = 'button';
					btn.id = 'groupdocsv'
					btn.value = 'Embed GroupDocs Viewer';
					btn.onclick = function() { insertGroupDocsIframe(); };
					insertAfter(leg, btn);
				},500);

				function insertGroupDocsIframe(){
						// Enter GroupDocs File ID
						var ans=prompt('Enter GroupDocs File ID:','');
						if(ans.length<50) { alert('Sorry, but this File ID is too short'); return false; }
						if(ans.length>70) { alert('Sorry, but this File ID is too big'); return false; }
						// all good continue
                        var CMSNAME = 'Contao'
                        var CMSVERSION = '2.11.6'
						var iframe = '<iframe src=\"https://apps.groupdocs.com/document-viewer/embed/'+ans+'?&referer='+CMSNAME+'/'+CMSVERSION+'\" frameborder=\"0\" width=\"600\" height=\"400\"></iframe>';
						var tinyMceContent = tinyMCE.activeEditor.getContent();
						// set content
						tinyMCE.activeEditor.setContent(tinyMceContent+iframe);
				}
				// as in jquery .after()
				function insertAfter(referenceNode, newNode) {
					referenceNode.parentNode.insertBefore(newNode, referenceNode.nextSibling);
				}
			</script>";
    }

}

Preparation

Build an extension on Heroku.

Download lib from Heroku.

Add lib and php.ini file to your app and upload them to Heroku

Preparation

Creating a Heroku project

Requirements

Sample creation

Template file code

Controller file

Screenshots

The input form

The output PDF

Requirements

Theory

Upload local file

Upload file from web

Practice

Template file code

Controller code

Displaying the file

The code in action

The input form

The iframe showing the uploaded document

GroupDocs Annotation

GroupDocs Viewer

GroupDocs Assembly

GroupDocs Signature

GroupDocs Comparison

Platform

Dashboard

API

Requirements

Theory

Callback

The logic

Practice

template.html

controller.php

convert_callback.php

check_file.php

download_file.php

Program in action

Save your time and effort with GroupDocs’ online signature

Get peace of mind by tracking the signing process

Efficient work flow walks you through the entire process

Procedure for preparing and sending a document for online signature

Step 1 - Choose a File:

Step 2 - Add Recipients:

Step 3 - Add Info (optional):

Step 4 - Add Reminders (optional):

Step 5 - Add Fields:

Step 6 - Summary (optional):

Requirements

Sample Creation: Creating the Template

The Template Code Explained

Callbacks

Displaying the Comparison Results

Sample Creation: Creating the Controller

The Controller Code Explained

Creating the Compare Function

The Comparison

Calling the Function

Requirements

Preparation

Creating the Plugin

The Code Line by Line

Completing the Plugin Declaration

modules.php

tl_gdv.php

Adding Functionality

htaccess

tl_gdv.php

The Config Folder