Custom module PHP properties and methods

[mebeingken]

@patrick

Do you have php versions for these two posts?

@patrick

The function runs in the context of Server Connect and has access to several of its internal methods. this.parse is like dmx.parse in App Connect, it parses an expression and returns the result. The input can also be a complete object, it will then check all the properties if it contains a string with an expression to parse and parses them all.

Other maybe handy methods/properties:

// parse an option or throw an error if not a valid string
this.parseRequired(options.value, 'string', 'parameter value is required.');
// parse an option, a default value will be used if it is not a valid string
this.parseOptional(options.value, 'string', 'default value');
// parse an option, like above a default value will be used if it is not set, it doesn't check the type
this.parseOptional(options.value, '*', 'default value');

// execute sub steps/actions
// always set the second parameter to true
await this.exec(options.then, true);

// express req object
this.req
// express res object
this.res

// set session variable
this.setSession(key, value);
// get session variable
this.getSession(key);
// remove session variable
this.removeSession(key);

// set cookie
this.setCookie(name, value, opts);
// get cookie
this.getCookie(name, opts);
// remove cookie
this.removeCookie(name);

I think these will be the most important ones. These only applies to custom modules, they are not available with formatters.

@patrick

You need to convert the path to system path first. Here the exists action of the fs module with a little modification to use it in the extensions folder.

const fs = require('fs-extra');
const { toSystemPath } = require('../../lib/core/path');

exports.exists = async function(options) {
  let path = toSystemPath(this.parseRequired(options.path, 'string', 'fs.exists: path is required.'));

  if (fs.existsSync(path)) {
    if (options.then) this.exec(options.then, true);
    return true;
  } else {
    if (options.else) this.exec(options.else, true);
    return false;
  }
}

[mebeingken]

@patrick Would sure be great to have these when you have a minute.

[mebeingken]

@patrick toSystemPath usage for php?

[patrick]

Check the fs.php module, you need to include the \lib\core\Path namespace and then you can use it like:

$path = Path::toSystemPath($options->path);

Here the example of exists from the fs module

<?php

namespace modules;

use \lib\core\Module;
use \lib\core\FileSystem;
use \lib\core\Path;

class fs extends Module
{
  public function exists($options) {
    option_require($options, 'path');

    $options->path = $this->app->parseObject($options->path);

    if (FileSystem::isfile($path)) {
      if (isset($options->then)) {
        $this->app->exec($options->then, TRUE);
      }
    } else {
      if (isset($options->else)) {
        $this->app->exec($options->else, TRUE);
      }
    }
  }
}

for all methods in Path class see the file dmxConnectLib/lib/core/Path.php, there is also a FileSystem class that takes care of some encoding issues on windows filesystems, for all methods check the file dmxConnectLib/lib/core/FileSystem.php.

[mebeingken]

Perfect, that’s the pointer I needed. Welcome back.