christyb/sftp-api-bundle

list files and directories of a sftp server, possibility to search by file or content

1.0.0 2023-05-04 12:21 UTC

MIT

• christyB

README

Introduction

The purpose of this bundle is: first to list the files and directories of an sftp server; then to allow the search of a file or directory through its name; and finally to allow the search by content.

Installation

1. Download WyndApiBundle using composer
2. Add WyndApiBundle routing

1. Download WyndApiBundle using composer

Require the bundle with composer:

composer require christyb/sftp-api-bundle

2. Add WyndApiBundle routing

Add these lines in your config/routes/routes.yaml:

sftp_api_bundle:
  resource: '@WyndApiBundle/Resources/config/routes.yaml'
  prefix:

Routes

the differents routes availables in this bundle:

• /api/sftp/list
• /api/sftp/list/search?search=
• /api/sftp/list/search/content?word=

Documentation

• using of phpdocumentor :

• creation of the Doxygen configuration file:

• generation of documentation

Other

1. No forget environment variables(sftp server)
2. install phpseclib in your project

1. sftp

SFTP_HOST= #host of your sftp server SFTP_PASSWORD= #the password SFTP_USER= # the user

2. phpseclib

composer require phpseclib/phpseclib:~3.0