Class: Utils_CommonDataCommon

Source Location: /modules/Utils/CommonData/CommonDataCommon_0.php

Class Utils_CommonDataCommon

Class Overview

Implements interfaces:

Base_AdminModuleCommonInterface

Located in /modules/Utils/CommonData/CommonDataCommon_0.php [line 12]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Utils_CommonDataCommon

Author(s):

Arkadiusz Bisaga <abisaga@telaxus.com>

Information Tags:

Version:	1.0
Copyright:	Copyright © 2006, Telaxus LLC
License:	MIT

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ModuleCommon

ModuleCommon::Instance()

Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()

ModulePrimitive::check_access()

Checks access to function which name is passed as first parameter.

ModulePrimitive::create_data_dir()

Creates default data directory for module. Typical usage: in module installation

ModulePrimitive::get_data_dir()

Returns path to the default data directory for module calling this method.

ModulePrimitive::get_module_dir()

Returns path to the module directory.

ModulePrimitive::get_type()

Returns name(type) of module that called this function.

ModulePrimitive::get_type_with_bt()

ModulePrimitive::remove_data_dir()

Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Method Summary

static void	admin_access()	For internal use only.
static void	admin_caption()	For internal use only.
static void	extend_array()	Extends common data array.
static mixed	get_array()	Returns common data array.
static mixed	get_array_count()	Counts elements in common data array.
static void	get_id()
static mixed	get_nodes()	Gets nodes by keys.
static void	get_translated_array()
static mixed	get_value()	Gets node value.
static void	new_array()	Creates new array for common use.
static void	new_id()
static true	remove()	Removes common data array or entry.
static true	remove_by_id()	Removes common data array or entry using id.
static void	rename_key()
static void	set_value()	Creates new node with value.
static void	translate_array()

[ Top ]

Methods

static method admin_access [line 24]

static void admin_access(
)

For internal use only.

API Tags:

Access:

public

[ Top ]

static method admin_caption [line 17]

static void admin_caption(
)

For internal use only.

API Tags:

Access:

public

[ Top ]

static method extend_array [line 143]

static void extend_array(
string
$name, array
$array, [bool
$overwrite = false], [
$readonly = false] 
)

Extends common data array.

Parameters:

string	$name:	array name
array	$array:	values to insert
bool	$overwrite:	whether method should overwrite data if array key already exists, otherwise the data will be preserved
	$readonly:

API Tags:

Access:

public

[ Top ]

static method get_array [line 192]

static mixed get_array(
string
$name, [boolean
$order_by_key = false], [
$readinfo = false], [
$silent = false] 
)

Returns common data array.

Parameters:

string	$name:	array name
boolean	$order_by_key:	order by key instead of value
	$readinfo:
	$silent:

API Tags:

Return:	returns an array if such array exists, false otherwise
Access:	public

[ Top ]

static method get_array_count [line 226]

static mixed get_array_count(
string
$name 
)

Counts elements in common data array.

Parameters:

string

$name:

array name

API Tags:

Return:	returns an array if such array exists, false otherwise
Access:	public

[ Top ]

static method get_id [line 28]

static void get_id(

$name 
)

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

static method get_nodes [line 103]

static mixed get_nodes(
string
$root, 
$names 
)

Gets nodes by keys.

Parameters:

string	$root:	array name
array	$names:

API Tags:

Return:	false on invalid name
Access:	public

[ Top ]

static method get_translated_array [line 206]

static void get_translated_array(

$name, [
$order_by_key = false], [
$readinfo = false], [
$silent = false] 
)

Parameters:

	$name:
	$order_by_key:
	$readinfo:
	$silent:

API Tags:

Access:

public

[ Top ]

static method get_value [line 84]

static mixed get_value(
string
$name, [boolean
$translate = false] 
)

Gets node value.

Parameters:

string	$name:	array name
boolean	$translate:	translate?

API Tags:

Return:	false on invalid name
Access:	public

[ Top ]

static method new_array [line 117]

static void new_array(
string
$name, array
$array, [bool
$overwrite = false], [
$readonly = false] 
)

Creates new array for common use.

Parameters:

string	$name:	array name
array	$array:	initialization value
bool	$overwrite:	whether method should overwrite if array already exists, otherwise the data will be appended
	$readonly:

API Tags:

Access:

public

[ Top ]

static method new_id [line 41]

static void new_id(

$name 
)

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

static method remove [line 166]

static true remove(
string
$name 
)

Removes common data array or entry.

Parameters:

string

$name:

entry name

API Tags:

Return:	on success, false otherwise
Access:	public

[ Top ]

static method remove_by_id [line 178]

static true remove_by_id(
integer
$id 
)

Removes common data array or entry using id.

Parameters:

integer

$id:

entry id

API Tags:

Return:	on success, false otherwise
Access:	public

[ Top ]

static method rename_key [line 232]

static void rename_key(

$parent, 
$old, 
$new 
)

Parameters:

	$parent:
	$old:
	$new:

API Tags:

Access:

public

[ Top ]

static method set_value [line 65]

static void set_value(
string
$name, array
$value, [bool
$overwrite = true], [
$readonly = false] 
)

Creates new node with value.

Parameters:

string	$name:	array name
array	$value:	initialization value
bool	$overwrite:	whether method should overwrite if array already exists, otherwise the data will be appended
	$readonly:

API Tags:

Access:

public

[ Top ]

static method translate_array [line 213]

static void translate_array(

&$arr 
)

Parameters:

&$arr:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:40:01 -0500 by phpDocumentor 1.4.2

	epesi-utils CommonData

[ class tree: epesi-utils ] [ index: epesi-utils ] [ all elements ]