This extension allows jq.
% git clone --depth=1 https://github.com/kjdev/php-ext-jq.git
% cd php-ext-jq
% phpize
% ./configure
% make
% make test
% make install
jq.ini:
extension=jq.so
; jq.display_errors=Off
$jq = Jq\Input::fromString('{"name": "jq", "version": "0.1.0"}');
print_r($jq->filter('.'));
echo 'NAME: ', $jq->filter('.name'), PHP_EOL;
echo 'VERSION: ', $jq->filter('.version'), PHP_EOL;output:
Array
(
[name] => jq
[version] => 0.1.0
)
NAME: jq
VERSION: 0.1.0
Jq\Input {
public static fromString(string $text): Jq\Executor
public static fromFile(string $file): Jq\Executor
}public static fromString(string $text): Jq\ExecutorLoad a JSON string.
Parameters:
-
text
JSON text string.
Return Values:
Returns Jq\Executor instance.
public static fromFile(string $file): Jq\ExecutorLoad a JSON file.
Parameters:
-
file
JSON file name.
Return Values:
Returns Jq\Executor instance.
Jq\Executor {
public filter(string $filter, int $flags): mixed
public variable(string $name, string $value): self
public variables(): array
}public filter(string $filter, int $flags = 0): mixedGet filtering result of the load string.
Parameters:
-
filter
jq filter string.
-
flags
Jq\RAWis raw outputJq\SORTis object with the keys in sorted order
Return Values:
Returns the result value, or FALSE on error.
public variable(string $name, string $value): selfSet variable value.
Parameters:
-
name
variable name.
-
value
variable value.
- treat strings starting with
@as JSON strings
- treat strings starting with
Return Values:
Returns the self instance.
public variables(): arrayGet variables value.
Return Values:
Returns the variables.
Jq\Run {
public static fromString(string $text, string $filter, int $flags = 0, array $variables = []): mixed
public static fromFile(string $file, string $filter, int $flags = 0, array $variables = []): mixed
}public static fromString(string $text, string $filter, int $flags = 0, array $variables = []): mixedGet filtering result of the JSON string.
Parameters:
-
text
JSON text string.
-
filter
jq filter string.
-
flags
Jq\RAWis raw outputJq\SORTis object with the keys in sorted order
-
variables
jq variables array.
- key is variable name
- value is string of variable value
- treat strings starting with
@as JSON strings
- treat strings starting with
Return Values:
Returns the result value, or FALSE on error.
public static fromFile(string $file, string $filter, int $flags = 0, array $variables = []): mixedGet filtering result of the JSON file.
Parameters:
-
file
JSON file name.
-
filter
jq filter string.
-
flags
Jq\RAWis raw outputJq\SORTis object with the keys in sorted order
-
variables
jq variables array.
- key is variable name
- value is string of variable value
- treat strings starting with
@as JSON strings
- treat strings starting with
Return Values:
Returns the result value, or FALSE on error.
- Setting a
Jq\RAW
$jq = Jq\Input::fromString('{"name": "jq", "version": "0.1.0"}');
print_r($jq->filter('.', Jq\RAW));
echo PHP_EOL;
echo 'NAME: ', $jq->filter('.name', Jq\RAW), PHP_EOL;
echo 'VERSION: ', $jq->filter('.version', Jq\RAW), PHP_EOL;The above example will output:
{"name":"jq","version":"0.1.0"}
NAME: jq
VERSION: 0.1.0
- Execute static function
$text = '{"name": "jq", "version": "0.1.0"}';
print_r(Jq\Run::fromString($text, '.'));
echo 'NAME: ', Jq\Run::fromString($text, '.name'), PHP_EOL;
echo 'VERSION: ', Jq\Run::fromString($text, '.version', Jq\RAW), PHP_EOL;The above example will output:
Array
(
[name] => jq
[version] => 0.1.0
)
NAME: jq
VERSION: 0.1.0
- Execute static function with a variables
$text = <<<EOT
[
{"key": "string", "var": "STRING"},
{"key": 123, "var": "NUMBER:123"}
]
EOT;
$jq = Jq\Input::fromString($text);
print_r(
$jq->filter('.')
// (OR) Jq\Run::fromString($text, '.')
);
print_r(
$jq->variable('key', 'string')->filter('.[] | select(.key == $key)')
// (OR) Jq\Run::fromString($text, '.[] | select(.key == $key)', 0, ['key' => 'string'])
);
print_r(
$jq->variable('key', '@123')->filter('.[] | select(.key == $key)')
// (OR) Jq\Run::fromString($text, '.[] | select(.key == $key)', 0, ['key' => '@123'])
);
// ['key' => '123'], it is evaluated as a character string, so it does not matchThe above example will output:
Array
(
[0] => Array
(
[key] => string
[var] => STRING
)
[1] => Array
(
[key] => 123
[var] => NUMBER:123
)
)
Array
(
[key] => string
[var] => STRING
)
Array
(
[key] => 123
[var] => NUMBER:123
)