Class luya\admin\proxy\ClientTable

Inheritanceluya\admin\proxy\ClientTable » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version1.0.0

Prepare Client Tables

For admin/proxy usage see {{luya\admin\commands\ProxyController}}

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() luya\admin\proxy\ClientTable
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
getColumns() luya\admin\proxy\ClientTable
getContentRowCount() luya\admin\proxy\ClientTable
getDb() luya\admin\proxy\ClientTable
getFields() luya\admin\proxy\ClientTable
getName() luya\admin\proxy\ClientTable
getOffsetTotal() luya\admin\proxy\ClientTable
getPks() luya\admin\proxy\ClientTable
getRows() luya\admin\proxy\ClientTable
getSchema() luya\admin\proxy\ClientTable
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
isComplet() luya\admin\proxy\ClientTable
setDb() luya\admin\proxy\ClientTable
syncData() Sync the data from remote table to local table. luya\admin\proxy\ClientTable

Protected Methods

Hide inherited methods

Method Description Defined By
cleanUpBatchInsertFields() Clean Up Batch Insert Fields luya\admin\proxy\ClientTable
cleanUpMatchRow() Clean Up matching Rows luya\admin\proxy\ClientTable
cleanup() Revert database system variables. luya\admin\proxy\ClientTable
prepare() Prepare database for data sync and set system variables. luya\admin\proxy\ClientTable

Constants

Hide inherited constants

Constant Value Description Defined By
LARGE_TABLE_PROMPT 10000 luya\admin\proxy\ClientTable

Property Details

Hide inherited properties

$build public property
$columns public read-only property
public void getColumns ( )
$contentRowCount public read-only property
$db public property

Database connection. By default Yii::$app->db will be used.

public yii\db\Connection $db null
$fields public read-only property
public array getFields ( )
$name public read-only property
public string getName ( )
$offsetTotal public read-only property
$pks public read-only property
public array getPks ( )
$rows public read-only property
$schema public property

Schema object

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__construct() public method

public void __construct ( luya\admin\proxy\ClientBuild $build, array $data, array $config = [] )
$build luya\admin\proxy\ClientBuild
$data array
$config array

                public function __construct(ClientBuild $build, array $data, array $config = [])
{
    $this->build = $build;
    $this->_data = $data;
    parent::__construct($config);
}

            
__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set (not null).

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}

            
__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}

            
__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}

            
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property can be read

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}

            
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property can be written

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

                public static function className()
{
    return get_called_class();
}

            
cleanUpBatchInsertFields() protected method

Clean Up Batch Insert Fields

protected array cleanUpBatchInsertFields ( array $fields )
$fields array

                protected function cleanUpBatchInsertFields(array $fields)
{
    $data = [];
    foreach ($fields as $field) {
        if (in_array($field, $this->getColumns())) {
            $data[] = $field;
        }
    }
    return $data;
}

            
cleanUpMatchRow() protected method

Clean Up matching Rows

protected array cleanUpMatchRow ( array $row )
$row array

                protected function cleanUpMatchRow(array $row)
{
    $data = [];
    foreach ($row as $key => $item) {
        foreach ($item as $field => $value) {
            if (in_array($field, $this->getColumns())) {
                $data[$key][$field] = $value;
            }
        }
    }
    return $data;
}

            
cleanup() protected method (available since version 1.2.1)

Revert database system variables.

Enable the foreign key and unique check. Also set the sql mode to the given value. Currently only for MySql and MariaDB.

See also luya\admin\proxy\ClientTable::prepare().

protected void cleanup ( $sqlMode )
$sqlMode

String|null The old sql mode value from @see \luya\admin\proxy\ClientTable::prepare()

