Adding Docblocks throughout the project and lowering the missing docblock limit in phpci.yml to zero.

Closes #692
This commit is contained in:
Dan Cryer 2014-12-08 11:25:33 +00:00
commit 7f9a09fa29
83 changed files with 1283 additions and 69 deletions

View file

@ -9,8 +9,16 @@
namespace PHPCI\Helper;
/**
* Helper class for dealing with SSH keys.
* @package PHPCI\Helper
*/
class SshKey
{
/**
* Uses ssh-keygen to generate a public/private key pair.
* @return array
*/
public function generate()
{
$tempPath = sys_get_temp_dir() . '/';
@ -49,6 +57,10 @@ class SshKey
return $return;
}
/**
* Checks whether or not we can generate keys, by quietly test running ssh-keygen.
* @return bool
*/
public function canGenerateKeys()
{
$keygen = @shell_exec('ssh-keygen -h');