[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/projectpier/application/ -> functions.php (summary)

(no description)

File Size: 324 lines (10 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 17 functions

  __autoload()
  __shutdown()
  __production_error_handler()
  __production_exception_handler()
  get_url()
  product_name()
  product_version()
  product_signature()
  request_controller()
  request_action()
  prepare_company_website_controller()
  owner_company()
  logged_user()
  active_project()
  config_option()
  set_config_option()
  get_object_by_manager_and_id()

Functions
Functions that are not part of a class:

__autoload($load_class_name)   X-Ref
Gets called, when an undefined class is being instanciated
d


__shutdown()   X-Ref
ProjectPier shutdown function

param: void
return: null

__production_error_handler($code, $message, $file, $line)   X-Ref
This function will be used as error handler for production

param: integer $code
param: string $message
param: string $file
param: integer $line
return: null

__production_exception_handler($exception)   X-Ref
This function will be used as exception handler in production environment

param: Exception $exception
return: null

get_url($controller_name = null, $action_name = null, $params = null, $anchor = null, $include_project_id = true)   X-Ref
Return an application URL

If $include_project_id variable is presend active_project variable will be added to the list of params if we have a
project selected (active_project() function returns valid project instance)

param: string $controller_name
param: string $action_name
param: array $params
param: string $anchor
param: boolean $include_project_id
return: string

product_name()   X-Ref
Return product name. This is a wrapper function that abstracts the product name

param: void
return: string

product_version()   X-Ref
Return product version, wrapper function.

param: void
return: string

product_signature()   X-Ref
Returns product signature (name and version). If user is not logged in and
is not member of owner company he will see only product name

param: void
return: string

request_controller()   X-Ref
Return matched requst controller

param: void
return: string

request_action()   X-Ref
Return matched request action

param: void
return: string

prepare_company_website_controller(PageController $controller, $layout = 'dashboard')   X-Ref
Set internals of specific company website controller

param: PageController $controller
param: string $layout Project or company website layout. Or any other...
return: null

owner_company()   X-Ref
Return owner company object if we are on company website and it is loaded

param: void
return: Company

logged_user()   X-Ref
Return logged user if we are on company website

param: void
return: User

active_project()   X-Ref
Return active project if we are on company website

param: void
return: Project

config_option($option, $default = null)   X-Ref
Return config option value

param: string $name Option name
param: mixed $default Default value that is returned in case of any error
return: mixed

set_config_option($option_name, $value)   X-Ref
Set value of specific configuration option

param: string $option_name
param: mixed $value
return: boolean

get_object_by_manager_and_id($object_id, $manager_class)   X-Ref
This function will return object by the manager class and object ID

param: integer $object_id
param: string $manager_class
return: ApplicationDataObject



Generated: Tue Sep 25 23:40:09 2007 Cross-referenced by PHPXref 0.7