mirror of
https://github.com/wallabag/wallabag.git
synced 2025-04-16 15:04:06 +00:00
Improve docs
This commit is contained in:
parent
0d6cfb884c
commit
9e349f08a6
2 changed files with 6 additions and 3 deletions
src/Wallabag
|
@ -273,6 +273,9 @@ class EntryRestController extends WallabagRestController
|
|||
/**
|
||||
* Create an entry.
|
||||
*
|
||||
* If you want to provide the HTML content (which means wallabag won't fetch it from the url), you must provide `content`, `title` & `url` fields **non-empty**.
|
||||
* Otherwise, content will be fetched as normal from the url and values will be overwritten.
|
||||
*
|
||||
* @ApiDoc(
|
||||
* parameters={
|
||||
* {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
|
||||
|
|
|
@ -31,7 +31,7 @@ class ContentProxy
|
|||
}
|
||||
|
||||
/**
|
||||
* Fetch content using graby and hydrate given entry with results information.
|
||||
* Fetch content using graby and hydrate given $entry with results information.
|
||||
* In case we couldn't find content, we'll try to use Open Graph data.
|
||||
*
|
||||
* We can also force the content, in case of an import from the v1 for example, so the function won't
|
||||
|
@ -39,7 +39,7 @@ class ContentProxy
|
|||
*
|
||||
* @param Entry $entry Entry to update
|
||||
* @param string $url Url to grab content for
|
||||
* @param array $content An array with AT LEAST keys title, html, url, language & content_type to skip the fetchContent from the url
|
||||
* @param array $content An array with AT LEAST keys title, html, url to skip the fetchContent from the url
|
||||
*
|
||||
* @return Entry
|
||||
*/
|
||||
|
@ -85,7 +85,7 @@ class ContentProxy
|
|||
try {
|
||||
$entry->setPublishedAt(new \DateTime($content['date']));
|
||||
} catch (\Exception $e) {
|
||||
$this->logger->warn('Error while defining date', ['e' => $e, 'url' => $url, 'date' => $content['date']]);
|
||||
$this->logger->warning('Error while defining date', ['e' => $e, 'url' => $url, 'date' => $content['date']]);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
Loading…
Reference in a new issue