[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] notes/inc class.ipc_notes.inc.php, 1.2 class.uinotes.
|
From: |
powerstat |
|
Subject: |
[Phpgroupware-cvs] notes/inc class.ipc_notes.inc.php, 1.2 class.uinotes.inc.php, 1.35 hook_help.inc.php, 1.2 class.sonotes.inc.php, 1.13 class.bonotes.inc.php, 1.25 hook_preferences.inc.php, 1.24 hook_admin.inc.php, 1.9 hook_deleteaccount.inc.php, 1.3 |
|
Date: |
Thu, 28 Apr 2005 20:33:00 +0200 |
Update of notes/inc
Modified Files:
Branch: MAIN
class.ipc_notes.inc.php lines: +33 -30
class.uinotes.inc.php lines: +15 -16
hook_help.inc.php lines: +12 -11
class.sonotes.inc.php lines: +16 -16
class.bonotes.inc.php lines: +16 -16
hook_preferences.inc.php lines: +9 -13
hook_admin.inc.php lines: +9 -12
hook_deleteaccount.inc.php lines: +8 -12
Log Message:
Added phpdocs
====================================================
Index: notes/inc/class.ipc_notes.inc.php
diff -u notes/inc/class.ipc_notes.inc.php:1.1
notes/inc/class.ipc_notes.inc.php:1.2
--- notes/inc/class.ipc_notes.inc.php:1.1 Tue Dec 23 16:17:35 2003
+++ notes/inc/class.ipc_notes.inc.php Thu Apr 28 18:33:52 2005
@@ -1,26 +1,29 @@
<?php
/**
- * IPC Layer
+ * Notes IPC Layer
*
- * @author Dirk Schaller <address@hidden>
- * @copyright Copyright (C) 2003 Free Software Foundation http://www.fsf.org/
- * @license http://www.fsf.org/licenses/gpl.html GNU General Public License
- * @package phpgwapi
- * @subpackage ipc
- * @version $Id$
+ * @author Dirk Schaller <address@hidden>
+ * @copyright Copyright (C) 2003,2005 Free Software Foundation
http://www.fsf.org/
+ * @license http://www.fsf.org/licenses/gpl.html GNU General Public License
+ * @package notes
+ * @subpackage ipc
+ * @version $Id$
*/
+// require_once(PHPGW_API_INC . 'class.ipc_.inc.php');
+
/**
* Fassade of the notes application.
*
- * @package notes
+ * @package notes
+ * @subpackage ipc
*/
class ipc_notes extends ipc_
{
/**
* Constructor
*
- * @access public
+ * @access public
*/
function ipc_notes()
{
@@ -30,10 +33,10 @@
/**
* Add data in a certain mime type format to the application.
*
- * @access public
- * @param mixed $data data for adding to the application, the
datatype depends on the mime type
- * @param string $type specifies the mime type of the passed data
- * @return integer id of the added data
+ * @access public
+ * @param mixed $data Data for adding to the application, the datatype
depends on the mime type
+ * @param string $type Specifies the mime type of the passed data
+ * @return integer ID of the added data
*/
function addData($data, $type)
{
@@ -52,11 +55,11 @@
/**
* Convert data from a mime type to another.
*
- * @access public
- * @param mixed $data data for converting, the datatype
depends on the input mime type
- * @param string $typeIn specifies the input mime type of the
passed data
- * @param string $typeOut specifies the output mime type of the
passed data
- * @return mixed converted data from application, the
datatype depends on the passed output mime type
+ * @access public
+ * @param mixed $data Data for converting, the datatype depends on the
input mime type
+ * @param string $typeIn Specifies the input mime type of the passed
data
+ * @param string $typeOut Specifies the output mime type of the passed
data
+ * @return mixed Converted data from application, the datatype depends
on the passed output mime type
*/
function convertData($data, $typeIn, $typeOut)
{
@@ -75,9 +78,9 @@
/**
* Get data from the application in a certain mime type format.
*
- * @param integer $id id of data to get from the application
- * @param string $type specifies the mime type of the returned data
- * @return mixed data from application, the datatype depends
on the passed mime type, false if no data exists for the passed id
+ * @param integer $id ID of data to get from the application
+ * @param string $type Specifies the mime type of the returned data
+ * @return mixed Data from application, the datatype depends on the
passed mime type, false if no data exists for the passed id
*/
function getData($id, $type)
{
@@ -96,8 +99,8 @@
/**
* Remove data of the passed id.
*
- * @param integer $id id of data to remove from the application
- * @return boolean true if the data is removed, otherwise false
+ * @param integer $id ID of data to remove from the application
+ * @return boolean True if the data is removed, otherwise false
*/
function removeData($id)
{
@@ -116,10 +119,10 @@
/**
* Replace the existing data of the passed id with the passed data in a
certain mime type format.
*
- * @param integer $id id of data to replace
- * @param mixed $data the new data, the datatype depends on the
passed mime type
- * @param string $type specifies the mime type of the passed data
- * @return boolean true if the data is replaced, otherwise
false
+ * @param integer $id ID of data to replace
+ * @param mixed $data The new data, the datatype depends on the passed
mime type
+ * @param string $type Specifies the mime type of the passed data
+ * @return boolean True if the data is replaced, otherwise false
*/
function replaceData($id, $data, $type)
{
@@ -149,12 +152,12 @@
/**
* Checks if data for the passed id exists.
*
- * @param integer $id id to check
- * @return boolean true if the data with id exist, otherwise
false
+ * @param integer $id ID to check
+ * @return boolean True if the data with id exist, otherwise false
*/
function existData($id)
{
- // i dont know what we need to check? you want to ckeck for a
note with identically content? (ceb)
+ // I don't know what we need to check? You want to check for a
note with identically content? (ceb)
// workaround: sonotes doesn't support a method for check
// --> sql query
$sql = "SELECT * FROM phpgw_notes WHERE note_id=".intval($id);
====================================================
Index: notes/inc/class.uinotes.inc.php
diff -u notes/inc/class.uinotes.inc.php:1.34
notes/inc/class.uinotes.inc.php:1.35
--- notes/inc/class.uinotes.inc.php:1.34 Tue Jan 18 23:52:13 2005
+++ notes/inc/class.uinotes.inc.php Thu Apr 28 18:33:52 2005
@@ -1,20 +1,19 @@
<?php
-
/**************************************************************************\
- * phpGroupWare - Notes
*
- * http://www.phpgroupware.org
*
- * Written by : Bettina Gille address@hidden *
- * Based on notes by Andy Holman (LoCdOg)
*
- *
------------------------------------------------------------------------ *
- * Copyright 2000 - 2003 Free Software Foundation, Inc
*
- * This program is part of the GNU project, see http://www.gnu.org/
*
- *
------------------------------------------------------------------------ *
- * This program is free software; you can redistribute it and/or modify
it *
- * under the terms of the GNU General Public License as published by the
*
- * Free Software Foundation; either version 2 of the License, or (at
your *
- * option) any later version.
*
-
\**************************************************************************/
- /* $Id$ */
-
+ /**
+ * Notes
+ * @author Andy Holman
+ * @author Bettina Gille address@hidden
+ * @copyright Copyright (C) 2000-2003,2005 Free Software Foundation,
Inc. http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package notes
+ * @version $Id$
+ */
+
+ /**
+ * Notes GUI class
+ *
+ * @package notes
+ */
class uinotes
{
var $grants;
====================================================
Index: notes/inc/hook_help.inc.php
diff -u notes/inc/hook_help.inc.php:1.1 notes/inc/hook_help.inc.php:1.2
--- notes/inc/hook_help.inc.php:1.1 Tue Dec 24 01:43:38 2002
+++ notes/inc/hook_help.inc.php Thu Apr 28 18:33:52 2005
@@ -1,16 +1,17 @@
<?php
-
/**************************************************************************\
- * phpGroupWare - help system
*
- * http://www.phpgroupware.org
*
- * --------------------------------------------
*
- * This program is free software; you can redistribute it and/or modify
it *
- * under the terms of the GNU General Public License as published by
the *
- * Free Software Foundation; either version 2 of the License, or (at
your *
- * option) any later version.
*
-
\**************************************************************************/
- /* $Id$ */
+ /**
+ * Notes - help system
+ * @author Bettina Gille address@hidden
+ * @copyright Copyright (C) 2000-2002,2005 Free Software Foundation,
Inc. http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package notes
+ * @version $Id$
+ */
- include(PHPGW_SERVER_ROOT.'/'.'notes'.'/setup/setup.inc.php');
+ /**
+ * Include notes setup
+ */
+ include(PHPGW_SERVER_ROOT . '/notes/setup/setup.inc.php');
$GLOBALS['phpgw']->help->set_params(array('app_name' =>
'notes',
'title' => lang('notes'),
====================================================
Index: notes/inc/class.sonotes.inc.php
diff -u notes/inc/class.sonotes.inc.php:1.12
notes/inc/class.sonotes.inc.php:1.13
--- notes/inc/class.sonotes.inc.php:1.12 Tue Dec 23 16:17:35 2003
+++ notes/inc/class.sonotes.inc.php Thu Apr 28 18:33:52 2005
@@ -1,20 +1,20 @@
<?php
-
/**************************************************************************\
- * phpGroupWare - Notes
*
- * http://www.phpgroupware.org
*
- * Written by : Bettina Gille address@hidden *
- * Based on notes by Andy Holman (LoCdOg)
*
- *
------------------------------------------------------------------------ *
- * Copyright 2000 - 2003 Free Software Foundation, Inc
*
- * This program is part of the GNU project, see http://www.gnu.org/
*
- *
------------------------------------------------------------------------ *
- * This program is free software; you can redistribute it and/or modify
it *
- * under the terms of the GNU General Public License as published by the
*
- * Free Software Foundation; either version 2 of the License, or (at
your *
- * option) any later version.
*
-
\**************************************************************************/
- /* $Id$ */
-
+ /**
+ * Notes
+ * @author Andy Holman
+ * @author Bettina Gille address@hidden
+ * @copyright Copyright (C) 2000-2003,2005 Free Software Foundation,
Inc. http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package notes
+ * @version $Id$
+ */
+
+
+ /**
+ * Notes storage object class
+ *
+ * @package notes
+ */
class sonotes
{
var $grants;
====================================================
Index: notes/inc/class.bonotes.inc.php
diff -u notes/inc/class.bonotes.inc.php:1.24
notes/inc/class.bonotes.inc.php:1.25
--- notes/inc/class.bonotes.inc.php:1.24 Tue Dec 23 16:17:35 2003
+++ notes/inc/class.bonotes.inc.php Thu Apr 28 18:33:52 2005
@@ -1,20 +1,20 @@
<?php
-
/**************************************************************************\
- * phpGroupWare - Notes
*
- * http://www.phpgroupware.org
*
- * Written by : Bettina Gille address@hidden *
- * Based on notes by Andy Holman (LoCdOg)
*
- *
------------------------------------------------------------------------ *
- * Copyright 2000 - 2003 Free Software Foundation, Inc
*
- * This program is part of the GNU project, see http://www.gnu.org/
*
- *
------------------------------------------------------------------------ *
- * This program is free software; you can redistribute it and/or modify
it *
- * under the terms of the GNU General Public License as published by the
*
- * Free Software Foundation; either version 2 of the License, or (at
your *
- * option) any later version.
*
-
\**************************************************************************/
- /* $Id$ */
-
+ /**
+ * Notes
+ * @author Andy Holman
+ * @author Bettina Gille address@hidden
+ * @copyright Copyright (C) 2000-2003,2005 Free Software Foundation,
Inc. http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package notes
+ * @version $Id$
+ */
+
+
+ /**
+ * Notes business object class
+ *
+ * @package notes
+ */
class bonotes
{
var $start;
====================================================
Index: notes/inc/hook_preferences.inc.php
diff -u notes/inc/hook_preferences.inc.php:1.23
notes/inc/hook_preferences.inc.php:1.24
--- notes/inc/hook_preferences.inc.php:1.23 Mon Nov 4 00:50:18 2002
+++ notes/inc/hook_preferences.inc.php Thu Apr 28 18:33:52 2005
@@ -1,25 +1,21 @@
<?php
-
/*************************************************************************\
- * phpGroupWare - Notes Preferences
*
- * http://www.phpgroupware.org
*
- * --------------------------------------------
*
- * This program is free software; you can redistribute it and/or modify
it *
- * under the terms of the GNU General Public License as published by the
*
- * Free Software Foundation; either version 2 of the License, or (at
your *
- * option) any later version.
*
-
\*************************************************************************/
- /* $Id$ */
+ /**
+ * Notes Preferences
+ * @author Bettina Gille address@hidden
+ * @copyright Copyright (C) 2000-2002,2005 Free Software Foundation,
Inc. http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package notes
+ * @version $Id$
+ */
{
// Only Modify the $file and $title variables.....
-
$file = Array
(
'Grant Access' =>
$GLOBALS['phpgw']->link('/index.php','menuaction=preferences.uiaclprefs.index&acl_app='.$appname),
'Edit categories' =>
$GLOBALS['phpgw']->link('/index.php','menuaction=preferences.uicategories.index&cats_app=notes&cats_level=True&global_cats=True')
);
-
-//Do not modify below this line
+// Do not modify below this line
display_section($appname,$file);
}
?>
====================================================
Index: notes/inc/hook_admin.inc.php
diff -u notes/inc/hook_admin.inc.php:1.8 notes/inc/hook_admin.inc.php:1.9
--- notes/inc/hook_admin.inc.php:1.8 Mon Jan 17 16:23:40 2005
+++ notes/inc/hook_admin.inc.php Thu Apr 28 18:33:52 2005
@@ -1,16 +1,13 @@
<?php
-
/**************************************************************************\
- * phpGroupWare
*
- * http://www.phpgroupware.org
*
- * Written by Joseph Engo <address@hidden> *
- * --------------------------------------------
*
- * This program is free software; you can redistribute it and/or modify
it *
- * under the terms of the GNU General Public License as published by
the *
- * Free Software Foundation; either version 2 of the License, or (at
your *
- * option) any later version.
*
-
\**************************************************************************/
- // $Id$
- // $Source$
+ /**
+ * Notes
+ * @author Joseph Engo <address@hidden>
+ * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc.
http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package notes
+ * @version $Id$
+ * @internal $Source$
+ */
{
$file = array
====================================================
Index: notes/inc/hook_deleteaccount.inc.php
diff -u notes/inc/hook_deleteaccount.inc.php:1.2
notes/inc/hook_deleteaccount.inc.php:1.3
--- notes/inc/hook_deleteaccount.inc.php:1.2 Tue Apr 30 01:09:13 2002
+++ notes/inc/hook_deleteaccount.inc.php Thu Apr 28 18:33:52 2005
@@ -1,16 +1,12 @@
<?php
- /**************************************************************************\
- * phpGroupWare *
- * http://www.phpgroupware.org *
- * Written by Mark Peters <address@hidden> *
- * -------------------------------------------- *
- * This program is free software; you can redistribute it and/or modify it *
- * under the terms of the GNU General Public License as published by the *
- * Free Software Foundation; either version 2 of the License, or (at your *
- * option) any later version. *
- \**************************************************************************/
-
- /* $Id$ */
+ /**
+ * Notes
+ * @author Mark Peters <address@hidden>
+ * @copyright Copyright (C) 2000-2002,2005 Free Software Foundation,
Inc. http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package notes
+ * @version $Id$
+ */
// Delete all records for a user
$table_locks = Array('phpgw_notes');
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Phpgroupware-cvs] notes/inc class.ipc_notes.inc.php, 1.2 class.uinotes.inc.php, 1.35 hook_help.inc.php, 1.2 class.sonotes.inc.php, 1.13 class.bonotes.inc.php, 1.25 hook_preferences.inc.php, 1.24 hook_admin.inc.php, 1.9 hook_deleteaccount.inc.php, 1.3,
powerstat <=
- Prev by Date:
[Phpgroupware-cvs] phpgwapi/inc class.schema_proc_mssql.inc.php, 1.7 class.log.inc.php, 1.9 class.schema_proc.inc.php, 1.12 class.setup.inc.php, 1.22
- Next by Date:
[Phpgroupware-cvs] bookmarks/inc hook_admin.inc.php, 1.10 class.ui.inc.php, 1.10 hook_bookmarks_about.inc.php, 1.5 class.bo.inc.php, 1.7 class.sqlquery.inc.php, 1.6 hook_preferences.inc.php, 1.20 class.so.inc.php, 1.5
- Previous by thread:
[Phpgroupware-cvs] phpgwapi/inc class.schema_proc_mssql.inc.php, 1.7 class.log.inc.php, 1.9 class.schema_proc.inc.php, 1.12 class.setup.inc.php, 1.22
- Next by thread:
[Phpgroupware-cvs] bookmarks/inc hook_admin.inc.php, 1.10 class.ui.inc.php, 1.10 hook_bookmarks_about.inc.php, 1.5 class.bo.inc.php, 1.7 class.sqlquery.inc.php, 1.6 hook_preferences.inc.php, 1.20 class.so.inc.php, 1.5
- Index(es):