TRADER-18 php parallel ide autocomplete init

Author: borutainfo

.gitignore

@@ -0,0 +1,3 @@
+.idea/
+composer.lock
+vendor/

README.md

@@ -1 +1,26 @@
-# php-parallel-ide-autocomplete
+# PHP Parallel - IDE autocomplete
+
+This package allows you to activate the auto-complete in the IDE for native functions from the extension: [PHP Parallel](https://www.php.net/manual/en/book.parallel.php).
+
+## Installation
+
+Install the library using Composer. Please read the [Composer Documentation](https://getcomposer.org/doc/01-basic-usage.md) if you are unfamiliar with Composer or dependency managers in general.
+
+You don't need this package in production, please use `require-dev`.
+```shell
+composer require --dev boruta/php-parallel-ide-autocomplete
+```
+
+That's it, the IDE autocomplete should work.
+
+## Requirements
+
+Package requires PHP 7.2 or above and `ext-parallel` >= 1.1.4.
+
+## About
+
+If your IDE does not auto-complete functions from the PHP Parallel extension, add this package to your project to fix it. The directory `autocomplete` contains documentation of the functions from the extension mentioned above, without their implementation. This files are not automatically loaded by composer and you shouldn't include them. It's just their presence in the project directory, which fixes the missing documentation in the IDE. Just add the package to composer and your IDE should start displaying the documentation correctly.
+
+![PHPStorm auto-complete fixed](image.png "PHPStorm auto-complete fixed")
+
+

autocomplete/Future.php

@@ -0,0 +1,57 @@
+<?php
+declare(strict_types=1);
+
+namespace parallel;
+
+
+use RuntimeException;
+
+/**
+ * Interface Future
+ * @package parallel
+ * @link https://www.php.net/manual/en/class.parallel-future.php
+ */
+final class Future
+{
+    private const EXCEPTION_MESSAGE = 'You should not autoload or include file `Future.php`! This file exists only for IDE auto complete function.';
+
+    /**
+     * Shall return (and if necessary wait for) return from task.
+     *
+     * @return mixed
+     */
+    public function value()
+    {
+        throw new RuntimeException(self::EXCEPTION_MESSAGE);
+    }
+
+    /**
+     * Shall indicate if the task was cancelled.
+     *
+     * @return bool
+     */
+    public function cancelled(): bool
+    {
+        throw new RuntimeException(self::EXCEPTION_MESSAGE);
+    }
+
+    /**
+     * Shall indicate if the task is completed.
+     *
+     * @return bool
+     */
+    public function done(): bool
+    {
+        throw new RuntimeException(self::EXCEPTION_MESSAGE);
+    }
+
+    /**
+     *  Shall try to cancel the task. If task is running, it will be interrupted.
+     *
+     * @return bool
+     */
+    public function cancel(): bool
+    {
+        throw new RuntimeException(self::EXCEPTION_MESSAGE);
+    }
+}

autocomplete/Runtime.php

@@ -0,0 +1,55 @@
+<?php
+declare(strict_types=1);
+
+namespace parallel;
+
+
+use RuntimeException;
+
+/**
+ * Interface Runtime
+ * @package parallel
+ * @link https://www.php.net/manual/en/parallel-runtime.run.php
+ */
+final class Runtime
+{
+    private const EXCEPTION_MESSAGE = 'You should not autoload or include file `Runtime.php`! This file exists only for IDE auto complete function.';
+
+    /**
+     * Shall construct a new runtime with or without bootstrapping.
+     *
+     * @param string $bootstrap [optional] The location of a bootstrap file, generally an autoloader.
+     */
+    public function __construct(string $bootstrap = '')
+    {
+        throw new RuntimeException(self::EXCEPTION_MESSAGE);
+    }
+
+    /**
+     * Shall schedule task for execution in parallel, passing argv at execution time.
+     *
+     * @param callable $task A Closure with specific characteristics.
+     * @param array $argv [optional] An array of arguments with specific characteristics to be passed to task at execution time.
+     * @return Future|null
+     */
+    public function run(callable $task, array $argv = []): ?Future
+    {
+        throw new RuntimeException(self::EXCEPTION_MESSAGE);
+    }
+
+    /**
+     * Shall request that the runtime shutdown. Tasks scheduled for execution will be executed before the shutdown occurs.
+     */
+    public function close(): void
+    {
+        throw new RuntimeException(self::EXCEPTION_MESSAGE);
+    }
+
+    /**
+     * Shall attempt to force the runtime to shutdown. Tasks scheduled for execution will not be executed, the currently running task shall be interrupted.
+     */
+    public function kill(): void
+    {
+        throw new RuntimeException(self::EXCEPTION_MESSAGE);
+    }
+}

composer.json

@@ -0,0 +1,16 @@
+{
+  "name": "boruta/php-parallel-ide-autocomplete",
+  "description": "This package allows you to activate the auto-complete in the IDE for native functions from the extension: PHP Parallel.",
+  "type": "library",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Boruta",
+      "email": "sebastian@boruta.info"
+    }
+  ],
+  "require": {
+    "php": ">=7.2",
+    "ext-parallel": ">=1.1.4"
+  }
+}