Menu

## Budget
in package

Budget.php : 33

Класс для работы с объектом Бюджет

Class Budget

##### Tags

author

  Vladislav Andreev v@salesman.pro

version
  1.0

  (06/09/2019)

  Example:

      $Budget  = new Salesman\Budget();
      $result = $Budget -> add($params);
      $id = $result['data'];

### Table of Contents

categorySelect() : string
  HTML-элемент select
delete() : array<string|int, mixed>
  Удаление расхода/дохода
deleteCategory() : array<string|int, mixed>
  Удаление категории расхода/дохода
doit() : array<string|int, mixed>
  Проведение платежа
edit() : array<string|int, mixed>
  Добавление/изменение расхода/дохода
editCategory() : array<string|int, mixed>
  Добавление/изменение категории расхода/дохода
fields() : array<string|int, mixed>
  Возвращет массив имен полей таблицы Бюджет
getAgentsJournal() : array<string|int, mixed>
  Вывод расходов раздела Контрагенты
getBudjetStat() : array<string|int, mixed>
  Вывод данных для формирования сводной таблицы Бюджета
getCategory() : array<string|int, mixed>
  Получаем структуру статей расхода в бюджет
getCategorySimple() : array<string|int, mixed>
  Получаем расшифровку статей расхода в бюджет
getJournal() : Generator
  Вывод журнала
getRS() : array<string|int, mixed>
  Получаем информацию по расчетным счетам
info() : array<string|int, mixed>
  Получение информации по расходу/доходу
logStatus() : bool
  Логгирование статуса
logStatusDelete() : void
  Удаление статусов (например, при удалении расхода)
logStatusGet() : array<string|int, mixed>
  Лог изменения статусов
move() : array<string|int, mixed>
  Перемещение средств между счетами
rsadd() : bool
  Действие. Перемещение денег со счета на счет
sendEmailNotify() : array<string|int, mixed>
  Метод ортправки уведомления всем сотрудникам в одном письме
sendNotify() : array<string|int, mixed>
  Отправка уведомлений через систему Нотификации
undoit() : array<string|int, mixed>
  Отмена проведения платежа
unmove() : array<string|int, mixed>
  Отмена перемещения средств м/у счетами

### Methods

#### categorySelect()

Budget.php : 1551

HTML-элемент select

`public static categorySelect([string $name = "category" ][, array<string|int, mixed> $opt = [] ]) : string`

##### Parameters

$name : string = "category"
  - имя элемента
$opt : array<string|int, mixed> = []
  - массив с параметрами
  - array category - массив элементов (готовый массив [ получать вызовом getCategory() ], применять в случае, если метод надо вызвать несколько раз, а структура одна)
  - int sel - выбранный элемент
  - array disabled - отключенные элементы
  - str word - поисковое слово названия статьи
  - str class - класс для элемента select

##### Return values

string —

#### delete()

Budget.php : 466

Удаление расхода/дохода

`public static delete(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор записи расхода/дохода

##### Return values

array<string|int, mixed> —

good result - result = Успешно удален - data = id

error result - result = result - error - code - text

code: - 403 - Расход/доход с указанным id не найден в пределах аккаунта - 405 - Отсутствуют параметры - id записи расхода/дохода

Example:

    $Budget = \Salesman\Budget::delete($id);

#### deleteCategory()

Budget.php : 1083

Удаление категории расхода/дохода

`public static deleteCategory(int $catid, int $newcat) : array<string|int, mixed>`

##### Parameters

$catid : int
  - идентификатор записи категории расхода/дохода
$newcat : int
  - новая категория для переноса

##### Return values

array<string|int, mixed> —

good result - result = Успешно удалено - data = id

error result - result = result - error - code - text

code: - 403 - Категория с указанным id не найден в пределах аккаунта - 405 - Отсутствуют параметры - id записи категории

Example:

    $Budget = \Salesman\Budget::deleteCategory($catid);

#### doit()

Budget.php : 589

Проведение платежа

`public static doit(int $id[, bool $forsed = NULL ]) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор записи расхода/дохода
$forsed : bool = NULL
  - принудительное проведение ( игнорируя остаток )

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed> —

