Класс UpdateResult

Граф наследования:UpdateResult:

Открытые члены
	__construct ()
	setAffectedRowsCount (Connection $connection)
	getAffectedRowsCount ()
	setPrimary ($primary)
	getPrimary ()
	getId ()
	getResource ()
	setReplacedAliases (array $replacedAliases)
	addReplacedAliases (array $replacedAliases)
	setSerializedFields (array $serializedFields)
	addFetchDataModifier ($fetchDataModifier)
	fetchRaw ()
	fetch (\Bitrix\Main\Text\Converter $converter=null)
	fetchAll (\Bitrix\Main\Text\Converter $converter=null)
	getFields ()
	getSelectedRowsCount ()
	getTrackerQuery ()
	getConverters ()
	setConverters ($converters)
	setCount ($n)
	getCount ()
	getIterator ()

Защищенные члены
	fetchRowInternal ()

Защищенные данные
	$affectedRowsCount
	$primary
	$connection
	$resource
	$trackerQuery = null
	$converters = array()
	$serializedFields = array()
	$replacedAliases = array()
	$fetchDataModifiers = array()
	$count

Подробное описание

См. определение в файле updateresult.php строка 13

Конструктор(ы)

__construct()

__construct

(

)

См. определение в файле updateresult.php строка 21

    {
        parent::__construct();
    }

Методы

addFetchDataModifier()

addFetchDataModifier (   $fetchDataModifier )

inherited

Modifier should accept once fetched array as an argument, then modify by link or return new array:

• function (&$data) { $data['AGE'] -= 7; }
• function ($data) { $data['AGE'] -= 7; return $data; }

Аргументы

callable

$fetchDataModifier

Valid callback.

Возвращает

void

Исключения

Bitrix\Main\ArgumentException

Переопределяется в Result.

См. определение в файле result.php строка 123

    {
        if (!is_callable($fetchDataModifier))
        {
            throw new \Bitrix\Main\ArgumentException('Data Modifier should be a callback');
        }
 
        $this->fetchDataModifiers[] = $fetchDataModifier;
    }

addReplacedAliases()

addReplacedAliases ( array  $replacedAliases )

inherited

Extends list of aliased columns.

Аргументы

array[string]string

$replacedAliases Aliases map from tech to human.

Возвращает

void

См. также

\Bitrix\Main\Db\ResultsetReplacedAliases

Переопределяется в Result.

См. определение в файле result.php строка 96

    {
        $this->replacedAliases = array_merge($this->replacedAliases, $replacedAliases);
    }

fetch()

fetch ( \Bitrix\Main\Text\Converter  $converter = null )

inherited

Fetches one row of the query result and returns it in the associative array of converted data or false on empty data.

Аргументы

\Bitrix\Main\Text\Converter

$converter

Optional converter to encode data on fetching.

Возвращает

array|false

Переопределяется в Result.

См. определение в файле result.php строка 167

    {
        $data = $this->fetchRaw();
 
        if (!$data)
        {
            return false;
        }
 
        if ($this->converters)
        {
            foreach ($this->converters as $field => $convertDataModifier)
            {
                $data[$field] = call_user_func_array($convertDataModifier, array($data[$field]));
            }
        }
 
        if ($this->serializedFields)
        {
            foreach ($this->serializedFields as $field)
            {
                if (isset($data[$field]))
                    $data[$field] = unserialize($data[$field]);
            }
        }
 
        if ($this->replacedAliases)
        {
            foreach ($this->replacedAliases as $tech => $human)
            {
                $data[$human] = $data[$tech];
                unset($data[$tech]);
            }
        }
 
        if ($this->fetchDataModifiers)
        {
            foreach ($this->fetchDataModifiers as $fetchDataModifier)
            {
                $result = call_user_func_array($fetchDataModifier, array(&$data));
 
                if (is_array($result))
                {
                    $data = $result;
                }
            }
        }
 
        if ($converter != null)
        {
            foreach ($data as $key => $val)
            {
                $data[$key] = $converter->encode(
                    $val,
                    (isset($data[$key."_TYPE"])? $data[$key."_TYPE"] : \Bitrix\Main\Text\Converter::TEXT)
                );
            }
        }
 
        return $data;
    }

fetchAll()

fetchAll ( \Bitrix\Main\Text\Converter  $converter = null )

inherited

Fetches all the rows of the query result and returns it in the array of associative arrays. Returns an empty array if query has no data.

Аргументы

\Bitrix\Main\Text\Converter

$converter

Optional converter to encode data on fetching.

Возвращает

array

Переопределяется в Result.

См. определение в файле result.php строка 237

    {
        $res = array();
        while ($ar = $this->fetch($converter))
        {
            $res[] = $ar;
        }
        return $res;
    }

fetchRaw()

fetchRaw ( )

inherited

Fetches one row of the query result and returns it in the associative array of raw DB data or false on empty data.

Возвращает

array|false

Переопределяется в Result.

См. определение в файле result.php строка 138

    {
        if ($this->trackerQuery != null)
        {
            $this->trackerQuery->restartQuery();
        }
 
        $data = $this->fetchRowInternal();
 
        if ($this->trackerQuery != null)
        {
            $this->trackerQuery->refinishQuery();
        }
 
        if (!$data)
        {
            return false;
        }
 
        return $data;
    }

