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: /Blocks/pnadminapi.php

Classes:



Page Details:

Zikula Application Framework



Tags:

version:  $Id: pnadminapi.php 24383 2008-06-12 14:15:02Z markwest $
copyright:  (c) 2001, Zikula Development Team
link:  http://www.zikula.org
license:  GNU/GPL







blocks_adminapi_activate [line 231]

bool blocks_adminapi_activate( int $args)

activate a block



Tags:

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


Parameters

int   $args   ['bid'] the ID of the block to activate
[ Top ]


blocks_adminapi_create [line 120]

mixed blocks_adminapi_create( $args, int $block)

create a new block



Tags:

return:  block Id on success, false on failure
author:  Jim McDonald
author:  Robert Gasch


Parameters

int   $block   ['bkey'] the key of the block
   $args  
[ Top ]


Blocks_adminapi_createposition [line 288]

mixed Blocks_adminapi_createposition( $args, string $args['name'], string $args['description'])

create a block position



Tags:

return:  position ID on success, false on failure
author:  Mark West


Parameters

string   $args['name']   name of the position
string   $args['description']   description of the position
   $args  
[ Top ]


blocks_adminapi_deactivate [line 212]

bool blocks_adminapi_deactivate( int $args)

deactivate a block



Tags:

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


Parameters

int   $args   ['bid'] the ID of the block to deactivate
[ Top ]


blocks_adminapi_delete [line 249]

bool blocks_adminapi_delete( int $args)

delete a block



Tags:

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


Parameters

int   $args   ['bid'] the ID of the block to delete
[ Top ]


blocks_adminapi_deleteposition [line 367]

bool blocks_adminapi_deleteposition( $args, int $args['pid'])

delete a block position



Tags:

return:  true on success, false on failure
author:  Mark West


Parameters

int   $args['pid']   ID of the position
   $args  
[ Top ]


blocks_adminapi_getlinks [line 398]

array blocks_adminapi_getlinks( )

get available admin panel links



Tags:

return:  array of admin links
author:  Mark West


[ Top ]


blocks_adminapi_setActiveState [line 183]

bool blocks_adminapi_setActiveState( $block, int $args)

Set a block's active state



Tags:

return:  true on success, false on failure
author:  Robert Gasch


Parameters

int   $args   ['bid'] the ID of the block to deactivate
   $block  
[ Top ]


blocks_adminapi_update [line 24]

bool blocks_adminapi_update( string $args)

update attributes of a block



Tags:

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


Parameters

string   $args   ['content'] the new content of the block
[ Top ]


Blocks_adminapi_updateposition [line 329]

bool Blocks_adminapi_updateposition( $args, int $args['pid'], sting $args['name'], string $args['description'])

update a block position item



Tags:

return:  true if successful, false otherwise
author:  Mark West


Parameters

int   $args['pid']   the ID of the item
sting   $args['name']   name of the block position
string   $args['description']   description of the block position
   $args  
[ Top ]


Packages:

Files:

Classes: