Core  3.2
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
Deprecated List
Global _IGROUPUSER::getWuser ($nocache=false)
use getAccount instead
Returns
Account return false if not found
Global Account::CheckLogin ($login, $unused, $whatid)
use SearchAccount class instead
Parameters
string$login
string$unused
int$whatid
Returns
bool
Global Account::setAdminHtpasswd ($admin_passwd)
use Account::setSupervisorHtpasswd instead
See Also
Account::setSupervisorHtpasswd
Global Account::setLogin ($login, $unused= '0')
use setLoginName instead
Returns
bool true if ok
Global Account::setUsers ($fid, $lname, $fname, $expires, $passdelay, $login, $status, $pwd1, $pwd2, $unused= '', $extmail= '')
replace by updateUser
Parameters
int$fiddocument id
string$loginlogin
Global AccountCollection::postModify ()
use postStore() instead
Returns
string
Global Action::getImageUrl ($name, $detectstyle=true, $size=null)
use Application::getImageLink instead
Global ApiUsage::addEmpty ($argName, $argDefinition="")
use ApiUsage::addEmptyParameter instead
Global ApiUsage::addHidden ($argName, $argDefinition)
use ApiUsage::addHiddenParameter instead
Global ApiUsage::addNeeded ($argName, $argDefinition, array $restriction=null)
use ApiUsage::addRequiredParameter instead
Global ApiUsage::addOption ($argName, $argDefinition, array $restriction=null, $default=null)
use ApiUsage::addOptionParameter instead
Parameters
string$argNameargument name
string$argDefinitionargument définition
array$restrictionoptional enumeration for argument
string$defaultdefault value if no value set
Global ApiUsage::setText ($text)
use ApiUsage::setDefinitionText instead
Returns
void setText
Global ApiUsage::strict ($strict=true)
use Application::setStrictMode instead
Global Application::$access_free

Global Application::$machine

Global Application::$objectclass

Global Application::$ssl

