eduVPN / vpn-server-api

src/fkooman/VPN/Server/OpenVpn/ServerSocketInterface.php

Doc Comments +2 added lines, -2 removed lines

@@ -21,11 +21,10 @@ 
     /**
      * Open the socket.
      *
-     * @param int $timeOut the amount of time to wait before 
-     *                     giving up on trying to connect
      *
      * @throws Exception\ServerSocketException if the socket cannot be opened 
      *                                         within timeout
+     * @return void
      */
     public function open();
 
@@ -45,6 +44,7 @@ 
      * Close the socket connection.
      *
      * @throws Exception\ServerSocketException if socket is not open
+     * @return void
      */
     public function close();
 }

src/fkooman/VPN/Server/Log/LogModule.php

Spacing +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
     {
         $service->get(
             '/log/:showDate',
-            function (Request $request, TokenInfo $tokenInfo, $showDate) {
+            function(Request $request, TokenInfo $tokenInfo, $showDate) {
                 self::requireScope($tokenInfo, 'log_get');
 
                 InputValidation::date($showDate);

src/fkooman/VPN/Server/OpenVpn/OpenVpnModule.php

Spacing +4 added lines, -4 removed lines

@@ -44,7 +44,7 @@ 
     {
         $service->get(
             '/openvpn/status',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 self::requireScope($tokenInfo, 'openvpn_info');
 
                 $response = new JsonResponse();
@@ -56,7 +56,7 @@ 
 
         $service->get(
             '/openvpn/load-stats',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 self::requireScope($tokenInfo, 'openvpn_info');
 
                 $response = new JsonResponse();
@@ -68,7 +68,7 @@ 
 
         $service->get(
             '/openvpn/version',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 self::requireScope($tokenInfo, 'openvpn_info');
 
                 $response = new JsonResponse();
@@ -80,7 +80,7 @@ 
 
         $service->post(
             '/openvpn/kill',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 self::requireScope($tokenInfo, 'openvpn_kill');
 
                 $commonName = $request->getPostParameter('common_name');

src/fkooman/VPN/Server/Ca/CaModule.php

Spacing +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
     {
         $service->post(
             '/ca/crl/fetch',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 self::requireScope($tokenInfo, 'ca_crl_fetch');
 
                 $this->logger->info('fetching CRL');

web/api.php

Indentation +1 added lines, -1 removed lines

@@ -123,7 +123,7 @@
             $config->v('api')
         ),
         ['realm' => 'VPN Server API']
-     );
+        );
 
     $authenticationPlugin = new AuthenticationPlugin();
     $authenticationPlugin->register($apiAuth, 'api');

src/fkooman/VPN/Server/Info/InfoModule.php

Spacing +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
     {
         $service->post(
             '/ca/crl/fetch',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 self::requireScope($tokenInfo, 'ca_crl_fetch');
 
                 $this->logger->info('fetching CRL');

src/fkooman/VPN/Server/Config/FileConfigStorage.php

Doc Comments +10 added lines

@@ -62,6 +62,7 @@ 
     /**
      * Get the configuration for a particular common name.
      *
+     * @param string $commonName
      * @return CommonNameConfig
      */
     public function getCommonNameConfig($commonName)
@@ -99,6 +100,9 @@ 
         );
     }
 
+    /**
+     * @param string $fileName
+     */
     private function readFile($fileName)
     {
         if (false === $fileContent = @file_get_contents($fileName)) {
@@ -108,6 +112,9 @@ 
         return Json::decode($fileContent);
     }
 
+    /**
+     * @param string $fileName
+     */
     private function writeFile($fileName, array $fileContent)
     {
         self::checkMakeDirectory(dirname($fileName));
@@ -116,6 +123,9 @@ 
         }
     }
 
+    /**
+     * @param string $dirName
+     */
     private static function checkMakeDirectory($dirName)
     {
         if (!is_dir($dirName)) {

src/fkooman/VPN/Server/Config/UserConfig.php

Doc Comments +3 added lines

@@ -67,6 +67,9 @@
         }
     }
 
+    /**
+     * @param string $otpSecret
+     */
     public function setOtpSecret($otpSecret)
     {
         InputValidation::otpSecret($otpSecret);

src/fkooman/VPN/Server/Config/ConfigModule.php

Spacing +5 added lines, -5 removed lines

@@ -46,7 +46,7 @@ 
         // get all configurations
         $service->get(
             '/config/common_names/',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 self::requireScope($tokenInfo, ['admin', 'portal']);
 
                 $userId = $request->getUrl()->getQueryParameter('user_id');
@@ -70,7 +70,7 @@ 
         // get configuration for a particular common_name
         $service->get(
             '/config/common_names/:commonName',
-            function (Request $request, TokenInfo $tokenInfo, $commonName) {
+            function(Request $request, TokenInfo $tokenInfo, $commonName) {
                 self::requireScope($tokenInfo, ['admin', 'portal']);
 
                 InputValidation::commonName($commonName);
@@ -87,7 +87,7 @@ 
         // set configuration for a particular common_name
         $service->put(
             '/config/common_names/:commonName',
-            function (Request $request, TokenInfo $tokenInfo, $commonName) {
+            function(Request $request, TokenInfo $tokenInfo, $commonName) {
                 self::requireScope($tokenInfo, ['admin']);
 
                 InputValidation::commonName($commonName);
@@ -110,7 +110,7 @@ 
         // get configuration for a particular user_id
         $service->get(
             '/config/users/:userId',
-            function (Request $request, TokenInfo $tokenInfo, $userId) {
+            function(Request $request, TokenInfo $tokenInfo, $userId) {
                 self::requireScope($tokenInfo, ['admin', 'portal']);
 
                 InputValidation::userId($userId);
@@ -131,7 +131,7 @@ 
         // set configuration for a particular user_id
         $service->put(
             '/config/users/:userId',
-            function (Request $request, TokenInfo $tokenInfo, $userId) {
+            function(Request $request, TokenInfo $tokenInfo, $userId) {
                 self::requireScope($tokenInfo, ['admin', 'portal']);
 
                 InputValidation::userId($userId);