- set required php 7

- update readme
- update phpDoc

Author: optimistex

DeployApplication.php

@@ -10,7 +10,7 @@
 
 /**
  * Main class for deploying
- * Example for use it:
+ * Usage example:
  *
  * ```php
  * // Run default commands
@@ -42,13 +42,24 @@ class DeployApplication
 
     /** @var boolean */
     private $hasAccess;
-    private $is_first = true;
 
-    public function __construct($securityKey, $project_root = '.', $logFileName = 'git-deploy-log.txt')
+    /** @var boolean */
+    private $isFirstLogging = true;
+
+    /** @var boolean */
+    private $logError = false;
+
+    /**
+     * DeployApplication constructor.
+     * @param string $securityKey string key for protect application
+     * @param string $workPath set working path for executing all commands
+     * @param string $logFileName path to a log file
+     */
+    public function __construct(string $securityKey, string $workPath = '.', string $logFileName = 'git-deploy-log.txt')
     {
         $this->securityKey = $securityKey;
         $this->logFileName = getcwd() . '/' . $logFileName;
-        chdir($project_root);
+        chdir($workPath);
         putenv('HOME=' . getcwd());
     }
 
@@ -63,13 +74,20 @@ public function run(array $customCommands = [])
         $this->end();
     }
 
+    /**
+     * Begin log file
+     */
     public function begin()
     {
         if ($this->checkSecurity()) {
             $this->logDated('SESSION START');
         }
     }
 
+    /**
+     * Executing command like a command lines
+     * @param array $customCommands you can execute custom commands
+     */
     public function execute(array $customCommands = [])
     {
         if (!$this->checkSecurity()) {
@@ -82,17 +100,23 @@ public function execute(array $customCommands = [])
         }
     }
 
+    /**
+     * Finish logging and output all content from the log file
+     */
     public function end()
     {
         if ($this->checkSecurity()) {
             $this->logDated('SESSION END');
         }
-        if (file_exists($this->logFileName)) {
+
+        if ($this->logError) {
+            echo 'Write log failed';
+        } else if (file_exists($this->logFileName)) {
             echo '<h1>LOG </h1><pre>';
             echo file_get_contents($this->logFileName);
             echo '</pre>';
         } else {
-            echo 'log not found';
+            echo 'A log file not found';
         }
     }
 
@@ -155,9 +179,9 @@ private function exec(array $commands)
 
     private function logDated(string $message)
     {
-        if ($this->is_first) {
+        if ($this->isFirstLogging) {
             $this->log("\n==============================\n");
-            $this->is_first = false;
+            $this->isFirstLogging = false;
         }
 
         $this->log(date('Y.m.d H:i:s') . "\t" . $message . "\n");
@@ -168,8 +192,10 @@ private function log(string $message)
         if (empty($this->logFileName)) {
             return;
         }
-
-        file_put_contents($this->logFileName, $message, FILE_APPEND | LOCK_EX);
-        flush();
+        if (file_put_contents($this->logFileName, $message, FILE_APPEND | LOCK_EX) === false) {
+            $this->logError = true;
+        } else {
+            flush();
+        }
     }
 }

README.md

@@ -28,7 +28,7 @@ It does auto deploy your site to hosting
 
         http://your.domain/deploy.php?key=ytJHvMHFdTYUryDhmJkjFjFiYk
 
-4. Visit page ``http://your.domain/deploy.php`` for check log history        
+4. Visit page ``http://your.domain/deploy.php`` to check log history        
 
 Do not forget to change the secret code ``ytJHvMHFdTYUryDhmJkjFjFiYk``
 

composer.json

@@ -29,5 +29,7 @@
       "dev-master": "1.2.x-dev"
     }
   },
-  "require": {}
+  "require": {
+    "php": "^7.0"
+  }
 }