Skip to content

Commit cc066a6

Browse files
RonefRonef
committed
Version 2.4
2 parents b82c96e + 98b81c7 commit cc066a6

5 files changed

Lines changed: 168 additions & 96 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 8 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# (MODX)EvolutionCMS.snippets.ddGetFileInfo changelog
22

33

4+
## Version 2.4 (2021-01-15)
5+
* \+ The ability to return the MIME content type for a file (see the `tpl` parameter).
6+
* \* Parameters → `tpl`: Wrong `[+file+]` placeholder was fixed.
7+
* \+ README, CHANGELOG: Style improvements.
8+
* \+ README → Documentation → Parameters description → `tpl_placeholders`: Text improved.
9+
10+
411
## Version 2.3 (2019-12-12)
512
* \+ If `file` doesn't contain base path, the snippet will add it.
613
* \* `fopen` is not used anymore because `@` operator doesn't always work.
@@ -29,63 +36,9 @@
2936
* \* Is equal to `EnShort` by default.
3037

3138

32-
## Version 2.1 (2015-12-28)
33-
* \+ Добавлен вывод типа файла (плэйсхолдер `[+type+]` при выводе через `tpl` и `type` в `output` соответственно). Удобно использовать с [Font Awesome](http://fontawesome.io/).
34-
* \* Нулевой размер файла выводится (не считается ошибкой filesize).
35-
* \* Сниппет `ddGetDocumentField` больше не используется, значение поля документа получается при помощи метода `ddTools::getTemplateVarOutput`.
36-
* \* Вместо прямого обращения к полю `$modx->config` используется метод `$modx->getConfig`.
37-
* \* Внимание! Сниппет использует библиотеку `modx.ddTools` версии 0.15.
38-
39-
40-
## Version 2.0 (2014-03-25)
41-
* \* Сниппет переименован в `ddGetFileInfo`.
42-
* \* Следующие параметры были переименованы:
43-
* \* `getField` → `docField`.
44-
* \* `getId` → `docId`.
45-
* \* `type` → `sizeType`.
46-
* \* `prec` → `sizePrec`.
47-
* \* При выводе через шаблон следующие плэйсхолдеры были переименованы:
48-
* \* `[+filesize+]` → `[+size+]`.
49-
* \* `[+fileext+]` → `[+extension+]`.
50-
* \* `[+filename+]` → `[+name+]`.
51-
* \* `[+filepath+]` → `[+path+]`.
52-
* \+ Добавлен параметр `$output`, позволяющий задать, что именно будет выводиться, если не задан шаблон.
53-
54-
55-
## Version 1.6.1 (2013-10-23)
56-
* \+ Существование файла теперь проверяется через `fopen`, что позволяет работать с удалёнными файлами.
57-
* \* Если имя файла начинается с сивола `/`, он всегда вырезается.
58-
* \* Если размер файла получить не удалось (например, файл где-то в интернетах), плэйсхолдер `filesize` в чанке `tpl` будет содержать пустую строку.
59-
* \* Рефакторинг.
60-
61-
62-
## Version 1.6 (2013-08-14)
63-
* \* Внимание! Нарушена обратная совместимость.
64-
* \+ При выводе через шаблон добавлен плэйсхолдер `[+file+]` (полный адрес файла).
65-
* \* При выводе через шаблон плэйсхолдер `[+ext+]` переименован в `[+fileext+]` (для однообразности).
66-
* \- Удалён параметр `getPublished` за ненадобностью.
67-
68-
69-
## Version 1.5 (2013-01-17)
70-
* \+ Добавлена возможность передавать дополнительные (параметр `placeholders`) в чанк `tpl`.
71-
* \* Внимание! Сниппет теперь использует библиотеку ddTools 0.4 (при использовании параметра `placeholders`).
72-
73-
74-
## Version 1.4 (2012-08-13)
75-
* \+ При выводе через шаблон добавлены плэйсхолдеры: `[+filename+]` (имя файла), `[+filepath+]` (путь к файлу).
76-
77-
78-
## Version 1.3 (2011-06-07)
79-
* \+ Добавлена возможность получения адреса файла из поля заданного документа (добавлены параметры `getId`, `getField`, `getPublished`).
80-
81-
82-
## Version 1.2 (2011-04-20)
83-
* \+ Если файл получить не удалось, пробуем отрезать '/' от начала имени.
84-
* \+ Добавлен плейсхолдер `[+ext+]`, в который записывается расширение файла при выводе через шаблон.
85-
86-
8739
## Version 1.0 (2010)
8840
* \+ The first release.
8941

9042

43+
<link rel="stylesheet" type="text/css" href="https://DivanDesign.ru/assets/files/ddMarkdown.css" />
9144
<style>ul{list-style:none;}</style>

‎CHANGELOG_ru.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# (MODX)EvolutionCMS.snippets.ddGetFileInfo changelog
2+
3+
4+
## Версия 2.4 (2021-01-15)
5+
* \+ Возможность возвращать MIME тип файла (см. параметр `tpl`).
6+
* \* Параметры → `tpl`: Некорректный плейсходлер `[+file+]` исправлен.
7+
* \+ README, CHANGELOG: Улучшения стиля.
8+
* \+ README → Документация → Описание параметров → `tpl_placeholders`: Текст улучшен.
9+
10+
11+
## Версия 2.1 (2015-12-28)
12+
* \+ Добавлен вывод типа файла (плэйсхолдер `[+type+]` при выводе через `tpl` и `type` в `output` соответственно). Удобно использовать с [Font Awesome](http://fontawesome.io/).
13+
* \* Нулевой размер файла выводится (не считается ошибкой filesize).
14+
* \* Сниппет `ddGetDocumentField` больше не используется, значение поля документа получается при помощи метода `ddTools::getTemplateVarOutput`.
15+
* \* Вместо прямого обращения к полю `$modx->config` используется метод `$modx->getConfig`.
16+
* \* Внимание! Сниппет использует библиотеку `modx.ddTools` версии 0.15.
17+
18+
19+
## Версия 2.0 (2014-03-25)
20+
* \* Сниппет переименован в `ddGetFileInfo`.
21+
* \* Следующие параметры были переименованы:
22+
* \* `getField` → `docField`.
23+
* \* `getId` → `docId`.
24+
* \* `type` → `sizeType`.
25+
* \* `prec` → `sizePrec`.
26+
* \* При выводе через шаблон следующие плэйсхолдеры были переименованы:
27+
* \* `[+filesize+]` → `[+size+]`.
28+
* \* `[+fileext+]` → `[+extension+]`.
29+
* \* `[+filename+]` → `[+name+]`.
30+
* \* `[+filepath+]` → `[+path+]`.
31+
* \+ Добавлен параметр `$output`, позволяющий задать, что именно будет выводиться, если не задан шаблон.
32+
33+
34+
## Версия 1.6.1 (2013-10-23)
35+
* \+ Существование файла теперь проверяется через `fopen`, что позволяет работать с удалёнными файлами.
36+
* \* Если имя файла начинается с сивола `/`, он всегда вырезается.
37+
* \* Если размер файла получить не удалось (например, файл где-то в интернетах), плэйсхолдер `filesize` в чанке `tpl` будет содержать пустую строку.
38+
* \* Рефакторинг.
39+
40+
41+
## Версия 1.6 (2013-08-14)
42+
* \* Внимание! Нарушена обратная совместимость.
43+
* \+ При выводе через шаблон добавлен плэйсхолдер `[+file+]` (полный адрес файла).
44+
* \* При выводе через шаблон плэйсхолдер `[+ext+]` переименован в `[+fileext+]` (для однообразности).
45+
* \- Удалён параметр `getPublished` за ненадобностью.
46+
47+
48+
## Версия 1.5 (2013-01-17)
49+
* \+ Добавлена возможность передавать дополнительные (параметр `placeholders`) в чанк `tpl`.
50+
* \* Внимание! Сниппет теперь использует библиотеку ddTools 0.4 (при использовании параметра `placeholders`).
51+
52+
53+
## Версия 1.4 (2012-08-13)
54+
* \+ При выводе через шаблон добавлены плэйсхолдеры: `[+filename+]` (имя файла), `[+filepath+]` (путь к файлу).
55+
56+
57+
## Версия 1.3 (2011-06-07)
58+
* \+ Добавлена возможность получения адреса файла из поля заданного документа (добавлены параметры `getId`, `getField`, `getPublished`).
59+
60+
61+
## Версия 1.2 (2011-04-20)
62+
* \+ Если файл получить не удалось, пробуем отрезать '/' от начала имени.
63+
* \+ Добавлен плейсхолдер `[+ext+]`, в который записывается расширение файла при выводе через шаблон.
64+
65+
66+
## Версия 1.0 (2010)
67+
* \+ Первый релиз.
68+
69+
70+
<link rel="stylesheet" type="text/css" href="https://DivanDesign.ru/assets/files/ddMarkdown.css" />
71+
<style>ul{list-style:none;}</style>

‎README.md‎

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,32 @@
33
Выводит информацию о фале: размер, имя, расширение и пр.
44

55

6-
## # Requires
6+
## Requires
77
* PHP >= 5.4
88
* [(MODX)EvolutionCMS](https://github.com/evolution-cms/evolution) >= 1.1
99
* [(MODX)EvolutionCMS.libraries.ddTools](https://code.divandesign.biz/modx/ddtools) >= 0.18
1010

1111

12-
## # Documentation
12+
## Documentation
1313

1414

15-
### ## Installation
15+
### Installation
1616

1717
Elements → Snippets: Create a new snippet with the following data:
1818
1. Snippet name: `ddGetFileInfo`.
19-
2. Description: `<b>2.3</b> Выводит информацию о фале: размер, имя, расширение и пр.`.
19+
2. Description: `<b>2.4</b> Выводит информацию о фале: размер, имя, расширение и пр.`.
2020
3. Category: `Core`.
2121
4. Parse DocBlock: `no`.
2222
5. Snippet code (php): Insert content of the `ddGetFileInfo_snippet.php` file from the archive.
2323

2424

25-
### ## Parameters description
25+
### Parameters description
2626

2727
* `file`
2828
* Desctription: Имя файла (путь).
2929
* Valid values:
30-
* `string_filePath` — путь к файлу можно указать относительно корня сайта (`/` в начале не играет роли, поддерживаются оба варианта), а можно и полный (включая `$modx->config['base_path']`)
31-
* `string_url` — можно указать не только локальный файл, но и адрес в интернете, но в этом случае по объективным причинам поддерживаются не все функции
30+
* `stringFilePath` — путь к файлу можно указать относительно корня сайта (`/` в начале не играет роли, поддерживаются оба варианта), а можно и полный (включая `$modx->config['base_path']`)
31+
* `stringUrl` — можно указать не только локальный файл, но и адрес в интернете, но в этом случае по объективным причинам поддерживаются не все функции
3232
* **Required**
3333

3434
* `file_docField`
@@ -38,7 +38,7 @@ Elements → Snippets: Create a new snippet with the following data:
3838

3939
* `file_docId`
4040
* Desctription: ID документа, из поля которого нужно получить адрес файла.
41-
* Valid values: `integer_docId`
41+
* Valid values: `integerDocId`
4242
* Default value: —
4343

4444
* `sizeNameFormat`
@@ -62,6 +62,7 @@ Elements → Snippets: Create a new snippet with the following data:
6262
* `'size'`
6363
* `'extension'`
6464
* `'type'`
65+
* `'typeMime'`
6566
* `'name'`
6667
* `'path'`
6768
* Default value: `'size'`
@@ -85,16 +86,27 @@ Elements → Snippets: Create a new snippet with the following data:
8586
* `'word'`
8687
* `'excel'`
8788
* `'powerpoint'`
88-
* `''`
89+
* `[+typeMime+]` — content type in MIME format (only for local files, not for URLs)
8990
9091
* Valid values:
91-
* `string_chunkName`
92+
* `stringChunkName`
9293
* `string` — use inline templates starting with `@CODE:`
9394
* Default value: —
9495

9596
* `tpl_placeholders`
96-
* Desctription: Additional data has to be passed into the `tpl`. Arrays are supported too: `some[a]=one&some[b]=two` => `[+some.a+]`, `[+some.b+]`; `some[]=one&some[]=two` => `[+some.0+]`, `[some.1]`.
97+
* Desctription:
98+
Additional data has to be passed into the `tpl`.
99+
Nested objects and arrays are supported too:
100+
* `{"someOne": "1", "someTwo": "test" }` => `[+someOne+], [+someTwo+]`.
101+
* `{"some": {"a": "one", "b": "two"} }` => `[+some.a+]`, `[+some.b+]`.
102+
* `{"some": ["one", "two"] }` => `[+some.0+]`, `[+some.1+]`.
97103
* Valid values:
98-
* `stirng_json` — as [JSON](https://en.wikipedia.org/wiki/JSON)
99-
* `string_queryFormated` — as [Query string](https://en.wikipedia.org/wiki/Query_string)
100-
* Default value: —
104+
* `stringJsonObject` — as [JSON](https://en.wikipedia.org/wiki/JSON)
105+
* `stringQueryFormated` — as [Query string](https://en.wikipedia.org/wiki/Query_string)
106+
* It can also be set as native PHP object or array (e. g. for calls through `$modx->runSnippet`):
107+
* `arrayAssociative`
108+
* `object`
109+
* Default value: —
110+
111+
112+
<link rel="stylesheet" type="text/css" href="https://DivanDesign.ru/assets/files/ddMarkdown.css" />

‎composer.json‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "dd/evolutioncms-snippets-ddgetfileinfo",
33
"type": "modxevo-snippet",
4-
"version": "2.3",
4+
"version": "2.4",
55
"description": "Выводит информацию о фале: размер, имя, расширение и пр.",
66
"keywords": [
77
"modx",
@@ -10,10 +10,16 @@
1010
"evo",
1111
"evo cms",
1212
"evolution cms",
13-
"ddgetfileinfo"
13+
"ddgetfileinfo",
14+
"get file info",
15+
"file info",
16+
"file size",
17+
"file extension",
18+
"file type",
19+
"file mime"
1420
],
1521
"require": {
1622
"php": ">=5.4",
17-
"dd/modxevo-library-ddtools": ">=0.18"
23+
"dd/evolutioncms-libraries-ddtools": ">=0.18"
1824
}
1925
}

0 commit comments

Comments
 (0)