Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
drupal-3174996
Manage
Activity
Members
Labels
Plan
Custom issue tracker
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Model registry
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Issue forks
drupal-3174996
Commits
01151024
Commit
01151024
authored
12 years ago
by
Jennifer Hodgdon
Browse files
Options
Downloads
Patches
Plain Diff
Issue
#1398404
by batigolix: Fix up API docs for a few remaining functions in overlay module
parent
1df8d280
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
core/modules/overlay/overlay.module
+15
-7
15 additions, 7 deletions
core/modules/overlay/overlay.module
with
15 additions
and
7 deletions
core/modules/overlay/overlay.module
+
15
−
7
View file @
01151024
...
...
@@ -311,7 +311,11 @@ function overlay_page_alter(&$page) {
}
/**
* Access callback; determines access to dismiss the overlay accessibility message.
* Access callback: Determines access to dismiss the accessibility message.
*
* @return
* TRUE if the user has permission to dismiss the accessibility message or if
* the user is anonymous. FALSE if otherwise.
*
* @see overlay_user_dismiss_message()
* @see overlay_menu()
...
...
@@ -331,7 +335,10 @@ function overlay_user_dismiss_message_access() {
}
/**
* Menu callback: Dismisses the overlay accessibility message for this user.
* Page callback: Dismisses the overlay accessibility message for this user.
*
* @return
* A render array for a page containing a list of content.
*
* @see overlay_user_dismiss_message_access()
* @see overlay_menu()
...
...
@@ -554,7 +561,7 @@ function overlay_preprocess_page(&$variables) {
}
/**
*
Callback
to
re
quest that the overlay display an empty page
.
*
S
tore
s and returns whether an empty page override is needed
.
*
* This is used to prevent a page request which closes the overlay (for
* example, a form submission) from being fully re-rendered before the overlay
...
...
@@ -731,12 +738,13 @@ function overlay_overlay_child_initialize() {
}
/**
*
Callback to r
equest that the overlay
close as soon as
the page is displayed.
*
R
equest
s
that the overlay
overlay closes when
the page is displayed.
*
* @param $redirect
* (optional) The path that should open in the parent window after the
* overlay closes. If not set, no redirect will be performed on the parent
* window.
*
* @param $redirect_options
* (optional) An associative array of options to use when generating the
* redirect URL.
...
...
@@ -966,7 +974,7 @@ function overlay_store_rendered_content($id = NULL, $content = NULL) {
}
/**
* Request that the parent window refresh a particular page region.
* Request
s
that the parent window refresh
es
a particular page region.
*
* @param $region
* The name of the page region to refresh. The parent window will trigger a
...
...
@@ -981,7 +989,7 @@ function overlay_request_refresh($region) {
}
/**
* Request that the entire parent window
be
reloaded when the overlay closes.
* Request
s
that the entire parent window
is
reloaded when the overlay closes.
*
* @see overlay_trigger_refresh()
*/
...
...
@@ -990,7 +998,7 @@ function overlay_request_page_refresh() {
}
/**
* Check if the parent window needs to be refreshed on this page load.
* Check
s
if the parent window needs to be refreshed on this page load.
*
* If the previous page load requested that any page regions be refreshed, or
* if it requested that the entire page be refreshed when the overlay closes,
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment