Download the PHP package numencode/wn-fundamentals-plugin without Composer

On this page you can find all versions of the php package numencode/wn-fundamentals-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of numencode/wn-fundamentals-plugin

Informations about the package wn-fundamentals-plugin

Fundamentals Plugin

The Fundamentals Plugin provides essential functionalities to streamline application development within the Winter CMS ecosystem. It includes backend overrides, helper functions, Twig extensions, and more, allowing developers to build robust applications efficiently.

Version Packagist PHP Version Support Checks Tests License

Target Audience

This plugin is designed for developers working with Winter CMS who seek to accelerate development processes and enhance code maintainability by leveraging reusable components and utilities.

Dependencies

This plugin is a prerequisite for other NumenCode Winter CMS plugins. To use those plugins, this one must be installed first as it provides essential components and utilities required for their functionality.

Installation

This plugin is available for installation via Composer.

After installing the plugin you will need to run the migrations.

Requirements

Features Overview

Common Translations

The Fundamentals plugin provides a comprehensive set of common language translations designed for reuse across applications. These translations promote consistency, streamline development, and eliminate the need for repetitive localization efforts.

Additionally, the common translations are fully compatible with and intended for use alongside other NumenCode plugins. Since the Fundamentals plugin is a prerequisite for all NumenCode plugins, these translations serve as a standardized foundation, ensuring seamless integration and uniformity across projects utilizing the NumenCode ecosystem.

Backend Overrides

The BackendOverride class customizes and extends the behavior of the Winter CMS backend panel. It provides a centralized way to enhance the backend's functionality, styling, and user experience. This class is useful for injecting custom styles, scripts, or modifying the backend behavior without altering the core framework.

Key Features

Config Overrides

The ConfigOverride class enables developers to customize and extend configuration files dynamically across a Winter CMS application. Its primary purpose is to facilitate granular or global overrides of configuration files, reducing duplication and enhancing flexibility.

Key Features

Usage Example

Form Widgets Overrides

Repeater Field Type

The Repeater field type allows you to display and manage a form with multiple collapsible sections, each representing an individual record. This is useful for managing lists of related data, where each item can be edited using the same form structure.

Usage Example

Define a Repeater field in your form configuration YAML:

Example

This setup provides a flexible and user-friendly interface for managing lists of related data.

Behaviors

RelationableModel Behavior

The RelationableModel behavior allows a Repeater to be used as a relations editor via relation behavior.

Example

For a Category model with multiple Item relations:

In \models\category\fields.yaml:

Helper Functions

The plugin provides a collection of helper functions to simplify complex operations. These can be used across the application to improve code readability and functionality.

Function Description
numencode_partial Returns the path to the NumenCode partial file.
validate_request Validates the current request and flashes errors to the session. Returns true if the request is valid, false otherwise.
select_options Creates options for the <select> element.
array_insert Inserts a new element into a specific position within an array.
array_before Moves a specific array element before another array element.
array_merge_reference Merges elements from passed arrays into one array, retaining references to the original arrays.
array_search_recursive Recursively searches an array for a value and returns the corresponding keys if successful.
round_global Rounds a number to a predefined number of decimals set in a global configuration.
plugin_exists Checks if a plugin exists and is enabled.
extend_class Extends a class with a behavior.
dumpbug Dumps a simple debug backtrace.
diebug Dumps a simple debug backtrace and terminates the script.
dd_query Dumps the next database query.
d Dumps the passed variables without terminating the script.
ddd Resolves rendering issues with dd() in the browser's network tab.
ddt Dumps a debug backtrace and terminates the script, useful for console debugging.

CMS Permissions

The CmsPermissions class enables fine-grained control over user group actions, such as creating, updating, and deleting data.

Configuration Example

Step 1: Configure permissions in the plugin's boot() method:

Step 2: Apply permission logic in templates:

Traits

Progress Bar

The ProgressBar trait displays progress status in the CLI while iterating through an array during console command execution. The AutoProgressBar should be used when you need to display a progress bar in the CMS backend.

Parameters

Usage Example

Publishable

The Publishable trait provides a simple way to manage content visibility using an is_published field in the database table.

Requirements

Add a boolean field named is_published to the table.

Features

  1. Automatic Filtering: Only records with is_published = true are included in queries for frontend users.
  2. Override Scope: Use the withUnpublished() method to retrieve all records, including unpublished ones.

Usage Example

Wrapper

The Wrapper trait is designed to wrap and extend the functionality of an existing object, providing a flexible way to interact with the parent object while maintaining access to its properties and methods. This trait acts as a proxy, delegating calls to the wrapped object, and can be used to enhance or modify its behavior without directly modifying the parent class.

Usage Example

  1. Include the Wrapper trait in your class.
  2. Pass the parent object to the constructor of the class using the Wrapper trait.
  3. Use the init() method in your class to define any custom initialization logic.

ImageResize Utility

The ImageResize utility is a helper class designed to resize images dynamically. It provides an easy-to-use interface for adjusting image dimensions while maintaining high performance and quality.

Features

Usage

You can use the ImageResize utility in your Twig templates by using resize filter to process images.

Example: Image resizing in Twig

ImageResizer Utility

The ImageResizer utility is a helper class designed to resize all images in the provided content dynamically.

Usage

You can use the ImageResizer utility in your Twig templates by using resize_images filter to process images.

Example: Resize images in content in Twig

Twig Extensions

Twig extensions provide enhanced template functionality and are divided into two scopes:

Filters

Use filters to transform data.

Filter Description Usage
resize Resize an image and create a thumbnail cache file 'picture.jpg'|media|resize('600x400.crop')
resize_images Resize all images in HTML content by creating thumbnails {{ content|resize_images }}
str_pad Pad a string to a specific length 'file.pdf'|str_pad(4, '0')
url_path Parse URL and return its components 'file.pdf'|url_path

Functions

Use functions for broader, dynamic operations.

Function Description Usage
app Retrieves the container instance app()
asset_hash Generates a cache-busting asset version asset_hash()
class_basename Retrieves the "basename" of a class class_basename('\Namespace\Class')
collect Creates a collection from a given value collect($array)
config Retrieves or sets configuration values config('app.key')
d Dumps the passed variables and does not end the script d($variable)
dd Dumps the passed variables and ends the script dd($variable)
detect Detects mobile devices detect()
device_type Returns 'mobile' or 'desktop' based on detected device device_type()
require Reads a file into a string require('file.txt')
trans Translates a string trans('backend::lang.form.save')
trim Strip whitespaces (or other characters) trim(' Some random sentence ')
url_params Retrieves the current routing parameters dd(url_params())

When to Use

Changelog

All notable changes are documented in the CHANGELOG.

Contributing

Please refer to the CONTRIBUTING guide for details on contributing to this project.

Security

If you identify any security issues, email [email protected] rather than using the issue tracker.

Author

The NumenCode.Fundamentals plugin is created and maintained by Blaz Orazem.

For inquiries, contact: [email protected]

License

This project is open-sourced software licensed under the MIT license.

License

All versions of wn-fundamentals-plugin with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0.2
mobiledetect/mobiledetectlib Version ^4.8
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package numencode/wn-fundamentals-plugin contains the following files

Loading the files please wait ....