ORMRow.php

Go to the documentation of this file.

<?php
class ORMRow implements IORMRow {
    protected $fields = array( 'id' => null );

    protected $updateSummaries = true;

    protected $inSummaryMode = false;

    protected $table;

    public function __construct( IORMTable $table = null, $fields = null, $loadDefaults = false ) {
        $this->table = $table;

        if ( !is_array( $fields ) ) {
            $fields = array();
        }

        if ( $loadDefaults ) {
            $fields = array_merge( $this->table->getDefaults(), $fields );
        }

        $this->setFields( $fields );
    }

    public function loadFields( $fields = null, $override = true, $skipLoaded = false ) {
        if ( is_null( $this->getId() ) ) {
            return false;
        }

        if ( is_null( $fields ) ) {
            $fields = array_keys( $this->table->getFields() );
        }

        if ( $skipLoaded ) {
            $fields = array_diff( $fields, array_keys( $this->fields ) );
        }

        if ( !empty( $fields ) ) {
            $result = $this->table->rawSelectRow(
                $this->table->getPrefixedFields( $fields ),
                array( $this->table->getPrefixedField( 'id' ) => $this->getId() ),
                array( 'LIMIT' => 1 ),
                __METHOD__
            );

            if ( $result !== false ) {
                $this->setFields( $this->table->getFieldsFromDBResult( $result ), $override );

                return true;
            }

            return false;
        }

        return true;
    }

    public function getField( $name, $default = null ) {
        if ( $this->hasField( $name ) ) {
            return $this->fields[$name];
        } elseif ( !is_null( $default ) ) {
            return $default;
        } else {
            throw new MWException( 'Attempted to get not-set field ' . $name );
        }
    }

    public function loadAndGetField( $name ) {
        if ( !$this->hasField( $name ) ) {
            $this->loadFields( array( $name ) );
        }

        return $this->getField( $name );
    }

    public function removeField( $name ) {
        unset( $this->fields[$name] );
    }

    public function getId() {
        return $this->getField( 'id' );
    }

    public function setId( $id ) {
        $this->setField( 'id', $id );
    }

    public function hasField( $name ) {
        return array_key_exists( $name, $this->fields );
    }

    public function hasIdField() {
        return $this->hasField( 'id' ) && !is_null( $this->getField( 'id' ) );
    }

    protected function getWriteValues() {
        $values = array();

        foreach ( $this->table->getFields() as $name => $type ) {
            if ( array_key_exists( $name, $this->fields ) ) {
                $value = $this->fields[$name];

                // Skip null id fields so that the DBMS can set the default.
                if ( $name === 'id' && is_null( $value ) ) {
                    continue;
                }

                switch ( $type ) {
                    case 'array':
                        $value = (array)$value;
                    // fall-through!
                    case 'blob':
                        $value = serialize( $value );
                    // fall-through!
                }

                $values[$this->table->getPrefixedField( $name )] = $value;
            }
        }

        return $values;
    }

    public function setFields( array $fields, $override = true ) {
        foreach ( $fields as $name => $value ) {
            if ( $override || !$this->hasField( $name ) ) {
                $this->setField( $name, $value );
            }
        }
    }

    public function toArray( $fields = null, $incNullId = false ) {
        $data = array();
        $setFields = array();

        if ( !is_array( $fields ) ) {
            $setFields = $this->getSetFieldNames();
        } else {
            foreach ( $fields as $field ) {
                if ( $this->hasField( $field ) ) {
                    $setFields[] = $field;
                }
            }
        }

        foreach ( $setFields as $field ) {
            if ( $incNullId || $field != 'id' || $this->hasIdField() ) {
                $data[$field] = $this->getField( $field );
            }
        }

        return $data;
    }

    public function loadDefaults( $override = true ) {
        $this->setFields( $this->table->getDefaults(), $override );
    }

    public function save( $functionName = null ) {
        if ( $this->hasIdField() ) {
            return $this->table->updateRow( $this, $functionName );
        } else {
            return $this->table->insertRow( $this, $functionName );
        }
    }

    protected function saveExisting( $functionName = null ) {
        $dbw = $this->table->getWriteDbConnection();

        $success = $dbw->update(
            $this->table->getName(),
            $this->getWriteValues(),
            $this->table->getPrefixedValues( $this->getUpdateConditions() ),
            is_null( $functionName ) ? __METHOD__ : $functionName
        );

        $this->table->releaseConnection( $dbw );

        // DatabaseBase::update does not always return true for success as documented...
        return $success !== false;
    }

    protected function getUpdateConditions() {
        return array( 'id' => $this->getId() );
    }

    protected function insert( $functionName = null, array $options = null ) {
        $dbw = $this->table->getWriteDbConnection();

        $success = $dbw->insert(
            $this->table->getName(),
            $this->getWriteValues(),
            is_null( $functionName ) ? __METHOD__ : $functionName,
            $options
        );

        // DatabaseBase::insert does not always return true for success as documented...
        $success = $success !== false;

        if ( $success ) {
            $this->setField( 'id', $dbw->insertId() );
        }

        $this->table->releaseConnection( $dbw );

        return $success;
    }

    public function remove() {
        $this->beforeRemove();

        $success = $this->table->removeRow( $this, __METHOD__ );

        if ( $success ) {
            $this->onRemoved();
        }

        return $success;
    }

    protected function beforeRemove() {
        $this->loadFields( $this->getBeforeRemoveFields(), false, true );
    }

    protected function getBeforeRemoveFields() {
        return array();
    }

    protected function onRemoved() {
        $this->setField( 'id', null );
    }

    public function getFields() {
        return $this->fields;
    }

    public function getSetFieldNames() {
        return array_keys( $this->fields );
    }

    public function setField( $name, $value ) {
        $this->fields[$name] = $value;
    }

    public function addToField( $field, $amount ) {
        return $this->table->addToField( $this->getUpdateConditions(), $field, $amount );
    }

    public function getFieldNames() {
        return array_keys( $this->table->getFields() );
    }

    public function loadSummaryFields( $summaryFields = null ) {
    }

    public function setUpdateSummaries( $update ) {
        $this->updateSummaries = $update;
    }

    public function setSummaryMode( $summaryMode ) {
        $this->inSummaryMode = $summaryMode;
    }

    public function getTable() {
        return $this->table;
    }
}