MadelineProto/src/danog/MadelineProto/DocsBuilder/Constructors.php

251 lines
11 KiB
PHP
Raw Normal View History

2017-08-18 18:10:30 +02:00
<?php
2017-08-18 18:10:30 +02:00
/*
Copyright 2016-2018 Daniil Gentili
2017-08-18 18:10:30 +02:00
(https://daniil.it)
This file is part of MadelineProto.
MadelineProto is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
MadelineProto is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Affero General Public License for more details.
You should have received a copy of the GNU General Public License along with MadelineProto.
If not, see <http://www.gnu.org/licenses/>.
*/
namespace danog\MadelineProto\DocsBuilder;
trait Constructors
{
2017-08-18 18:11:04 +02:00
public function mk_constructors()
{
foreach (glob('constructors/' . $this->any) as $unlink) {
2017-08-18 18:10:30 +02:00
unlink($unlink);
}
if (file_exists('constructors')) {
rmdir('constructors');
}
mkdir('constructors');
$this->docs_constructors = [];
\danog\MadelineProto\Logger::log(['Generating constructors documentation...'], \danog\MadelineProto\Logger::NOTICE);
$got = [];
foreach ($this->constructors->by_predicate_and_layer as $predicate => $id) {
$data = $this->constructors->by_id[$id];
if (isset($got[$id])) {
$data['layer'] = '';
}
$got[$id] = '';
/*
if (preg_match('/%/', $type)) {
$type = $this->constructors->find_by_type(str_replace('%', '', $type))['predicate'];
}*/
$layer = isset($data['layer']) && $data['layer'] !== '' ? '_' . $data['layer'] : '';
2017-08-18 18:10:30 +02:00
$type = str_replace(['.', '<', '>'], ['_', '_of_', ''], $data['type']);
$php_type = preg_replace('/.*_of_/', '', $type);
$constructor = str_replace(['.', '<', '>'], ['_', '_of_', ''], $data['predicate']);
$php_constructor = preg_replace('/.*_of_/', '', $constructor);
if (!isset($this->types[$php_type])) {
$this->types[$php_type] = ['constructors' => [], 'methods' => []];
}
if (!in_array($data, $this->types[$php_type]['constructors'])) {
$this->types[$php_type]['constructors'][] = $data;
}
$params = '';
foreach ($data['params'] as $param) {
if (in_array($param['name'], ['flags', 'random_id', 'random_bytes'])) {
continue;
}
2017-09-28 19:38:43 +02:00
if ($type === 'EncryptedMessage' && $param['name'] === 'bytes' && !isset($this->settings['td'])) {
2017-08-18 18:10:30 +02:00
$param['name'] = 'decrypted_message';
$param['type'] = 'DecryptedMessage';
}
$type_or_subtype = isset($param['subtype']) ? 'subtype' : 'type';
$type_or_bare_type = ctype_upper($this->end(explode('.', $param[$type_or_subtype]))[0]) || in_array($param[$type_or_subtype], ['!X', 'X', 'bytes', 'true', 'false', 'double', 'string', 'Bool', 'int53', 'int', 'long', 'int128', 'int256', 'int512']) ? 'types' : 'constructors';
2017-08-18 18:10:30 +02:00
$param[$type_or_subtype] = str_replace(['.', 'true', 'false'], ['_', 'Bool', 'Bool'], $param[$type_or_subtype]);
if (preg_match('/%/', $param[$type_or_subtype])) {
$param[$type_or_subtype] = $this->constructors->find_by_type(str_replace('%', '', $param[$type_or_subtype]))['predicate'];
}
2017-09-29 15:50:59 +02:00
if (substr($param[$type_or_subtype], -1) === '>') {
2017-09-29 16:09:05 +02:00
$param[$type_or_subtype] = substr($param[$type_or_subtype], 0, -1);
2017-09-29 15:50:59 +02:00
}
$params .= "'" . $param['name'] . "' => ";
$param[$type_or_subtype] = '[' . $this->escape($param[$type_or_subtype]) . '](../' . $type_or_bare_type . '/' . $param[$type_or_subtype] . '.md)';
$params .= (isset($param['subtype']) ? '\\[' . $param[$type_or_subtype] . '\\]' : $param[$type_or_subtype]) . ', ';
2017-08-18 18:10:30 +02:00
}
$md_constructor = str_replace('_', '\\_', $constructor . $layer);
$this->docs_constructors[$constructor] = '[$' . $md_constructor . '](../constructors/' . $php_constructor . $layer . '.md) = \\[' . $params . '\\];<a name="' . $constructor . $layer . '"></a>
2017-08-18 18:10:30 +02:00
';
$table = empty($data['params']) ? '' : '### Attributes:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-08-18 18:10:30 +02:00
';
if (isset($this->td_descriptions['constructors'][$data['predicate']])) {
$table = '### Attributes:
| Name | Type | Required | Description |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|-------------|
2017-08-18 18:10:30 +02:00
';
}
$params = '';
$lua_params = '';
$pwr_params = '';
$hasreplymarkup = false;
$hasentities = false;
foreach ($data['params'] as $param) {
if (in_array($param['name'], ['flags', 'random_id', 'random_bytes'])) {
continue;
}
2017-09-28 19:38:43 +02:00
if ($type === 'EncryptedMessage' && $param['name'] === 'bytes' && !isset($this->settings['td'])) {
2017-08-18 18:10:30 +02:00
$param['name'] = 'decrypted_message';
$param['type'] = 'DecryptedMessage';
}
$ptype = str_replace('.', '_', $param[isset($param['subtype']) ? 'subtype' : 'type']);
2017-09-29 15:50:59 +02:00
//$type_or_bare_type = 'types';
/*if (isset($param['subtype'])) {
if ($param['type'] === 'vector') {
$type_or_bare_type = 'constructors';
}
}*/
2017-08-18 18:10:30 +02:00
if (preg_match('/%/', $ptype)) {
$ptype = $this->constructors->find_by_type(str_replace('%', '', $ptype))['predicate'];
}
$type_or_bare_type = (ctype_upper($this->end(explode('_', $ptype))[0]) || in_array($ptype, ['!X', 'X', 'bytes', 'true', 'false', 'double', 'string', 'Bool', 'int53', 'int', 'long', 'int128', 'int256', 'int512'])) && $ptype !== 'MTmessage' ? 'types' : 'constructors';
2017-09-29 15:50:59 +02:00
if (substr($ptype, -1) === '>') {
2017-09-29 16:09:05 +02:00
$ptype = substr($ptype, 0, -1);
2017-09-29 15:50:59 +02:00
}
2017-08-18 18:10:30 +02:00
switch ($ptype) {
case 'true':
case 'false':
$ptype = 'Bool';
}
$table .= '|' . str_replace('_', '\\_', $param['name']) . '|' . (isset($param['subtype']) ? 'Array of ' : '') . '[' . str_replace('_', '\\_', $ptype) . '](../' . $type_or_bare_type . '/' . $ptype . '.md) | ' . (isset($param['pow']) || $this->constructors->find_by_predicate(lcfirst($param['type']) . 'Empty') ? 'Optional' : 'Yes') . '|';
2017-08-18 18:10:30 +02:00
if (isset($this->td_descriptions['constructors'][$data['predicate']]['params'][$param['name']])) {
$table .= $this->td_descriptions['constructors'][$data['predicate']]['params'][$param['name']] . '|';
2017-08-18 18:10:30 +02:00
}
$table .= PHP_EOL;
$pptype = in_array($ptype, ['string', 'bytes']) ? "'" . $ptype . "'" : $ptype;
$ppptype = in_array($ptype, ['string', 'bytes']) ? '"' . $ptype . '"' : $ptype;
$params .= ", '" . $param['name'] . "' => ";
$params .= isset($param['subtype']) ? '[' . $pptype . ']' : $pptype;
$lua_params .= ', ' . $param['name'] . '=';
$lua_params .= isset($param['subtype']) ? '{' . $pptype . '}' : $pptype;
$pwr_params .= ', "' . $param['name'] . '": ' . (isset($param['subtype']) ? '[' . $ppptype . ']' : $ppptype);
2017-08-18 18:10:30 +02:00
if ($param['name'] === 'reply_markup') {
$hasreplymarkup = true;
}
}
$params = "['_' => '" . $data['predicate'] . "'" . $params . ']';
$lua_params = "{_='" . $data['predicate'] . "'" . $lua_params . '}';
$pwr_params = '{"_": "' . $data['predicate'] . '"' . $pwr_params . '}';
$description = isset($this->td_descriptions['constructors'][$data['predicate']]) ? $this->td_descriptions['constructors'][$data['predicate']]['description'] : $constructor . ' attributes, type and example';
2017-08-18 18:10:30 +02:00
$header = '---
title: ' . $data['predicate'] . '
description: ' . $description . '
2017-08-18 18:10:30 +02:00
---
## Constructor: ' . str_replace('_', '\\_', $data['predicate'] . $layer) . '
2017-08-18 18:10:30 +02:00
[Back to constructors index](index.md)
';
$table .= '
';
if (isset($this->td_descriptions['constructors'][$data['predicate']])) {
$header .= $this->td_descriptions['constructors'][$data['predicate']]['description'] . PHP_EOL . PHP_EOL;
2017-08-18 18:10:30 +02:00
}
$type = '### Type: [' . str_replace('_', '\\_', $php_type) . '](../types/' . $php_type . '.md)
2017-08-18 18:10:30 +02:00
';
2017-08-25 14:43:29 +02:00
$example = '';
if (!isset($this->settings['td'])) {
2017-08-25 14:43:50 +02:00
$example = '### Example:
2017-08-18 18:10:30 +02:00
```
$' . $constructor . $layer . ' = ' . $params . ';
2017-08-18 18:10:30 +02:00
```
[PWRTelegram](https://pwrtelegram.xyz) json-encoded version:
```
' . $pwr_params . '
2017-08-18 18:10:30 +02:00
```
Or, if you\'re into Lua:
```
' . $constructor . $layer . '=' . $lua_params . '
2017-08-18 18:10:30 +02:00
```
';
2017-08-25 14:43:50 +02:00
if ($hasreplymarkup) {
$example .= '
2017-08-18 18:10:30 +02:00
## Usage of reply_markup
You can provide bot API reply_markup objects here.
';
2017-08-25 14:43:50 +02:00
}
if ($hasentities) {
$example .= '
2017-08-18 18:10:30 +02:00
## Usage of parse_mode:
Set parse_mode to html to enable HTML parsing of the message.
Set parse_mode to Markdown to enable markown AND html parsing of the message.
The following tags are currently supported:
```
<br>a newline
<b><i>bold works ok, internal tags are stripped</i> </b>
<strong>bold</strong>
<em>italic</em>
<i>italic</i>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
<a href="https://github.com">URL</a>
<a href="mention:@danogentili">Mention by username</a>
<a href="mention:186785362">Mention by user id</a>
<pre language="json">Pre tags can have a language attribute</pre>
```
You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html:
```
[Mention by username](mention:@danogentili)
[Mention by user id](mention:186785362)
```
MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
';
2017-08-25 14:43:50 +02:00
}
}
file_put_contents('constructors/' . $constructor . $layer . '.md', $header . $table . $type . $example);
2017-08-18 18:10:30 +02:00
}
\danog\MadelineProto\Logger::log(['Generating constructors index...'], \danog\MadelineProto\Logger::NOTICE);
ksort($this->docs_constructors);
$last_namespace = '';
foreach ($this->docs_constructors as $constructor => &$value) {
$new_namespace = preg_replace('/_.*/', '', $constructor);
$br = $new_namespace != $last_namespace ? '***
<br><br>' : '';
$value = $br . $value;
2017-08-18 18:10:30 +02:00
$last_namespace = $new_namespace;
}
file_put_contents('constructors/' . $this->index, '---
2017-08-18 18:10:30 +02:00
title: Constructors
description: List of constructors
---
# Constructors
[Back to API documentation index](..)
' . implode('', $this->docs_constructors));
2017-08-18 18:10:30 +02:00
}
}