Advanced Silent Multipage TIF Printing with Tray, Paper Size, Rotation & Pages Range Settings from PHP

Product WebClientPrint for PHP Published 01/21/2021 Updated 01/21/2021 Author

Overview

In this walkthrough, you'll learn how to silently print Multipage TIF files from an PHP website directly to the client printer without displaying a print dialog. You'll be able to print TIF files to the Default client printer as well as to any other installed printer at the client machine with advanced settings like Tray Name, Paper Size, Print Rotation, Pages Range and more! This solution works with any browser on Windows OS like IE (6 or later), Chrome, Firefox, Opera & Safari as well as on Linux, Raspberry Pi & Mac systems!

Try Online Demo!

Requirements

Development/Server-side

  WebClientPrint 6.0 for PHP (or greater)
  PHP 5.3 (or greater)

Client-side

  WebClientPrint Processor 6.0 for Windows, Linux, Raspberry Pi & Mac

Follow up these steps

  • Download & install WebClientPrint for PHP
  • Create a new PHP Website naming it PrintTIFSample
  • Now follow up the instructions for each PHP Classic or PHP MVC/Laravel:

    • Create a new folder called wcpcache at your project's root folder

    • Copy the WebClientPrint.php to your project's root folder

    Creating Controllers

    • Create a new PHP file at root folder and name it WebClientPrintController.php and then copy/paste the following code:

    <?php
//*********************************
// IMPORTANT NOTE 
// 1. In this sample we store users related stuff (like
// the list of printers and whether they have the WCPP 
// client utility installed) in the wcpcache folder BUT 
// you can change it to another different storage (like a DB)!
// which will be required in Load Balacing scenarios
// 
// 2. If your website requires user authentication, then
// THIS FILE MUST be set to ALLOW ANONYMOUS access!!!
// 
//*********************************

include 'WebClientPrint.php';
use Neodynamic\SDK\Web\WebClientPrint;

//IMPORTANT SETTINGS:
//===================
//Set wcpcache folder RELATIVE to WebClientPrint.php file
//FILE WRITE permission on this folder is required!!!
WebClientPrint::$wcpCacheFolder = getcwd().'/wcpcache/';

if (file_exists(WebClientPrint::$wcpCacheFolder) == false) {
    //create wcpcache folder
    $old_umask = umask(0);
    mkdir(WebClientPrint::$wcpCacheFolder, 0777);
    umask($old_umask);
}

//===================

// Clean built-in Cache
// NOTE: Remove it if you implement your own cache system
WebClientPrint::cacheClean(30); //in minutes


// Process WebClientPrint Request

