Download the PHP package gromit/oc-popupbuilder-plugin without Composer

On this page you can find all versions of the php package gromit/oc-popupbuilder-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 gromit/oc-popupbuilder-plugin

Informations about the package oc-popupbuilder-plugin

Popups plugin

Plugin provides PopupController controller behavior for easy creating popups on OctoberCMS backend pages.

Creating popups

Add PopupController behavior to your controller.

You can add multiple configurations.

For render open popup button call method from controller.

receives two optional parameters. First is a definition of popup, second is extra data for attribute.

Or you can write html by yourself.

Popup types

PopupController supports 3 types of popups:

Popup config

Common options

Common options for popups of all types:

Option Description Default value
type Popup type. Possible values: , or .  
openBtnLabel Open popup button label.  
openBtnClass Open popup button css class. btn btn-default
closeBtnLabel Close popup button label. Close (from lang file)
closeBtnClass Close popup button css class. btn btn-default
popupSize Size of popup. Available sizes: , , , , , . medium
noPadding Remove padding from popup body.  
popupId Popup Id attribute. definition name
inset Do not wrap popup in div with id. false

type is required for every popup config.

openBtnLabel is required for render open popup button.

Msg

Option Description Default value
msgType Message type. Available values: , , , info
content Message text  

Config for msg popup must contain both of these options.

Content

Option Description
title Popup title.
content Popup content.
contentPartial Partial name with popup content. Overrides content property.

Config for content popup must contain content or contentPartial.

Form

Option Description Default value
title Popup title.  
content Popup content. Renders above the form.  
contentBelow Popup content. Renders below the form.  
contentPartial Popup content partial. Renders above the form. Overrides content property.  
contentPartialBelow Popup content partial. Renders below the form. Overrides contentBelow property.  
actionBtnLabel Label of form submit button. OK
actionBtnClass Css class of form submit button. btn btn-primary
actionBtnRequestData Additional request data for action button.
actionOnClick Action on form submit button.  
loadIndicator Show loading popup on performing actionOnClick action? false
confirm Confirm message for form submit button. null
closeOnSuccess Close popup on success. false
successCallback Javascript callback for execute after success. Overrides closeOnSuccess. null
buttons Config for multiple buttons. See details below.  
form Form config. Must contain fields config.  
modelClass Model class for form. \October\Rain\Database\Model

Config for form popup must contain actionOnClick and form options.

If your form popup config has buttons property, ten next properties will be ignored:

Each element in buttons has these properties:

Option Description
label Same as actionBtnLabel
class Same as actionBtnClass
onClick Same as actionOnClick
loadIndicator Same as loadIndicator
confirm Same as confirm
closeOnSuccess Same as closeOnSuccess
requestData Same as actionBtnRequestData

Overrides

There are methods for the override.

You can use it for override title and content of popups and form model of form popups.

Below param of getPopupContent() is for overriding the contentBelow.

Complex example

Below is example of using PopupController for make simple wizard. For doing this you can use popup id.

All versions of oc-popupbuilder-plugin with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
composer/installers Version ~1.0
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 gromit/oc-popupbuilder-plugin contains the following files

Loading the files please wait ....