good result - result = Успешно проведен - data = id

error result - result = result - error - code - text

code:

         - 403 - Расход/доход с указанным id не найден в пределах аккаунта
         - 405 - Отсутствуют параметры - id записи расхода/дохода

Example:

    $Budget = \Salesman\Budget::doit($id);

#### edit()

Budget.php : 75

Добавление/изменение расхода/дохода

`public static edit(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор записи расхода/дохода
$params : array<string|int, mixed> = []
  - массив с параметрами
  - title - название
  - cat - категория расхода/дохода
  - des - описание
  - summa - сумма расхода/дохода
  - do - пизнак проведения
  - datum - дата изменения
  - rs - номер р/с
  - fid - id файла
  - did - id сделки

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed> —

good result - result = Успешно добавлен/изменен - data = id

error result - result = result - error - code - text

code: - 403 - Расход/доход с указанным id не найден в пределах аккаунта - 405 - Отсутствуют параметры - id записи расхода/дохода

Example:

    $Budget = \Salesman\Budget::edit($id,$params);

#### editCategory()

Budget.php : 981

Добавление/изменение категории расхода/дохода

`public static editCategory(int $catid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$catid : int
  - идентификатор категории расхода/дохода
$params : array<string|int, mixed> = []
  - массив с параметрами
  - subid - id основной записи категории
  - title - название
  - tip - расход или доход

##### Return values

array<string|int, mixed> —

good result - result = Успешно добавлено/изменено - data = id

error result - result = result - error - code - text

code: - 403 - Категория с указанным id не найден в пределах аккаунта - 405 - Отсутствуют параметры - id записи категории

Example:

    $Budget = \Salesman\Budget::editCategory($catid,$params);

#### fields()

Budget.php : 926

Возвращет массив имен полей таблицы Бюджет

`public static fields() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

Example:

    $Budget = \Salesman\Budget::fields();

#### getAgentsJournal()

Budget.php : 2049

Вывод расходов раздела Контрагенты

`public static getAgentsJournal([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$params : array<string|int, mixed> = []

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed> —

#### getBudjetStat()

Budget.php : 1643

Вывод данных для формирования сводной таблицы Бюджета

`public static getBudjetStat([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$params : array<string|int, mixed> = []
  - array rs - массив id расчетных счетов
  - int year - год

##### Return values

array<string|int, mixed> —

#### getCategory()

Budget.php : 1442

Получаем структуру статей расхода в бюджет

`public static getCategory() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

    [ dohod ] => (
        [ name ] => Доходы
        [ main ] => (
            [ 0 ] => (
                [ id ] => 4
                [ title ] => Прочие поступления
                [ sub ] => (
                    [ 0 ] => (
                        [ id ] => 5
                        [ title ] => Инвестиции
                    )
                    [ 1 ] => (
                        [ id ] => 13
                        [ title ] => Наличка
                    )
                )
            )
        )
    )

#### getCategorySimple()

Budget.php : 1507

Получаем расшифровку статей расхода в бюджет

`public static getCategorySimple([string $word = '' ][, string $tip = 'rashod' ]) : array<string|int, mixed>`

##### Parameters

$word : string = ''
  - название или ключевое слово для поиска
$tip : string = 'rashod'
  - тип статьи - rashod|dohod

##### Return values

array<string|int, mixed> —

- id => title

#### getJournal()

Budget.php : 1851

Вывод журнала

`public static getJournal([array<string|int, mixed> $params = [] ]) : Generator`

##### Parameters

$params : array<string|int, mixed> = []
  - string do = do|nodo - проведен/не проведен
  - array rs - массив id расчетных счетов
  - int year - год
  - array category - массив статей расхода
  - string word - поиск по названию/описанию расхода

##### Tags

throws
  Exception

##### Return values

Generator —

#### getRS()

Budget.php : 1606

Получаем информацию по расчетным счетам

`public static getRS() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

- int id - id записи
- str title - название р/с
- float summa - сумма на счету
- str rs - р/с
- str company - название компании

#### info()

Budget.php : 831

Получение информации по расходу/доходу

`public static info(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор расхода/дохода

##### Return values

array<string|int, mixed> —

error result - result = result - error - code - text

code: - 403 - Расход/доход с указанным id не найден в пределах аккаунта - 405 - Отсутствуют параметры - id записи расхода/дохода

Example:

    $Budget = \Salesman\Budget::info($id);

#### logStatus()

Budget.php : 2555

Логгирование статуса

`public static logStatus( $id[, string $status = 'new' ][, string $comment = '' ]) : bool`

##### Parameters

$id :
$status : string = 'new'
$comment : string = ''

##### Return values

bool —

#### logStatusDelete()

Budget.php : 2631

Удаление статусов (например, при удалении расхода)

`public static logStatusDelete(int $id) : void`

##### Parameters

$id : int

##### Return values

void —

#### logStatusGet()

Budget.php : 2582

Лог изменения статусов

`public static logStatusGet(int $id) : array<string|int, mixed>`

##### Parameters

$id : int

##### Return values

array<string|int, mixed> —

#### move()

Budget.php : 1174

Перемещение средств между счетами

`public static move(array<string|int, mixed> $params) : array<string|int, mixed>`

##### Parameters

$params : array<string|int, mixed>
  - массив с параметрами
  - summa - сумма перевода
  - title - название перевода
  - des - описание
  - bmon - месяц
  - byear - год
  - rs - счет, с которого переводим
  - rs_move - счет, на который переводим

##### Return values

array<string|int, mixed> —

good result - result = Средства успешно перемещены - data = id

Example:

    $Budget = \Salesman\Budget::move($params);

#### rsadd()

Budget.php : 2282

Действие. Перемещение денег со счета на счет

`public static rsadd(int $rs[, float $summa = 0.0 ][, string|null $operacia = NULL ][, string|null $rs_move = NULL ]) : bool`

##### Parameters

$rs : int
$summa : float = 0.0
$operacia : string|null = NULL
$rs_move : string|null = NULL

##### Tags

category

  Core

##### Return values

bool —

#### sendEmailNotify()

Budget.php : 2332

Метод ортправки уведомления всем сотрудникам в одном письме

`public static sendEmailNotify(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$id : int
  - id расхода
$params : array<string|int, mixed> = []

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed> —

#### sendNotify()

Budget.php : 2462

Отправка уведомлений через систему Нотификации

`public static sendNotify( $event[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$event :
  - budjet.new, budjet.edit, budjet.doit
$params : array<string|int, mixed> = []

  id - ID Расхода [обязательное ] title - Заголовок [ не обязательное ] content - Содержание [ желательное ]

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed> —

#### undoit()

Budget.php : 732

Отмена проведения платежа

`public static undoit(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор записи расхода/дохода

##### Return values

array<string|int, mixed> —

good result - result = Платеж успешно отменен - data = id

error result - result = result - error - code - text

code: - 403 - Платеж с указанным id не найден в пределах аккаунта - 405 - Отсутствуют параметры - id записи платежа

Example:

    $Budget = \Salesman\Budget::undoit($id);

#### unmove()

Budget.php : 1343

Отмена перемещения средств м/у счетами

`public static unmove(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - идентификатор записи перемещения средств м/у счетами

##### Return values

array<string|int, mixed> —

good result - result = Перемещение средств успешно отменено - data = id

error result - result = result - error - code - text

code: - 403 - Запись о перемещении средств с указанным id не найден в пределах аккаунта - 405 - Отсутствуют параметры - id записи о перемещении средств

Example:

    $Budget = \Salesman\Budget::unmove($id);

## Search results