Download the PHP package teqneers/php-stream-wrapper-for-git without Composer
On this page you can find all versions of the php package teqneers/php-stream-wrapper-for-git. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download teqneers/php-stream-wrapper-for-git
More information about teqneers/php-stream-wrapper-for-git
Files in teqneers/php-stream-wrapper-for-git
Package php-stream-wrapper-for-git
Short Description Git Stream Wrapper for PHP
License MIT
Homepage https://github.com/teqneers/PHP-Stream-Wrapper-for-Git
Informations about the package php-stream-wrapper-for-git
Git Stream Wrapper for PHP
Git Stream Wrapper for PHP is a PHP library that allows PHP code to interact with one or multiple Git repositories from within an application. The library consists of a Git repository abstraction that can be used to programmatically access Git repositories and of a stream wrapper that can be hooked into the PHP stream infrastructure to allow the developer to use file and directory access functions directly on files in a Git repository. The library provides means to access status information on a Git repository, such as the log, the current repository status or commit information, as well.
The Git Stream Wrapper for PHP core is a wrapper around the Git command line binary, so it is required to have Git installed on the machine running the PHP code. Git Stream Wrapper for PHP does not include a Git protocol abstraction, it relies on the Git command line binary for all its functionality.
The code is currently running stable (see comments on Windows below) and should be API-stable. It's however not feature-complete - so please feel free to request features you require.
Examples
Using the repository abstraction
Using the streamwrapper
Requirements
- PHP >= 8.0.0
- Composer available to include the dependencies
- Git installed on the machine running the PHP code
- SVN installed on the machine running the PHP code if you want to use the SVN component
Run tests
- clone the repository
- run
composer install
to install dependencies and create the autoloader - copy
phpunit.xml.dist
tophpunit.xml
- adjust the
GIT_BINARY
,SVN_BINARY
andSVN_ADMIN_BINARY
constants inphpunit.xml
to the path to your Git binary - run
phpunit
from within the cloned project folder
Please note that the library has been tested on a Mac OS X 12.6 with the bundled PHP 8.0.27, 8.1.14 and 8.2.1 (git version 2.39.1) and on several Ubuntu Linux installations. Due to currently unknown reasons the test run a bit unstable on Windows. All tests should be green but during cleanup there may be the possibility that some access restrictions randomly kick in and prevent the cleanup code from removing the test directories.
The unit test suite is continuously tested with GitHub Actions on PHP 8.0, 8.1, 8.2 and 8.3 and its current status is:
Contribute
Please feel free to use the Git issue tracking to report back any problems or errors. You're encouraged to clone the repository and send pull requests if you'd like to contribute actively in developing the library.
License
Copyright (C) 2023 by TEQneers GmbH & Co. KG
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.