https://github.com/xp-framework/command
Commands, a.k.a. xpcli
https://github.com/xp-framework/command
argument-parser command-line php xp-framework
Last synced: 9 months ago
JSON representation
Commands, a.k.a. xpcli
- Host: GitHub
- URL: https://github.com/xp-framework/command
- Owner: xp-framework
- Created: 2016-01-09T16:19:49.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-28T20:21:59.000Z (almost 2 years ago)
- Last Synced: 2025-01-30T02:41:29.071Z (11 months ago)
- Topics: argument-parser, command-line, php, xp-framework
- Language: PHP
- Homepage:
- Size: 137 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
Awesome Lists containing this project
README
Commands
========
[](https://github.com/xp-framework/command/actions)
[](https://github.com/xp-framework/core)
[](https://github.com/xp-framework/core/blob/master/LICENCE.md)
[](http://php.net/)
[](http://php.net/)
[](https://packagist.org/packages/xp-framework/command)
Also known as "xpcli": Command line argument parsing via annotations.
Example
-------
```php
use util\cmd\{Command, Arg};
use rdbms\DriverManager;
use io\streams\Streams;
/**
* Performs an SQL query
*/
class Query extends Command {
private $connection, $query;
private $verbose= false;
/** Connection DSN, e.g. `mysql://user:pass@host[:port][/database]` */
#[Arg(position: 0)]
public function useConnection(string $dsn) {
$this->connection= DriverManager::getConnection($dsn);
$this->connection->connect();
}
/** SQL query. Use `-` to read from standard input */
#[Arg(position: 1)]
public function useQuery(string $query) {
if ('-' === $query) {
$this->query= Streams::readAll($this->in->stream());
} else {
$this->query= $query;
}
}
/** Verbose output */
#[Arg]
public function useVerbose() {
$this->verbose= true;
}
/** @return int */
public function run() {
$this->verbose && $this->out->writeLine('@ ', $this->connection);
$this->verbose && $this->out->writeLine('>>> ', $this->query);
$result= $this->connection->open($this->query);
if ($result->isSuccess()) {
$this->verbose && $this->out->writeLine('<<< ', $result->affected());
return $result->affected() ? 0 : 1;
} else {
$this->verbose && $this->out->writeLine('<<< Results');
foreach ($result as $found => $record) {
$this->out->writeLine($record);
}
return isset($found) ? 0 : 2;
}
}
}
```
To execute the class, use the `cmd` command:
```sh
$ xp -m /path/to/rdbms cmd Query 'mysql://localhost/test' 'select * from account' -v
@ rdbms.mysqlx.MySqlxConnection(->rdbms.DSN@(mysql://localhost/test), rdbms.mysqlx.MySqlxProtocol(...)
>>> select * from account
<<< Results
[
account_id => 1
username => "kiesel"
email => "alex.dandrea@example.com"
]
[
account_id => 2
username => "thekid"
email => "timm.friebe@example.com"
]
```
To show the command's usage, supply `-?` or `--help`:
See also
--------
* [RFC #0133](https://github.com/xp-framework/rfc/issues/133) - Add support for filenames as argument for XPCLI
* [RFC #0102](https://github.com/xp-framework/rfc/issues/102) - XP Class Runners *(original RFC)*