Global Application::getImageUrl ($img, $detectstyle=true, $size=null)
use Application::getImageLink instead
Global Archiving::postModify ()
use postStore() instead
Returns
string
Global base64_decodefile ($filename)
use Dcp::base64Decodefile instead
Global BasicAttribute::getXmlValue (Doc &$doc, $opt=false)
use class instead
Global cleanhtml ($html)
Global DbObj::autoUpdate ()
not used now
Returns
string
Global deleteContentDirectory ($dirname)
To delete (not used)
Global DetailSearch::postModify ()
use postStore() instead
Returns
string
Global Dir::AddFile ($docid, $mode="latest", $noprepost=false, $forcerestrict=false, $nocontrol=false)
use Dir::insertDocument instead
See Also
Dir::insertDocument
Global Dir::DelFile ($docid, $noprepost=false, $nocontrol=false)
use Dir::removeDocument instead
See Also
Dir::removeDocument
Global Dir::InsertMDoc ($tdocs, $mode="latest", $noprepost=false, &$tinserted=array(), &$twarning=array())
use Dir::InsertMultipleDocuments instead
See Also
insertMultipleDocuments::InsertMultipleDocuments
Global Dir::postInsertDoc ($docid, $multiple=false)
hook use Dir::postInsertDocument instead
Global Dir::postMInsertDoc ($tdocid)
hook use {::postInsertMultipleDocuments} instead
Global Dir::postModify ()
use postStore() instead
Returns
string
Global Dir::postUnlinkDoc ($docid, $multiple=false)
hook use Doc::postRemoveDocument instead
Global Dir::preInsertDoc ($docid, $multiple=false)
hook use Dir::preInsertDocument instead
Global Dir::preUnlinkDoc ($docid, $multiple=false)
hook use Doc::preRemoveDocument instead
Global Doc::_array2val ($v, $br= '< BR >')
use Doc::arrayToRawValue instead
See Also
Doc::arrayToRawValue
Returns
string
Global Doc::_val2array ($v)
use instead {::rawValueToArray}
See Also
Doc::rawValueToArray
Parameters
string$vvalue
Returns
array
Global Doc::addComment ($comment= '', $level=DocHisto::INFO, $code= '', $uid= '')
use Doc::addHistoryEntry instead
See Also
Doc::addHistoryEntry
Returns
string error message
Global Doc::addRevision ($comment= '')
use Doc::revise instead
See Also
Doc::revise
Parameters
string$commentthe comment of the revision
Returns
string error text (empty if no error)
Global Doc::canUpdateDoc ()
use canEdit instead
Returns
string empty means user can update else message of the raison
Global Doc::copy ($temporary=false, $control=true, $linkfld=false, $copyfile=false)
use Doc::duplicate instead
See Also
Doc::duplicate
Parameters
bool$temporaryif true the document create it as temporary document
bool$controlif false don't control acl create (generaly use when temporary is true)
bool$linkfldif true and document is a folder then document included in folder are also inserted in the copy (are not duplicated) just linked
bool$copyfileif true duplicate files of the document
Returns
Doc in case of error return a string that indicate the error
Global Doc::deleteArray ($idAttr)
use Doc::clearArrayValues instead
See Also
Doc::clearArrayValues
Returns
string error message, if no error empty string
Global Doc::deleteValue ($attrid)
use Doc::clearValue instead
See Also
Doc::clearValue
Returns
string error message
Global Doc::editoptcard ($target="_self", $ulink=true, $abstract=false)
option attributes are not supported
Parameters
string$target
bool$ulink
bool$abstract
Returns
void
Global Doc::getAValues ($idAttr, $index=-1)
use Doc::getArrayRawValues instead
See Also
Doc::getArrayRawValues
Parameters
string$idAttridentifier of array attribute
int$indexthe values for $index row (default value -1 means all values)
Returns
array all values of array order by rows (return false if not an array attribute)
Global Doc::getFamDoc ()
use Doc::getFamilyDocument instead
See Also
Doc::getFamilyDocument
Returns
DocFam
Global Doc::getOldValue ($attrid)
use Doc::getOldRawvalue
See Also
Doc::getOldRawValue
Parameters
string$attridattribute identifier
Returns
string the old value (false if not modified before)
Global Doc::getOldValues ()
use Doc::getOldRawValues instead
See Also
Doc::getOldRawValues
Returns
array indexed by attribute identifier (lowercase)
Global Doc::getParam ($param, $defv="")
use instead getParam global function or parameterManager
See Also
Doc::parameterManager
Parameters
string$paramparameter
string$defvdefault return value
Returns
string returns parameter value ou default value
Global Doc::getParamValue ($idp, $def="")
use Doc::getFamilyParameterValue instead
See Also
Doc::getFamilyParameterValue
Parameters
string$idpparameter identifier
string$defdefault value if parameter not found or if it is null
Returns
string parameter value
Global Doc::getProperty ($prop)
use Doc::getPropertyValue instead
See Also
Doc::getPropertyValue
Parameters
string$propproperty identifier
Returns
string false if not an property
Global Doc::getSpecTitle ()
This hook may be replaced by getCustomTitle in the the next version. this method can be redefined in child family to compose specific title
Global Doc::getTValue ($idAttr, $def="", $index=-1)
use Doc::getMultipleRawValues instead
Parameters
string$idAttridentifier of list attribute
string$defdefault value returned if attribute not found or if is empty
int$indexthe values for $index row (default value -1 means all values)
See Also
Doc::getMultipleRawValues
Returns
array the list of attribute values
Global Doc::getValue ($idAttr, $def="")
use Doc::getRawValue instead
Parameters
string$idAttrattribute identifier
string$defdefault value returned if attribute not found or if is empty
See Also
Doc::getRawValue
Returns
string the attribute value
Global Doc::getWhatUserId ()
use getSystemUserId instead
Returns
int
Global Doc::latestId ($fixed=false, $forcequery=false)
use Doc::getLatestId instead
Parameters
bool$fixedif true latest fixed revision
bool$forcequeryif true force recompute of id (use it in case of modification by another program)
See Also
Doc::getLatestId
Returns
int identifier of latest revision
Global Doc::postCopy (&$copyfrom)
use Doc::postDuplicate hook instead
See Also
Doc::postDuplicate
Parameters
Doc$copyfrom
Returns
string
Global Doc::postModify ()
hook use Doc::postStore instead
See Also
Doc::postStore
Returns
string error message
Global Doc::postRevive ()
hook use Doc:::postUndelete instead
See Also
Doc::postUndelete
Returns
string warning message, if no warning empty string
Global Doc::preCopy (&$copyfrom)
hook use Doc::preDuplicate instead
See Also
Doc::preDuplicate
Parameters
Doc$copyfrom
Returns
string
Global Doc::preRevive ()
hook use Doc:::preUndelete instead
See Also
Doc::preUndelete
Returns
string error message, if no error empty string
Global Doc::ReallyDelete ($nopost)
use Doc::delete instead
See Also
Doc::delete
Parameters
bool$nopostset to true if no need tu call postDelete methods
Returns
string error message, if no error empty string
Global Doc::refreshDocTitle ($nameId, $nameTitle)
not needed until 2.0 version
Parameters
string$nameId
$nameTitle
Global Doc::revive ()
use Doc::undelete instead
Returns
string error message (empty message if no errors);
Global Doc::save (&$info=null, $skipConstraint=false)
use ::store() instead
Returns
string error message
Global Doc::setLogicalIdentificator ($name, $reset=false)
use ::setLogicalName instead
Returns
string error message if cannot be
Global Doc::specRefresh ()
This hook may be replaced by preRefresh in the the next version.
See Also
Doc::refresh
Global Doc::storeFile ($attrid, $filename, $ftitle="", $index=-1)
use setFile() instead
Global Doc::storeFiles ($attrid, $filenames, $ftitle="")
use setFile() instead
Global Doc::todtd ()
use exportXml instead
Returns
string
Global Doc::toxml ($withdtd=false, $id_doc="")
use exportXml instead
Parameters
bool$withdtd
string$id_doc
Returns
string
Global Doc::viewoptcard ($target="_self", $ulink=true, $abstract=false)
option attributes are not supported
Parameters
string$target
bool$ulink
bool$abstract
Returns
void
Global DocFam::getParamValue ($idp, $def="")
use Doc::getParameterRawValue instead
See Also
Doc::getParameterRawValue
Parameters
string$idpparameter identifier
string$defdefault value if parameter not found or if it is null
Returns
string parameter value
Class DocFile
only need for migrated
Global DocPerm::ControlG ($pos)
no need now. Control process has changed
Returns
bool
Global DocumentList::addDocumentIdentificators (array $ids, $useInitid=true)
use addDocumentIdentifiers instead
Global ExportDocument::cvsExport ( &$doc, &$ef, $fout, $wprof, $wfile, $wident, $wutf8, $nopref, $eformat)
rename to csvExport
Global extractFileFromXmlDocument ($file)
use DcpextractFileFromXmlDocument
Global extractFilesFromXmlDirectory ($splitdir)
DcpextractFilesFromXmlDirectory
Returns
string
Namespace FDL

