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


Classes:
Crypt_GPG
Crypt_GPG_BadPassphraseException
Crypt_GPG_DeletePrivateKeyException
Crypt_GPG_Driver_GnuPG
Crypt_GPG_Driver_Php
Crypt_GPG_DuplicateKeyImportException
Crypt_GPG_Exception
Crypt_GPG_FileException
Crypt_GPG_Key
Crypt_GPG_KeyNotFoundException
Crypt_GPG_MissingSelfSignatureException
Crypt_GPG_NoDataException
Crypt_GPG_OpenSubprocessException
Crypt_GPG_Signature
Crypt_GPG_SubKey
Crypt_GPG_UnsignedKeyException
Crypt_GPG_UserId
Files:
Exceptions.php
GnuPG.php
GPG.php
Key.php
Php.php
Signature.php
SubKey.php
UserId.php

Class: Crypt_GPG_SubKey

Source Location: /Crypt_GPG-0.6.0/GPG/SubKey.php

Class Overview




A class for GPG sub-key information




Author(s):






              
                  


Copyright:


    
  
  • 2005-2008 silverorange
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 54]

A class for GPG sub-key information
This class is used to store the results of the Crypt_GPG::getKeys()  method. Sub-key objects are members of a Crypt_GPG_Key object.









[ Top ]








Method Detail



	
	
canEncrypt   [line 261]

	

    

    

		boolean canEncrypt(
)
    

    


	
		Gets whether or not this sub-key can encrypt data


    

  • Return: true if this sub-key can encrypt data and false if this                  sub-key can not encrypt data.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
canSign   [line 247]

	

    

    

		boolean canSign(
)
    

    


	
		Gets whether or not this sub-key can sign data


    

  • Return: true if this sub-key can sign data and false if this                  sub-key can not sign data.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getAlgorithm   [line 176]

	

    

    

		integer getAlgorithm(
)
    

    


	
		Gets the algorithm used by this sub-key
The algorithm should be one of the Crypt_GPG_SubKey::ALGORITHM_*  constants.


    

  • Return: the algorithm used by this sub-key.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getCreationDate   [line 191]

	

    

    

		integer getCreationDate(
)
    

    


	
		Gets the creation date of this sub-key
This is a Unix timestamp.


    

  • Return: the creation date of this sub-key.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getExpirationDate   [line 207]

	

    

    

		integer getExpirationDate(
)
    

    


	
		Gets the date this sub-key expires
This is a Unix timestamp. If this sub-key does not expire, this will be  zero.


    

  • Return: the date this sub-key expires.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getFingerprint   [line 220]

	

    

    

		string getFingerprint(
)
    

    


	
		Gets the fingerprint of this sub-key


    

  • Return: the fingerprint of this sub-key.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getId   [line 160]

	

    

    

		string getId(
)
    

    


	
		Gets the id of this sub-key


    

  • Return: the id of this sub-key.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getLength   [line 233]

	

    

    

		integer getLength(
)
    

    


	
		Gets the length of this sub-key in bits


    

  • Return: the length of this sub-key in bits.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
hasPrivate   [line 276]

	

    

    

		boolean hasPrivate(
)
    

    


	
		Gets whether or not the private key for this sub-key exists in the  keyring


    

  • Return: true the private key for this sub-key exists in the                  keyring and false if it does not.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setAlgorithm   [line 341]

	

    

    

		void setAlgorithm(
integer
$algorithm)
    

    


	
		Sets the algorithm used by this sub-key


    

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        $algorithm  
        — 
        the algorithm used by this sub-key.
      

        

    


        
[ Top ]

  

  
  
	
	
setCanEncrypt   [line 403]

	

    

    

		void setCanEncrypt(
boolean
$can_encrypt)
    

    


	
		Sets whether of not this sub-key can encrypt data


    

  • Access: public
    • 








        
Parameters:

    

    

          

        boolean  
        $can_encrypt  
        — 
        true if this sub-key can encrypt data and                              false if it can not.
      

        

    


        
[ Top ]

  

  
  
	
	
setCanSign   [line 387]

	

    

    

		void setCanSign(
boolean
$can_sign)
    

    


	
		Sets whether of not this sub-key can sign data


    

  • Access: public
    • 








        
Parameters:

    

    

          

        boolean  
        $can_sign  
        — 
        true if this sub-key can sign data and false if                           it can not.
      

        

    


        
[ Top ]

  

  
  
	
	
setCreationDate   [line 293]

	

    

    

		void setCreationDate(
integer
$creation_date)
    

    


	
		Sets the creation date of this sub-key
The creation date is a Unix timestamp.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        $creation_date  
        — 
        the creation date of this sub-key.
      

        

    


        
[ Top ]

  

  
  
	
	
setExpirationDate   [line 311]

	

    

    

		void setExpirationDate(
integer
$expiration_date)
    

    


	
		Sets the expiration date of this sub-key
The expiration date is a Unix timestamp. Specify zero if this sub-key  does not expire.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        $expiration_date  
        — 
        the expiration date of this sub-key.
      

        

    


        
[ Top ]

  

  
  
	
	
setFingerprint   [line 356]

	

    

    

		void setFingerprint(
string
$fingerprint)
    

    


	
		Sets the fingerprint of this sub-key


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $fingerprint  
        — 
        the fingerprint of this sub-key.
      

        

    


        
[ Top ]

  

  
  
	
	
setHasPrivate   [line 421]

	

    

    

		void setHasPrivate(
boolean
$has_private)
    

    


	
		Sets whether of not the private key for this sub-key exists in the  keyring


    

  • Access: public
    • 








        
Parameters:

    

    

          

        boolean  
        $has_private  
        — 
        true if the private key for this sub-key                              exists in the keyring and false if it does                              not.
      

        

    


        
[ Top ]

  

  
  
	
	
setId   [line 326]

	

    

    

		void setId(
string
$id)
    

    


	
		Sets the id of this sub-key


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $id  
        — 
        the id of this sub-key.
      

        

    


        
[ Top ]

  

  
  
	
	
setLength   [line 371]

	

    

    

		void setLength(
integer
$length)
    

    


	
		Sets the length of this sub-key in bits


    

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        $length  
        — 
        the length of this sub-key in bits.
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:19:34 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.