From 96d49bf04ce77c975fe500f4d961e4a1ffed4c26 Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Sun, 30 Dec 2012 14:43:00 +0200 Subject: Use sdoc to generate application code documentation --- doc/code/classes/ApplicationHelper.html | 890 ++++++++++++++++++++++++++++++++ 1 file changed, 890 insertions(+) create mode 100644 doc/code/classes/ApplicationHelper.html (limited to 'doc/code/classes/ApplicationHelper.html') diff --git a/doc/code/classes/ApplicationHelper.html b/doc/code/classes/ApplicationHelper.html new file mode 100644 index 00000000000..2c3a82bb7b1 --- /dev/null +++ b/doc/code/classes/ApplicationHelper.html @@ -0,0 +1,890 @@ + + + + + ApplicationHelper + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
A
+
+ +
+ +
C
+
+ +
+ +
E
+
+ +
+ +
G
+
+ +
+ +
H
+
+ +
+ +
L
+
+ +
+ +
P
+
+ +
+ +
R
+
+ +
+ +
S
+
+ +
+ +
U
+
+ +
+ +
W
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + app_theme() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 130
+def app_theme
+  Gitlab::Theme.css_class_by_id(current_user.try(:theme_id))
+end
+
+
+ +
+ +
+
+ + authbutton(provider, size = 64) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 159
+def authbutton(provider, size = 64)
+  file_name = "#{provider.to_s.split('_').first}_#{size}.png"
+  image_tag("authbuttons/#{file_name}",
+            alt: "Sign in with #{provider.to_s.titleize}")
+end
+
+
+ +
+ +
+
+ + current_action?(*args) + + +
+ + +
+

Check if a partcular action is the current one

+ +

args - One or more action names to check

+ +

Examples

+ +
# On Projects#new
+current_action?(:new)           # => true
+current_action?(:create)        # => false
+current_action?(:new, :create)  # => true
+
+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 30
+def current_action?(*args)
+  args.any? { |v| v.to_s.downcase == action_name }
+end
+
+
+ +
+ +
+
+ + current_controller?(*args) + + +
+ + +
+

Check if a particular controller is the current one

+ +

args - One or more controller names to check

+ +

Examples

