eGroupWare 1.2.106-2 : Vue détaillée de class.boinfolog.inc.php

This class is the BO-layer of InfoLog, it also handles xmlrpc requests

boinfolog($info_id = 0,$instanciate_link=true) X-Ref

Constructor Infolog BO

param: int $info_id
param: boolean $instanciate_link=true should the link class be instanciated, used by the link-registry to prevent infinit recursion

has_customfields($typ) X-Ref

checks if there are customfields for typ $typ

param: string $typ
return: boolean True if there are customfields for $typ, else False

check_access( $info,$required_rights ) X-Ref

check's if user has the requiered rights on entry $info_id

param: int/array $info data or info_id of infolog entry to check
param: int $required_rights EGW_ACL_{READ|EDIT|ADD|DELETE}
return: boolean

init() X-Ref

init internal data to be empty

link_id2from(&$info,$not_app='',$not_id='') X-Ref

convert a link_id value into an info_from text

param: array &$info infolog entry, key info_from gets set by this function
param: string $not_app='' app to exclude
param: string $not_id='' id to exclude
return: boolean True if we have a linked item, False otherwise

subject_from_des($des) X-Ref

Create a subject from a description: truncate it and add ' ...'

read($info_id,$run_link_id2from=true) X-Ref

Read an infolog entry specified by $info_id

param: int/array $info_id integer id or array with key 'info_id' of the entry to read
param: boolean $run_link_id2from=true should link_id2from run, default yes,
return: array/boolean infolog entry or False if not found or no permission to read it

delete($info_id,$delete_children=False,$new_parent=False) X-Ref

Delete an infolog entry, evtl. incl. it's children / subs

param: int/array $info_id int id or array with keys 'info_id', 'delete_children' and 'new_parent' setting all 3 params
param: boolean $delete_children should the children be deleted
param: int/boolean $new_parent parent to use for not deleted children if > 0
return: boolean True if delete was successful, False otherwise ($info_id does not exist or no rights)

write(&$values,$check_defaults=True,$touch_modified=True) X-Ref

writes the given $values to InfoLog, a new entry gets created if info_id is not set or 0

checks and asures ACL

param: array &$values values to write, if contains values for check_defaults and touch_modified,
param: boolean $check_defaults=true check and set certain defaults
param: boolean $touch_modified=true touch the modification data and sets the modiefier's user-id
return: int/boolean info_id on a successfull write or false

anzSubs( $info_id ) X-Ref

Query the number of children / subs

param: int $info_id id
return: int number of subs

search(&$query) X-Ref

searches InfoLog for a certain pattern in $query

param: $query[order] column-name to sort after
param: $query[sort] sort-order DESC or ASC
param: $query[filter] string with combination of acl-, date- and status-filters, eg. 'own-open-today' or ''
param: $query[cat_id] category to use or 0 or unset
param: $query[search] pattern to search, search is done in info_from, info_subject and info_des
param: $query[action] / $query[action_id] if only entries linked to a specified app/entry show be used
param: &$query[start], &$query[total] nextmatch-parameters will be used and set if query returns less entries
param: $query[col_filter] array with column-name - data pairs, data == '' means no filter (!)
return: array with id's as key of the matching log-entries

search_link($location) X-Ref

Hook called by link-class to include infolog in the appregistry of the linkage

param: array/string $location location and other parameters (not used)
return: array with method-names

link_title( $info ) X-Ref

get title for an infolog entry identified by $info

Is called as hook to participate in the linking

param: int/array $info int info_id or array with infolog entry
return: string the title

link_query( $pattern ) X-Ref

query infolog for entries matching $pattern

Is called as hook to participate in the linking

param: string $pattern pattern to search
return: array with info_id - title pairs of the matching entries

cal_to_include($args) X-Ref

hook called be calendar to include events or todos in the cal-dayview

param: int $args[year], $args[month], $args[day] date of the events
param: int $args[owner] owner of the events
param: string $args[location] calendar_include_{events|todos}
return: array of events (array with keys starttime, endtime, title, view, icon, content)

list_methods($_type='xmlrpc') X-Ref

handles introspection or discovery by the logged in client,
in which case the input might be an array. The server always calls
this function to fill the server dispatch map using a string.

param: string $_type='xmlrpc' xmlrpc or soap
return: array

data2xmlrpc($data) X-Ref

Convert an InfoLog entry into its xmlrpc representation, eg. convert timestamps to datetime.iso8601

param: array $data infolog entry
param: array xmlrpc infolog entry

xmlrpc2data($data) X-Ref

Convert an InfoLog xmlrpc representation into the internal one, eg. convert datetime.iso8601 to timestamps

param: array $data infolog entry
param: array xmlrpc infolog entry

categories($complete = False) X-Ref

return array with all infolog categories (for xmlrpc)

param: boolean $complete true returns array with all data for each cat, else only the title is returned
return: array with cat_id / title or data pairs (see above)

pm_icons($args) X-Ref

Returm InfoLog (custom) status icons for projectmanager

param: array $args array with id's in $args['infolog']
return: array with id => icon pairs

Poids:	923 lignes (30 kb)
Inclus ou requis:	6 fois
Référencé:	0 fois
Nécessite:	1 fichier infolog/inc/class.soinfolog.inc.php

Code source de eGroupWare 1.2.106-2

/infolog/inc/ -> class.boinfolog.inc.php (sommaire)

Définit 1 class