Download the PHP package starkeen/yandex-search-api without Composer

On this page you can find all versions of the php package starkeen/yandex-search-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of starkeen/yandex-search-api

Informations about the package yandex-search-api

yandex-search-api

Library for Yandex Search API

Packagist Version (custom server) Packagist PHP Version Support (specify version) GitHub codecov Quality Gate Status Codacy Badge

Description

This library is a convenient way to interact with the Yandex Search API (the XML interface). It allows for easy integration of Yandex search functionality into your PHP projects. The library encapsulates the complex logic of interacting with the API and provides a simple and understandable interface for executing search queries.

Requirements

Installation

To install the library, add it to your project using Composer:

Usage

To use the library, you need to get an API key. You can get it on the Yandex Search API page.

Configuration

To use the library, you need to provide your Yandex Search API key and your account (folder) ID. You can obtain them by registering your application on the Yandex Cloud Console.

The recommended way is to pass the credentials to the constructor (store them in a configuration file / environment variables rather than hard-coding them):

The setApiId() / setApiKey() setters are still available but deprecated since 2.0 — prefer constructor injection.

If credentials are not provided, search() throws a YandexSearchAPI\ConfigurationException.

Tuning the request

SearchRequest exposes setters to control the query:

Passing a value outside the allowed enum to setLanguage(), setSort() or setFilter() throws a YandexSearchAPI\ConfigurationException.

Working with the response

search() returns a YandexSearchAPI\SearchResponse:

Error handling

Exception When it is thrown
YandexSearchAPI\ConfigurationException Missing credentials, or an invalid language / sort / filter value.
YandexSearchAPI\SearchException Transport error, malformed XML, or an error reported by the API (e.g. code 15).

Both exceptions extend \RuntimeException.

Questions and Feedback

If you have questions, issues, or suggestions for improvement, please create a new issue in the Issues section on GitHub.

License

This library is distributed under the MIT license. See the LICENSE file for details.

All versions of yandex-search-api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-libxml Version *
ext-simplexml Version *
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
psr/log Version ^3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package starkeen/yandex-search-api contains the following files

Loading the files please wait ...