A modules framework for XOOPS
Switch branches/tags
Clone or download
bitcero Merge pull request #103 from bitcero/helium
Improvements and fixes
Latest commit 9163d04 Nov 10, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
modules
rmcommon
src
.gitattributes
.gitignore
README.md

README.md

alt Common Utilities Logo Common Utilities

alt Common Utilities

Common Utilities is a framework oriented to develop advanced XOOPS modules by providing useful objects and new methods for developers. Development work turns more easy while Common Utilities provide new capabilities to create a new kind of components for XOOPS.

Also, Common Utilities transform the XOOPS default GUI into a new styled adn improved Admin GUI, with the target of improve the usability and the look and feel of all modules.

Modules and plugins created with Common Utilities will be integrated in a top and low level with the entire system, and the interoperation between modules will be a reality.

Common Utilities counts with a integrated update system that will be more easy to maintain modules and plugins updated. The advantages are obvious: More security, more stability and the last features with every module.


Requirements

  • PHP >= 5.6+
  • XOOPS >= 2.5.8 installed and running

Install

#####See the tutorial video

Prior to install Common Utilities, an installation of XOOPS must exists.

Important: Enable debug inline before to install Common Utilities.

Follow next steps in order to get Common Utilities installed in XOOPS:

  1. Extract compressed file on your hard disk.

  2. Upload folder modules to your XOOPS installation.

    This folder contains the system theme called redmexico, and this theme make possible all integration between rmcommon and XOOPS.

  3. Upload rmcommon folder to directory modules of your XOOPS installation.

  4. Go to XOOPS modules manager and install Common Utilities as a normal module.

    All initial configuration will be done automatically during installation process. After that, you can customize the configuration if you wish.

  5. Done! Common Utilities is installed.


Update

Common Utilities includes its own integrated updates system. You can update the module directly from Updates Manager, however, if you are upgrading from a XOOPS version prior to 2.5.8 then follow next instructions in order to prevent any issue.

  1. Upgrade XOOPS version to 2.5.8 by following the instructions. If you experience any problem you can follow next steps:
    1. If you have installed protector: open file xoops_lib/modules/protector/include/precheck.inc.php and change line #6 from require __DIR__ . '/postcheck.inc.php'; to require_once __DIR__ . '/postcheck.inc.php';
    2. Save file and continue the upgarde process.
  2. Go to modules management and update Common Utilities.

A brief list of its features

Next is a brief list of the current features of Common Utilities. Note that new features and improvements are added frequently.

At top level

  • A new awesome look for Control Panel of XOOPS.
  • A new modules manager, more friendly (See the video).
  • A new block manager with drag and drop capabilities.
  • New graphical components: menus, toolbars, breadcrumbs, admin blocks.
  • All graphical components are integrated.
  • Support for Admin GUI themes (See the video).
  • A very versatile new Images Manager that allows to create categories and specific images sizes for every category (See the video).
  • A new comment system, more easy to integrate with modules and other components.
  • Support for plugins that can extend system features, add new features or interact with themes or modules.
  • An awesome updates system that will maintain the system updated.
  • A very new configuration sub-system for native modules. Options can be configured in line with the new popup feature.
  • A RSS center that can group all rss feeds from your modules.
  • Inline help subsystem.

At low level

  • A totally new security sub-system. More versatile and useful that allows to control every single action if you wish.
  • Also, the new groups management system allows to assign very specific permissions to each group.
  • Methods and objects more intuitive.
  • New URL rewriting method that can be integrated easily with new modules.
  • New MVC support that allow to maintain components organized.
  • Support for shortcodes with the style [shortcode].
  • Support blocks from different components: modules, themes and plugins.
  • Integration drived by events.

And much more...


What next?

You can download modules and plugins from XOOPS Mexico download center or directly from my repositories in GitHub.

If you need help with Common Utilities you can go to XOOPS Official Site and get help in English. But if you are a Spanish speaker, then you can go to Xoops Mexico and get help in your own language.


Modules

Currently exists some native modules developed by me. I think that all these are a good start point for users or developers.

  • MyWords. A blogging and news module.
  • bXpress. A light weight forum module.
  • xThemes. A very flexible and powerful themes framework and themes manager.
  • D-Transport. An awesome downloads center module.
  • QuickPages. A static pages creator with advanced features.

If you want to contact me, please do it trough my web site.