mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-09-29 23:01:54 +00:00
Code Issues Projects Releases Wiki Activity

Improve docs

Browse source
This commit is contained in:
Jeremy Benoist 2017-05-24 16:02:49 +02:00
parent 0d6cfb884c
commit 9e349f08a6
No known key found for this signature in database
GPG key ID: BCA73962457ACC3C
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/Wallabag/ApiBundle/Controller/EntryRestController.php
View file

@ -273,6 +273,9 @@ class EntryRestController extends WallabagRestController
/** /**
* Create an entry. * 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( * @ApiDoc(
* parameters={ * parameters={
* {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."}, * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},

6
src/Wallabag/CoreBundle/Helper/ContentProxy.php
View file

@ -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. * 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 * 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 Entry $entry Entry to update
* @param string $url Url to grab content for * @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 * @return Entry
*/ */
@ -85,7 +85,7 @@ class ContentProxy
try { try {
$entry->setPublishedAt(new \DateTime($content['date'])); $entry->setPublishedAt(new \DateTime($content['date']));
} catch (\Exception $e) { } 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']]);
} }
} }