since HTTP Authentification

since HTTP Authentification

since HTTP Authentification

Class Fdl_Mail_mime
use instead
Global FieldSetAttribute::getXmlValue (Doc &$doc, $opt=false)
use class instead
Global formatErrorLogException ($e)
use DcpformatErrorLogException()
Returns
string
Global getAuthParam ($freedomctx="", $provider="")
Global getAuthProvider ($freedomctx="")
Returns
string
Global getAuthProviderList ($freedomctx="")
Returns
array
Global getAuthType ($freedomctx="")
Returns
string
Global getAuthTypeParams ($freedomctx="")
Parameters
string$freedomctx,</dd>
Global getChildDoc ($dbaccess, $dirid, $start="0", $slice="ALL", $sqlfilters=array(), $userid=1, $qtype="LIST", $fromid="", $distinct=false, $orderby="title", $latest=true, $trash="", &$debug=null, $folderRecursiveLevel=2, $join= '', &$searchDoc=null)
use SearchDoc instead
See Also
SearchDoc
Returns
array/Doc
Global getDbEnv ()
context notion are be deleted
Returns
string
Global getFreedomContext ()
context notion are be deleted
Returns
string
Global GroupAccount::postModify ()
use postStore() instead
Returns
string
Global importXmlDirectory ($dbaccess, $splitdir, $opt)
use DcpimportXmlDirectory instead
Returns
array
Global Layout::setEncoding ($enc)
not need always utf-8
Global lenumvalues ($enum, $val="")
replaced by fdlGetEnumValues
Returns
array/string*2 array of (enum, enum)
Global lfamilly ($dbaccess, $famid, $name="", $dirid=0, $filter=array(), $idid="id")
use lfamily instead
Parameters
$dbaccess
$famid
string$name
int$dirid
array$filter
string$idid
Returns
mixed
Global NormalAttribute::getXmlValue (Doc &$doc, $opt=false)
use class intead
Global PARAM_APP
use Param::PARAM_APP instead
Global PARAM_GLB
use Param::PARAM_GLB instead
Global PARAM_STYLE
use Param::PARAM_STYLE instead
Global PARAM_USER
use Param::PARAM_USER instead
Class ParameterManager
use ApplicationParameterManager instead
Global ParameterManager::getApplicationParameter ($appName, $name)
use ApplicationParameterManager instead
Parameters
string$appNameapplication name
string$nameparamter
Returns
string|null value of parameter (null if parameter not exists)
Global ParameterManager::getParameter ($name)
use ApplicationParameterManager instead
Global ParameterManager::resetCache ()
use ApplicationParameterManager instead
Global ParameterManager::setApplicationParameter ($appName, $name, $value)
use ApplicationParameterManager instead
Parameters
string$appNameapplication name
string$nameparameter name
string$valuenew value to set
Exceptions
Dcp\PMGT\Exception
Global ParameterManager::setGlobalParameter ($name, $value)
use ApplicationParameterManager instead
Parameters
string$nameparameter name
string$valuenew value to set
Exceptions
Dcp\PMGT\Exception
Global ParameterManager::setGlobalUserParameter ($name, $value, $userId=null)
use ApplicationParameterManager instead
Parameters
string$nameparameter name (must be declared as user and global)
string$valuenew value to set
int$userIduser account identificator (if null use current user)
Exceptions
Dcp\PMGT\Exception
Global ParameterManager::setUserApplicationParameter ($appName, $name, $value, $userId=null)
use ApplicationParameterManager instead
Parameters
string$appNameapplication name
string$nameparameter name (must be declared as user)
string$valuenew value to set
int$userIduser account identificator (if null use current user)
Exceptions
Dcp\PMGT\Exception
Global PHPMailer::encodeQPphp ($string, $line_max=76, $space_conv=false)
Use encodeQP instead.
Global recordStatus (Action &$action, $exportId, $msg, $endStatus=false)
use DcprecordStatus() instead
Global SearchAccount::docName2login ($name)
use SearchAccount::getLoginFromDocName instead
See Also
SearchAccount::getLoginFromDocName
Global SearchAccount::setObjectReturn ($type)
use SearchAccount::setReturnType instead
See Also
SearchAccount::setReturnType
Global SearchAccount::useViewControl ($control=true)
use SearchAccount::overrideViewControl instead. Be carefull: this is the opposite!
See Also
SearchAccount::overrideViewControl
Global SearchDoc::getDebugInfo ()
use getSearchInfo instead
Global SearchDoc::nextDoc ()
use Application::getNextDoc instead
Global SearchDoc::noViewControl ()
use SearchDoc::overrideViewControl instead
Returns
void
Global SearchDoc::setDebugMode ($debug=true)
no debug mode setting are necessary
Returns
void
Global SearchDoc::setValueReturn ()
use setObjectReturn(false) instead
Returns
void
Global splitXmlDocument ($xmlfiles, $splitdir)
use DcpsplitXmlDocument
Global splitZipXmlDocument ($zipfiles, $splitdir)
use Dcp::unZipXmlDocument
Class Table
not necessary and not used now
Global toIso8601 ($fdate, $wtz=false)
use stringDateToIso() instead
Class User
use Account Class instead
Global UserAccount::postModify ()
use postStore() instead
Returns
string
Global VaultDiskStorage::GetEngineObject ($te_name, &$ngf)
no usage
Exceptions
\Dcp\Db\Exception
Global WDoc::getAction ($state, $def="")
use getActivity instead
Parameters
string$statethe state
string$defdefault value if not set
Returns
string the text of action
← centre documentaire © anakeen