Home » Documentation » Class Reference » GiiModule

GiiModule

Package	system.gii
Inheritance	class GiiModule » CWebModule » CModule » CComponent
Since	1.1.2
Version	$Id: GiiModule.php 2078 2010-04-30 02:18:31Z qiang.xue $

GiiModule is a module that provides Web-based code generation capabilities.

To use GiiModule, you must include it as a module in the application configuration like the following:

return array(
    ......
    'modules'=>array(
        'gii'=>array(
            'class'=>'system.gii.GiiModule',
            'password'=>***choose a password***
        ),
    ),
)

Because GiiModule generates new code files on the server, you should only use it on your own development machine. To prevent other people from using this module, it is required that you specify a secret password in the configuration. Later when you access the module via browser, you will be prompted to enter the correct password.

By default, GiiModule can only be accessed by localhost. You may configure its ipFilters property if you want to make it accessible on other machines.

With the above configuration, you will be able to access GiiModule in your browser using the following URL:

http://localhost/path/to/index.php?r=gii

If your application is using path-format URLs with some customized URL rules, you may need to add the following URLs in your application configuration in order to access GiiModule:

'components'=>array(
    'urlManager'=>array(
        'urlFormat'=>'path',
        'rules'=>array(
            'gii'=>'gii',
            'gii/<controller:\w+>'=>'gii/<controller>',
            'gii/<controller:\w+>/<action:\w+>'=>'gii/<controller>/<action>',
            ...other rules...
        ),
    )
)

You can then access GiiModule via:

http://localhost/path/to/index.php/gii

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
assetsUrl	string	the base URL that contains all published asset files of gii.	GiiModule
basePath	string	the root directory of the module.	CModule
behaviors	array	the behaviors that should be attached to the module.	CModule
components	array	Returns the application components.	CModule
controllerMap	array	mapping from controller ID to controller configurations.	CWebModule
controllerPath	string	the directory that contains the controller classes.	CWebModule
defaultController	string	the ID of the default controller for this module.	CWebModule
description	string	Returns the description of this module.	CWebModule
generatorPaths	array	a list of path aliases that refer to the directories containing code generators.	GiiModule
id	string	the module ID.	CModule
ipFilters	array	the IP filters that specify which IP addresses are allowed to access GiiModule.	GiiModule
layout	mixed	the layout that is shared by the controllers inside this module.	CWebModule
layoutPath	string	the root directory of layout files.	CWebModule
modulePath	string	the directory that contains the application modules.	CModule
modules	array	the configuration of the currently installed modules (module ID => configuration)	CModule
name	string	Returns the name of this module.	CWebModule
newDirMode	integer	the permssion to be set for newly generated directories.	GiiModule
newFileMode	integer	the permssion to be set for newly generated code files.	GiiModule
params	CAttributeCollection	the list of user-defined parameters	CModule
parentModule	CModule	the parent module.	CModule
password	string	the password that can be used to access GiiModule.	GiiModule
preload	array	the IDs of the application components that should be preloaded.	CModule
version	string	Returns the version of this module.	CWebModule
viewPath	string	the root directory of view files.	CWebModule

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CModule
__get()	Getter magic method.	CModule
__isset()	Checks if a property value is null.	CModule
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
afterControllerAction()	The post-filter for controller actions.	CWebModule
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
beforeControllerAction()	Performs access check to gii.	GiiModule
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
configure()	Configures the module with the specified configuration.	CModule
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getAssetsUrl()		GiiModule
getBasePath()		CModule
getComponent()	Retrieves the named application component.	CModule
getComponents()	Returns the application components.	CModule
getControllerPath()		CWebModule
getDescription()	Returns the description of this module.	CWebModule
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getId()		CModule
getLayoutPath()		CWebModule
getModule()	Retrieves the named application module.	CModule
getModulePath()		CModule
getModules()		CModule
getName()	Returns the name of this module.	CWebModule
getParams()		CModule
getParentModule()		CModule
getVersion()	Returns the version of this module.	CWebModule
getViewPath()		CWebModule
hasComponent()		CModule
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasModule()	Returns a value indicating whether the specified module is installed.	CModule
hasProperty()	Determines whether a property is defined.	CComponent
init()	Initializes the gii module.	GiiModule
raiseEvent()	Raises an event.	CComponent
setAliases()	Defines the root aliases.	CModule
setAssetsUrl()		GiiModule
setBasePath()	Sets the root directory of the module.	CModule
setComponent()	Puts a component under the management of the module.	CModule
setComponents()	Sets the application components.	CModule
setControllerPath()		CWebModule
setId()		CModule
setImport()	Sets the aliases that are used in the module.	CModule
setLayoutPath()		CWebModule
setModulePath()		CModule
setModules()	Configures the sub-modules of this module.	CModule
setParams()		CModule
setViewPath()		CWebModule

Protected Methods

Hide inherited methods

Method	Description	Defined By
allowIp()	Checks to see if the user IP is allowed by ipFilters.	GiiModule
findGenerators()	Finds all available code generators and their code templates.	GiiModule
preinit()	Preinitializes the module.	CModule
preloadComponents()	Loads static application components.	CModule

Property Details

assetsUrl property

public string getAssetsUrl()
public void setAssetsUrl(string $value)

the base URL that contains all published asset files of gii.

generatorPaths property

public array $generatorPaths;

a list of path aliases that refer to the directories containing code generators. The directory referred by a single path alias may contain multiple code generators, each stored under a sub-directory whose name is the generator name. Defaults to array('application.gii').

ipFilters property

public array $ipFilters;

the IP filters that specify which IP addresses are allowed to access GiiModule. Each array element represents a single filter. A filter can be either an IP address or an address with wildcard (e.g. 192.168.0.*) to represent a network segment. If you want to allow all IPs to access gii, you may set this property to be false (DO NOT DO THIS UNLESS YOU KNOW THE CONSEQUENCE!!!) The default value is array('127.0.0.1', '::1'), which means GiiModule can only be accessed on the localhost.

newDirMode property

public integer $newDirMode;

the permssion to be set for newly generated directories. This value will be used by PHP chmod function. Defaults to 0777, meaning the directory can be read, written and executed by all users.

newFileMode property

public integer $newFileMode;

the permssion to be set for newly generated code files. This value will be used by PHP chmod function. Defaults to 0666, meaning the file is read-writable by all users.

password property

public string $password;

the password that can be used to access GiiModule. If this property is set false, then GiiModule can be accessed without password (DO NOT DO THIS UNLESS YOU KNOW THE CONSEQUENCE!!!)

Method Details

allowIp() method

protected boolean allowIp(string $ip)
$ip	string	the user IP
{return}	boolean	whether the user IP is allowed by ipFilters.

Checks to see if the user IP is allowed by ipFilters.

beforeControllerAction() method

public boolean beforeControllerAction(CController $controller, CAction $action)
$controller	CController	the controller to be accessed.
$action	CAction	the action to be accessed.
{return}	boolean	whether the action should be executed.

Performs access check to gii. This method will check to see if user IP and password are correct if they attempt to access actions other than "default/login" and "default/error".

findGenerators() method

protected void findGenerators()

Finds all available code generators and their code templates.

getAssetsUrl() method

public string getAssetsUrl()
{return}	string	the base URL that contains all published asset files of gii.

init() method

public void init()

Initializes the gii module.

setAssetsUrl() method

public void setAssetsUrl(string $value)
$value	string	the base URL that contains all published asset files of gii.