API Documentation
\

\

Interfaces

formField
mfCategoryNodeInterface
mfIndexable
module
plugin

Classes

altLangField
backend
categoryNodes
categoryTrees
checkboxField
colorField
contact Classe de base Gérant les enregistrements de base de donnée
contacts
contactsPlugin
countriesFilter Base class managing simple forms without database recording of their values
dateField
dateTimeField
dbForm Base class managing simple forms without database recording of their values
dbManager Classe de base gérant les plugins
dbRecord Classe de base Gérant les enregistrements de base de donnée
event Classe de base Gérant les enregistrements de base de donnée
events
eventsPlugin
ExceptionThrower Utility for catching PHP errors and converting them to an exception that can be caught at runtime
fieldset
filesField
formsManager
franceFilter Base class managing simple forms without database recording of their values
frontend
hiddenField
htmlField
inputField
installToolLoginForm Base class managing simple forms without database recording of their values
l10nManager Classe de base Gérant les plugins
manageCountries
manageFrance
manageSearchIndex
mf
mfAuthentification
mfAuthentificationPlugin
mfCategoriesPlugin
mfCategoryNode Classe de base Gérant les enregistrements de base de donnée
mfCategoryTree Classe de base Gérant les enregistrements de base de donnée
mfColissimoFees Classe de base Gérant les enregistrements de base de donnée
mfCountry Classe de base Gérant les enregistrements de base de donnée
mfCountryDataPlugin
mfDepartement Classe de base Gérant les enregistrements de base de donnée
mfFrance Classe de base Gérant les enregistrements de base de donnée
mfSearchEnginePlugin
mfSearchIndex Classe de base Gérant les enregistrements de base de donnée
mfUser Classe de base Gérant les enregistrements de base de donnée
mfUserGroup Classe de base Gérant les enregistrements de base de donnée
mfUsersPlugin
microtemplateField
page Classe de base Gérant les enregistrements de base de donnée
pages
pagesPlugin
pluginManager Classe de base Gérant les plugins
portfolio
portfolioCategory Classe de base Gérant les enregistrements de base de donnée
portfolioItem Classe de base Gérant les enregistrements de base de donnée
portfolioPlugin
radioField
recordSelectField
richTextField
searchIndexer
searchIndexFilter Base class managing simple forms without database recording of their values
selectField
siteInfo Classe de base Gérant les enregistrements de base de donnée
siteInfosPlugin
templateDataField
templateNameField
textareaField
timeField
treeSelectorField
urlInputField
urlRewriter
urlRewriterPlugin
userGroups
users
usersForm Base class managing simple forms without database recording of their values
webSearch
welcome
welcomePlugin

Constants

HIGH_PRIORITY

HIGH_PRIORITY

LOOSE_PRIORITY

LOOSE_PRIORITY

LOW_PRIORITY

LOW_PRIORITY

MEDIUM_PRIORITY

MEDIUM_PRIORITY

TOP_PRIORITY

TOP_PRIORITY

Functions

addHttp()

addHttp(  $url) : string

Recognizes ftp://, ftps://, http:// and https:// in a case insensitive way and adds http:// prefix to the URL if missing

Parameters

$url

Returns

string

addHttpHost()

addHttpHost(  $url) : string

Recognizes ftp://, ftps://, http:// and https:// in a case insensitive way and adds 'http://'.$_SERVER['SERVER_NAME'] prefix to the URL if missing

Parameters

$url

Returns

string

addWrapper()

addWrapper(  $item1,   $key,   $wrapString)

Parameters

$item1
$key
$wrapString

array2Html()

array2Html(  $array,   $table = true)

Parameters

$array
$table

array_deep_copy()

array_deep_copy(  $array,   $copy,   $maxdepth = 50,   $depth)

Parameters

$array
$copy
$maxdepth
$depth

array_delete()

array_delete(  $array,   $element)

Parameters

$array
$element

array_merge_recursive_distinct()

array_merge_recursive_distinct(array  $array1, array  $array2) : array

array_merge_recursive does indeed merge arrays, but it converts values with duplicate keys to arrays rather than overwriting the value in the first array with the duplicate value in the second array, as array_merge does. I.e., with array_merge_recursive, this happens (documented behavior):

array_merge_recursive(array('key' => 'org value'), array('key' => 'new value'));

=> array('key' => array('org value', 'new value'));

array_merge_recursive_distinct does not change the datatypes of the values in the arrays. Matching keys' values in the second array overwrite those in the first array, as is the case with array_merge, i.e.:

array_merge_recursive_distinct(array('key' => 'org value'), array('key' => 'new value'));

=> array('key' => array('new value'));

Parameters are passed by reference, though only for performance reasons. They're not altered by this function.

Parameters

array $array1
array $array2

Returns

array

clear_dir()

clear_dir(  $dir, boolean  $delete = false)

Empties a folder recursively from all the files and folders it contains

Parameters

$dir

absolute path to the folder to be emptied
boolean $delete

if true, delete the root folder as well

convert()

convert(  $size)

Parameters

$size

copyr()

copyr(string  $source, string  $dest) : boolean

Copy a file, or recursively copy a folder and its contents

Parameters

string $source

Source path
string $dest

Destination path

Returns

boolean —

Returns TRUE on success, FALSE on failure

crop()

crop(  $image, integer|array  $x1, integer  $y1, integer  $x2, integer  $y2,   $originalWidth,   $originalHeight) : \ImageManipulator

Crop image

Parameters

$image
integer|array $x1

Top left x-coordinate of crop box or array of coordinates
integer $y1

Top left y-coordinate of crop box
integer $x2

Bottom right x-coordinate of crop box
integer $y2

Bottom right y-coordinate of crop box
$originalWidth
$originalHeight

Throws

\RuntimeException

Returns

\ImageManipulator —

for a fluent interface

dateFromSQL()

dateFromSQL(  $date,   $dataType,   $locale)

Parameters

$date
$dataType
$locale

dateNow()

dateNow(  $locale)

Parameters

$locale

dateTimeMsNow()

dateTimeMsNow(  $locale)

Parameters

$locale

dateTimeNow()

dateTimeNow(  $locale)

Parameters

$locale

dateToSQL()

dateToSQL(  $date,   $dataType,   $locale)

Parameters

$date
$dataType
$locale

echoBackButton()

echoBackButton()

echoTable()

echoTable(  $table)

Parameters

$table

echoValue()

echoValue(  $name,   $value)

Parameters

$name
$value

formatTel()

formatTel(  $tel)

Parameters

$tel

generateStrongPassword()

generateStrongPassword(  $length = 9,   $add_dashes = false,   $available_sets = 'luds')

Parameters

$length
$add_dashes
$available_sets

GenerateUrl()

GenerateUrl(  $text)

Parameters

$text

getHTTPHost()

getHTTPHost()

Returns the hostname prepended with http:// or https://

getHTTPScheme()

getHTTPScheme()

Returns http:// or https:// , matching the protocol used to load the current page

getImageResizedDimensions()

getImageResizedDimensions(  $orig_width,   $orig_height,   $max_width,   $max_height) : array

Computes the dimension of a resized image without actually processing the image

Parameters

$orig_width
$orig_height
$max_width

maximum width after resizing : if the image is wider than higher this limit will be used.
$max_height

maximum height after resizing : if the image is higher than wider this limit will be used.

Returns

array —

width computed width as 'width' and computed height as 'height' indices

getImgRessourceFromFilename()

getImgRessourceFromFilename(  $filename) : \image

loads filename and converts it into an image object in memory

Parameters

$filename

string the file to be loaded

Returns

\image

getMarkers()

getMarkers(  $subject) : array

Looks for all markers in $subject and returns an array populated with these

Parameters

$subject

string the template feature {markers} to be analyzed

Returns

array —

a list of all the markers found ordered as {marker} => marker

j_parseUrl()

j_parseUrl(  $url) : array

Identical functionnality to parse_url(), but supports IPv6 hostnames as well

Parameters

$url

Returns

array

logMails()

logMails(  $from,   $to,   $subject,   $textToLog)

Parameters

$from
$to
$subject
$textToLog

makeHTMLActionLink()

makeHTMLActionLink(  $action, string  $recordClass,   $recordUid,   $includeCssAndJs = false,   $parentUid)

Creates a link to ajax-core-html.php with secured form parameters

@param string $action an action available from ajax-core-html.php, such as 'editRecord' or 'viewRecord'

Parameters

$action
string $recordClass

the class of the record to process @param int|string $recordUid the uid of the record to be edited. @param boolean $includeCssAndJs tell mindflow to include all required CSS and JS code. This is usefull if the given HTML is displayed in an open window instead of an AJAX Window @return string the link to get the content action executed
$recordUid
$includeCssAndJs
$parentUid

makeJSONActionLink()

makeJSONActionLink(  $action, string  $recordClass,   $recordUid)

Creates a link to ajax-core-json.php with secured form parameters

@param string $action an action available from ajax-core-html.php, such as 'editRecord' or 'viewRecord'

Parameters

$action
string $recordClass

the class of the record to process @param int|string $recordUid the uid of the record to be edited. @return string the link to get the content action executed
$recordUid

mfResizeImage()

mfResizeImage(  $imageArray,   $maxWidth,   $maxHeight,   $forceMatchDimensions = false,   $forceCreateImage = false)

Parameters

$imageArray
$maxWidth
$maxHeight
$forceMatchDimensions
$forceCreateImage

print_r_level()

print_r_level(mixed  $data, integer  $level = 5) : string

Recrusive print variables and limit by level.

Parameters

mixed $data

The variable you want to dump.
integer $level

The level number to limit recrusive loop.

Returns

string —

Dumped data.

resize()

resize(  $cur_dir,   $cur_file,   $max_width,   $max_height,   $originalWidth,   $originalHeight,   $preserveAspect = true,   $timestamp = '')

Parameters

$cur_dir
$cur_file
$max_width
$max_height
$originalWidth
$originalHeight
$preserveAspect
$timestamp

resizeImage()

resizeImage(  $filename,   $max_width,   $max_height) : \image

Resize an image and keep the proportions

Parameters

$filename

the file to be processed
$max_width

maximum width after resizing : if the image is wider than higher this limit will be used.
$max_height

maximum height after resizing : if the image is higher than wider this limit will be used.

Returns

\image

selfURL()

selfURL(  $includeQueryString = true) : String

Returns the complete URL of the current page

Parameters

$includeQueryString

boolean set to false if you do not want to get the parameters after the ? in the url returned

Returns

String

Slug()

Slug(  $string,   $slug = '-',   $extra = null)

Parameters

$string
$slug
$extra

str_replace_limit()

str_replace_limit(  $search,   $replace,   $string,   $limit = 1)

Parameters

$search
$replace
$string
$limit

tableExists()

tableExists(string  $tableName) : boolean

Check if a table exists in the current database.

Parameters

string $tableName

Table to search for.

Returns

boolean —

TRUE if table exists, FALSE if no table found.

truncateHtml()

truncateHtml(string  $text, integer  $length = 100, string  $ending = '...', boolean  $exact = false, boolean  $considerHtml = true) : string

truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags

Parameters

string $text

String to truncate.
integer $length

Length of returned string, including ellipsis.
string $ending

Ending to be appended to the trimmed string.
boolean $exact

If false, $text will not be cut mid-word
boolean $considerHtml

If true, HTML tags would be handled correctly

Returns

string —

Trimmed string.

Unaccent()

Unaccent(  $string)

Parameters

$string

unaccent_keywords()

unaccent_keywords(  $dataString)

Parameters

$dataString

validateDate()

validateDate(  $date) : boolean

Validates a given date string formated as DD/MM/YYYY, returning true or false. Makes use of the standard PHP function checkdate()

Parameters

$date

a date formated according to the current display locale

Returns

boolean —

validation result

validateEmail()

validateEmail(  $email) : boolean

Validates the format of an email address. Makes use of the standard PHP function filter_var ( $email, FILTER_VALIDATE_EMAIL);

Parameters

$email

Returns

boolean —

validation result