Merge pull request #12 from codenamephp/feature/8-add-within-to-deployer-functions

Added within method

Author: bastianschwarz

MIGRATION.md

@@ -2,9 +2,16 @@
 
 ## 2.x -> 3.x
 
+### Before Method
+
 The iAll interface was extended with the iBefore interface. If you created your own implementation of iAll you need to implement the iBefore interface as well. 
 If you use the All class you don't need to do anything.
 
+### Within Method
+
+The iAll interface was extended with the iWithin interface. If you created your own implementation of iAll you need to implement the iWithin interface as well. 
+If you use the All class you don't need to do anything.
+
 ## 1.x -> 2.x
 
 The ssh connection string is now part of `\Deployer\Host\Host`. This means the

src/functions/All.php

@@ -42,6 +42,7 @@
 use function Deployer\runLocally;
 use function Deployer\set;
 use function Deployer\upload;
+use function Deployer\within;
 
 /**
  * Implements all method interfaces so we a "all drop-in" class to easily access the methods
@@ -169,4 +170,8 @@ public function registerTask(iTaskWithName $task) : void {
   public function upload(string $source, string $destination, array $config = []) : void {
     upload($source, $destination, $config);
   }
+
+  public function within(string $path, callable $callback) : mixed {
+    return within($path, $callback);
+  }
 }

src/functions/iAll.php

@@ -22,6 +22,6 @@
  *
  * The idea is to provide a stable, typed API and also a level of abstraction to the global deployer functions so testing is easier.
  */
-interface iAll extends iAdd, iAfter, iBefore, iCurrentHost, iDownload, iGet, iHost, iInput, iLocalhost, iOn, iParse, iRun, iSet, iTask, iUpload {
+interface iAll extends iAdd, iAfter, iBefore, iCurrentHost, iDownload, iGet, iHost, iInput, iLocalhost, iOn, iParse, iRun, iSet, iTask, iUpload, iWithin {
 
 }

src/functions/iWithin.php

@@ -0,0 +1,33 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\base\functions;
+
+/**
+ * Interface for the Deployer\within function
+ */
+interface iWithin {
+
+  /**
+   * Execute a callback within a specific directory and revert back to the initial working directory.
+   *
+   * @param string $path The path to execute the callback in
+   * @param callable():mixed $callback The callback to execute. No parameters and the return value is returned by this function
+   * @return mixed|null Return value of the $callback function or null if callback throws an exception
+   */
+  public function within(string $path, callable $callback) : mixed;
+}