PHP download

Download the PHP package marwanalsoltany/blend without Composer

On this page you can find all versions of the php package marwanalsoltany/blend. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download marwanalsoltany/blend
More information about marwanalsoltany/blend
Files in marwanalsoltany/blend

Vendor marwanalsoltany
Package blend
Short Description A versatile and lightweight PHP task runner, designed with simplicity in mind.
License MIT
Homepage https://github.com/MarwanAlsoltany/blend#readme

Keywords php cli task runner task runner

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of marwanalsoltany/blend

Informations about the package blend

Blend

A versatile and lightweight PHP task runner, designed with simplicity in mind. [![PHP Version][php-icon]][php-href] [![Latest Version on Packagist][version-icon]][version-href] [![Packagist Downloads][downloads-icon]][downloads-href] [![GitHub Downloads][github-downloads-icon]][github-downloads-href] [![License][license-icon]][license-href] [![Maintenance][maintenance-icon]][maintenance-href] [![Travis Build Status][travis-icon]][travis-href] [![codecov][codecov-icon]][codecov-href] [![Open in Visual Studio Code][vscode-icon]][vscode-href] [![Run on Repl.it][replit-icon]][replit-href] [![Tweet][tweet-icon]][tweet-href] [![Star][github-icon]][github-href]

Table of Contents

