瀏覽代碼

Update README.md

master
Dark 9 年之前
父節點
當前提交
905946e33b
共有 1 個文件被更改,包括 7 次插入6 次删除
  1. +7
    -6
      README.md

+ 7
- 6
README.md 查看文件

@@ -4,7 +4,7 @@ A PHP CLI script to ouput the contents of a whole directory tree to a JSON objec
by Ryan, 2015
URL: http://www.ryadel.com/

# What does it do
## What does it do
It fetches a directory tree structure like this:

```
@@ -43,16 +43,17 @@ and outputs its contents into a json-formatted file like this:

It can be very useful when working with Javascript frameworks and/or similar scenarios where you need to load/browse/show a directory structure without being allowed to access the system IO.

The code it's meant to be used as a dedicated CLI script (see **Usage** section below), but you can also execute it from a standard, web-hosted PHP page by populating the $argv[] array directly from code. If you need further help to implement it into a PHP page, contact me and I'll update the docs accordingly.

# General rules

## General rules
* If a folder contains only files (without subfolders), they will be listed as items of a single array.
* If a folder contains one or more subfolders, each one will be listed as a key/value array.
* If a folder contains files and subfolders, both will be listed as a key/value array: each file will have an auto-generated numeric key starting from 0 (numbers already used by a subfolder's name will be skipped).


# Usage (from CLI)
The code it's meant to be used as a dedicated CLI script, but you can also execute it from a standard, web-hosted PHP page by populating the $argv[] array directly from code. If you need further help to implement it into a PHP page, contact me and I'll update the docs accordingly.

## Usage
### From CLI

```
> php dir2json <targetFolder> <outputFile> [JSON_OPTIONS]
@@ -68,7 +69,7 @@ JSON_OPTIONS is a bitmask consisting of:
The behaviour of these constants is described on the JSON constants page:
http://php.net/manual/en/json.constants.php

## Example
#### Example
```
> php dir2json ./images out.json JSON_PRETTY_PRINT
```


Loading…
取消
儲存