Download the PHP package superbig/craft-ordernotes without Composer

On this page you can find all versions of the php package superbig/craft-ordernotes. 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 superbig/craft-ordernotes

Informations about the package craft-ordernotes

Order Notes for Craft Commerce

Add internal notes to Craft Commerce orders. Team members can annotate orders directly from the control panel and optionally notify customers by email.

Requirements

Installation

Then go to Settings → Plugins and install Order Notes.

Quick Start

Once installed, a notes panel appears on every Commerce order edit screen. Type a message, optionally check "Notify customer", and submit.

Using Order Notes in Templates

Access order notes in Twig via the craft.orderNotes variable.

Get notes by Order object

Get notes by order ID

Available properties

Property Type Description
note.id int Note ID
note.message string Note content
note.orderId int Associated order ID
note.userId int Author's user ID
note.notify bool Whether the customer was notified
note.dateCreated DateTime When the note was created
note.dateUpdated DateTime When the note was last updated
note.getUser() User The User element who created the note
note.getUsername() string Username of the note author

Configuration

Configure via the CP settings page or a config/order-notes.php file:

Option Type Default Description
notifyEmailFrom string '' Sender email address (falls back to system email)
notifyEmailFromName string '' Sender name (falls back to system name)
notifyEmailTemplate string '' Path to HTML email template
notifyEmailTemplateText string '' Path to plain text email template
notifyEmailSubject string '' Email subject (Twig, receives order and note)

Config file example

Email templates receive order (Commerce Order) and note (OrderNotesModel) as variables.

Support

Brought to you by Superbig

All versions of craft-ordernotes with dependencies

PHP Build Version
Package Version
Requires craftcms/cms Version ^3.0.0
craftcms/commerce Version >=2.0.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 superbig/craft-ordernotes contains the following files

Loading the files please wait ...