The base class for most "grimas". More...

Inheritance diagram for GrimaTask:

Public Member Functions
	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	__construct ()

	setup_splat ()

	print_form ()

	print_success ()

	print_failure ()

	check_login ()

	addMessage ($type, $message)

	run ()

	get_input ()

	check_input ()

	get_input_param ($param)

	do_task ()

	usage ()

Static Public Member Functions
static	RunIt ()

static	call ($grimaname, $args=array())

Public Attributes
	$error = false

	$args = array()

	$el_override = array()

	$auto_args = array()

	$messages = array()

Detailed Description

The base class for most "grimas".

Definition at line 1522 of file grima-lib.php.

Constructor & Destructor Documentation

◆ __construct()

GrimaTask::__construct ( )

Definition at line 1553 of file grima-lib.php.

    {

        $webroot = __DIR__;

        $base = get_class($this); //basename($_SERVER['PHP_SELF'],'.php');

        if (file_exists(join_paths($webroot, $base, "$base.xml")) and (!isset($this->formxml))) {

            $this->formxml = file_get_contents(join_paths($webroot, $base, "$base.xml"));

        }

        if (isset($this->formxml)) {

            $this->form = new GrimaForm();

            $this->form->fromXML($this->formxml);

        }

    }

References join_paths().

Member Function Documentation

◆ addMessage()

GrimaTask::addMessage	(	$type,
		$message
	)

Definition at line 1626 of file grima-lib.php.

    {

        $this->messages[] = new GrimaTaskMessage($type, $message);

    }

Referenced by run().

◆ call()

static GrimaTask::call	(	$grimaname,
		$args = `array()`
	)

static

Definition at line 1801 of file grima-lib.php.

    {

        $url = rtrim("../$grimaname/$grimaname.php?" . http_build_query($args), "?");

        do_redirect($url);

    }

References $args, and do_redirect().

Referenced by check_login().

◆ check_input()

GrimaTask::check_input ( )

Definition at line 1707 of file grima-lib.php.

    {

        if (isset($this->form)) {

            $input_good = true;

            foreach ($this->form->fields as $field) {

                if ($field->required) {

                    if (!isset($this[$field->name])

                        or !($this[$field->name])

                    ) {

                        $field->error_condition = "error";

                        $field->error_message = "Field is required\n";

                        $input_good = false;

                    }

                }

            }

            return $input_good;

        } else {

            foreach ($this->auto_args as $k => $v) {

                if (preg_match('/[^:]:$/', $k)) {

                    if (!isset($this->args[$v]) or !($this->args[$v])) {

                        return false;

                    }

                }

            }

            return true;

        }

    }

Referenced by get_input(), get_input_param(), and run().

◆ check_login()

GrimaTask::check_login ( )

Definition at line 1612 of file grima-lib.php.

    {

        global $grima;

        if (isset($grima->apikey) and isset($grima->server)

            and ($grima->apikey) and ($grima->server)

        ) {

            return true;

        } else {

            GrimaTask::call('Login', array("redirect_url"=>$_SERVER['PHP_SELF']));

            exit;

            return false;

        }

    }

References $grima, and call().

Referenced by run().

◆ do_task()

GrimaTask::do_task ( )

abstract

Referenced by run().

◆ get_input()

GrimaTask::get_input ( )

Definition at line 1661 of file grima-lib.php.

    {

        if (isset($this->form)) {

            if (php_sapi_name() == "cli") { // command line

                $param = "";

                foreach ($this->form->fields as $field) {

                    $short = $field->shortname;

                    if ($field->required) {

                        $param .= "$short:";

                    } else {

                        $param .= "$short::";

                    }

                }

                if ($option = getopt($param)) {

                    foreach ($this->form->fields as $field) {

                        if (isset($option[$field->shortname])) {

                            $this[$field->name] = $option[$field->shortname];

                        }

                    }

                /*

                } else {

                    $this->usage(); exit;

                */

                }

                if (!$this->check_input()) {

                    $this->usage(); exit;

                }

            } else { // web

                foreach ($this->form->fields as $field) {

                    if (isset($_REQUEST[$field->name])) {

                        $this[$field->name] = $_REQUEST[$field->name];

                        /* sanitize */

                    }

                }

            }

        } else {

            // ??

            $this->get_input_param($this->auto_args);

        }

    }

References check_input(), get_input_param(), and usage().

Referenced by run().

◆ get_input_param()

GrimaTask::get_input_param ( $param )

Definition at line 1736 of file grima-lib.php.

    {

        if (php_sapi_name() == "cli") { // command line

            if ($options = getopt(implode(array_keys($param)))) {

                foreach ($param as $k => $v) {

                    $this->args[$v] = $options[$k[0]];

                }

                if (!$this->check_input()) {

                    $this->usage(); exit;

                }

            } else {

                $this->usage(); exit;

            }

        } else { // web

            foreach ($param as $k => $v) {

                if (isset($_REQUEST[$v])) {

                    $this->args[$v] = $_REQUEST[$v];

                }

            }

            if (!$this->check_input()) {

                $this->print_form(); exit;

            }

        }

    }

References check_input(), print_form(), and usage().

Referenced by get_input().

◆ offsetExists()

