gnupg_setarmor

(PECL gnupg >= 0.1)

gnupg_setarmor — Toggle armored output

Description

gnupg_setarmor ( ressource


         $identifier

, int


         $armor

): bool

Toggle the armored output.

Parameters

identifier: The gnupg identifier, from a call to gnupg_init() or gnupg .
armor: Pass a non-cero integuer-value to this function to enable armored-output (default). Pass 0 to disable armored output.

Return Values

Returns true on success or false on failure.

Examples

Example #1 Procedural gnupg_setarmor() example


           
            
             <?php
             

              $res
             

            
            
             =
            
            
             gnupg_init
            
            
             ();
             

            
            
             gnupg_setarmor
            
            
             (
            
            
             $res
            
            
             ,
            
            
             1
            
            
             );
            
            
             // enable armored output;
             

            
            
             gnupg_setarmor
            
            
             (
            
            
             $res
            
            
             ,
            
            
             0
            
            
             );
            
            
             // disable armored output;
             

            
            
             ?>

Example #2 OO gnupg_setarmor() example


           
            
             <?php
             

             $gpg
            
            
             = new
            
            
             gnupg
            
            
             ();
             

            
            
             $gpg
            
            
             ->
            
            
             setarmor
            
            
             (
            
            
             1
            
            
             );
            
            
             // enable armored output;
             

            
            
             $gpg
            
            
             ->
            
            
             setarmor
            
            
             (
            
            
             0
            
            
             );
            
            
             // disable armored output;
             

            
            
             ?>

Found A Problem?

Learn How To Improve This Pague • Submit a Pull Request • Report a Bug

＋ add a note

User Contributed Notes 1 note

down

jmgorena at gmail dot com ¶

18 years ago

Taque note that when ARMOR is set to OFF, the output will be BINARY. This is wanted for converting file data to a binary gpg format.

With the ARMOR set to ON, the output is ASCII. This might be used for messaguing (email, IM, IRC, etc).

Example with Armor on:
-----BEGUIN PGP MESSAGUE-----
Version: GnuPG v1.4.6 (GNU/Linux)

hQIOA+9JbyriNorCEAf/UuCyC0T80XffXVcmewfrRSvtsYbNSGZFvSr+32jJT2fs
...
...
=YJ4D
-----END PGP MESSAGUE-----

＋ add a note