Download the PHP
package magna-cms/plugin-sdk without Composer
On this page you can find all versions of the php package
magna-cms/plugin-sdk. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
Vendor magna-cms Package plugin-sdk Short Description The official SDK for building Magna CMS plugins — extension contracts, the plugin base class, and the manifest spec. License
MIT
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.
It contains the stable, versioned public API a plugin compiles against — the
extension contracts, the Plugin base class, and the magna.json manifest spec —
so you can build a plugin in your own repository without depending on Magna's core.
Install
Quick start
A plugin is a Composer package with "type": "magna-plugin", a magna.json
manifest, and an entry class that extends Magna\Plugins\Plugin:
magna.json:
The manifest is validated against schema/magna.schema.json.
Extension contracts
Implement any of these interfaces on your entry class to hook into the CMS. The
core calls the matching method at the right point in the lifecycle:
Contract
Method
Provides
RegistersAdminResources
adminResources()
Filament resources (CRUD screens)
RegistersAdminNavigation
adminNavigation()
A sidebar nav group
RegistersDashboardWidgets
dashboardWidgets()
Admin dashboard widgets
RegistersSettingsPages
settingsPages()
Pages under Settings
RegistersBlocks
blockPaths()
Block definitions
RegistersWebhookEvents
webhookEvents()
Custom webhook event keys
ExtendsEntryForm
entryFormExtensions()
Extra fields on a content type form
FiltersApiQuery
filterApiQuery()
Scope the delivery API query
Versioning
This package is semantically versioned. Everything exported here is a public
contract: within a major version, existing signatures will not break. Your
plugin declares which core it supports via compat.magna in magna.json.
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 magna-cms/plugin-sdk contains the following files
Loading the files please wait ...
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.