grunt-php-constants

Update named constants in PHP files.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-php-constants --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-php-constants');

The "php_constants" task

Overview

In your project's Gruntfile, add a section named php_constants to the data object passed into grunt.initConfig().

grunt.initConfig({
  php_constants: {
    your_target: {
      options: {
      },
      src: '',
      dest: ''
    },
  },
});

Options

options.constName

Type: String Default value: ''

The $name parameter for the named constant.

options.constValue

Type: String Function Default value: ''

The new $value for the named constant.

Usage Examples

Static options.constName

In this example, we set options.constValue to a static value.

grunt.initConfig({
  php_constants: {
    static_option: {
      options: {
        constName: 'EXAMPLE',
        constValue: 'static'
      },
      src: 'src.php',
      dest: 'dest.php'
    },
  },
});

Template options.constName

In this example, we set options.constValue to a template value.

grunt.initConfig({
  php_constants: {
    template_option: {
      options: {
        constName: 'EXAMPLE',
        constValue: '<%= template.example %>'
      },
      src: 'src.php',
      dest: 'dest.php'
    },
  },
});

Function options.constName

In this example, we set options.constValue to a function.

grunt.initConfig({
  php_constants: {
    template_option: {
      options: {
        constName: 'EXAMPLE',
        constValue: function() {
          return 'function';
        }
      },
      src: 'src.php',
      dest: 'dest.php'
    },
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.