fetchRowInternal()

fetchRowInternal ( )

abstractprotectedinherited

Returns next result row or false.

Возвращает

array|false

Переопределяется в ArrayResult, MssqlResult, MysqliResult, MysqlResult, OracleResult и Result.

getAffectedRowsCount()

getAffectedRowsCount

(

)

Возвращает

int

См. определение в файле updateresult.php строка 34

    {
        return $this->affectedRowsCount;
    }

getConverters()

getConverters ( )

inherited

Возвращает

callable[]

Переопределяется в Result.

См. определение в файле result.php строка 281

    {
        return $this->converters;
    }

getCount()

getCount ( )

inherited

Returns record count. It's required to set record count explicitly before.

Возвращает

int

Исключения

Bitrix\Main\ObjectPropertyException

Переопределяется в Result.

См. определение в файле result.php строка 308

    {
        if($this->count !== null)
        {
            return $this->count;
        }
        throw new \Bitrix\Main\ObjectPropertyException("count");
    }

getFields()

getFields ( )

abstractinherited

Returns an array of fields according to columns in the result.

Возвращает

\Bitrix\Main\ORM\Fields\ScalarField[]

Переопределяется в ArrayResult, MssqlResult, MysqliResult, MysqlResult, OracleResult и Result.

getId()

getId

(

)

Returns id of updated record

Возвращает

array|int|string

См. определение в файле updateresult.php строка 56

    {
        if (count($this->primary) == 1)
        {
            return end($this->primary);
        }
 
        return $this->primary;
    }

getIterator()

getIterator ( )

inherited

Retrieve an external iterator An instance of an object implementing Iterator or Traversable 5.0.0

Переопределяется в Result.

См. определение в файле result.php строка 324

                                 : \Traversable
    {
        return new ResultIterator($this);
    }

getPrimary()

getPrimary

(

)

Возвращает

array

См. определение в файле updateresult.php строка 47

    {
        return $this->primary;
    }

getResource()

getResource ( )

inherited

Returns database-specific resource of this result.

Возвращает

null|resource

Переопределяется в Result.

См. определение в файле result.php строка 69

    {
        return $this->resource;
    }

getSelectedRowsCount()

getSelectedRowsCount ( )

abstractinherited

Returns the number of rows in the result.

Возвращает

int

Переопределяется в ArrayResult, MssqlResult, MysqliResult, MysqlResult, OracleResult и Result.

getTrackerQuery()

getTrackerQuery ( )

inherited

Returns current query tracker.

Возвращает

\Bitrix\Main\Diag\SqlTrackerQuery|null

Переопределяется в Result.

См. определение в файле result.php строка 273

    {
        return $this->trackerQuery;
    }

setAffectedRowsCount()

setAffectedRowsCount

(

Connection

$connection

)

См. определение в файле updateresult.php строка 26

    {
        $this->affectedRowsCount = $connection->getAffectedRowsCount();
    }

setConverters()

setConverters (   $converters )

inherited

Аргументы

callable[]

$converters

Переопределяется в Result.

См. определение в файле result.php строка 289

    {
        $this->converters = $converters;
    }

setCount()

setCount (   $n )

inherited

Sets record count.

Аргументы

int

$n

Переопределяется в Result.

См. определение в файле result.php строка 298

    {
        $this->count = (int)$n;
    }

setPrimary()

setPrimary

(

$primary

)

См. определение в файле updateresult.php строка 39

    {
        $this->primary = $primary;
    }

setReplacedAliases()

setReplacedAliases ( array  $replacedAliases )

inherited

Sets list of aliased columns. This allows to overcome database limits on length of the column names.

Аргументы

array[string]string

$replacedAliases Aliases map from tech to human.

Возвращает

void

См. также

\Bitrix\Main\Db\ResultaddReplacedAliases

Переопределяется в Result.

См. определение в файле result.php строка 83

    {
        $this->replacedAliases = $replacedAliases;
    }

setSerializedFields()

setSerializedFields ( array  $serializedFields )

inherited

Sets internal list of fields which will be unserialized on fetch.

Аргументы

array

$serializedFields

List of fields.

Возвращает

void

Переопределяется в Result.

См. определение в файле result.php строка 108

    {
        $this->serializedFields = $serializedFields;
    }

Поля

$affectedRowsCount

$affectedRowsCount

protected

См. определение в файле updateresult.php строка 16

$connection

$connection

protectedinherited

См. определение в файле result.php строка 21

$converters

$converters = array()

protectedinherited

См. определение в файле result.php строка 28

$count

$count

protectedinherited

См. определение в файле result.php строка 37

$fetchDataModifiers

$fetchDataModifiers = array()

protectedinherited

См. определение в файле result.php строка 34

$primary

$primary

protected

См. определение в файле updateresult.php строка 19

$replacedAliases

$replacedAliases = array()

protectedinherited

См. определение в файле result.php строка 32

$resource

Bitrix Main DB Result $resource

protectedinherited

См. определение в файле result.php строка 23

$serializedFields

$serializedFields = array()

protectedinherited

См. определение в файле result.php строка 30

$trackerQuery

$trackerQuery = null

protectedinherited

См. определение в файле result.php строка 25

---

Объявления и описания членов класса находятся в файле:

• C:/Bitrix/modules/main/lib/orm/data/updateresult.php