GrimaTask Class Reference

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 1306 of file grima-lib.php.

Constructor & Destructor Documentation

__construct()

GrimaTask::__construct

(

)

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

References join_paths().

                            {

         $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);

         }

     }

Member Function Documentation

addMessage()

GrimaTask::addMessage	(		$type,
			$message
	)

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

                                                {

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

     }

call()

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

static

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

References do_redirect().

Referenced by check_login().

                                                             {

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

         do_redirect($url);

     }

check_input()

GrimaTask::check_input

(

)

Definition at line 1457 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;

         }

     }

check_login()

GrimaTask::check_login

(

)

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

References $grima, and call().

                            {

         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;

         }

     }

do_task()

GrimaTask::do_task ( )

abstract

get_input()

GrimaTask::get_input

(

)

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

                          {

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

             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 ($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);

         }

     }

get_input_param()

GrimaTask::get_input_param

(

$param

)

Definition at line 1484 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;

             }

         }

     }

offsetExists()

GrimaTask::offsetExists

(

$offset

)

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

                                    {

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

     }

offsetGet()

GrimaTask::offsetGet

(

$offset

)

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

                                 {

         return $this->args[$offset];

     }

offsetSet()

GrimaTask::offsetSet	(		$offset,
			$value
	)

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

                                        {

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

     }

offsetUnset()

GrimaTask::offsetUnset

(

$offset

)

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

                                   {

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

     }

print_failure()

GrimaTask::print_failure

(

)

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

                              {

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

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

     }

print_form()

GrimaTask::print_form

(

)

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

                           {

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

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

     }

print_success()

GrimaTask::print_success

(

)

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

                              {

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

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

     }

run()

GrimaTask::run

(

)

Definition at line 1400 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();

         }

     }

RunIt()

static GrimaTask::RunIt ( )

static

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

                                    {

         $task = new static();

         $task->run();

     }

setup_splat()

GrimaTask::setup_splat

(

)

Definition at line 1344 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'];

         }

     }

usage()

GrimaTask::usage

(

)

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

                      { # XXX rewrite for grima form

         global $argv;

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

         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;

     }

Member Data Documentation

$args

GrimaTask::$args = array()

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

$auto_args

GrimaTask::$auto_args = array()

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

$el_override

GrimaTask::$el_override = array()

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

$error

GrimaTask::$error = false

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

$messages

GrimaTask::$messages = array()

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

---

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

• grimas/grima-lib.php