+ +
# On TreeController
+current_controller?(:tree)           # => true
+current_controller?(:commits)        # => false
+current_controller?(:commits, :tree) # => true
+
+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 16
+def current_controller?(*args)
+  args.any? { |v| v.to_s.downcase == controller.controller_name }
+end
+
+
+ +
+ +
+
+ + emoji_autocomplete_source() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 120
+def emoji_autocomplete_source
+  # should be an array of strings
+  # so to_s can be called, because it is sufficient and to_json is too slow
+  Emoji.names.to_s
+end
+
+
+ +
+ +
+
+ + gravatar_icon(user_email = '', size = nil) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 34
+def gravatar_icon(user_email = '', size = nil)
+  size = 40 if size.nil? || size <= 0
+
+  if !Gitlab.config.gravatar.enabled || user_email.blank?
+    'no_avatar.png'
+  else
+    gravatar_url = request.ssl? ? Gitlab.config.gravatar.ssl_url : Gitlab.config.gravatar.plain_url
+    user_email.strip!
+    sprintf(gravatar_url, {:hash => Digest::MD5.hexdigest(user_email.downcase), :email => URI.escape(user_email), :size => size})
+  end
+end
+
+
+ +
+ +
+
+ + grouped_options_refs(destination = :tree) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 64
+def grouped_options_refs(destination = :tree)
+  options = [
+    ["Branch", @project.branch_names ],
+    [ "Tag", @project.tag_names ]
+  ]
+
+  # If reference is commit id -
+  # we should add it to branch/tag selectbox
+  if(@ref && !options.flatten.include?(@ref) &&
+     @ref =~ %r^[0-9a-zA-Z]{6,52}$/)
+    options << ["Commit", [@ref]]
+  end
+
+  grouped_options_for_select(options, @ref || @project.default_branch)
+end
+
+
+ +
+ +
+
+ + hexdigest(string) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 146
+def hexdigest(string)
+  Digest::SHA1.hexdigest string
+end
+
+
+ +
+ +
+
+ + last_commit(project) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 54
+def last_commit(project)
+  if project.repo_exists?
+    time_ago_in_words(project.commit.committed_date) + " ago"
+  else
+    "Never"
+  end
+rescue
+  "Never"
+end
+
+
+ +
+ +
+
+ + ldap_enable?() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 126
+def ldap_enable?
+  Devise.omniauth_providers.include?(:ldap)
+end
+
+
+ +
+ +
+
+ + project_last_activity(project) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 150
+def project_last_activity project
+  activity = project.last_activity
+  if activity && activity.created_at
+    time_ago_in_words(activity.created_at) + " ago"
+  else
+    "Never"
+  end
+end
+
+
+ +
+ +
+
+ + request_protocol() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 46
+def request_protocol
+  request.ssl? ? "https" : "http"
+end
+
+
+ +
+ +
+
+ + search_autocomplete_source() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 80
+def search_autocomplete_source
+  projects = current_user.authorized_projects.map { |p| { label: p.name_with_namespace, url: project_path(p) } }
+  groups = current_user.authorized_groups.map { |group| { label: "<group> #{group.name}", url: group_path(group) } }
+
+  default_nav = [
+    { label: "My Profile", url: profile_path },
+    { label: "My SSH Keys", url: keys_path },
+    { label: "My Dashboard", url: root_path },
+    { label: "Admin Section", url: admin_root_path },
+  ]
+
+  help_nav = [
+    { label: "Workflow Help", url: help_workflow_path },
+    { label: "Permissions Help", url: help_permissions_path },
+    { label: "Web Hooks Help", url: help_web_hooks_path },
+    { label: "System Hooks Help", url: help_system_hooks_path },
+    { label: "API Help", url: help_api_path },
+    { label: "Markdown Help", url: help_markdown_path },
+    { label: "SSH Keys Help", url: help_ssh_path },
+    { label: "Gitlab Rake Tasks Help", url: help_raketasks_path },
+  ]
+
+  project_nav = []
+  if @project && !@project.new_record?
+    project_nav = [
+      { label: "#{@project.name} Issues",   url: project_issues_path(@project) },
+      { label: "#{@project.name} Commits",  url: project_commits_path(@project, @ref || @project.root_ref) },
+      { label: "#{@project.name} Merge Requests", url: project_merge_requests_path(@project) },
+      { label: "#{@project.name} Milestones", url: project_milestones_path(@project) },
+      { label: "#{@project.name} Snippets", url: project_snippets_path(@project) },
+      { label: "#{@project.name} Team",     url: project_team_index_path(@project) },
+      { label: "#{@project.name} Tree",     url: project_tree_path(@project, @ref || @project.root_ref) },
+      { label: "#{@project.name} Wall",     url: wall_project_path(@project) },
+      { label: "#{@project.name} Wiki",     url: project_wikis_path(@project) },
+    ]
+  end
+
+  [groups, projects, default_nav, project_nav, help_nav].flatten.to_json
+end
+
+
+ +
+ +
+
+ + show_last_push_widget?(event) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 138
+def show_last_push_widget?(event)
+  event &&
+    event.last_push_to_non_root? &&
+    !event.rm_ref? &&
+    event.project &&
+    event.project.merge_requests_enabled
+end
+
+
+ +
+ +
+
+ + user_color_scheme_class() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 134
+def user_color_scheme_class
+  current_user.dark_scheme ? :black : :white
+end
+
+
+ +
+ +
+
+ + web_app_url() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/application_helper.rb, line 50
+def web_app_url
+  "#{request_protocol}://#{Gitlab.config.gitlab.host}/"
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file -- cgit v1.2.1