Prose\FromHost::getSshUsername PHP Method

    public function getSshUsername()
    {
        // what are we doing?
        $log = usingLog()->startAction("get username to use with SSH to host '{$this->args[0]}'");
        // make sure we have valid host details
        $hostDetails = $this->getHostDetails();
        // get the information
        $return = $hostDetails->sshUsername;
        // all done
        $log->endAction("username is '{$return}'");
        return $return;
    }