Module: Pageflow

Extended by:

GlobalConfigApi, NewsItemApi

Defined in:

lib/pageflow.rb,
lib/pageflow/hooks.rb,
lib/pageflow/quota.rb,
lib/pageflow/react.rb,
lib/pageflow/seeds.rb,
lib/pageflow/theme.rb,
lib/pageflow/engine.rb,
lib/pageflow/plugin.rb,
lib/pageflow/quotas.rb,
lib/pageflow/themes.rb,
lib/pageflow/feature.rb,
lib/pageflow/version.rb,
lib/pageflow/features.rb,
lib/pageflow/admin/tab.rb,
lib/pageflow/file_type.rb,
lib/pageflow/page_type.rb,
lib/pageflow/admin/tabs.rb,
lib/pageflow/entry_type.rb,
lib/pageflow/file_types.rb,
lib/pageflow/help_entry.rb,
lib/pageflow/page_types.rb,
lib/pageflow/user_mixin.rb,
app/models/pageflow/page.rb,
app/models/pageflow/site.rb,
lib/pageflow/entry_types.rb,
lib/pageflow/widget_type.rb,
app/models/pageflow/entry.rb,
app/models/pageflow/roles.rb,
lib/pageflow/help_entries.rb,
lib/pageflow/widget_types.rb,
lib/pageflow/zencoder_api.rb,
app/models/pageflow/folder.rb,
app/models/pageflow/widget.rb,
lib/pageflow/ability_mixin.rb,
lib/pageflow/configuration.rb,
lib/pageflow/file_importer.rb,
lib/pageflow/news_item_api.rb,
lib/pageflow/rails_version.rb,
app/models/pageflow/account.rb,
app/models/pageflow/chapter.rb,
lib/pageflow/file_importers.rb,
lib/pageflow/view_component.rb,
app/models/pageflow/revision.rb,
app/models/pageflow/sitemaps.rb,
app/models/pageflow/edit_lock.rb,
app/models/pageflow/null_user.rb,
app/models/pageflow/permalink.rb,
app/models/pageflow/storyline.rb,
app/models/pageflow/used_file.rb,
lib/pageflow/admin/form_input.rb,
app/models/pageflow/audio_file.rb,
app/models/pageflow/file_reuse.rb,
app/models/pageflow/file_usage.rb,
app/models/pageflow/image_file.rb,
app/models/pageflow/membership.rb,
app/models/pageflow/other_file.rb,
app/models/pageflow/video_file.rb,
lib/pageflow/admin/form_inputs.rb,
lib/pageflow/editor_controller.rb,
lib/pageflow/global_config_api.rb,
lib/pageflow/page_type_feature.rb,
app/models/pageflow/draft_entry.rb,
app/models/pageflow/file_import.rb,
app/models/pageflow/home_button.rb,
lib/pageflow/built_in_file_type.rb,
lib/pageflow/built_in_page_type.rb,
lib/pageflow/revision_component.rb,
app/mailers/pageflow/user_mailer.rb,
app/models/pageflow/entries_feed.rb,
app/models/pageflow/invited_user.rb,
app/models/pageflow/url_template.rb,
lib/pageflow/entry_export_import.rb,
lib/pageflow/revision_components.rb,
app/helpers/pageflow/feeds_helper.rb,
app/helpers/pageflow/files_helper.rb,
app/helpers/pageflow/pages_helper.rb,
app/helpers/pageflow/quota_helper.rb,
app/helpers/pageflow/sites_helper.rb,
app/jobs/pageflow/application_job.rb,
app/jobs/pageflow/file_import_job.rb,
app/policies/pageflow/file_policy.rb,
app/policies/pageflow/site_policy.rb,
app/policies/pageflow/user_policy.rb,
lib/pageflow/built_in_widget_type.rb,
lib/pageflow/theme_customizations.rb,
app/helpers/pageflow/config_helper.rb,
app/helpers/pageflow/themes_helper.rb,
app/models/pageflow/entry_template.rb,
app/policies/pageflow/entry_policy.rb,
app/helpers/pageflow/entries_helper.rb,
app/helpers/pageflow/folders_helper.rb,
app/helpers/pageflow/widgets_helper.rb,
app/jobs/pageflow/poll_zencoder_job.rb,
app/models/pageflow/entry_duplicate.rb,
app/models/pageflow/invitation_form.rb,
app/models/pageflow/overview_button.rb,
app/models/pageflow/positioned_file.rb,
app/models/pageflow/published_entry.rb,
app/models/pageflow/text_track_file.rb,
app/models/pageflow/user_name_query.rb,
app/policies/pageflow/folder_policy.rb,
lib/pageflow/configuration/defaults.rb,
app/helpers/pageflow/info_box_helper.rb,
app/helpers/pageflow/overview_helper.rb,
app/models/pageflow/chapter_scaffold.rb,
app/models/pageflow/customized_theme.rb,
app/models/pageflow/entry_role_query.rb,
app/policies/pageflow/account_policy.rb,
app/helpers/pageflow/meta_tags_helper.rb,
app/models/pageflow/application_query.rb,
app/models/pageflow/entry_at_revision.rb,
app/models/pageflow/entry_publication.rb,
lib/pageflow/active_admin_can_can_fix.rb,
lib/pageflow/entry_type_configuration.rb,
lib/pageflow/paperclip_processors/vtt.rb,
app/helpers/pageflow/admin/form_helper.rb,
app/helpers/pageflow/asset_urls_helper.rb,
app/helpers/pageflow/embed_code_helper.rb,
app/helpers/pageflow/page_types_helper.rb,
app/models/pageflow/account_role_query.rb,
app/models/pageflow/application_record.rb,
app/models/pageflow/managed_user_query.rb,
app/models/pageflow/storyline_scaffold.rb,
lib/pageflow/configuration/permissions.rb,
lib/pageflow/nested_revision_component.rb,
lib/pageflow/paperclip_processors/noop.rb,
lib/pageflow/paperclip_processors/webp.rb,
app/helpers/pageflow/admin/users_helper.rb,
app/helpers/pageflow/audio_files_helper.rb,
app/helpers/pageflow/media_query_helper.rb,
app/helpers/pageflow/public_i18n_helper.rb,
app/helpers/pageflow/render_json_helper.rb,
app/helpers/pageflow/video_files_helper.rb,
app/models/pageflow/permalink_directory.rb,
app/models/pageflow/theme_customization.rb,
app/models/pageflow/zencoder_attachment.rb,
app/policies/pageflow/membership_policy.rb,
lib/pageflow/built_in_page_types_plugin.rb,
lib/pageflow/zencoder_output_definition.rb,
app/helpers/pageflow/editor/files_helper.rb,
app/helpers/pageflow/help_entries_helper.rb,
app/helpers/pageflow/social_share_helper.rb,
app/models/concerns/pageflow/suspendable.rb,
app/models/pageflow/account_member_query.rb,
app/models/pageflow/authentication_token.rb,
app/policies/pageflow/application_policy.rb,
lib/pageflow/admin/attributes_table_rows.rb,
app/controllers/pageflow/feeds_controller.rb,
app/controllers/pageflow/files_controller.rb,
app/controllers/pageflow/pages_controller.rb,
app/helpers/pageflow/admin/entries_helper.rb,
app/helpers/pageflow/admin/locales_helper.rb,
app/helpers/pageflow/admin/widgets_helper.rb,
app/helpers/pageflow/editor/config_helper.rb,
app/helpers/pageflow/revision_file_helper.rb,
app/models/pageflow/auto_snapshot_pruning.rb,
app/models/pageflow/encoding_confirmation.rb,
app/models/pageflow/potential_memberships.rb,
lib/pageflow/built_in_widget_types_plugin.rb,
app/helpers/pageflow/admin/features_helper.rb,
app/helpers/pageflow/editor/entries_helper.rb,
app/helpers/pageflow/navigation_bar_helper.rb,
app/helpers/pageflow/text_direction_helper.rb,
app/jobs/pageflow/prune_auto_snapshots_job.rb,
app/models/concerns/pageflow/output_source.rb,
app/models/concerns/pageflow/permalinkable.rb,
app/models/concerns/pageflow/reusable_file.rb,
lib/pageflow/entries_controller_env_helper.rb,
lib/pageflow/primary_domain_entry_redirect.rb,
app/controllers/pageflow/entries_controller.rb,
app/helpers/pageflow/admin/revisions_helper.rb,
app/helpers/pageflow/entry_json_seed_helper.rb,
app/helpers/pageflow/file_thumbnails_helper.rb,
app/helpers/pageflow/structured_data_helper.rb,
app/models/concerns/pageflow/feature_target.rb,
app/models/pageflow/thumbnail_file_resolver.rb,
app/policies/pageflow/entry_template_policy.rb,
lib/generators/pageflow/user/user_generator.rb,
app/controllers/pageflow/chapters_controller.rb,
app/controllers/pageflow/sitemaps_controller.rb,
app/helpers/pageflow/background_image_helper.rb,
app/helpers/pageflow/stub_page_configuration.rb,
app/models/concerns/pageflow/uploadable_file.rb,
app/models/pageflow/audio_file_url_templates.rb,
app/models/pageflow/cname_site_request_scope.rb,
app/models/pageflow/image_file_url_templates.rb,
app/models/pageflow/other_file_url_templates.rb,
app/models/pageflow/theme_customization_file.rb,
app/models/pageflow/video_file_url_templates.rb,
app/policies/pageflow/admin/entry_tab_policy.rb,
lib/pageflow/entry_export_import/zip_archive.rb,
app/controllers/pageflow/revisions_controller.rb,
app/helpers/pageflow/admin/memberships_helper.rb,
app/helpers/pageflow/common_entry_seed_helper.rb,
app/jobs/pageflow/submit_file_to_zencoder_job.rb,
app/models/concerns/pageflow/theme_referencer.rb,
app/models/pageflow/with_file_usage_extension.rb,
app/views/components/pageflow/admin/sites_tab.rb,
app/views/components/pageflow/admin/tabs_view.rb,
app/views/components/pageflow/admin/timestamp.rb,
app/views/components/pageflow/admin/users_tab.rb,
lib/generators/pageflow/seeds/seeds_generator.rb,
lib/generators/pageflow/theme/theme_generator.rb,
lib/pageflow/paperclip_interpolations/support.rb,
lib/pageflow/partial_editor_fragment_renderer.rb,
lib/pageflow/zencoder_audio_output_definition.rb,
lib/pageflow/zencoder_video_output_definition.rb,
app/controllers/concerns/pageflow/edit_locking.rb,
app/controllers/pageflow/edit_locks_controller.rb,
app/controllers/pageflow/storylines_controller.rb,
app/helpers/pageflow/social_share_links_helper.rb,
lib/pageflow/entry_export_import/file_mappings.rb,
app/controllers/pageflow/application_controller.rb,
app/views/components/pageflow/admin/entries_tab.rb,
app/views/components/pageflow/admin/members_tab.rb,
lib/generators/pageflow/assets/assets_generator.rb,
lib/generators/pageflow/cancan/cancan_generator.rb,
lib/generators/pageflow/resque/resque_generator.rb,
lib/generators/pageflow/routes/routes_generator.rb,
app/controllers/pageflow/editor/files_controller.rb,
app/views/components/pageflow/admin/features_tab.rb,
app/views/components/pageflow/admin/icon_link_to.rb,
lib/pageflow/paperclip_processors/audio_waveform.rb,
app/jobs/pageflow/process_image_or_text_track_job.rb,
app/models/pageflow/text_track_file_url_templates.rb,
app/policies/pageflow/admin/admin_only_tab_policy.rb,
app/views/components/pageflow/admin/revisions_tab.rb,
lib/generators/pageflow/install/install_generator.rb,
lib/pageflow/active_admin_patches/views/table_for.rb,
lib/pageflow/entry_export_import/attachment_files.rb,
lib/pageflow/zencoder_meta_data_output_definition.rb,
app/controllers/pageflow/editor/entries_controller.rb,
app/controllers/pageflow/editor/widgets_controller.rb,
app/helpers/pageflow/file_background_images_helper.rb,
app/jobs/pageflow/poll_meta_data_from_zencoder_job.rb,
lib/pageflow/active_admin_patches/views/pages/base.rb,
app/controllers/concerns/pageflow/public_https_mode.rb,
lib/generators/pageflow/procfile/procfile_generator.rb,
lib/pageflow/entry_export_import/page_type_versions.rb,
app/controllers/concerns/pageflow/quota_verification.rb,
app/models/concerns/pageflow/auto_generated_perma_id.rb,
app/models/concerns/pageflow/serialization_blacklist.rb,
app/views/components/pageflow/admin/embed_code_field.rb,
app/views/components/pageflow/admin/user_entries_tab.rb,
lib/pageflow/entry_export_import/entry_serialization.rb,
app/jobs/pageflow/request_meta_data_from_zencoder_job.rb,
app/models/concerns/pageflow/entry_publication_states.rb,
app/models/concerns/pageflow/serialized_configuration.rb,
app/models/pageflow/entry_title_or_account_name_query.rb,
app/views/components/pageflow/admin/user_accounts_tab.rb,
app/controllers/pageflow/editor/file_import_controller.rb,
app/controllers/concerns/pageflow/controller_delegation.rb,
app/views/components/pageflow/admin/entry_templates_tab.rb,
app/views/components/pageflow/admin/grouped_folder_list.rb,
lib/pageflow/entry_export_import/revision_serialization.rb,
app/models/pageflow/image_file_css_background_image_urls.rb,
app/models/pageflow/video_file_css_background_image_urls.rb,
app/state_machines/pageflow/media_encoding_state_machine.rb,
app/views/components/pageflow/admin/embedded_index_table.rb,
lib/pageflow/active_admin_patches/views/attributes_table.rb,
app/views/components/pageflow/admin/add_membership_button.rb,
app/views/components/pageflow/admin/entry_user_badge_list.rb,
lib/generators/pageflow/error_pages/error_pages_generator.rb,
lib/generators/pageflow/initializer/initializer_generator.rb,
app/views/components/pageflow/admin/custom_scopes_renderer.rb,
app/controllers/concerns/pageflow/entry_password_protection.rb,
app/controllers/pageflow/admin/initial_passwords_controller.rb,
app/views/components/pageflow/admin/user_account_badge_list.rb,
app/controllers/pageflow/users/omniauth_callbacks_controller.rb,
app/controllers/pageflow/editor/entry_publications_controller.rb,
lib/pageflow/entry_export_import/revision_serialization/import.rb,
app/views/components/pageflow/admin/extensible_attributes_table.rb,
app/views/components/pageflow/admin/membership_role_with_tooltip.rb,
app/controllers/pageflow/editor/encoding_confirmations_controller.rb,
app/jobs/pageflow/entry_export_import/upload_and_publish_file_job.rb,
app/views/components/pageflow/admin/entry_publication_state_indicator.rb,
app/state_machines/pageflow/image_and_text_track_processing_state_machine.rb,
lib/generators/pageflow/active_admin_initializer/active_admin_initializer_generator.rb

