Commit e21ef112 authored by alexpott's avatar alexpott

Issue #1807160 by Mile23, martin107, ParisLiakos, Lars Toomre: Add missing...

Issue #1807160 by Mile23, martin107, ParisLiakos, Lars Toomre: Add missing type hinting to Aggregator module docblocks
parent a154917d
......@@ -163,10 +163,10 @@ function aggregator_cron() {
/**
* Renders the HTML content safely, as allowed.
*
* @param $value
* @param string $value
* The content to be filtered.
*
* @return
* @return string
* The filtered content.
*/
function aggregator_filter_xss($value) {
......
......@@ -182,9 +182,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
* Feeds are recognized as <outline> elements with the attributes "text" and
* "xmlurl" set.
*
* @todo Move this functionality to a parser.
*
* @param $opml
* @param string $opml
* The complete contents of an OPML document.
*
* @return array
......@@ -192,6 +190,8 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
* element, or NULL if the OPML document failed to be parsed. An empty array
* will be returned if the document is valid but contains no feeds, as some
* OPML documents do.
*
* @todo Move this to a parser in https://www.drupal.org/node/1963540.
*/
protected function parseOpml($opml) {
$feeds = array();
......
......@@ -47,7 +47,7 @@ protected function setUp() {
*
* This method simulates the form submission on path aggregator/sources/add.
*
* @param $feed_url
* @param string $feed_url
* (optional) If given, feed will be created with this URL, otherwise
* /rss.xml will be used. Defaults to NULL.
* @param array $edit
......@@ -82,13 +82,13 @@ function deleteFeed(FeedInterface $feed) {
/**
* Returns a randomly generated feed edit array.
*
* @param $feed_url
* @param string $feed_url
* (optional) If given, feed will be created with this URL, otherwise
* /rss.xml will be used. Defaults to NULL.
* @param array $edit
* Array with additional form fields.
*
* @return
* @return array
* A feed array.
*/
function getFeedEditArray($feed_url = NULL, array $edit = array()) {
......@@ -138,7 +138,7 @@ function getFeedEditObject($feed_url = NULL, array $values = array()) {
/**
* Returns the count of the randomly created feed array.
*
* @return
* @return int
* Number of feed items on default feed created by createFeed().
*/
function getDefaultFeedItemCount() {
......@@ -215,12 +215,12 @@ function updateAndDelete(FeedInterface $feed, $expected_count) {
/**
* Checks whether the feed name and URL are unique.
*
* @param $feed_name
* @param string $feed_name
* String containing the feed name to check.
* @param $feed_url
* @param string $feed_url
* String containing the feed url to check.
*
* @return
* @return bool
* TRUE if feed is unique.
*/
function uniqueFeed($feed_name, $feed_url) {
......@@ -231,10 +231,10 @@ function uniqueFeed($feed_name, $feed_url) {
/**
* Creates a valid OPML file from an array of feeds.
*
* @param $feeds
* @param array $feeds
* An array of feeds.
*
* @return
* @return string
* Path to valid OPML file.
*/
function getValidOpml($feeds) {
......@@ -273,7 +273,7 @@ function getValidOpml($feeds) {
/**
* Creates an invalid OPML file.
*
* @return
* @return string
* Path to invalid OPML file.
*/
function getInvalidOpml() {
......@@ -290,7 +290,7 @@ function getInvalidOpml() {
/**
* Creates a valid but empty OPML file.
*
* @return
* @return string
* Path to empty OPML file.
*/
function getEmptyOpml() {
......@@ -326,7 +326,7 @@ function getHtmlEntitiesSample() {
/**
* Creates sample article nodes.
*
* @param $count
* @param int $count
* (optional) The number of nodes to generate. Defaults to five.
*/
function createSampleNodes($count = 5) {
......
......@@ -20,11 +20,11 @@ class AggregatorTestRssController extends ControllerBase {
/**
* Generates a test feed and simulates last-modified and etags.
*
* @param $use_last_modified
* @param bool $use_last_modified
* Set TRUE to send a last modified header.
* @param $use_etag
* @param bool $use_etag
* Set TRUE to send an etag.
* @param Request $request
* @param \Symfony\Component\HttpFoundation\Request $request
* Information about the current HTTP request.
*
* @return \Symfony\Component\HttpFoundation\Response
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment