energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Procedural File: utils.func.php

Source Location: /framework/utils.func.php



Page Details:

Содержит набор служебных утилит системы.



Tags:

author:   1m.dm
version:   $Id$
copyright:   Energine 2006
filesource:   Source Code for this file








arrayPush [line 246]

int arrayPush( &$array, mixed $var, [int $key = null], ref $array)

Добавляет элемент $var в конец массива $array и возвращает индекс добавленного элемента. С помощью аргумента $key возможно принудительно задать индекс для добавляемого элемента.



Tags:

see:   array_push()


Parameters

ref   $array  
mixed   $var  
int   $key  
array   &$array  
[ Top ]



array_push_before [line 271]

array array_push_before( $array, mixed $var, int $pos)

Добавляет элемент(ы) в массив перед указанной позицией и возвращает результат в виде нового массива.



Parameters

array   $array  
mixed   $var  
int   $pos  
[ Top ]



convertDatetimeToTimestamp [line 112]

mixed convertDatetimeToTimestamp( string $datetime)

Конвертирует строку формата DATETIME (YYYY-MM-DD HH:MM:SS) в UNIX timestamp.

Возвращает timestamp (int) в случае успеха, или false в случае неудачи.




Parameters

string   $datetime  
[ Top ]



convertDBResult [line 184]

array convertDBResult( mixed $dbResult, mixed $pkName, [boolean $deletePK = false])



Tags:

see:   QAL::select()
todo:   написать подробное описание!


Parameters

mixed   $dbResult  
mixed   $pkName  
boolean   $deletePK  
[ Top ]



convertFieldNames [line 223]

array convertFieldNames( $fields, [string $prefix = ''])

Приводит имена полей массива $fields в так называемую Camel Notation, где каждое слово после первого написано с большой буквы. Необязательный аргумент $prefix позволяет задать префикс, который будет удаляться из имени поля при конвертации.



Parameters

array   $fields  
string   $prefix   префикс имени подлежащий удалению
[ Top ]



ddump_log [line 91]

void ddump_log( [mixed $var, = ...])

Записывает информацию о переданных переменных в лог-файл и завершает работу программы. Информация записывается в начало файла, при этом прежнее содержимое удаляется.



Parameters

mixed   $var,   ...
[ Top ]



dump_log [line 69]

void dump_log( mixed $var, [boolean $append = false])

Записывает информацию о переменной в лог-файл.

Флаг $append контролирует способ записи: true - добавить информацию в конец файла; false - записать информацию в начало файла, удалив прежнее содержимое (по-умолчанию);




Parameters

mixed   $var  
boolean   $append  
[ Top ]



inspect [line 21]

void inspect( [mixed $var, = ...])

Выводит форматированнюу с помощью HTML информацию о переданных переменных непосредственно в текущий поток вывода (output stream).



Parameters

mixed   $var,   ...
[ Top ]



inverseDBResult [line 164]

array inverseDBResult( $dbResult)

Трансформирует массив результата SELECT-запроса к БД из представления по строкам в представление по столбцам.

На входе: array($n => array($fieldName => $fieldValue))

На выходе: array($fieldName => array($n => $fieldValue))




Parameters

array   $dbResult  
[ Top ]



simple_log [line 41]

void simple_log( $var)



Parameters

   $var  
[ Top ]



simplifyDBResult [line 133]

mixed simplifyDBResult( mixed $dbResult, string $fieldName, [boolean $singleRow = false])

Выбирает значения указанного поля из двумерного ассоциативного массива результата SELECT-запроса к БД в одномерный массив. Если флаг $singleRow установлен в true, возвращается значение указанного поля из первой (обычно единственной) строки результата $dbResult.



Parameters

mixed   $dbResult   результат SELECT-запроса к БД
string   $fieldName   имя поля для выборки из результата
boolean   $singleRow  
[ Top ]



stop [line 35]

void stop( [mixed $var, = ...])

Аналог функции inspect, с завершением работы программы сразу после вывода.



Parameters

mixed   $var,   ...
[ Top ]


В создании документации нам помог: phpDocumentor