$urlParts = parse_url($_SERVER['REQUEST_URI']);
if (isset($urlParts['query'])){
    $query = $urlParts['query'];
    parse_str($query, $qs);
    
    //get session id from querystring if any
    $sid = NULL;
    if (isset($qs[WebClientPrint::SID])){
        $sid = $qs[WebClientPrint::SID];
    }
    
    try{
        //get request type
        $reqType = WebClientPrint::GetProcessRequestType($query);
        
        if($reqType == WebClientPrint::GenPrintScript ||
           $reqType == WebClientPrint::GenWcppDetectScript){
            //Let WebClientPrint to generate the requested script
            
            //Get Absolute URL of this file
            $currentAbsoluteURL = (@$_SERVER["HTTPS"] == "on") ? "https://" : "http://";
            $currentAbsoluteURL .= $_SERVER["SERVER_NAME"];
            if($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443")
            {
                $currentAbsoluteURL .= ":".$_SERVER["SERVER_PORT"];
            } 
            $currentAbsoluteURL .= $_SERVER["REQUEST_URI"];
            $currentAbsoluteURL = substr($currentAbsoluteURL, 0, strrpos($currentAbsoluteURL, '?'));
            
            ob_start();
            ob_clean();
            header('Content-type: text/javascript');
            echo WebClientPrint::generateScript($currentAbsoluteURL, $query);
            return;
        } 
        else if ($reqType == WebClientPrint::ClientSetWcppVersion)
        {
            //This request is a ping from the WCPP utility
            //so store the session ID indicating this user has the WCPP installed
            //also store the WCPP Version if available
            if(isset($qs[WebClientPrint::WCPP_SET_VERSION]) && strlen($qs[WebClientPrint::WCPP_SET_VERSION]) > 0){
                WebClientPrint::cacheAdd($sid, WebClientPrint::WCP_CACHE_WCPP_VER, $qs[WebClientPrint::WCPP_SET_VERSION]);
            }
            return;
        }
        else if ($reqType == WebClientPrint::ClientSetInstalledPrinters)
        {
            //WCPP Utility is sending the installed printers at client side
            //so store this info with the specified session ID
            WebClientPrint::cacheAdd($sid, WebClientPrint::WCP_CACHE_PRINTERS, strlen($qs[WebClientPrint::WCPP_SET_PRINTERS]) > 0 ? $qs[WebClientPrint::WCPP_SET_PRINTERS] : '');
            return;
        }
        else if ($reqType == WebClientPrint::ClientSetInstalledPrintersInfo)
        {
            //WCPP Utility is sending the installed printers at client side with detailed info
            //so store this info with the specified session ID
            //Printers Info is in JSON format
            $printersInfo = $_POST['printersInfoContent'];
            
            WebClientPrint::cacheAdd($sid, WebClientPrint::WCP_CACHE_PRINTERSINFO, $printersInfo);
            return;
        }
        else if ($reqType == WebClientPrint::ClientGetWcppVersion)
        {
            //return the WCPP version for the specified Session ID (sid) if any
            ob_start();
            ob_clean();
            header('Content-type: text/plain');
            echo WebClientPrint::cacheGet($sid, WebClientPrint::WCP_CACHE_WCPP_VER);
            return;    
        }
        else if ($reqType == WebClientPrint::ClientGetInstalledPrinters)
        {
            //return the installed printers for the specified Session ID (sid) if any
            ob_start();
            ob_clean();
            header('Content-type: text/plain');
            echo base64_decode(WebClientPrint::cacheGet($sid, WebClientPrint::WCP_CACHE_PRINTERS));
            return;
        }    
        else if ($reqType == WebClientPrint::ClientGetInstalledPrintersInfo)
        {
            //return the installed printers with detailed info for the specified Session ID (sid) if any
            ob_start();
            ob_clean();
            header('Content-type: text/plain');
            echo base64_decode(WebClientPrint::cacheGet($sid, WebClientPrint::WCP_CACHE_PRINTERSINFO));
            return;
        }    
    }
    catch (Exception $ex)
    {
        throw $ex;
    }
    
}

    • Create a new PHP file and name it PrintTIFController.php and then copy/paste the following code:

    <?php

include 'WebClientPrint.php';

use Neodynamic\SDK\Web\WebClientPrint;
use Neodynamic\SDK\Web\DefaultPrinter;
use Neodynamic\SDK\Web\InstalledPrinter;
use Neodynamic\SDK\Web\PrintFile;
use Neodynamic\SDK\Web\PrintFileTIF;
use Neodynamic\SDK\Web\PrintRotation;
use Neodynamic\SDK\Web\ClientPrintJob;

// Process request
// Generate ClientPrintJob? only if clientPrint param is in the query string
$urlParts = parse_url($_SERVER['REQUEST_URI']);

if (isset($urlParts['query'])) {
    $rawQuery = $urlParts['query'];
    parse_str($rawQuery, $qs);
    if (isset($qs[WebClientPrint::CLIENT_PRINT_JOB])) {

        //the TIF file to be printed, supposed to be in files folder
        $filePath = 'files/MyTIFdocument.TIF';
        //create a temp file name for our TIF file...
        $fileName = 'MyFile'.uniqid();
        
        //Create PrintFileTIF obj
        $myfile = new PrintFileTIF($filePath, $fileName, null);
        $myfile->printRotation = PrintRotation::parse($qs['printRotation']);
        $myfile->pagesRange = $qs['pagesRange'];
        $myfile->printAsGrayscale = ($qs['printAsGrayscale']=='true');
        $myfile->printInReverseOrder = ($qs['printInReverseOrder']=='true');
        
        //Create a ClientPrintJob obj that will be processed at the client side by the WCPP
        $cpj = new ClientPrintJob();
        $cpj->printFile = $myfile;
        
        //Create an InstalledPrinter obj
        $myPrinter = new InstalledPrinter(urldecode($qs['printerName']));
        $myPrinter->trayName = $qs['trayName'];
        $myPrinter->paperName = $qs['paperName'];
        
        $cpj->clientPrinter = $myPrinter;
        
        //Send ClientPrintJob back to the client
		ob_start();
		ob_clean();
		header('Content-type: application/octet-stream');
		echo $cpj->sendToClient();
		ob_end_flush();
		exit();
        
    }
}

    Creating Web Pages

    • The default page is for detecting whether the client machine has the WebClientPrint Processor (WCPP) Utility installed. Create a new PHP page and name it index.php. Then copy/paste the following code:

    <?php
  session_start();
  
  include 'WebClientPrint.php';
  use Neodynamic\SDK\Web\WebClientPrint;
  
?>
<!DOCTYPE html>
<html>
    <head>
        <title>Detecting WebClientPrint Processor...</title>
        
        <style>
        body{font: 13px 'Segoe UI', Tahoma, Arial, Helvetica, sans-serif;}        
        </style>
    
    </head>
    <body>
        <div id="msgInProgress">
            <div id="mySpinner" style="width:32px;height:32px"></div>
            <br />
            Detecting WCPP utility at client side... 
            <br />
            Please wait a few seconds...
            <br />
        </div>
        <div id="msgInstallWCPP" style="display:none;">    
            <h3>#1 Install WebClientPrint Processor (WCPP)!</h3>
            <p>
                <strong>WCPP is a native app (without any dependencies!)</strong> that handles all print jobs 
                generated by the <strong>WebClientPrint PHP component</strong> at the server side. The WCPP 
                is in charge of the whole printing process and can be 
                installed on <strong>Windows, Linux, Raspberry Pi & Mac!</strong>
            </p>
            <p>
                <a href="http://www.neodynamic.com/downloads/wcpp/" target="_blank">Download and Install WCPP from Neodynamic website</a><br />                
            </p>         
            <h3>#2 After installing WCPP...</h3>
            <p>
                <a href="PrintTIF.php">You can go and test the printing page</a>
            </p>

        </div>
        
        <!-- Add Reference to jQuery at Google CDN -->
        <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>

        
        

        <script type="text/javascript">

            var wcppPingTimeout_ms = 60000; //60 sec
            var wcppPingTimeoutStep_ms = 500; //0.5 sec

            function wcppDetectOnSuccess(){
                // WCPP utility is installed at the client side
                // redirect to WebClientPrint sample page

                // get WCPP version
                var wcppVer = arguments[0];
                if(wcppVer.substring(0, 1) == "6")
                    window.location.href = "PrintTIF.php";
                else //force to install WCPP v6.0
                    wcppDetectOnFailure();
            }

            function wcppDetectOnFailure() {
                // It seems WCPP is not installed at the client side
                // ask the user to install it
                $('#msgInProgress').hide();
                $('#msgInstallWCPP').show();                
            }


        </script>
        
        <?php
        
        //Get Absolute URL of this page
        $currentAbsoluteURL = (@$_SERVER["HTTPS"] == "on") ? "https://" : "http://";
        $currentAbsoluteURL .= $_SERVER["SERVER_NAME"];
        if($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443")
        {
            $currentAbsoluteURL .= ":".$_SERVER["SERVER_PORT"];
        } 
        $currentAbsoluteURL .= $_SERVER["REQUEST_URI"];
    
        //WebClientPrinController.php is at the same page level as WebClientPrint.php
        $webClientPrintControllerAbsoluteURL = substr($currentAbsoluteURL, 0, strrpos($currentAbsoluteURL, '/')).'/WebClientPrintController.php';

        // Create WCPP detection script
        echo WebClientPrint::createWcppDetectionScript($webClientPrintControllerAbsoluteURL, session_id());

        ?>
    </body>
</html>

    • Add a new PHP page and name it PrintTIF.php. Copy/paste the following code:

    <?php 
    session_start();

    include 'WebClientPrint.php';
    use Neodynamic\SDK\Web\WebClientPrint;
?>

    <h1>Advanced TIF Printing</h1>
    <p>
	    With <strong>WebClientPrint</strong> solution you can <strong>print TIF files</strong> right to any installed printer at the client side with advanced settings.
    </p>

    <h4>Click on <strong>"Get Printers Info"</strong> button to get Printers Name, Supported Papers and Trays</h4>
    <input type="button" onclick="javascript:jsWebClientPrint.getPrintersInfo();" value="Get Printers Info..." />
    <br />
    <label for="lstPrinters">Printers:</label>
    <select name="lstPrinters" id="lstPrinters" onchange="showSelectedPrinterInfo();" ></select>
    <br />
    <label for="lstPrinterTrays">Supported Trays:</label>
    <select name="lstPrinterTrays" id="lstPrinterTrays" ></select>
    <br />
    <label for="lstPrinterPapers">Supported Papers:</label>
    <select name="lstPrinterPapers" id="lstPrinterPapers" ></select>
    <br />
    <label for="lstPrintRotation">Print Rotation (Clockwise):</label>
    <select name="lstPrintRotation" id="lstPrintRotation" >
	    <option>None</option>
	    <option>Rot90</option>
	    <option>Rot180</option>
	    <option>Rot270</option>
    </select>
    <br />
    <label for="txtPagesRange">Pages Range: [e.g. 1,2,3,10-15]</label>
    <input type="text" id="txtPagesRange">
    <br />
    <label><input id="chkPrintInReverseOrder" type="checkbox" value="">Print In Reverse Order?</label>
    <br />
    <label><input id="chkPrintAsGrayscale" type="checkbox" value="">Print As Grayscale? </label>
    <br />
    <br />
    <input type="button" onclick="javascript:jsWebClientPrint.print('printerName=' + encodeURIComponent($('#lstPrinters').val()) + '&trayName=' + encodeURIComponent($('#lstPrinterTrays').val()) + '&paperName=' + encodeURIComponent($('#lstPrinterPapers').val()) + '&printRotation=' + $('#lstPrintRotation').val() + '&pagesRange=' + encodeURIComponent($('#txtPagesRange').val()) + '&printAsGrayscale=' + $('#chkPrintAsGrayscale').prop('checked') + '&printInReverseOrder=' + $('#chkPrintInReverseOrder').prop('checked'));" value="Print TIF..." />


    <script type="text/javascript">
    var clientPrinters = null;

    var wcppGetPrintersTimeout_ms = 60000; //60 sec
    var wcppGetPrintersTimeoutStep_ms = 500; //0.5 sec
    function wcpGetPrintersOnSuccess() {
	    // Display client installed printers
	    if (arguments[0].length > 0) {
		    if (JSON) {
			    try {
				    clientPrinters = JSON.parse(arguments[0]);
				    if (clientPrinters.error) {
					    alert(clientPrinters.error)
				    } else {
					    var options = '';
					    for (var i = 0; i < clientPrinters.length; i++) {
						    options += '<option>' + clientPrinters[i].name + '</option>';
					    }
					    $('#lstPrinters').html(options);
					    $('#lstPrinters').focus();

					    showSelectedPrinterInfo();
				    }
			    } catch (e) {
				    alert(e.message)
			    }
		    }


	    } else {
		    alert("No printers are installed in your system.");
	    }
    }
    function wcpGetPrintersOnFailure() {
	    // Do something if printers cannot be got from the client
	    alert("No printers are installed in your system.");
    }


    function showSelectedPrinterInfo() {
	    // get selected printer index
	    var idx = $("#lstPrinters")[0].selectedIndex;
	    // get supported trays
	    var options = '';
	    for (var i = 0; i < clientPrinters[idx].trays.length; i++) {
		    options += '<option>' + clientPrinters[idx].trays[i] + '</option>';
	    }
	    $('#lstPrinterTrays').html(options);
	    // get supported papers
	    options = '';
	    for (var i = 0; i < clientPrinters[idx].papers.length; i++) {
		    options += '<option>' + clientPrinters[idx].papers[i] + '</option>';
	    }
	    $('#lstPrinterPapers').html(options);
    }
    </script>
    
    <!-- Add Reference to jQuery at Google CDN -->
    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js" type="text/javascript"></script>

    <?php
    //Get Absolute URL of this page
    $currentAbsoluteURL = (@$_SERVER["HTTPS"] == "on") ? "https://" : "http://";
    $currentAbsoluteURL .= $_SERVER["SERVER_NAME"];
    if($_SERVER["SERVER_PORT"] != "80" && $_SERVER["SERVER_PORT"] != "443")
    {
        $currentAbsoluteURL .= ":".$_SERVER["SERVER_PORT"];
    } 
    $currentAbsoluteURL .= $_SERVER["REQUEST_URI"];
    
    //WebClientPrinController.php is at the same page level as WebClientPrint.php
    $webClientPrintControllerAbsoluteURL = substr($currentAbsoluteURL, 0, strrpos($currentAbsoluteURL, '/')).'/WebClientPrintController.php';
    
    //PrintTIFController.php is at the same page level as WebClientPrint.php
    $printTIFControllerAbsoluteURL = substr($currentAbsoluteURL, 0, strrpos($currentAbsoluteURL, '/')).'/PrintTIFController.php';
    
    //Specify the ABSOLUTE URL to the WebClientPrintController.php and to the file that will create the ClientPrintJob object
    echo WebClientPrint::createScript($webClientPrintControllerAbsoluteURL, $printTIFControllerAbsoluteURL, session_id());
    ?>
       

</body>
</html>

    WebClientPrint Setup for Laravel 8+

    • Create a new folder called WebClientPrint under app folder of your project

    • Copy the WebClientPrint.php to that WebClientPrint folder

    • Create a new folder called wcpcache under the WebClientPrint folder

    Creating Controllers

    • Add a new Controller to your project and name it WebClientPrintController.php. Then copy/paste the following code:

    <?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

//*********************************
// IMPORTANT NOTE 
// 1. In this sample we store users related stuff (like
// the list of printers and whether they have the WCPP 
// client utility installed) in the wcpcache folder BUT 
// you can change it to another different storage (like a DB)!
// which will be required in Load Balacing scenarios
// 
// 2. If your website requires user authentication, then
// THIS FILE MUST be set to ALLOW ANONYMOUS access!!!
//
// 3. EXCLUDE this Controller from CSRF Protection
// Ref https://laravel.com/docs/5.5/csrf#csrf-excluding-uris
//*********************************

//Includes WebClientPrint classes
include_once(app_path() . '\WebClientPrint\WebClientPrint.php');
use Neodynamic\SDK\Web\WebClientPrint;


class WebClientPrintController extends Controller
{

    public function processRequest(Request $request){

        
        //IMPORTANT SETTINGS:
        //===================
        //Set wcpcache folder RELATIVE to WebClientPrint.php file
        //FILE WRITE permission on this folder is required!!!
        WebClientPrint::$wcpCacheFolder = app_path() . '/WebClientPrint/wcpcache/';
        //===================

        // Clean built-in Cache
        // NOTE: Remove it if you implement your own cache system
        WebClientPrint::cacheClean(30); //in minutes

        //get session id from querystring if any
        $sid = NULL;
        if ($request->has(WebClientPrint::SID)){
            $sid = $request->input(WebClientPrint::SID);
        }
        
        try{
            //get query string from url
            $query = substr($request->fullUrl(), strpos($request->fullUrl(), '?')+1);
            //get request type
            $reqType = WebClientPrint::GetProcessRequestType($query);
            
            if($reqType == WebClientPrint::GenPrintScript ||
            $reqType == WebClientPrint::GenWcppDetectScript){
                //Let WebClientPrint to generate the requested script
                
                //Get Absolute URL of this file
                $currentAbsoluteURL = substr($request->fullUrl(), 0, strrpos($request->fullUrl(), '?'));
                
                // Return WebClientPrint's javascript code 
                return response(WebClientPrint::generateScript($currentAbsoluteURL, $query))
                        ->header('Content-Type', 'text/javascript');
                
            } 
            else if ($reqType == WebClientPrint::ClientSetWcppVersion)
            {
                //This request is a ping from the WCPP utility
                //so store the session ID indicating this user has the WCPP installed
                //also store the WCPP Version if available
                if($request->has(WebClientPrint::WCPP_SET_VERSION) && strlen($request->input(WebClientPrint::WCPP_SET_VERSION)) > 0){
                    WebClientPrint::cacheAdd($sid, WebClientPrint::WCP_CACHE_WCPP_VER, $request->input(WebClientPrint::WCPP_SET_VERSION));
                }
                return;
            }
            else if ($reqType == WebClientPrint::ClientSetInstalledPrinters)
            {
                //WCPP Utility is sending the installed printers at client side
                //so store this info with the specified session ID
                WebClientPrint::cacheAdd($sid, WebClientPrint::WCP_CACHE_PRINTERS, strlen($request->input(WebClientPrint::WCPP_SET_PRINTERS)) > 0 ? $request->input(WebClientPrint::WCPP_SET_PRINTERS) : '');
                return;
            }
            else if ($reqType == WebClientPrint::ClientSetInstalledPrintersInfo)
            {
                //WCPP Utility is sending the installed printers at client side with detailed info
                //so store this info with the specified session ID
                //Printers Info is in JSON format
                $printersInfo = $request->input('printersInfoContent');
                
                WebClientPrint::cacheAdd($sid, WebClientPrint::WCP_CACHE_PRINTERSINFO, $printersInfo);
                return;
            }
            else if ($reqType == WebClientPrint::ClientGetWcppVersion)
            {
                //return the WCPP version for the specified Session ID (sid) if any
                return response(WebClientPrint::cacheGet($sid, WebClientPrint::WCP_CACHE_WCPP_VER))
                        ->header('Content-Type', 'text/plain');                 
            }
            else if ($reqType == WebClientPrint::ClientGetInstalledPrinters)
            {
                //return the installed printers for the specified Session ID (sid) if any
                return response(base64_decode(WebClientPrint::cacheGet($sid, WebClientPrint::WCP_CACHE_PRINTERS)))
                        ->header('Content-Type', 'text/plain'); 
            }    
            else if ($reqType == WebClientPrint::ClientGetInstalledPrintersInfo)
            {
                //return the installed printers with detailed info for the specified Session ID (sid) if any
                return response(base64_decode(WebClientPrint::cacheGet($sid, WebClientPrint::WCP_CACHE_PRINTERSINFO)))
                        ->header('Content-Type', 'text/plain'); 
            }    
        }
        catch (Exception $ex)
        {
            throw $ex;
        }

    }
    
}

    • Exclude WebClientPrintAPIController from CSRF Protection by editing app\Http\Middleware\VerifyCsrfToken.php so it looks like the following code:

    <?php

namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;

class VerifyCsrfToken extends BaseVerifier
{
    /**
     * The URIs that should be excluded from CSRF verification.
     *
     * @var array
     */
    protected $except = [
        'WebClientPrintController'
    ];
}

    • Edit the HomeController so it looks like the following code:

    <?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use Session;

//Includes WebClientPrint classes
include_once(app_path() . '\WebClientPrint\WebClientPrint.php');
use Neodynamic\SDK\Web\WebClientPrint;


class HomeController extends Controller
{
    public function index(){

        $wcppScript = WebClientPrint::createWcppDetectionScript(action('WebClientPrintController@processRequest'), Session::getId());    

        return view('home.index', ['wcppScript' => $wcppScript]);
    }

    public function printTIF(){
        $wcpScript = WebClientPrint::createScript(action('WebClientPrintController@processRequest'), action('PrintTIFController@printFile'), Session::getId());    

        return view('home.printTIF', ['wcpScript' => $wcpScript]);
    }
    
}

    • Add a new Controller and name it PrintTIFController and paste the following code:

    <?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;


//*********************************
// IMPORTANT NOTE 
// ==============
// If your website requires user authentication, then
// THIS FILE MUST be set to ALLOW ANONYMOUS access!!!
//
//*********************************

//Includes WebClientPrint classes
include_once(app_path() . '\WebClientPrint\WebClientPrint.php');
use Neodynamic\SDK\Web\WebClientPrint;
use Neodynamic\SDK\Web\Utils;
use Neodynamic\SDK\Web\DefaultPrinter;
use Neodynamic\SDK\Web\InstalledPrinter;
use Neodynamic\SDK\Web\PrintFile;
use Neodynamic\SDK\Web\PrintFileTIF;
use Neodynamic\SDK\Web\PrintRotation;
use Neodynamic\SDK\Web\ClientPrintJob;

use Session;

class PrintTIFController extends Controller
{
    
    public function printFile(Request $request){
        
       if ($request->exists(WebClientPrint::CLIENT_PRINT_JOB)) {

            $fileName = 'MyFile'.uniqid();
            $filePath = public_path().'/files/MyTIFdocument.TIF';
        
            //Create PrintFileTIF obj
            $myfile = new PrintFileTIF($filePath, $fileName, null);
            $myfile->printRotation = PrintRotation::parse($request->input('printRotation'));
            $myfile->pagesRange = $request->input('pagesRange');
            $myfile->printAsGrayscale = ($request->input('printAsGrayscale')=='true');
            $myfile->printInReverseOrder = ($request->input('printInReverseOrder')=='true');
            
            //Create a ClientPrintJob obj that will be processed at the client side by the WCPP
            $cpj = new ClientPrintJob();
            $cpj->printFile = $myfile;
            
            //Create an InstalledPrinter obj
            $myPrinter = new InstalledPrinter(urldecode($request->input('printerName')));
            $myPrinter->trayName = $request->input('trayName');
            $myPrinter->paperName = $request->input('paperName');
            
            $cpj->clientPrinter = $myPrinter;
            
            //Send ClientPrintJob back to the client
            return response($cpj->sendToClient())
                        ->header('Content-Type', 'application/octet-stream');
                
            
        }
    }    
    
}

    Creating/Editing Views

    • Edit the resources / views / layouts / app.blade.php file so it looks like follows:

    
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <title>WebClientPrint for PHP</title>    
</head>
<body>
    
    <div>
        @yield('body')
	</div>

	<script src="https://code.jquery.com/jquery-2.2.4.min.js"></script>
    
    @yield('scripts')

</body>
</html>

    • The default View is for detecting whether the client machine has the WebClientPrint Processor (WCPP) Utility installed. Edit the resources / views / home / index.blade.php file and add the folowing section to the BODY:

    
@extends('layouts.app')

@section('body')
<div id="msgInProgress">
    
    <h3>Detecting WCPP utility at client side...</h3>
    <h3>Please wait a few seconds...</h3>
    <br />
</div>
<div id="msgInstallWCPP" style="display:none;">
    <h3>#1 Install WebClientPrint Processor (WCPP)!</h3>
    <p>
        <strong>WCPP is a native app (without any dependencies!)</strong> that handles all print jobs
        generated by the <strong>WebClientPrint for PHP component</strong> at the server side. The WCPP
        is in charge of the whole printing process and can be
        installed on <strong>Windows, Linux, Mac & Raspberry Pi!</strong>
    </p>
    <p>
        <a href="//www.neodynamic.com/downloads/wcpp/" target="_blank" >Download and Install WCPP from Neodynamic website</a><br />
    </p>
    <h3>#2 After installing WCPP...</h3>
    <p>
        <a href="{{action('HomeController@printTIF')}}" >You can go and test the printing page...</a>
    </p>

</div>
@endsection

@section('scripts')
<script type="text/javascript">

    var wcppPingTimeout_ms = 60000; //60 sec
    var wcppPingTimeoutStep_ms = 500; //0.5 sec

                     
    function wcppDetectOnSuccess(){
        // WCPP utility is installed at the client side
        // redirect to WebClientPrint sample page
                
        // get WCPP version
        var wcppVer = arguments[0];
        if(wcppVer.substring(0, 1) == "6")
            window.location.href = '{{action('HomeController@printTIF')}}';
        else //force to install WCPP v6.0
            wcppDetectOnFailure();
    }

    function wcppDetectOnFailure() {
        // It seems WCPP is not installed at the client side
        // ask the user to install it
        $('#msgInProgress').hide();
        $('#msgInstallWCPP').show();
    }

</script>


{!! 

// Register the WCPP Detection script code
// The $wcpScript was generated by HomeController@index

$wcppScript;

!!}

@endsection

    • Add a new View with the following name and under such folders: resources / views / home / printTIF.blade.php Then, copy/paste the folowing code:

    
@extends('layouts.app')

@section('body')

<h1>Advanced TIF Printing</h1>
<p>
	With <strong>WebClientPrint</strong> solution you can <strong>print TIF files</strong> right to any installed printer at the client side with advanced settings.
</p>

<h4>Click on <strong>"Get Printers Info"</strong> button to get Printers Name, Supported Papers and Trays</h4>
<input type="button" onclick="javascript:jsWebClientPrint.getPrintersInfo();" value="Get Printers Info..." />
<br />
<label for="lstPrinters">Printers:</label>
<select name="lstPrinters" id="lstPrinters" onchange="showSelectedPrinterInfo();" ></select>
<br />
<label for="lstPrinterTrays">Supported Trays:</label>
<select name="lstPrinterTrays" id="lstPrinterTrays" ></select>
<br />
<label for="lstPrinterPapers">Supported Papers:</label>
<select name="lstPrinterPapers" id="lstPrinterPapers" ></select>
<br />
<label for="lstPrintRotation">Print Rotation (Clockwise):</label>
<select name="lstPrintRotation" id="lstPrintRotation" >
	<option>None</option>
	<option>Rot90</option>
	<option>Rot180</option>
	<option>Rot270</option>
</select>
<br />
<label for="txtPagesRange">Pages Range: [e.g. 1,2,3,10-15]</label>
<input type="text" id="txtPagesRange">
<br />
<label><input id="chkPrintInReverseOrder" type="checkbox" value="">Print In Reverse Order?</label>
<br />
<label><input id="chkPrintAsGrayscale" type="checkbox" value="">Print As Grayscale? </label>
<br />
<br />
<input type="button" onclick="javascript:jsWebClientPrint.print('printerName=' + encodeURIComponent($('#lstPrinters').val()) + '&trayName=' + encodeURIComponent($('#lstPrinterTrays').val()) + '&paperName=' + encodeURIComponent($('#lstPrinterPapers').val()) + '&printRotation=' + $('#lstPrintRotation').val() + '&pagesRange=' + encodeURIComponent($('#txtPagesRange').val()) + '&printAsGrayscale=' + $('#chkPrintAsGrayscale').prop('checked') + '&printInReverseOrder=' + $('#chkPrintInReverseOrder').prop('checked'));" value="Print TIF..." />


@endsection

@section('scripts')

<script type="text/javascript">
var clientPrinters = null;

var wcppGetPrintersTimeout_ms = 60000; //60 sec
var wcppGetPrintersTimeoutStep_ms = 500; //0.5 sec
function wcpGetPrintersOnSuccess() {
	// Display client installed printers
	if (arguments[0].length > 0) {
		if (JSON) {
			try {
				clientPrinters = JSON.parse(arguments[0]);
				if (clientPrinters.error) {
					alert(clientPrinters.error)
				} else {
					var options = '';
					for (var i = 0; i < clientPrinters.length; i++) {
						options += '<option>' + clientPrinters[i].name + '</option>';
					}
					$('#lstPrinters').html(options);
					$('#lstPrinters').focus();

					showSelectedPrinterInfo();
				}
			} catch (e) {
				alert(e.message)
			}
		}


	} else {
		alert("No printers are installed in your system.");
	}
}
function wcpGetPrintersOnFailure() {
	// Do something if printers cannot be got from the client
	alert("No printers are installed in your system.");
}


function showSelectedPrinterInfo() {
	// get selected printer index
	var idx = $("#lstPrinters")[0].selectedIndex;
	// get supported trays
	var options = '';
	for (var i = 0; i < clientPrinters[idx].trays.length; i++) {
		options += '<option>' + clientPrinters[idx].trays[i] + '</option>';
	}
	$('#lstPrinterTrays').html(options);
	// get supported papers
	options = '';
	for (var i = 0; i < clientPrinters[idx].papers.length; i++) {
		options += '<option>' + clientPrinters[idx].papers[i] + '</option>';
	}
	$('#lstPrinterPapers').html(options);
}
</script>


{!! 

// Register the WebClientPrint script code
// The $wcpScript was generated by PrintTIFController@index

$wcpScript;

!!}

@endsection

    • Finally, add the following routes to routes / web.php

    
Route::get('/', 'HomeController@index');
Route::get('home', 'HomeController@index');
Route::get('home/index', 'HomeController@index');
Route::get('home/printTIF', 'HomeController@printTIF');
Route::get('PrintTIFController', 'PrintTIFController@printFile');
Route::any('WebClientPrintController', 'WebClientPrintController@processRequest');

    • Edit the app\Providers\RouteServiceProvider.php and uncommet the line protected $namespace = 'App\\Http\\Controllers';

  • That's it! Run your website and test it. Click on Print TIF to print the TIF file without preview. You can print it to the Default client printer or you can get a list of the installed printers available at the client machine.



Useful? Share it!

Related Articles

  How to directly Print Word docs without Preview or Printer Dialog from PHP
  How to Print Excel Spreadsheet without Preview or Printer Dialog from PHP
  How to Print RAW Text Files without Print Dialog from PHP
  How to print multiple files to client printers from PHP

Need help? Contact Support

We provide best-in-class customer service and support directly from members of our dev team! If we are available when you contact us, you will get a response in few minutes; otherwise the maximum turnaround is 24hs in most cases.