thelia/hook-doc-module

This package is abandoned and no longer maintained. No replacement package was suggested.

Maintainers

Details

github.com/thelia-modules/HookDoc

Source

Issues

Installs: 12

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 7

Forks: 0

Open Issues: 0

Type:thelia-module

1.0 2015-01-21 16:18 UTC

Requires

LGPL-3.0+ f5152267bf20e9ac4f870dd88a8e9ad7b28f4047

This package is auto-updated.

Last update: 2024-03-14 20:27:42 UTC

README

This module export all hooks present in a specified template. It is used to generate the documentation

Only a command is available in this module.

Installation

with composer :

"require": {
    "thelia/hook-doc-module": "~1.0"
}

Usage

$ php Thelia hook:export-list

Arguments :

  • template : it is the template id definition :
    • 1 : front-office (default)
    • 2 : back-office
    • 3 : pdf
    • 4 email

exemple :

$ php Thelia hook:export-list 2 \\export hooks for current activated back-office template

Options

  • format : export format wanted : json, xml, yml or array (default: "json")
  • order : hooks order by file

exemple :

$ php Thelia hook:export-list 3 -f json -o \\ export hooks in PDF template in json format ordered by file name