GrimaTask::offsetExists ( $offset )

Definition at line 1533 of file grima-lib.php.

    {

        return isset($this->args[$offset]);

    }

◆ offsetGet()

GrimaTask::offsetGet ( $offset )

Definition at line 1538 of file grima-lib.php.

    {

        return $this->args[$offset];

    }

◆ offsetSet()

GrimaTask::offsetSet	(	$offset,
		$value
	)

Definition at line 1543 of file grima-lib.php.

    {

        $this->args[$offset] = $value;

    }

◆ offsetUnset()

GrimaTask::offsetUnset ( $offset )

Definition at line 1548 of file grima-lib.php.

    {

        unset($this->args[$offset]);

    }

◆ print_failure()

GrimaTask::print_failure ( )

Definition at line 1606 of file grima-lib.php.

    {

        $this->form->loadValues($this);

        $this->splat->splat('print_failure', $this->splatVars);

    }

Referenced by run().

◆ print_form()

GrimaTask::print_form ( )

Definition at line 1594 of file grima-lib.php.

    {

        $this->form->loadValues($this);

        $this->splat->splat('print_form', $this->splatVars);

    }

Referenced by get_input_param(), and run().

◆ print_success()

GrimaTask::print_success ( )

Definition at line 1600 of file grima-lib.php.

    {

        $this->form->loadPersistentValues($this);

        $this->splat->splat('print_success', $this->splatVars);

    }

Referenced by run().

◆ run()

GrimaTask::run ( )

Definition at line 1631 of file grima-lib.php.

    {

        $this->check_login(); // if not logged in, print login form

        $this->error = false;

        $this->get_input();

        $this->setup_splat(); // should happen after form xml read in get_input

        if ($this->check_input()) {

            try {

                $this->do_task();

            } catch (Exception $e) {

                $this->addMessage('error', $e->getMessage());

                $this->error = true;

            }

        } else {

            $this->print_form();

            exit;

        }

        if ($this->error) {

            $this->print_failure();

        } else {

            $this->print_success();

        }

    }

References addMessage(), check_input(), check_login(), do_task(), get_input(), print_failure(), print_form(), print_success(), and setup_splat().

◆ RunIt()

static GrimaTask::RunIt ( )

static

Definition at line 1655 of file grima-lib.php.

    {

        $task = new static();

        $task->run();

    }

◆ setup_splat()

GrimaTask::setup_splat ( )

Definition at line 1566 of file grima-lib.php.

    {

        $webroot = __DIR__;

        $basename = get_class($this); //basename($_SERVER['PHP_SELF'],'.php');

        $this->splat = new zemowsplat\Splat();

        $this->splat->addBases(

            array(

            "$webroot/$basename/splats",    // per-task overrides

            "$webroot/splats",              // default

            )

        );

        $this->splatVars = array(

            'title'             => $this->form->title,

            'basename'          => $basename,

            'webroot'           => $webroot,

            'local_stylesheets' => array('Grima.css'),

            'form'              => &$this->form,

            'messages'          => &$this->messages,

            'width'             => 9,

        );

        if (isset($this['redirect_url'])) {

            $this->splatVars['redirect_url'] = $this['redirect_url'];

        }

    }

Referenced by run().

◆ usage()

GrimaTask::usage ( )

Definition at line 1763 of file grima-lib.php.

    {

        // XXX rewrite for grima form

        global $argv;

        print "Usage: php ${argv[0]} ";

        foreach ($this->form->fields as $field) {

            $k = $field->shortname;

            $n = $field->name;

            if ($field->required) {

                print "-$k <$n> ";

            } else {

                print "[-$k <$n>] ";

            }

        }

        print "\n"; exit;

        // old format

        /*

        foreach ($this->auto_args as $k => $v) {

            if (preg_match('/^(.):$/', $k, $m)) {

                print "-${m[1]} <$v> ";

            } else {

                if (preg_match('/^(.)::$/', $k, $m)) {

                    print "[ -${m[1]} <$v> ] ";

                } else {

                    if (preg_match('/^.$/', $k)) {

                        print "[ -$k ] ";

                    }

                }

            }

        }

        print "\n";

        exit;

        */

    }

Referenced by get_input(), and get_input_param().

Member Data Documentation

◆ $args

GrimaTask::$args = array()

Definition at line 1526 of file grima-lib.php.

Referenced by call().

◆ $auto_args

GrimaTask::$auto_args = array()

Definition at line 1529 of file grima-lib.php.

◆ $el_override

GrimaTask::$el_override = array()

Definition at line 1527 of file grima-lib.php.

◆ $error

GrimaTask::$error = false

Definition at line 1525 of file grima-lib.php.

◆ $messages

GrimaTask::$messages = array()

Definition at line 1531 of file grima-lib.php.

The documentation for this class was generated from the following file:

grimas/grima-lib.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMessage()

◆ call()

◆ check_input()

◆ check_login()

◆ do_task()

◆ get_input()

◆ get_input_param()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ print_failure()

◆ print_form()

◆ print_success()

◆ run()

◆ RunIt()

◆ setup_splat()

◆ usage()

Member Data Documentation

◆ $args

◆ $auto_args

◆ $el_override

◆ $error

◆ $messages