Crypt_GPG
[ class tree: Crypt_GPG ] [ index: Crypt_GPG ] [ all elements ]

Source for file KeyGeneratorErrorHandler.php

Documentation is available at KeyGeneratorErrorHandler.php

  1. <?php
  2.  
  3. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  4.  
  5. /**
  6.  * Crypt_GPG is a package to use GPG from PHP
  7.  *
  8.  * This file contains an object that handles GPG's error output for the
  9.  * key generation operation.
  10.  *
  11.  * PHP version 5
  12.  *
  13.  * LICENSE:
  14.  *
  15.  * This library is free software; you can redistribute it and/or modify
  16.  * it under the terms of the GNU Lesser General Public License as
  17.  * published by the Free Software Foundation; either version 2.1 of the
  18.  * License, or (at your option) any later version.
  19.  *
  20.  * This library is distributed in the hope that it will be useful,
  21.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  23.  * Lesser General Public License for more details.
  24.  *
  25.  * You should have received a copy of the GNU Lesser General Public
  26.  * License along with this library; if not, write to the Free Software
  27.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  28.  *
  29.  * @category  Encryption
  30.  * @package   Crypt_GPG
  31.  * @author    Michael Gauthier <mike@silverorange.com>
  32.  * @copyright 2011-2013 silverorange
  33.  * @license   http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
  34.  * @version   CVS: $Id:$
  35.  * @link      http://pear.php.net/package/Crypt_GPG
  36.  * @link      http://www.gnupg.org/
  37.  */
  38.  
  39. /**
  40.  * Error line handler for the key generation operation
  41.  *
  42.  * This class is used internally by Crypt_GPG and does not need be used
  43.  * directly. See the {@link Crypt_GPG} class for end-user API.
  44.  *
  45.  * @category  Encryption
  46.  * @package   Crypt_GPG
  47.  * @author    Michael Gauthier <mike@silverorange.com>
  48.  * @copyright 2011-2013 silverorange
  49.  * @license   http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
  50.  * @link      http://pear.php.net/package/Crypt_GPG
  51.  * @link      http://www.gnupg.org/
  52.  */
  53. {
  54.     // {{{ protected properties
  55.  
  56.     /**
  57.      * Error code (if any) caused by key generation
  58.      *
  59.      * @var integer 
  60.      */
  61.     protected $errorCode = Crypt_GPG::ERROR_NONE;
  62.  
  63.     /**
  64.      * Line number at which the error occurred
  65.      *
  66.      * @var integer 
  67.      */
  68.     protected $lineNumber = null;
  69.  
  70.     // }}}
  71.     // {{{ handle()
  72.  
  73.     /**
  74.      * Handles an error line
  75.      *
  76.      * @param string $line the error line to handle.
  77.      *
  78.      * @return void 
  79.      */
  80.     public function handle($line)
  81.     {
  82.         $matches = array();
  83.         $pattern '/:([0-9]+): invalid algorithm$/';
  84.         if (preg_match($pattern$line$matches=== 1{
  85.             $this->errorCode  = Crypt_GPG::ERROR_BAD_KEY_PARAMS;
  86.             $this->lineNumber = intval($matches[1]);
  87.         }
  88.     }
  89.  
  90.     // }}}
  91.     // {{{ getErrorCode()
  92.  
  93.     /**
  94.      * Gets the error code resulting from key gneration
  95.      *
  96.      * @return integer the error code resulting from key generation.
  97.      */
  98.     public function getErrorCode()
  99.     {
  100.         return $this->errorCode;
  101.     }
  102.  
  103.     // }}}
  104.     // {{{ getLineNumber()
  105.  
  106.     /**
  107.      * Gets the line number at which the error occurred
  108.      *
  109.      * @return integer the line number at which the error occurred. Null if
  110.      *                  no error occurred.
  111.      */
  112.     public function getLineNumber()
  113.     {
  114.         return $this->lineNumber;
  115.     }
  116.  
  117.     // }}}
  118. }
  119.  
  120. ?>

Documentation generated on Wed, 13 Mar 2013 18:30:10 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.