Zikula: A Flexible Open Source Content Management System
home | forum | international support | contact us

Docs for page pnadminapi.php

[ class tree: Zikula_System_Modules ] [ index: Zikula_System_Modules ] [ all elements ] [ Todo List ]

Procedural File: pnadminapi.php

Source Location: /Modules/pnadminapi.php

Classes:



Page Details:

Zikula Application Framework



Tags:

author:  Jim McDonald
version:  $Id: pnadminapi.php 24390 2008-06-17 15:56:45Z markwest $
copyright:  (c) 2001, Zikula Development Team
link:  http://www.zikula.org
license:  GNU/GPL







modules_adminapi_checkconsistency [line 1337]

array modules_adminapi_checkconsistency( array $args)

check modules for consistency



Tags:

return:  an array of arrays with links to inconsistencies
author:  Jörg Napp
see:  modules_adminapi_getfilemodules()


Parameters

array   $args   args['filemodules'] array of modules in the filesystem, as returned by modules_adminapi_getfilemodules
[ Top ]


modules_adminapi_countitems [line 962]

integer modules_adminapi_countitems( $args)

utility function to count the number of items held by this module



Tags:

return:  number of items held by this module
author:  Mark West
since:  1.16


Parameters

   $args  
[ Top ]


modules_adminapi_disablehooks [line 1120]

bool modules_adminapi_disablehooks( $args['callermodname'] $args, $args['hookmodname'] 1)

Disable hooks between a caller module and a hook module



Tags:

return:  true if successful
author:  Xaraya Team
copyright:  (C) 2003 by the Xaraya Development Team.
link:  http://www.xaraya.com
license:  GPL


Parameters

$args['hookmodname']   1   hook module
$args['callermodname']   $args   caller module
[ Top ]


modules_adminapi_enablehooks [line 1068]

bool modules_adminapi_enablehooks( $args['callermodname'] $args, $args['hookmodname'] 1)

Enable hooks between a caller module and a hook module



Tags:

return:  true if successful
author:  Xaraya Team
copyright:  (C) 2003 by the Xaraya Development Team.
link:  http://www.xaraya.com
license:  GPL


Parameters

$args['hookmodname']   1   hook module
$args['callermodname']   $args   caller module
[ Top ]


modules_adminapi_extendedupdatehooks [line 127]

bool modules_adminapi_extendedupdatehooks( int $args)

update module hook information, extended version



Tags:

return:  true on success, false on failure
author:  Jim McDonald
author:  Frank Schummertz


Parameters

int   $args   ['id'] the id number of the module to update
[ Top ]


modules_adminapi_getdallependencies [line 1289]

array modules_adminapi_getdallependencies( $args)

get all module dependencies



Tags:

return:  of dependencies
author:  Mark West


Parameters

   $args  
[ Top ]


modules_adminapi_getdependencies [line 1301]

mixed modules_adminapi_getdependencies( modid $args)

get dependencies for a module



Tags:

return:  array of dependencies e or false otherwise
author:  Mark West


Parameters

modid   $args   - id of module to get dependencies for
[ Top ]


modules_adminapi_getdependents [line 1319]

mixed modules_adminapi_getdependents( modid $args)

get dependencies for a module



Tags:

return:  array of dependencies e or false otherwise
author:  Mark West


Parameters

modid   $args   - id of module to get dependencies for
[ Top ]


modules_adminapi_getextendedmoduleshooks [line 1202]

array modules_adminapi_getextendedmoduleshooks( $args['modid'] $args)

Get a extended list of hooks for a given module



Tags:

return:  array of hooks attached the module
author:  Frank Schummertz


Parameters

$args['modid']   $args   the modules id
[ Top ]


modules_adminapi_getfilemodules [line 429]

array modules_adminapi_getfilemodules( )

scan the file system for modules

This function scans the file system for modules and returns an array with all (potential) modules found. This information is used to regenerate the module list.




Tags:

return:  Array of modules found in the file system
author:  Jim McDonald
author:  Jörg Napp


[ Top ]