throws yii\db\Exception

                protected function cleanup($sqlMode)
{
    if ($this->getDb()->schema instanceof \yii\db\mysql\Schema) {
        try {
            $this->getDb()->createCommand('SELECT CONNECTION_ID()')->execute();
        } catch (Exception $ex) {
            throw new \luya\Exception('Connection lost. Server has gone away?');
        }
        $this->getDb()->createCommand('SET FOREIGN_KEY_CHECKS = 1;')->execute();
        $this->getDb()->createCommand('SET UNIQUE_CHECKS = 1;')->execute();
        if ($sqlMode !== null) {
            $this->getDb()->createCommand('SET SQL_MODE=:sqlMode;', [':sqlMode' => $sqlMode])->execute();
        }
    }
}

            
getColumns() public method

public void getColumns ( )

                public function getColumns()
{
    return $this->schema->getColumnNames();
}

            
getContentRowCount() public method

public integer getContentRowCount ( )

                public function getContentRowCount()
{
    return $this->_contentRowsCount;
}

            
getDb() public method (available since version 2.0.0)

public yii\db\Connection getDb ( )

                public function getDb()
{
    if (!$this->_db) {
        $this->setDb(Yii::$app->db);
    }
    return $this->_db;
}

            
getFields() public method

public array getFields ( )

                public function getFields()
{
    return $this->_data['fields'];
}

            
getName() public method

public string getName ( )

                public function getName()
{
    return $this->_data['name'];
}

            
getOffsetTotal() public method

public integer getOffsetTotal ( )

                public function getOffsetTotal()
{
    return $this->_data['offset_total'];
}

            
getPks() public method

public array getPks ( )

                public function getPks()
{
    return $this->_data['pks'];
}

            
getRows() public method

public string|integer getRows ( )

                public function getRows()
{
    return $this->_data['rows'];
}

            
getSchema() public method

public void getSchema ( )

                public function getSchema()
{
    if ($this->_schema === null) {
        $this->_schema = $this->getDb()->getTableSchema($this->getName());
    }
    return $this->_schema;
}

            
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name

return boolean

Whether the method is defined

                public function hasMethod($name)
{
    return method_exists($this, $name);
}

            
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also:

public boolean hasProperty ( $name, $checkVars true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property is defined

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}

            
init() public method

Defined in: yii\base\BaseObject::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
}

            
isComplet() public method

public boolean isComplet ( )

                public function isComplet()
{
    return $this->getRows() == $this->getContentRowCount();
}

            
prepare() protected method (available since version 1.2.1)

Prepare database for data sync and set system variables.

Disable the foreign key and unique check. Also set the sql mode to "NO_AUTO_VALUE_ON_ZERO". Currently only for MySql and MariaDB.

protected false|null|string prepare ( )
return false|null|string

The old sql mode.

throws yii\db\Exception

                protected function prepare()
{
    $sqlMode = null;
    if ($this->getDb()->schema instanceof \yii\db\mysql\Schema) {
        $this->getDb()->createCommand('SET FOREIGN_KEY_CHECKS = 0;')->execute();
        $this->getDb()->createCommand('SET UNIQUE_CHECKS = 0;')->execute();
        $sqlMode = $this->getDb()->createCommand('SELECT @@SQL_MODE;')->queryScalar();
        $this->getDb()->createCommand('SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";')->execute();
    }
    return $sqlMode;
}

            
setDb() public method (available since version 2.0.0)

public void setDb ( yii\db\Connection $db )
$db yii\db\Connection

                public function setDb(Connection $db)
{
    $this->_db = $db;
}

            
syncData() public method

Sync the data from remote table to local table.

public void syncData ( )
throws yii\db\Exception

                public function syncData()
{
    if (Yii::$app->controller->interactive && $this->getRows() > self::LARGE_TABLE_PROMPT) {
        if (Console::confirm("{$this->getName()} has {$this->getRows()} entries. Do you want continue table sync?", true) === false) {
            return;
        }
    }
    $sqlMode = $this->prepare();
    try {
        $this->getDb()->createCommand()->truncateTable($this->getName())->execute();
        $this->syncDataInternal();
    } finally {
        $this->cleanup($sqlMode);
    }
}