Class luya\admin\proxy\ClientBuild

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

Admin Proxy Build.

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\ClientBuild
__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
getOptionTable() luya\admin\proxy\ClientBuild
getStorageFilesCount() luya\admin\proxy\ClientBuild
getTables() luya\admin\proxy\ClientBuild
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() luya\admin\proxy\ClientBuild
setBuildConfig() The build config is assigned from the remote server containing all tables. luya\admin\proxy\ClientBuild
setOptionTable() luya\admin\proxy\ClientBuild

Property Details

Hide inherited properties

$buildConfig public write-only property

An array with a key tables. Example config `php $config = [

'tables' => [
    'admin_ngrest_log' => [
         'pks' => 1,
         'name' => 'admin_ngrest_log'
         'rows' => 2000, // the total amount of rows
         'fields' => ['foo', 'bar'],
         'offset_total' => 10,
    ]
]

]; `

public void setBuildConfig ( array $config )
$buildToken public property
public $buildToken null
$command public property

Object

$db public property (available since version 2.0.0)
public yii\db\Connection $db null
$fileProviderUrl public property

The Url to the remote storage system which provides the file returnning the file content. The url will recieved an fileId param as well as buildToken and machine params.

public string $fileProviderUrl null
$imageProviderUrl public property

The Url to the remote storage system which provides the image returnning the file content. The url will recieved an fileId param as well as buildToken and machine params.

public string $imageProviderUrl null
$machineIdentifier public property
public $machineIdentifier null
$machineToken public property
public $machineToken null
$optionStrict public property
Deprecated Deprecated since version 4, will be removed in 5. No replacement.
public $optionStrict null
$optionTable public property
public void getOptionTable ( )
public void setOptionTable ( $table )
$requestCloseUrl public property
public $requestCloseUrl null
$requestUrl public property
public $requestUrl null
$storageFilesCount public property
public $storageFilesCount null
$syncRequestsCount public property
public $syncRequestsCount null
$tables public read-only property

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\console\Command $command, yii\db\Connection $db, array $config = [] )
$command
$db
$config

                public function __construct(Command $command, Connection $db, array $config = [])
{
    $this->command = $command;
    $this->db = $db;
    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();
}

            
getOptionTable() public method

public void getOptionTable ( )

                public function getOptionTable()
{
    return $this->_optionTable;
}

            
getStorageFilesCount() public method

public void getStorageFilesCount ( )

                public function getStorageFilesCount()
{
    return $this->_buildConfig['storageFilesCount'];
}

            
getTables() public method

public luya\admin\proxy\ClientTable[] getTables ( )

                public function getTables()
{
    return $this->_tables;
}

            
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

public void init ( )

                public function init()
{
    parent::init();
    if ($this->_buildConfig === null) {
        throw new InvalidConfigException("build config can not be empty!");
    }
}

            
setBuildConfig() public method

The build config is assigned from the remote server containing all tables.

public void setBuildConfig ( array $config )
$config array

An array with a key tables. Example config `php $config = [

'tables' => [
    'admin_ngrest_log' => [
         'pks' => 1,
         'name' => 'admin_ngrest_log'
         'rows' => 2000, // the total amount of rows
         'fields' => ['foo', 'bar'],
         'offset_total' => 10,
    ]
]

]; `

                public function setBuildConfig(array $config)
{
    $this->_buildConfig = $config;
    foreach ($config['tables'] as $tableName => $tableConfig) {
        if (!empty($this->optionTable)) {
            if ($this->isSkippableTable($tableName, $this->optionTable)) {
                continue;
            }
        }
        $schema = $this->db->getTableSchema($tableName);
        if ($schema !== null) {
            $this->_tables[$tableName] = new ClientTable($this, $tableConfig, ['db' => $this->db]);
        }
    }
}

            
setOptionTable() public method

public void setOptionTable ( $table )
$table

                public function setOptionTable($table)
{
    if (!empty($table)) {
        $this->_optionTable = explode(",", $table);
    }
}