git_submodule_command.md

Git Submodule

Use the interface: ArtARTs36\GitHandler\Contracts\Commands\GitSubmoduleCommand

---

Create Instance

use \ArtARTs36\GitHandler\Factory\LocalGitFactory;

$command = (new LocalGitFactory())->factory(__DIR__)->submodules();

---

Features:

* Add git submodule

Method Signature:

public function add(string $url): void;

Equals Git Command:

git submodule add $url

Example:

use \ArtARTs36\GitHandler\Factory\LocalGitFactory;

(new LocalGitFactory())->factory(__DIR__)->submodules()->add('url-test');

---

* Get all submodules

Method Signature:

public function getAll(): array<string,\Submodule>;

Example:

use \ArtARTs36\GitHandler\Factory\LocalGitFactory;

(new LocalGitFactory())->factory(__DIR__)->submodules()->getAll();

---

* Remove submodule

Method Signature:

public function remove(string $name): void;

Example:

use \ArtARTs36\GitHandler\Factory\LocalGitFactory;

(new LocalGitFactory())->factory(__DIR__)->submodules()->remove('name-test');

---

* Determine is exists submodule

Method Signature:

public function exists(string $name): bool;

Example:

use \ArtARTs36\GitHandler\Factory\LocalGitFactory;

(new LocalGitFactory())->factory(__DIR__)->submodules()->exists('name-test');

---

* Sync git submodule

Method Signature:

public function sync(string $name): void;

Equals Git Command:

git submodule sync $name

Example:

use \ArtARTs36\GitHandler\Factory\LocalGitFactory;

(new LocalGitFactory())->factory(__DIR__)->submodules()->sync('name-test');

---

* Sync defines in .gitmodules from git config

Method Signature:

public function syncDefinesFromConfig(): void;

Example:

use \ArtARTs36\GitHandler\Factory\LocalGitFactory;

(new LocalGitFactory())->factory(__DIR__)->submodules()->syncDefinesFromConfig();

---