Using atkConsoleController for console/shell coding in ATK - Revision history

Wayneh at 22:50, 3 June 2015

2015-06-03T22:50:38Z

← Older revision		Revision as of 22:50, 3 June 2015
Line 43:		Line 43:
	''<your-module>'' is a mandatory field to supply. It is the name of the ATK module that the console application is part of.		''<your-module>'' is a mandatory field to supply. It is the name of the ATK module that the console application is part of.

	''<your-controller>'' is the class name of the controller class that you had defined (see below). ~~It is not the file~~ name.		''<your-controller>'' is the class name of the controller class that you had defined (see below). File name then needs to be class.your-controller.inc !

	'''The ATK Console class'''		'''The ATK Console class'''
Line 80:		Line 80:

	This shall be placed in a console folder in your module directory. Typically, this should be /modules/<your-module-dir>/console/ from		This shall be placed in a console folder in your module directory. Typically, this should be /modules/<your-module-dir>/console/ from
	the base directory where ATK is installed. A skeleton code of such a class is as follows:		the base directory where ATK is installed. File name needs to be class.mycontroller.inc

			A skeleton code of such a class is as follows:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 86:		Line 88:
	class MyController extends atkConsoleController		class MyController extends atkConsoleController
	{		{
	public function defaultAction()		public function defaultAction($params = Null)
	{		{
	$this->info("Default Action Called",$this);		$this->info("Default Action Called",$this);
Line 92:		Line 94:
	}		}

	public function yourAction()		public function yourAction($params = Null)
	{		{
	$this->info("Custom Action Called");		$this->info("Custom Action Called");

Bahati at 15:29, 16 March 2011

2011-03-16T15:29:21Z

← Older revision		Revision as of 15:29, 16 March 2011
Line 75:		Line 75:
	@param mixed $data data that should be logged (will be outputted using print_r)		@param mixed $data data that should be logged (will be outputted using print_r)

	On top of this, you are able to access the vast amount of tool and helper functions and classes within ATK conveniently [http://www.~~ibuildings~~.com/docs/atk/atk_6_1_0/].		On top of this, you are able to access the vast amount of tool and helper functions and classes within ATK conveniently [http://www.atk-framework.com/docs/atk/atk_6_1_0/].

	'''<Your>Controller extends atkConsoleController'''		'''<Your>Controller extends atkConsoleController'''
Line 110:		Line 110:
	Reusable Shell Scripting by Timothy Boronczyk (http://www.phparch.com/c/magazine/issue/78)		Reusable Shell Scripting by Timothy Boronczyk (http://www.phparch.com/c/magazine/issue/78)

	http://www.~~ibuildings~~.com/docs/atk/trunk/atk/console/atkConsoleController.html		http://www.atk-framework.com/docs/atk/trunk/atk/console/atkConsoleController.html

Bahati at 10:08, 11 March 2011

2011-03-11T10:08:05Z

← Older revision		Revision as of 10:08, 11 March 2011
Line 1:		Line 1:
	{{howto\|Easy\|[[Vito Chin]] ~~<vito at ibuildings dot com>~~}}		{{howto\|Easy\|[[Vito Chin]]}}

	'''Writing console / shell scripts with PHP ~ why is this necessary?'''		'''Writing console / shell scripts with PHP ~ why is this necessary?'''

Harrie at 13:33, 27 July 2010

2010-07-27T13:33:26Z

← Older revision		Revision as of 13:33, 27 July 2010
Line 35:		Line 35:
	Once your console.php file is placed correctly, the way to start it is as follows:		Once your console.php file is placed correctly, the way to start it is as follows:

	% php console.php modules.<your-module>.console.<your-controller> [yourAction] [param=value ...]		% php console.php [--list] [--debug] modules.<your-module>.console.<your-controller> [yourAction] [param=value ...]

			''--list'' when provided, rather than executing the commands in your controller the atkConsoleController will display a list of all available actions.

			''--debug'' when provided the $this->info calls in your controller will be display. When left out the messages will only be logged but not displayed.

	''<your-module>'' is a mandatory field to supply. It is the name of the ATK module that the console application is part of.		''<your-module>'' is a mandatory field to supply. It is the name of the ATK module that the console application is part of.
Line 49:		Line 53:
	'''''info()'''''		'''''info()'''''

	Useful method for outputting log data to a log file. Files will be placed		Useful method for outputting log data to a log file. If you provided --debug during your call, this output will also be displayed live when executing the script. Files will be placed
	in the ATK temp directory in a subdirectory called console/. Each file will		in the ATK temp directory in a subdirectory called console/. Each file will
	have the following name <controller>_<yyyymmdd>_info.log. The controller part		have the following name <controller>_<yyyymmdd>_info.log. The controller part

bahtiar at 13:23, 12 February 2010

2010-02-12T13:23:42Z

← Older revision		Revision as of 13:23, 12 February 2010
Line 78:		Line 78:
	the base directory where ATK is installed. A skeleton code of such a class is as follows:		the base directory where ATK is installed. A skeleton code of such a class is as follows:

			<syntaxhighlight lang="php">
	atkimport('atk.console.atkconsolecontroller');		atkimport('atk.console.atkconsolecontroller');
	class MyController extends atkConsoleController		class MyController extends atkConsoleController
Line 93:		Line 94:
	}		}
	}		}
			</syntaxhighlight>

	defaultAction() is the the action/method that will be called if you or the user of your console class did not specify any action to be called. If you do not implement this method, then make sure the action/method name is specified when starting a console script. The yourAction() action/method shows a typical custom method that can be included in a console controller class. Note how a call to $this->info('your_message',$some_data) or $this->error('some_error_message',$some_data) allows output . Some ideas on the use of defaultAction: you can implement some kind of while loop within defaultAction which calls a range of custom methods to do automated tasks, making intervals with PHP's built in sleep(). Other obvious possibilities: retrieve/modify database, setup config files, sends e-mails, log statuses.		defaultAction() is the the action/method that will be called if you or the user of your console class did not specify any action to be called. If you do not implement this method, then make sure the action/method name is specified when starting a console script. The yourAction() action/method shows a typical custom method that can be included in a console controller class. Note how a call to $this->info('your_message',$some_data) or $this->error('some_error_message',$some_data) allows output . Some ideas on the use of defaultAction: you can implement some kind of while loop within defaultAction which calls a range of custom methods to do automated tasks, making intervals with PHP's built in sleep(). Other obvious possibilities: retrieve/modify database, setup config files, sends e-mails, log statuses.

Vito at 11:01, 23 September 2008

2008-09-23T11:01:45Z

← Older revision		Revision as of 11:01, 23 September 2008
Line 87:		Line 87:
	}		}

	public function yourAction(~~$params=array()~~)		public function yourAction()
	{		{
	$this->info("Custom Action Called");		$this->info("Custom Action Called");

Vito at 11:00, 23 September 2008

2008-09-23T11:00:26Z

← Older revision		Revision as of 11:00, 23 September 2008
Line 79:		Line 79:

	atkimport('atk.console.atkconsolecontroller');		atkimport('atk.console.atkconsolecontroller');

	class MyController extends atkConsoleController		class MyController extends atkConsoleController
	{		{

Vito at 10:59, 23 September 2008

2008-09-23T10:59:13Z

← Older revision		Revision as of 10:59, 23 September 2008
Line 78:		Line 78:
	the base directory where ATK is installed. A skeleton code of such a class is as follows:		the base directory where ATK is installed. A skeleton code of such a class is as follows:

	atkimport('atk.console.atkconsolecontroller');		atkimport('atk.console.atkconsolecontroller');

	class MyController extends atkConsoleController		class MyController extends atkConsoleController

Vito at 10:58, 23 September 2008

2008-09-23T10:58:32Z

← Older revision		Revision as of 10:58, 23 September 2008
Line 71:		Line 71:
	@param mixed $data data that should be logged (will be outputted using print_r)		@param mixed $data data that should be logged (will be outputted using print_r)

	On top of this, you are able to access the ~~[link to API]~~vast amount of tool and helper functions and classes within ATK conveniently.		On top of this, you are able to access the vast amount of tool and helper functions and classes within ATK conveniently [http://www.ibuildings.com/docs/atk/atk_6_1_0/].

	'''<Your>Controller extends atkConsoleController'''		'''<Your>Controller extends atkConsoleController'''

Vito at 10:51, 23 September 2008

2008-09-23T10:51:55Z

← Older revision		Revision as of 10:51, 23 September 2008
Line 37:		Line 37:
	% php console.php modules.<your-module>.console.<your-controller> [yourAction] [param=value ...]		% php console.php modules.<your-module>.console.<your-controller> [yourAction] [param=value ...]

	''<your module>'' is a mandatory field to supply. It is the name of the ATK module that the console application is part of.		''<your-module>'' is a mandatory field to supply. It is the name of the ATK module that the console application is part of.

	''<your-controller>'' is the class name of the controller class that you had defined (see below). It is not the file name.		''<your-controller>'' is the class name of the controller class that you had defined (see below). It is not the file name.