diff --git a/core/includes/pager.inc b/core/includes/pager.inc index b738b39..a5869b4 100644 --- a/core/includes/pager.inc +++ b/core/includes/pager.inc @@ -19,7 +19,7 @@ * $element. This is determined from the URL query parameter * \Drupal::request()->query->get('page'), or 0 by default. Note that this * number may differ from the actual page being displayed. For example, if a - * search for "example text" brings up three pages of results, but a users + * search for "example text" brings up three pages of results, but a user * visits search/node/example+text?page=10, this function will return 10, even * though the default pager implementation adjusts for this and still displays * the third page of search results at that URL. @@ -164,7 +164,7 @@ function pager_get_query_parameters() { * An associative array containing: * - pager: A render element containing: * - #tags: An array of labels for the controls in the pager. - * - #element: An optional int to distinguish between multiple pagers on + * - #element: An optional integer to distinguish between multiple pagers on * one page. * - #parameters: An associative array of query string parameters to append to * the pager links. @@ -277,32 +277,32 @@ function template_preprocess_pager(&$variables) { } /** - * Adds the 'page' parameter to the url query parameter array of a pager link. + * Adds the 'page' parameter to the URL query parameter array of a pager link. * * Since we can have multiple pagers on a single page, each pager has an index * value assigned to it. If we have 5 pages on a single page, we could assign * them the index numbers: 0, 1, 2, 3, 4. To indicate that the 3rd pager is on - * page 5, we would need to indicate this in the url query, by having index 2 - * have the value of 5. The url query would then look like this: page=0,0,5. - * It's such an url query that is generated through this function, taking all + * page 5, we would need to indicate this in the URL query, by having index 2 + * have the value of 5. The URL query would then look like this: page=0,0,5. + * It's such an URL query that is generated through this function, taking all * pagers on the page into account. * * @param array $query * An associative array of query parameters to add to. * @param int $element * An integer to distinguish between multiple pagers on one page. - * @param int $index - * The index of the target page in the pager array. + * @param int $page_no + * The page number for the pager that should be set. * * @return array * The altered $query parameter array. */ -function pager_query_add_page(array $query, $element, $index) { +function pager_query_add_page(array $query, $element, $page_no) { // The general idea is to create an array with all the needed values and then // use implode to convert it to a string of integers separated by comma. Get // the default values from the request make sure other queries are maintained. $page = \Drupal::request()->query->get('page', ''); - if ($new_page = implode(',', pager_load_array($index, $element, explode(',', $page)))) { + if ($new_page = implode(',', pager_load_array($page_no, $element, explode(',', $page)))) { $query['page'] = $new_page; } @@ -322,12 +322,12 @@ function pager_query_add_page(array $query, $element, $index) { * Fills in $new_array[0 .. $element - 1] = 0 * * @param int $value - * The value which will be set in the copied array returned by this function. + * The value that will be set in the copied array returned by this function. * @param int $element - * The index which will have it's value overridden in the copied array - * returned by this function. + * The index that will have its value overridden in the copied array returned + * by this function. * @param array $old_array - * Array which will be copied and modified. + * Array that will be copied and modified. * * @return array * Copy of $old_array generated through the rule described above.