[About Blend](#about-blend)
[Installation](#installation)
[Config](#config)
[Examples](#examples)
[API](#api)
[Changelog](./CHANGELOG.md)

^{If you like this project and would like to support its development, giving it a :star: would be appreciated!}
![Blend Demo](./blend-demo.gif)

Key Features

Blazing fast
Easy to configure
Dependency free

About Blend

Blend is a versatile and lightweight PHP task runner, designed with simplicity in mind. Blend was created out of frustration of trying to manage multiple CLI Tools and/or Scripts with different interfaces and trying to remember their names, locations, syntax, and options/arguments. With Blend and its intuitive and powerful API you will have to do this only once, it will, well, as the name suggests blend it for you. Blend will present those CLI Tools and/or Scripts the way you like and give you the possibility to access all of them in the form of tasks from a single, beautiful, and insightful interface that will assist you, give you feedback, and suggestions throughout the process.

To keep it as portable and as simple as it can be, the Blend package consists of a single class (TaskRunner), this class does all the magic for you.

Blend was created to be flexible, it can be installed in many ways, each way has its benefits and drawbacks. Choose the installation method that suits you and your needs best. Check out the installation section for more details.

Why does Blend exist?

Blend was developed for personal use in the first place. However, it has come so far that it deserves to be published. It may not be what you are looking for, so check it out carefully.

Installation

Using Composer:

Require Blend through Composer using:

This is the recommended way to install Blend. With this installation method, Blend will be installed just like any normal Composer package. You can interact with it using either the vendor/bin/blend executable with a config file in the current working directory, or by requiring it in a stand-alone file and supplying the config programmatically. You can of course install it globally and let it be system-wide accessible.

Using PHAR:

Download Blend PHAR archive form the releases page or using one of the commands down below:

Or use the following command to download a specific version (replace vX.X.X with the wished version):

With this installation method, you will get Blend as a portable PHAR archive, you can place it anywhere you want or even include it in your PATH for easy access. With this installation method, you have to supply a config file in order to configure/customize Blend. This installation method exists for portability where Blend is not bound to a specific project and a config file is sufficient. Starting from v1.0.3, the PHAR installation method is distinguished from other methods with the task update (used to be called ~~phar:update~~ before v1.1.0) that will update your PHAR to the latest release available in this repository.

Using Installer:

Download Blend Setup directly from the repository, or using one of the commands down below:

Using this method, the Blend executable and source will be installed in the current working directory (to take advantage of IDEs Intellisense when configuring Blend programmatically). With this installation method, you can configure Blend programmatically using the blend executable file or by supplying a config file in CWD. This installation method exists merely for legacy projects, where Composer is not an option and programmable config is required.

Config

Blend can be configured using either of the two available config formats:

PHP Config `blend.config.php`:

JSON Config `blend.config.json`: (Recommended)

Note: Refer to config/schema.json to learn more about the expected data types. Note that JSON config has some limitations (callback tasks for example) so check out to both files.

How Does Config Loading Work?

Blend will try to load the config from the current working directory, if nothing is to be found there, it will go one level upwards and look in the parent directory and so on until it reaches the root directory, if it does not find anything there either, Blend will start without config.

Fact: Although JSON config format is recommended, PHP config has precedence. This means, if the two config formats are to be found in the same directory, the PHP config will get loaded instead of the JSON one. This is merely because the PHP config can be executed and is, therefore, more powerful.

Examples

A basic Blend executable:

A more advanced Blend executable:

A real life example of a Blend executable (PHP Development Server):

Note: Blend gets its ID from the executable name that contains it ($argv[0]). So if you were to rename the file that contains it to something else, all Blend output will reflect this new change (help message, suggestions, etc...). The environment variable and the config file name will also be expected to match the new name.

Hint: The TaskRunner class is well documented, if you have any questions about Blend API, refer to the DocBlocks of its methods, you will probably find your answer there.

API

Here is the full API of Blend (TaskRunner class).

Note: The full API of the TaskRunner::class —including private and protected members— is listed here as you mostly want to extend Blend by using the TaskRunner::extend() method which has access to the private scope.

Constants

Constant	Description
`VERSION`	Package version. (public)
`EXECUTABLES`	Default executables. (public)
`TRANSLATIONS`	Default task name translations. (public)
`CONFIG`	Default config. (public)
`SUCCESS`	Task success code. (public)
`FAILURE`	Task failure code. (public)
`CALLBACK_TASK`	Task type callback. (public)
`SHELL_TASK`	Task type shell. (public)
`INTERNAL_TASK`	Task type internal. (protected)

Properties

Property	Description
`$argc`	A reference to the `$argc` global variable. (public)
`$argv`	A reference to the `$argv` global variable. (public)
`$args`	An array of the arguments that could be passed to the executed task. (public)
`$envVar`	Environment variable. (private)
`$path`	Task runner path. (protected)
`$id`	Task runner ID. (protected)
`$name`	Task runner name. (protected)
`$version`	Task runner version. (protected)
`$task`	The current task name passed to the task runner. (protected)
`$tasks`	Task runner tasks. (protected)
`$methods`	Magic methods added via `self::extend()`. (protected)
`$results`	The results of commands executed via `self::exec()`. (protected)
`$executables`	The executables that will be loaded. (protected)
`$translations`	The translations that will be applied to tasks names. (protected)
`$config`	The currently loaded configuration. (protected)
`$ansi`	Whether or not to turn on ANSI colors for the output. (protected)
`$quiet`	Whether or not to turn on the output. (protected)

Public Methods

Method	Description
`extend()`	Extends the class with a magic method using the passed callback.
`passthru()`	Executes a shell command using `passthru()`.
`exec()`	Executes a shell command synchronously or asynchronous and prints out its result if possible.
`getExecResult()`	Returns the result of a command executed via `self::exec()`.
`addCallbackTask()`	Adds a task that executes the passed callback.
`addShellTask()`	Adds a task that can be executed by the used shell (Bash for example).
`addTask()`	Adds a new task.
`makeTask()`	Makes a task from array representation of a task object and adds it to the available tasks.
`removeTask()`	Removes a task from the available tasks.
`hideTask()`	Hides a task by preventing it from being listed. The task can still get ran though.
`disableTask()`	Disables a task by preventing it from being ran. The task will still get listed, but will be obfuscated.
`getTask()`	Returns a task.
`getTasks()`	Returns all tasks.
`runTask()`	Runs a task.
`run()`	Runs a task or starts the runner if no parameter is specified or the task is not found.
`say()`	Writes a message out to the console.
`sort()`	Sorts the tasks alphabetically.
`start()`	Starts the task runner.
`getName()`	Returns the task runner name.
`setName()`	Sets the task runner name.
`getVersion()`	Returns the task runner version.
`setVersion()`	Sets the task runner version.
`isAnsi()`	Returns whether the task runner output is currently using ANSI colors or not.
`setAnsi()`	Sets the task runner ANSI output value.
`isQuiet()`	Returns whether the task runner output is currently quiet or not.
`setQuiet()`	Sets the task runner quiet output value.

Protected Methods

Method	Description
`terminate()`	Terminates the task runner by exiting the script.
`bootstrap()`	Bootstraps the task runner by adding predefined tasks.
`load()`	Loads tasks from the specified executables array.
`translate()`	Translates the passed string using the specified translations.
`format()`	Formats a string like `*printf()` functions with the ability to add ANSI colors.
`write()`	Writes out a formatted text block from the specified lines and format value.
`displayHelp()`	Prints out a help message listing all tasks of the task runner.
`displayHint()`	Prints out a hint message listing tasks matching the current task of the task runner.
`displayList()`	Prints out a list of all available tasks of the task runner.
`displayExec()`	Prints out the result of executing the current argument of the task runner.
`listTasks()`	Prints out a list of the passed tasks.
`getUser()`	Returns the task runner user.

Private Methods

Method	Description
`registerHandlers()`	Registers error handler, exception handler, and shutdown function.
`restoreHandlers()`	Restores the error handler and the exception handler.
`checkEnvironment()`	Checks the environment for TR_* variable, validates its pattern and updates class internal state.
`checkConfiguration()`	Checks the CWD or its parent(s) for a configuration file, validates its entries and updates class internal state.

Magic Methods

Method	Description
`handleError()`	Error handler function. (public)
`handleException()`	Exception handler function. (public)
`shutdown()`	Shutdown function. This method is abstract, implement it using `self::extend()`. (public)

License

All versions of blend with dependencies

PHP Build Version

Package Version

Version v1.1.1 Release 17. Feb 2023
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of blend from vendor marwanalsoltany

Requires php Version ^7.4|^8.0
ext-json Version *

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package marwanalsoltany/blend contains the following files

Loading the files please wait ....