[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

/include/ -> class.filter.php (summary)

(no description)

File Size: 694 lines (31 kb)
Included or required: 6 times
Referenced: 0 times
Includes or requires: 4 files
 include/class.date.php
 include/class.misc.php
 include/class.auth.php
 include/class.error_handler.php

Defines 1 class

Filter:: (11 methods):
  isGlobal()
  isOwner()
  save()
  getFilterID()
  getAssocList()
  getListing()
  buildOptions()
  getDetails()
  remove()
  removeByProjects()
  getFiltersInfo()


Class: Filter  - X-Ref

Class to handle the business logic related to the custom filters.

isGlobal($cst_id)   X-Ref
Method used to check whether the given custom filter is a
global one or not.

param: integer $cst_id The custom filter ID
return: boolean

isOwner($cst_id, $usr_id)   X-Ref
Method used to check whether the given user is the owner of the custom
filter ID.

param: integer $cst_id The custom filter ID
param: integer $usr_id The user ID
return: boolean

save()   X-Ref
Method used to save the changes made to an existing custom
filter, or to create a new custom filter.

return: integer 1 if the update worked properly, any other value otherwise

getFilterID($cst_title)   X-Ref
Method used to get the filter ID associated with a specific
filter title.

param: string $cst_title The custom filter title
return: integer The custom filter ID

getAssocList()   X-Ref
Method used to get an associative array of the full list of
custom filters (filter id => filter title) associated with the
current user and the current 'active' project.

return: array The full list of custom filters

getListing($build_url = false)   X-Ref
Method used to get an array of the full list of the custom
filters associated with the current user and the current
'active' project.

param: boolean $build_url If a URL for this filter should be constructed.
return: array The full list of custom filters

buildOptions($details, $info)   X-Ref
Takes the saved search details and information about filters and returns an array of
of the saved search information.

param: array $details An array of information about the saved search, usually the direct row from the database.
param: array $info An array of information about filters
return: array An array of information about the saved search.

getDetails($cst_id, $check_perm = TRUE)   X-Ref
Method used to get an associative array of the full details of
a specific custom filter.

param: integer $cst_id The custom filter ID
param: boolean $check_perm Whether to check for the permissions or not
return: array The custom filter details

remove()   X-Ref
Method used to remove specific custom filters.

return: integer 1 if the removals worked properly, any other value otherwise

removeByProjects($ids)   X-Ref
Method used to remove all custom filters associated with some
specific projects.

param: array $ids List of projects to remove from
return: boolean Whether the removal worked properly or not

getFiltersInfo()   X-Ref
Returns an array of information about all the different filter fields.

return: Array an array of information.



Generated: Wed Dec 19 21:21:33 2007 Cross-referenced by PHPXref 0.7