DS Helper GameAP: различия между версиями

Материал из HLDM Wiki
Перейти к навигации Перейти к поиску
Строка 18: Строка 18:
  
 
  string get_ds_file_path( array $server_data )
 
  string get_ds_file_path( array $server_data )
'''server_data'''
+
:'''server_data'''
: Данные сервера.
+
:: Данные сервера.
  
 
=== get_file_protocol ===
 
=== get_file_protocol ===
Строка 25: Строка 25:
 
Получение названия протокола передачи файлов (FTP, SFTP, Local).
 
Получение названия протокола передачи файлов (FTP, SFTP, Local).
 
  string get_file_protocol( array $server_data )
 
  string get_file_protocol( array $server_data )
'''server_data'''
+
:'''server_data'''
: Данные сервера.
+
:: Данные сервера.
  
 
=== get_file_protocol_config ===
 
=== get_file_protocol_config ===
Строка 32: Строка 32:
 
Получение данных для соединения с sftp или ftp.
 
Получение данных для соединения с sftp или ftp.
 
  string get_file_protocol_config( array $server_data )
 
  string get_file_protocol_config( array $server_data )
'''server_data'''
+
:'''server_data'''
: Данные сервера.
+
:: Данные сервера.
  
 
=== get_last_command ===
 
=== get_last_command ===
Строка 49: Строка 49:
 
Список файлов в директории.
 
Список файлов в директории.
 
  array list_ds_files(string $dir, array $server_data [, bool $full_info = false ] [, array $extensions ] )
 
  array list_ds_files(string $dir, array $server_data [, bool $full_info = false ] [, array $extensions ] )
'''dir'''
+
:'''dir'''
:Директория на выделенном сервере
+
::Директория на выделенном сервере
'''server_data'''
+
:'''server_data'''
:Данные сервера.
+
::Данные сервера.
'''full_info'''
+
:'''full_info'''
:Полная информация о файле (дата создания, размер).
+
::Полная информация о файле (дата создания, размер).
'''extensions'''
+
:'''extensions'''
:Массив со списком расширений файлов.
+
::Массив со списком расширений файлов.
  
 
=== read_ds_file ===
 
=== read_ds_file ===
Строка 62: Строка 62:
 
Читает содержимое файла на выделенном сервере.
 
Читает содержимое файла на выделенном сервере.
 
  string read_ds_file ( string $file, array $server_data )
 
  string read_ds_file ( string $file, array $server_data )
'''file'''
+
:'''file'''
:Файл на выделенном сервере
+
::Файл на выделенном сервере
'''server_data'''
+
:'''server_data'''
:Данные сервера
+
::Данные сервера
  
 
=== write_ds_file ===
 
=== write_ds_file ===
Строка 71: Строка 71:
 
Записывает данные в файл на выделенном сервере.
 
Записывает данные в файл на выделенном сервере.
 
  bool write_ds_file ( string $file, string $contents, array $server_data )
 
  bool write_ds_file ( string $file, string $contents, array $server_data )
'''file'''
+
:'''file'''
:Файл на выделенном сервере
+
::Файл на выделенном сервере
'''contents'''
+
:'''contents'''
:Данные файла
+
::Данные файла
'''server_data'''
+
:'''server_data'''
:Данные сервера
+
::Данные сервера
  
 
=== replace_shotcodes ===
 
=== replace_shotcodes ===
Строка 82: Строка 82:
 
Заменяет шоткоды в команде.
 
Заменяет шоткоды в команде.
 
  replace_shotcodes ( string $command, array $server_data )
 
  replace_shotcodes ( string $command, array $server_data )
'''command'''
+
:'''command'''
:Отправляемая команда с шоткодами
+
::Отправляемая команда с шоткодами
'''server_data'''
+
:'''server_data'''
:Данные сервера
+
::Данные сервера
  
 
=== send_command ===
 
=== send_command ===
Строка 91: Строка 91:
 
Отправляет команду на сервер.
 
Отправляет команду на сервер.
 
  string send_command ( string $command, array $server_data [ , bool $path = false ] )
 
  string send_command ( string $command, array $server_data [ , bool $path = false ] )
'''command'''
+
:'''command'''
:Отправляемая команда
+
::Отправляемая команда
'''server_data'''
+
:'''server_data'''
:Данные сервера
+
::Данные сервера
'''path'''
+
:'''path'''
:Путь. Перед отправкой команды будет выполнена смена на указанный путь.
+
::Путь. Перед отправкой команды будет выполнена смена на указанный путь.
  
 
{{Категория:Документация_для_разработчиков}}
 
{{Категория:Документация_для_разработчиков}}

Версия 20:59, 14 мая 2014


Набор функций для работы с выделенным сервером.

Расположение файла

application/helpers/ds_helper.php

Загрузка помощника

$this->load->helper('ds');

get_ds_file_path

Получение полного пути к исполняемым файлам панели.

string get_ds_file_path( array $server_data )
server_data
Данные сервера.

get_file_protocol

Получение названия протокола передачи файлов (FTP, SFTP, Local).

string get_file_protocol( array $server_data )
server_data
Данные сервера.

get_file_protocol_config

Получение данных для соединения с sftp или ftp.

string get_file_protocol_config( array $server_data )
server_data
Данные сервера.

get_last_command

Последняя отправленная команда на выделенный сервер.

string get_last_command()

get_sended_commands

Список отправленных команд на выделенный сервер.

array get_sended_commands()

list_ds_files

Список файлов в директории.

array list_ds_files(string $dir, array $server_data [, bool $full_info = false ] [, array $extensions ] )
dir
Директория на выделенном сервере
server_data
Данные сервера.
full_info
Полная информация о файле (дата создания, размер).
extensions
Массив со списком расширений файлов.

read_ds_file

Читает содержимое файла на выделенном сервере.

string read_ds_file ( string $file, array $server_data )
file
Файл на выделенном сервере
server_data
Данные сервера

write_ds_file

Записывает данные в файл на выделенном сервере.

bool write_ds_file ( string $file, string $contents, array $server_data )
file
Файл на выделенном сервере
contents
Данные файла
server_data
Данные сервера

replace_shotcodes

Заменяет шоткоды в команде.

replace_shotcodes ( string $command, array $server_data )
command
Отправляемая команда с шоткодами
server_data
Данные сервера

send_command

Отправляет команду на сервер.

string send_command ( string $command, array $server_data [ , bool $path = false ] )
command
Отправляемая команда
server_data
Данные сервера
path
Путь. Перед отправкой команды будет выполнена смена на указанный путь.