modules_adminapi_gethookedmodules [line 1011]

array modules_adminapi_gethookedmodules( $args['hookmodname'] $args, $args['hookobject'] 1, $args['hookaction'] 2, $args['hookarea'] 3)

Get a list of modules calling a particular hook module



Tags:

return:  of modules calling this hook module
author:  Xaraya Team
copyright:  (C) 2003 by the Xaraya Development Team.
link:  http://www.xaraya.com


Parameters

$args['hookobject']   1   the object of the hook (item, module, ...) (optional)
$args['hookaction']   2   the action on that object (transform, display, ...) (optional)
$args['hookarea']   3   the area we're dealing with (GUI, API) (optional)
$args['hookmodname']   $args   hook module we're looking for
[ Top ]


modules_adminapi_getlinks [line 1260]

array modules_adminapi_getlinks( )

get available admin panel links



Tags:

return:  array of admin links
author:  Mark West


[ Top ]


modules_adminapi_getmoduleshooks [line 1149]

array modules_adminapi_getmoduleshooks( $args['modid'] $args)

Get a list of hooks for a given module



Tags:

return:  array of hooks attached the module
author:  Frank Schummertz


Parameters

$args['modid']   $args   the modules id
[ Top ]


modules_adminapi_initialise [line 792]

bool modules_adminapi_initialise( int $args, int 1)

initialise a module



Tags:

return:  true on success, false on failure
author:  Jim McDonald, changed by Frank Schummertz for interactive init


Parameters

int   1   args['interactive_mode'] boolean that tells us if we are in interactive mode or not
int   $args   args['id'] module ID
[ Top ]


modules_adminapi_list [line 200]

array modules_adminapi_list( $args)

obtain list of modules



Tags:

return:  associative array of known modules
author:  Jim McDonald


Parameters

   $args  
[ Top ]


modules_adminapi_modify [line 19]

array modules_adminapi_modify( int $args)

update module information



Tags:

return:  associative array


Parameters

int   $args   ['id'] the id number of the module
[ Top ]


modules_adminapi_regenerate [line 607]

bool modules_adminapi_regenerate( array $args)

regenerate modules list



Tags:

return:  true on success, false on failure
author:  Jim McDonald
see:  modules_adminapi_getfilemodules()


Parameters

array   $args   args['filemodules'] array of modules in the filesystem, as returned by modules_adminapi_getfilemodules defaults to modules_adminapi_getfilemodules()
[ Top ]


modules_adminapi_remove [line 336]

bool modules_adminapi_remove( bool $args, int $args['interactive_remove'])

remove a module



Tags:

return:  true on success, false on failure
author:  Jim McDonald


Parameters

bool   $args   ['removedependents'] remove any modules dependent on this module (default: false)
int   $args['interactive_remove']   true if in interactive upgrade mode, otherwise false
[ Top ]


modules_adminapi_setstate [line 266]

bool modules_adminapi_setstate( int $args)

set the state of a module



Tags:

return:  true if successful, false otherwise
author:  Jim McDonald


Parameters

int   $args   ['state'] the state
[ Top ]


modules_adminapi_update [line 32]

bool modules_adminapi_update( string $args)

update module information



Tags:

return:  true on success, false on failure
author:  Jim McDonald


Parameters

string   $args   ['description'] the new description of the module
[ Top ]


modules_adminapi_updatehooks [line 72]

bool modules_adminapi_updatehooks( int $args)

update module hook information



Tags:

return:  true on success, false on failure
author:  Jim McDonald


Parameters

int   $args   ['id'] the id number of the module to update
[ Top ]


modules_adminapi_upgrade [line 866]

bool modules_adminapi_upgrade( $args, int $args['id'], int $args['interactive_upgrade'])

upgrade a module



Tags:

return:  true on success, false on failure
author:  Jim McDonald


Parameters

int   $args['id']   module ID
int   $args['interactive_upgrade']   true if in interactive upgrade mode, otherwise false
   $args  
[ Top ]


Packages:

Files:

Classes: