Key editing tool (#43)

Author: alecpl

Crypt/GPG.php

@@ -235,6 +235,16 @@ class Crypt_GPG extends Crypt_GPGAbstract
      */
     protected $passphrases = [];
 
+    /**
+     * Get a key editor instance
+     *
+     * @return Crypt_GPG_KeyEditor Key editor object
+     */
+    public function getKeyEditor()
+    {
+        return $this->engine->getKeyEditor();
+    }
+
     /**
      * Imports a public or private key into the keyring
      *

Crypt/GPG/Engine.php

@@ -59,6 +59,11 @@
  */
 require_once 'Crypt/GPG/SignatureCreationInfo.php';
 
+/**
+ * Key editor
+ */
+require_once 'Crypt/GPG/KeyEditor.php';
+
 /**
  * Standard PEAR exception is used if GPG binary is not found.
  */
@@ -999,6 +1004,29 @@ public function setProcessData($name, $value)
         }
     }
 
+    /**
+     * Initialize key editor instance
+     *
+     * @return Crypt_GPG_KeyEditor Key editor object
+     */
+    public function getKeyEditor()
+    {
+        $keys = ['homedir', 'binary', 'publicKeyring', 'privateKeyring', 'trustDb'];
+        $options = [];
+
+        foreach ($keys as $key) {
+            if (isset($this->{"_{$key}"})) {
+                $options[$key] = $this->{"_{$key}"};
+            }
+        }
+
+        if ($this->_debug) {
+            $options['debug'] = function ($line) { $this->_debug($line); };
+        }
+
+        return new Crypt_GPG_KeyEditor($this, $options);
+    }
+
     /**
      * Displays debug output for status lines
      *

Crypt/GPG/Key.php

@@ -108,7 +108,7 @@ public function getUserIds()
      *
      * The primary key is the first added sub-key.
      *
-     * @return Crypt_GPG_SubKey the primary sub-key of this key.
+     * @return ?Crypt_GPG_SubKey the primary sub-key of this key.
      */
     public function getPrimaryKey()
     {
@@ -166,7 +166,7 @@ public function canEncrypt()
      *
      * @param Crypt_GPG_SubKey $subKey the sub-key to add.
      *
-     * @return Crypt_GPG_Key the current object, for fluent interface.
+     * @return $this the current object, for fluent interface.
      */
     public function addSubKey(Crypt_GPG_SubKey $subKey)
     {
@@ -179,7 +179,7 @@ public function addSubKey(Crypt_GPG_SubKey $subKey)
      *
      * @param Crypt_GPG_UserId $userId the user id to add.
      *
-     * @return Crypt_GPG_Key the current object, for fluent interface.
+     * @return $this the current object, for fluent interface.
      */
     public function addUserId(Crypt_GPG_UserId $userId)
     {