Skip to content

ocmod-space/ocmodw

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenCart MODule Wrapper

Description

A custom OpenCart dev-tool which designed to build ready-to-use OC extensions and convenient store the source code on GitHub. Required PHP.

Able to replace text in source files, which is convenient when adding identical words and texts, such as the name of a module, version or an infoblock at the beginning of a file. The constants defined in the ocmodw.ini.php file are used for replacement. All it needs for replacement is to define a constant and insert it in the right place of the source file using the <insertvar> tag (for example, <insertvar>CONST</insertvar>, this construction will be replaced with the value of CONST defined in the file ocmodw.php). If it needs to insert content of a whole file use the <insertfile> tag(for example, <insertfile>_inc/info.txt</insertfile> ). The <insertvar> tag also works inside such files - first all the variables will be substituted in a file and then its contains will be inserted in the appropriate place.

Directory structure example:

.
├── _fcl
│   └── module.fcl.g
├── _inc
│       include0.txt
│       include1.txt
├── addons
│   └── addon1
│       ├── src
│       │   ├── 23
│       │   │   ├── upload
│       │   │   │   ├── admin
│       │   │   │   └── catalog
│       │   │   └── install.xml
│       │   ├── 3x
│       │   │   ├── upload
│       │   │   │   ├── admin
│       │   │   │   └── catalog
│       │   │   └── install.xml
│       │   └── 4x
│       │       ├── admin
│       │       ├── catalog
│       │       └── ocmod
│       │           └── addon.ocmod.xml
│       └── zip
│           ├── module--addon1-oc23.ocmod.zip
│           ├── module--addon1-oc3x.ocmod.zip
│           └── module--addon1-oc4x.ocmod.zip
├── module
│   ├── src
│   │   ├── 23
│   │   │   ├── upload
│   │   │   │   ├── admin
│   │   │   │   └── catalog
│   │   │   └── install.xml
│   │   ├── 3x
│   │   │   ├── upload
│   │   │   │   ├── admin
│   │   │   │   └── catalog
│   │   │   └── install.xml
│   │   └── 4x
│   │       ├── admin
│   │       ├── catalog
│   │       └── ocmod
│   │           └── addon.ocmod.xml
│   └── zip
│       ├── module-oc23.ocmod.zip
│       ├── module-oc3x.ocmod.zip
│       └── module-oc4x.ocmod.zip
├── ocmodw.inc
│       ocmodw.fun.php
│       ocmodw.hlp.php
│       ocmodw.opt.php
│       ocmodw.req.php
├── .fclignore
├── ocmodw.ini.php
└── ocmodw.php

_fcl- A storage of fcl-file - a custom archive that contains all the necessary project files and has a git-friendly structure. Using to encrypt and store project files using git. It requires 3rd party tools and is not yet publicly available (maybe later).
_inc - A directory to store placeholder files are used with the <insertfile> tag.
src - A directory to store module or addon source files
zip - A directory where the compiled extension zip-file is created.
.fclignore - A list of files to be ignored by the fcl-utility. It is not yet publicly available.
ocmodw.ini.php - A file with defined constants to use them with the <insertvar> tag.

Usage example

$ php ocmodw.php -z0 -v3x > module-oc3x.ocmod.zip $ php ocmodw.php -z1 -v23 > module--addon1-oc23.ocmod.zip

Releases

No releases published

Packages

No packages published