Overview

Namespaces

  • None
  • Peg
    • Cli
      • Commands
    • Config
    • Custom
      • Command
        • Action
          • Generate
          • Parse
      • CommandLine
      • Config
      • Localization
      • Utilities
    • Lib
      • Definitions
        • Element
      • Generator
      • Lexers
      • Plugins
      • Signals
        • Data
          • Definitions
          • Lexers
        • Type
  • PHP

Classes

  • Base
  • Loader
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo
 1: <?php
 2: /**
 3:  * @author Jefferson González
 4:  * @license MIT
 5:  * @link http://github.com/peg-org/peg-src Source code.
 6: */
 7: 
 8: namespace Peg\Lib\Plugins;
 9: 
10: /**
11:  * Base interface to write plugins. All plugins should inherit from this class.
12:  */
13: class Base
14: {
15: 
16:     /**
17:      * Class name of the plugin.
18:      * This variable is set by the plugin loader.
19:      * @var string
20:      */
21:     public $name;
22: 
23:     /**
24:      * Path to directory where the plugin resides.
25:      * This variable is set by the plugin loader.
26:      * @var string
27:      */
28:     public $path;
29: 
30:     /**
31:      * Called when the system is ready to initialize the plugin.
32:      * On this method you can listen for signals, etc...
33:      */
34:     public function OnInit(){}
35: 
36: }
PEG Api API documentation generated by ApiGen 2.8.0