Class ModuleClientMeta

Module Client Meta

Allows read/write data containing module or module row specific data for a particular client.

Model

AppModel

ModuleClientMeta

Package: blesta\app\models
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at app/models/module_client_meta.php

Methods summary

`public`	# `set( integer $client_id, integer $module_id, integer $module_row_id = 0, array $fields = array() )` Add or update module meta data for a particular client and module Add or update module meta data for a particular client and module Parameters `$client_id` `integer` $client_id The ID of the client to set data for `$module_id` `integer` $module_id The ID of the module `$module_row_id` `integer` $module_row_id The ID of the module row (if necessary) `$fields` `array` $fields A numerically indexed array of arrays, each containing: - key The key to set - value The value to set - encrypted True to encrypt $value, false to store unencrypted, null to encrypt if currently set to encrypt (default null)
`public mixed`	# `get( integer $client_id, string $key, integer $module_id, integer $module_row_id = 0 )` Fetch a specific meta field Fetch a specific meta field Parameters `$client_id` `integer` $client_id The ID of the client to fetch on `$key` `string` $key The key to fetch `$module_id` `integer` $module_id The ID of the module `$module_row_id` `integer` $module_row_id The ID of the module row (if necessary) Returns `mixed` A stdClass object representing the meta field, false if no such field exists
`public array`	# `getAll( integer $client_id, integer $module_id, integer $module_row_id = 0 )` Fetches all meta fields for a client Fetches all meta fields for a client Parameters `$client_id` `integer` $client_id The ID of the client to fetch on `$module_id` `integer` $module_id The ID of the module `$module_row_id` `integer` $module_row_id The ID of the module row (if necessary) Returns `array` An array of stdClass objects, each representing a meta field
`public`	# `delete( integer $client_id, string $key, integer $module_id, integer $module_row_id = 0 )` Delete a specific entry for a client and module Delete a specific entry for a client and module Parameters `$client_id` `integer` $client_id The ID of the client `$key` `string` $key The key to delete `$module_id` `integer` $module_id The ID of the module `$module_row_id` `integer` $module_row_id The ID of the module row (if necessary)
`public`	# `deleteAll( integer $client_id, integer $module_id, integer $module_row_id = 0 )` Deletes all meta fields for a client and module Deletes all meta fields for a client and module Parameters `$client_id` `integer` $client_id The ID of the client `$module_id` `integer` $module_id The ID of the module `$module_row_id` `integer` $module_row_id The ID of the module row (if necessary)

Methods inherited from AppModel

_(), __construct(), boolToInt(), currencyToDecimal(), dateToUtc(), errors(), getPerPage(), ifSet(), loadCrypto(), setDefaultIfEmpty(), setPerPage(), setRulesIfSet(), strToBool(), systemDecrypt(), systemEncrypt(), systemHash(), truncateDecimal(), validateExists(), validateStateCountry()

Methods inherited from Model

affectedRows(), begin(), commit(), getConnection(), lastInsertId(), makeDSN(), prepare(), query(), rollBack(), setAttribute(), setFetchMode()

Magic methods summary

Properties summary

Properties inherited from AppModel

$replacement_keys

Packages

Classes

Class ModuleClientMeta

Methods summary

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Methods inherited from AppModel

Methods inherited from Model

Magic methods summary

Properties summary

Properties inherited from AppModel