Defined Under Namespace

Modules: AbilityMixin, ActiveAdminCanCanFix, ActiveAdminPatches, Admin, AssetUrlsHelper, AudioFilesHelper, AutoGeneratedPermaId, AutoSnapshotPruning, BackgroundImageHelper, BuiltInFileType, BuiltInPageType, CommonEntrySeedHelper, ConfigHelper, ControllerDelegation, EditLocking, Editor, EditorController, EmbedCodeHelper, EntriesControllerEnvHelper, EntriesHelper, EntryExportImport, EntryJsonSeedHelper, EntryPasswordProtection, EntryPublicationStates, EntryTypeConfiguration, FeatureTarget, FeedsHelper, FileBackgroundImagesHelper, FileThumbnailsHelper, FilesHelper, FoldersHelper, Generators, GlobalConfigApi, HelpEntriesHelper, ImageAndTextTrackProcessingStateMachine, InfoBoxHelper, MediaEncodingStateMachine, MediaQueryHelper, MetaTagsHelper, NavigationBarHelper, NestedRevisionComponent, NewsItemApi, OutputSource, OverviewHelper, PageTypesHelper, PagesHelper, PaperclipInterpolations, PaperclipProcessors, Permalinkable, PublicHttpsMode, PublicI18nHelper, QuotaHelper, QuotaVerification, RailsVersion, React, RenderJsonHelper, ReusableFile, RevisionComponent, RevisionFileHelper, Roles, Seeds, SerializationBlacklist, SerializedConfiguration, Sitemaps, SitesHelper, SocialShareHelper, SocialShareLinksHelper, StructuredDataHelper, Suspendable, TextDirectionHelper, ThemeReferencer, ThemesHelper, UploadableFile, UrlTemplate, UserMixin, Users, VideoFilesHelper, WidgetsHelper, WithFileUsageExtension Classes: Account, AccountMemberQuery, AccountPolicy, AccountRoleQuery, ApplicationController, ApplicationJob, ApplicationPolicy, ApplicationQuery, ApplicationRecord, AudioFile, AudioFileUrlTemplates, AuthenticationToken, BuiltInPageTypesPlugin, BuiltInWidgetType, BuiltInWidgetTypesPlugin, Chapter, ChapterScaffold, ChaptersController, CnameSiteRequestScope, Configuration, CustomizedTheme, DraftEntry, EditLock, EditLocksController, EncodingConfirmation, Engine, EntriesController, EntriesFeed, Entry, EntryAtRevision, EntryDuplicate, EntryPolicy, EntryPublication, EntryRoleQuery, EntryTemplate, EntryTemplatePolicy, EntryTitleOrAccountNameQuery, EntryType, EntryTypes, Feature, Features, FeedsController, FileImport, FileImportJob, FileImporter, FileImporters, FilePolicy, FileReuse, FileType, FileTypes, FileUsage, FilesController, Folder, FolderPolicy, HelpEntries, HelpEntry, HomeButton, Hooks, ImageFile, ImageFileCssBackgroundImageUrls, ImageFileUrlTemplates, InvitationForm, InvitedUser, ManagedUserQuery, Membership, MembershipPolicy, NullUser, OtherFile, OtherFileUrlTemplates, OverviewButton, Page, PageType, PageTypeFeature, PageTypes, PagesController, PartialEditorFragmentRenderer, Permalink, PermalinkDirectory, Plugin, PollMetaDataFromZencoderJob, PollZencoderJob, PositionedFile, PotentialMemberships, PrimaryDomainEntryRedirect, ProcessImageOrTextTrackJob, PruneAutoSnapshotsJob, PublishedEntry, Quota, Quotas, RequestMetaDataFromZencoderJob, Revision, RevisionComponents, RevisionsController, Site, SitePolicy, SitemapsController, Storyline, StorylineScaffold, StorylinesController, StubPageConfiguration, SubmitFileToZencoderJob, TextTrackFile, TextTrackFileUrlTemplates, Theme, ThemeCustomization, ThemeCustomizationFile, ThemeCustomizations, Themes, ThumbnailFileResolver, UsedFile, UserMailer, UserNameQuery, UserPolicy, VideoFile, VideoFileCssBackgroundImageUrls, VideoFileUrlTemplates, ViewComponent, Widget, WidgetType, WidgetTypes, ZencoderApi, ZencoderAttachment, ZencoderAudioOutputDefinition, ZencoderMetaDataOutputDefinition, ZencoderOutputDefinition, ZencoderVideoOutputDefinition

