Download the PHP package charcoal/admin without Composer

On this page you can find all versions of the php package charcoal/admin. 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?

Informations about the package admin

Charcoal Admin

The Admin package provides a customizable administration panel to manage data for Web applications and APIs.

Installation

Overview

Core concepts

The charcoal admin control panel is:

What's inside this module?

Like all Charcoal projects / modules, the main components are:

Users

Authentication is done through the Charcoal\Admin\User class. It reuses the authentication, authorization and user model provided by charcoal/user.

UI Elements

User-Interface elements in the Admin package (or any other Charcoal modules, in fact), are composed of:

There are 3 main types of UI Elements: Templates, Widgets and Property Inputs.

Templates

See the templates/charcoal/admin/template/ directory.

In addition to being standard Template Models (controllers), all Template of the admin module also implements the \Charcoal\Admin\Template class.

This class provides additional controls to all templates:

Widgets

The following base widgets are available to build the various admin templates:

Property Inputs

Similar to other UI elements, Inputs are specialized widgets that are meant to display a "form element" for a Property. Properties models are defined in the charcoal/property package.

The following property inputs are available to build forms in the admin module:

Selectize inputs options

Name Type Description Default
choice_obj_map array Custom mapping between an object properties or callable and the selectize. It is discouraged to use renderable data. choice_obj_map must be a mapping with existing object properties.

value Object property or object callable. Defines the actual value to be registered in the database
label Object property or object callable. Defines the visible label of the input. 
{
  "value" : "id",
  "label": "name:title:label:id"
}
form_ident string|array Allow to define a specific object form ident when creating or updating an object. You can specify different form idents for create and update by using the "create" and "update" array keys "quick"
selectize_templates string|array Allow custom rendering for selectize [item] and [option]. Overrule choice_obj_map[label]. Priotize using this for rendering custom labels instead of choice_obj_map.

The value can either be a string with render tags, a path to a custom template or even an array mapping to handle "item", "option", "controller" and "data" individually.

item
(Can be a renderable string or template path)		 Custom renderable html or mustache template for the selectize item. [Item] is the term used to refer to a selected choice.
option
(Can be a renderable string or template path)		 Custom renderable html or mustache template for the selectize option. [Option] is the term used to refer to an available choice.
controller Defines a rendering context (path to php controller). (optional) Default context is the object itself.
data(array) Provides additional data to the controller
{}
allow_create bool Display a 'create' button which triggers the selectize create functionality. false
allow_update bool Display an 'update' button which triggers the selectize update functionality. Applies to currently selected element. false
allow_clipboard_copy bool Display a 'copy' button which allows the user to easilly copy all selected elements at once. false
deferred bool Allow the select to load the dropdown "options" with an ajax request instead of on load. This can speed up the page load when there is a lot of "options". false
selectize_options array Defines the selectize js options. See the Selectize.js doc. Some usefull ones are :
  • "maxItems"
  • "maxOptions"
  • "create"
  • "placeholder"
  • "searchField"
  • "plugins"
Also, two home made plugins are available : "btn_remove" and "btn_update" that are custom buttons for selected items that work well with charcoal objects and doesn't break styling.		 
{
   persist: true,
   preload: "focus",
   openOnFocus: true, 
   labelField: "label",
   searchField: [
     "value",
     "label"
   ]
}

Usage example:

Selectize templates examples:

Actions

See the src/Charcoal/Admin/Action/ directory for the list of availables Actions in this module.

In addition to being standard Action Models (controllers), all Action of the admin module also implements the \Charcoal\Admin\Action class.

Post Actions

CLI Actions

See the src/Charcoal/Admin/Action/Cli/ directory for the list of all available Cli Actions in this module.

CLI Actions are specialized action meant to be run, interactively, from the Command Line Interface. With the Cli Actions in this module, it becomes quick and easy to manage a Charcoal project directly from a Terminal.

Resources

All versions of admin with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
barryvdh/elfinder-flysystem-driver Version ^0.3
guzzlehttp/guzzle Version ^6.0 || ^7.0
kriswallsmith/assetic Version ^1.4
laminas/laminas-permissions-acl Version ^2.8
charcoal/app Version ^5.0
charcoal/cache Version ^5.0
charcoal/cms Version ^5.0
charcoal/core Version ^5.0
charcoal/email Version ^5.0
charcoal/object Version ^5.0
charcoal/translator Version ^5.0
charcoal/ui Version ^5.0
charcoal/user Version ^5.0
mcaskill/php-html-build-attributes Version ^1.0
psr/cache Version ^1.0
psr/http-message Version ^1.0
psr/log Version ^1.0
studio-42/elfinder Version 2.1.64
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 charcoal/admin contains the following files

Loading the files please wait ....