eduVPN / vpn-server-api

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

Doc Comments +3 added lines

@@ -56,6 +56,9 @@
         }
     }
 
+    /**
+     * @param string $data
+     */
     private function write($data)
     {
         if (false === @fwrite($this->socket, $data)) {

src/fkooman/VPN/Server/Pool.php

Doc Comments +7 added lines

@@ -57,6 +57,9 @@ 
     /** @var array */
     private $instances;
 
+    /**
+     * @param integer $poolNumber
+     */
     public function __construct($poolNumber, array $poolData)
     {
         $this->setId(self::validate($poolData, 'id'));
@@ -248,6 +251,7 @@ 
      * 
      * A /24 or 'bigger' will be split in 4 networks, everything 'smaller'  
      * will be either be split in 2 networks or remain 1 network.
+     * @param integer $prefix
      */
     private static function getNetCount($prefix)
     {
@@ -302,6 +306,9 @@ 
         ];
     }
 
+    /**
+     * @param string $configName
+     */
     private static function validate(array $configData, $configName, $requiredField = true, $defaultValue = false)
     {
         if (!array_key_exists($configName, $configData)) {

src/fkooman/VPN/Server/Api/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/Api/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/Api/CommonNamesModule.php

Spacing +4 added lines, -4 removed lines

@@ -44,7 +44,7 @@ 
     {
         $service->get(
             '/common_names/disabled',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin', 'portal']);
 
                 return new ApiResponse('common_names', $this->commonNames->getDisabled());
@@ -53,7 +53,7 @@ 
 
         $service->get(
             '/common_names/disabled/:commonName',
-            function ($commonName, Request $request, TokenInfo $tokenInfo) {
+            function($commonName, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin', 'portal']);
                 InputValidation::commonName($commonName);
 
@@ -63,7 +63,7 @@ 
 
         $service->post(
             '/common_names/disabled/:commonName',
-            function ($commonName, Request $request, TokenInfo $tokenInfo) {
+            function($commonName, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin']);
                 InputValidation::commonName($commonName);
                 $this->logger->info(sprintf('disabling common_name "%s"', $commonName));
@@ -75,7 +75,7 @@ 
 
         $service->delete(
             '/common_names/disabled/:commonName',
-            function ($commonName, Request $request, TokenInfo $tokenInfo) {
+            function($commonName, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin']);
                 InputValidation::commonName($commonName);
                 $this->logger->info(sprintf('enabling common_name "%s"', $commonName));

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

Spacing +2 added lines, -2 removed lines

@@ -38,7 +38,7 @@ 
     {
         $service->get(
             '/openvpn/connections',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin']);
 
                 $response = new JsonResponse();
@@ -50,7 +50,7 @@ 
 
         $service->post(
             '/openvpn/kill',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin', 'portal']);
 
                 $commonName = $request->getPostParameter('common_name');

src/fkooman/VPN/Server/Api/UsersModule.php

Spacing +11 added lines, -11 removed lines

@@ -62,7 +62,7 @@ 
         //
         $service->get(
             '/users/disabled',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin']);
 
                 return new ApiResponse('users', $this->users->getDisabled());
@@ -71,7 +71,7 @@ 
 
         $service->get(
             '/users/disabled/:userId',
-            function ($userId, Request $request, TokenInfo $tokenInfo) {
+            function($userId, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin', 'portal']);
                 InputValidation::userId($userId);
 
@@ -81,7 +81,7 @@ 
 
         $service->post(
             '/users/disabled/:userId',
-            function ($userId, Request $request, TokenInfo $tokenInfo) {
+            function($userId, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin']);
                 InputValidation::userId($userId);
                 $this->logger->info(sprintf('disabling user "%s"', $userId));
@@ -92,7 +92,7 @@ 
 
         $service->delete(
             '/users/disabled/:userId',
-            function ($userId, Request $request, TokenInfo $tokenInfo) {
+            function($userId, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin']);
                 InputValidation::userId($userId);
                 $this->logger->info(sprintf('enabling user "%s"', $userId));
@@ -106,7 +106,7 @@ 
         //
         $service->get(
             '/users/otp_secrets',
-            function (Request $request, TokenInfo $tokenInfo) {
+            function(Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin']);
 
                 return new ApiResponse('users', $this->otpSecret->getOtpSecrets());
@@ -115,7 +115,7 @@ 
 
         $service->get(
             '/users/otp_secrets/:userId',
-            function ($userId, Request $request, TokenInfo $tokenInfo) {
+            function($userId, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin', 'portal']);
                 InputValidation::userId($userId);
 
@@ -127,7 +127,7 @@ 
 
         $service->post(
             '/users/otp_secrets/:userId',
-            function ($userId, Request $request, TokenInfo $tokenInfo) {
+            function($userId, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['portal']);
                 InputValidation::userId($userId);
                 $otpSecret = $request->getPostParameter('otp_secret');
@@ -139,7 +139,7 @@ 
 
         $service->delete(
             '/users/otp_secrets/:userId',
-            function ($userId, Request $request, TokenInfo $tokenInfo) {
+            function($userId, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin']);
                 InputValidation::userId($userId);
 
@@ -152,7 +152,7 @@ 
         //
         $service->get(
             '/users/groups/:userId',
-            function ($userId, Request $request, TokenInfo $tokenInfo) {
+            function($userId, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['admin', 'portal']);
                 InputValidation::userId($userId);
 
@@ -165,7 +165,7 @@ 
         //
         $service->get(
             '/users/voot_tokens/:userId',
-            function ($userId, Request $request, TokenInfo $tokenInfo) {
+            function($userId, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['portal']);
                 InputValidation::userId($userId);
 
@@ -177,7 +177,7 @@ 
 
         $service->post(
             '/users/voot_tokens/:userId',
-            function ($userId, Request $request, TokenInfo $tokenInfo) {
+            function($userId, Request $request, TokenInfo $tokenInfo) {
                 $tokenInfo->getScope()->requireScope(['portal']);
                 InputValidation::userId($userId);
                 $vootToken = $request->getPostParameter('voot_token');

src/fkooman/VPN/Server/Disable.php

Doc Comments +3 added lines

@@ -54,6 +54,9 @@
         return $this->io->isFile($commonNameFile);
     }
 
+    /**
+     * @param boolean $isDisabled
+     */
     public function setDisable($commonName, $isDisabled)
     {
         if ($isDisabled === $this->getDisable($commonName)) {