Platform  3.1
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
refreshDocuments.php File Reference

Go to the source code of this file.

Namespaces

namespace  FDL
 

Functions

 color_failure ($msg)
 
 color_success ($msg)
 
 color_warning ($msg)
 

Variables

global $action
 
 $usage = new ApiUsage()
 
 $famId = $usage->addNeeded("famid", "the family identificator used to filter")
 
 $method = $usage->addOption("method", "method to use)", array() , "refresh")
 
 $arg = $usage->addOption("arg", "optional method argument to set when calling method")
 
 $revision
 
 $docid = $usage->addOption("docid", "use only for this document id")
 
 $start = $usage->addOption("start", "start from offset", array() , 0)
 
 $slice = $usage->addOption("slice", "limit from offset", array() , "all")
 
 $fldid = $usage->addOption("fldid", "use collection id to limit search")
 
 $filter = $usage->addOption("filter", "sql filter to limit search")
 
 $save
 
 $allrev = ($revision == "yes")
 
 $dbaccess = $action->getParam("FREEDOM_DB")
 
if($dbaccess=="") $famtitle = ""
 
if($famId) $s = new SearchDoc($dbaccess, $famId)
 
$s orderby = 'id desc'
 
$s slice = $slice
 
$s start = $start
 
if($s->searchError()) $targ = array()
 
 $card = $s->count()
 
 $ret = ""
 

Function Documentation

color_failure (   $msg)

Definition at line 24 of file refreshDocuments.php.

color_success (   $msg)

Definition at line 30 of file refreshDocuments.php.

color_warning (   $msg)

Definition at line 36 of file refreshDocuments.php.

Variable Documentation

global $action

Definition at line 19 of file refreshDocuments.php.

$allrev = ($revision == "yes")

Definition at line 63 of file refreshDocuments.php.

$arg = $usage->addOption("arg", "optional method argument to set when calling method")

Definition at line 46 of file refreshDocuments.php.

$card = $s->count()

Definition at line 117 of file refreshDocuments.php.

$dbaccess = $action->getParam("FREEDOM_DB")

Definition at line 64 of file refreshDocuments.php.

$docid = $usage->addOption("docid", "use only for this document id")

Definition at line 51 of file refreshDocuments.php.

$famId = $usage->addNeeded("famid", "the family identificator used to filter")

Definition at line 44 of file refreshDocuments.php.

if ($dbaccess=="") $famtitle = ""

Definition at line 70 of file refreshDocuments.php.

$filter = $usage->addOption("filter", "sql filter to limit search")

Definition at line 55 of file refreshDocuments.php.

$fldid = $usage->addOption("fldid", "use collection id to limit search")

Definition at line 54 of file refreshDocuments.php.

$method = $usage->addOption("method", "method to use)", array() , "refresh")

Definition at line 45 of file refreshDocuments.php.

$ret = ""

Definition at line 120 of file refreshDocuments.php.

Initial value:
= $usage->addOption("revision", "use all revision", array(
"yes",
"no"
) , "no")

Definition at line 47 of file refreshDocuments.php.

if ($famId) $s = new SearchDoc($dbaccess, $famId)

Definition at line 83 of file refreshDocuments.php.

$save
Initial value:
= $usage->addOption("save", "store mode", array(
"complete",
"light",
"none"
) , "light")

Definition at line 56 of file refreshDocuments.php.

$slice = $usage->addOption("slice", "limit from offset", array() , "all")

Definition at line 53 of file refreshDocuments.php.

$start = $usage->addOption("start", "start from offset", array() , 0)

Definition at line 52 of file refreshDocuments.php.

if ($s->searchError()) $targ = array()

Definition at line 115 of file refreshDocuments.php.

$usage = new ApiUsage()

Definition at line 42 of file refreshDocuments.php.

$s orderby = 'id desc'

Definition at line 85 of file refreshDocuments.php.

$s slice = $slice

Definition at line 86 of file refreshDocuments.php.

$s start = $start

Definition at line 87 of file refreshDocuments.php.

← centre documentaire © anakeen - published under CC License - Dynacase