contenido\includes\api\functions.api.general.php

Show: PublicProtectedPrivateinherited
Table of Contents
Project: Contenido Content Management System

Description: Contenido General API functions

Requirements:

Author
Timo A. Hummel  
Con_php_req
5.0  
Copyright
four for business AG  
License
http://www.contenido.org/license/LIZENZ.txt  
Link
http://www.4fb.de  
Link
http://www.contenido.org  
Package
Contenido Backend includes  
Since
file available since contenido release <= 4.6 {@internal created 2003-09-01 modified 2008-06-25, Frederic Schneider, add security fix modified 2009-10-27, Murat Purc, initialization of variable $error to prevent PHP strict messages modified 2010-05-20, Murat Purc, standardized Contenido startup and security check invocations, see [#CON-307] $Id: functions.api.general.php 1157 2010-05-20 14:10:43Z xmurrix $: }}  
Version
1.0.2  

Constants

>VConstant  PATH_SEPARATOR = substr(PHP_OS, 0, 3) == 'WIN' ? ';' : ':'
>VConstant  DIRECTORY_SEPARATOR = substr(PHP_OS, 0, 3) == 'WIN' ? '\\' : '/'

Functions

functioncInclude( $where,  $what,  $force = false) : \none

cInclude: Shortcut to contenido_include.

Parameters
NameTypeDescription
$where

string The area which should be included

$what

string The filename of the include

$force

boolean If true, force the file to be included

Returns
TypeDescription
\none
Details
See
\global\contenido_include  
functioncontenido_include( $where,  $what,  $force = false,  $returnpath = false) : \none

contenido_include: Includes a file and takes care of all path transformations.

Example: contenido_include("classes", "class.backend.php");

Currently defined areas:

frontend Path to the current frontend conlib Path to conlib pear Path to the bundled pear copy classes Path to the contenido classes cronjobs Path to the cronjobs external Path to the external tools includes Path to the contenido includes scripts Path to the contenido scripts

NOTE: Since Contenido (since v 4.8.17) provides autoloading of required class files, there is no need to load Contenido class files of by using cInclude().

Parameters
NameTypeDescription
$where

string The area which should be included

$what

string The filename of the include

$force

boolean If true, force the file to be included

$returnpath

$string or boolean false if file is not found

Returns
TypeDescription
\none
functionplugin_include( $where,  $what) : \none

plugin_include: Includes a file from a plugin and takes care of all path transformations.

Example: plugin_include("formedit", "classes/class.formedit.php");

Parameters
NameTypeDescription
$where
$what

string The filename of the include

Returns
TypeDescription
\none
Documentation was generated by phpDocumentor 2.0.0a12.