Constant Summary

VERSION =

'17.0.4'.freeze

Class Method Summary

• .active_admin_load_path ⇒ Object
• .active_admin_settings(config) ⇒ Object
• .built_in_page_types_plugin ⇒ Object
• .built_in_widget_types_plugin ⇒ Object
• .routes(router) ⇒ Object
• .theme_customizations ⇒ ThemeCustomizations

  Apply account wide customizations to themes of a specific entry type.

Methods included from GlobalConfigApi

after_configure, after_global_configure, config, config_for, configure, configure!, configured?, finalize!

Methods included from NewsItemApi

news_item

Class Method Details

.active_admin_load_path ⇒ Object

# File 'lib/pageflow.rb', line 36

def self.active_admin_load_path
  Dir[Pageflow::Engine.root.join('admins')].first
end

.active_admin_settings(config) ⇒ Object

# File 'lib/pageflow.rb', line 30

def self.active_admin_settings(config)
  config.before_action do
    I18n.locale = current_user.try(:locale) || http_accept_language.compatible_language_from(I18n.available_locales) || I18n.default_locale
  end
end

.built_in_page_types_plugin ⇒ Object

# File 'lib/pageflow.rb', line 40

def self.built_in_page_types_plugin
  BuiltInPageTypesPlugin.new
end

.built_in_widget_types_plugin ⇒ Object

# File 'lib/pageflow.rb', line 44

def self.built_in_widget_types_plugin
  BuiltInWidgetTypesPlugin.new
end

.routes(router) ⇒ Object

# File 'lib/pageflow.rb', line 10

def self.routes(router)
  router.instance_eval do
    namespace :admin do
      resources :users do
        resources :memberships
      end

      resources :entries do
        resources :memberships
      end

      resources :accounts do
        resources :memberships
      end
    end

    mount Pageflow::Engine, at: '/'
  end
end

.theme_customizations ⇒ ThemeCustomizations

Apply account wide customizations to themes of a specific entry type.

Returns:

• (ThemeCustomizations)

Since:

• 15.7

# File 'lib/pageflow.rb', line 53

def self.theme_customizations
  ThemeCustomizations.new
end