Download the PHP package cu-boulder/ucb_site_configuration without Composer
On this page you can find all versions of the php package cu-boulder/ucb_site_configuration. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cu-boulder/ucb_site_configuration
More information about cu-boulder/ucb_site_configuration
Files in cu-boulder/ucb_site_configuration
Package ucb_site_configuration
Short Description Allows CU Boulder site administrators to configure site-specific settings.
License GPL-2.0-or-later
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ucb_site_configuration
CU Boulder Site Configuration
IMPORTANT: CU Boulder Site Configuration is considered a companion module to CU Boulder Base Theme. The two are intended to be installed together and must be updated together when changes are made to theme settings.
Functionality
CU Boulder Site Configuration is a module compatible with Drupal 9+ that allows CU Boulder-provided site-wide settings and information to be modified by users with the approprate permissions. The primary functionality provided by the module is grouped into three sections, and a matching three-item submenu is placed in the default Drupal configuration menu.
Appearance
Path: /admin/config/cu-boulder/appearance
User permission: edit ucb site appearance
The "Appearance" administration form exposes supported theme settings to users with the permission above. It is separate from the default Drupal theme settings form of CU Boulder Base Theme and requires a different permission to access, however both forms are built using SiteConfiguration::buildThemeSettingsForm.
Theme settings to expose on the "Appearance" administration form are defined in /config/install/ucb_site_configuration.configuration.yml. SiteConfiguration::buildThemeSettingsForm should output a form with fields for all CU Boulder Base Theme settings, including any not exposed on the "Appearance" administration form.
Contact info
Path: /admin/config/cu-boulder/contact-info
User permission: edit ucb site contact info
Site contact information is editable in the "Contact info" administration form and provided as a Site Contact Info block intended for the footer region (the install profile handles block configuration and region placement at install time). The block provides information about a given site including:
- Address
- Fax
- Phone
Third-party services
Path: /admin/config/cu-boulder/services
User permission: administer ucb external services
Users with the permission above may choose to add selected client-side third-party services (JavaScript) to their site in the "Third-party services" administration page. Supported services are:
- Mainstay chat widget
- LiveChat chat widget
- StatusPage status widget
These services can be configured and added to pages as desired, with options for specific pages or all pages on the site. Additionally, they can be configured to appear as options when creating or editing content, enabling them to be added or removed by content authors who don't have permission to administer ucb external services.
Some required configuration for these services isn't provided by default, and the responsibility for ensuring they are configured correctly falls to the site administrator.
Maintenance
CU Boulder Site Configuration adheres to Semantic Versioning, or the familiar major.minor.patch.
Configuration updates
For simplicity, most of the module's static configuration can be found in Update hooks can be used to remedy the issue.
Below is an example workflow for adding a theme setting to change the header text size with options for small, medium, or large, defaulting to medium, and exposing via the "Appearance" administration form, for both new and existing sites. It doesn't include additional steps in CU Boulder Base Theme such as modifying the template to apply the change.
-
Step 1: Increment the minor version number of CU Boulder Base Theme. In CU Boulder Base Theme, add the following line to
/config/install/boulderD9_base.settings.yml: -
Step 2: In CU Boulder Site Configration, add the form field to edit the setting in
SiteConfiguration::buildThemeSettingsForm. Your code will look something like this: -
Step 3: Increment the minor version number of CU Boulder Site Configuration. In CU Boulder Site Configuration, add the following line to
/config/install/ucb_site_configuration.configuration.ymlundereditable_theme_settings: -
Step 4: In CU Boulder Site Configration, create an update hook in
ucb_site_configuration.installto run when updating existing sites. Your code will look something like this: - Step 5: Release and deploy the new versions of CU Boulder Base Theme and CU Boulder Site Configration together. After clearing the cache the new theme setting should now be present.
