An example module for PyroCMS. Explore it or use it as a template for creating a custom module.
Pull request Compare This branch is 6 commits behind pyrocms:2.2.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
controllers
css
helpers
img
js
language/english
libraries
models
views
widgets
README.md
details.php
events.php
license.txt
plugin.php

README.md

PyroCMS Sample Module

  • Branch 2.0/master -- For PyroCMS v2.0.x
  • Branch 1.3/master -- For PyroCMS v1.3.x

Legal

This module was originally written by Jerel Unruh, one of the PyroCMS core developers but is now part of PyroCMS Documentation. Here is his blog post about this module. If you find issues please open a ticket in the issue tracker here.

It is unlicensed, meaning that you can use it as a base for your own module without keeping the copyright intact. visit unlicense.org Please spread the news about PyroCMS and point new developers here if you like. You may also be interested in PyroCMS Workless a theme based on iKreativ's Workless.

Description

This module was put together to give new developers something to start with when building their own modules. It makes use of some best practices (like using MY_Model to simplify database interaction) and hopefully shows a couple of shortcuts (like using the pagination helper instead of the default CI pagination). It includes an event file and its own plugin.

Usage

To use this module simply clone it using Git or download the zip. If you are running PyroCMS v1.3.2 you will want to download the 1.3/master branch. Likewise if you have v2.0 of PyroCMS you need to download the 2.0/master branch. Once you have the folder you will need to rename it to "sample". This is very important as PyroCMS uses the folder name to determine the class to call when installing or when loading a controller. This may mean that you will need to unzip the downloaded version and then rezip it before uploading to your PyroCMS install.