Overview
  • Namespace
  • Class

Namespaces

  • DevStrefa
    • Esemeser

Classes

  • Esemeser
  • Message
  • MessageType

Class Esemeser

Library main class

Esemeser is a simple library for sending Mobile Text messages through esemeser.pl official API

Namespace: DevStrefa\Esemeser
License: MIT
Author: Cichy d3ut3r@gmail.com
Version: 1.1.0
Located at src/DevStrefa/Esemeser/Esemeser.php

Methods summary

public
# __construct( string $account = null, string $login = null, string $password = null )

Class Constructor

Class Constructor

Parameters

$account
Account name
$login
Account login
$password
Account password
public
# setRequestMethod( $requestMethod )

Set mechanism used to make requests to API (Allowed values: fgc OR curl) file_get_contents is default

Set mechanism used to make requests to API (Allowed values: fgc OR curl) file_get_contents is default

Parameters

$requestMethod

Throws

InvalidArgumentException
Exception is thrown when invalud request method is provided as argument
public integer
# checkBalance( string $messageType = null )

Method returns number of possible to send messages of given type

Method returns number of possible to send messages of given type

Parameters

$messageType
Type of message

Returns

integer
Number of messages possible to send

Throws

InvalidArgumentException
Exception is thrown when provided type is incorrect
Exception
Exception is thrown when library wasn't able to get number of messages (ie. credentials was wrong)
public boolean
# send( DevStrefa\Esemeser\Message $message )

Method will send given message

Method will send given message

Parameters

$message
instance of message object

Returns

boolean
Function return true if message was sent

Throws

Exception
Exception is thrown when message wasn't send
public string
# getAccount( )

Method returns account name

Method returns account name

Returns

string
public DevStrefa\Esemeser\Esemeser
# setAccount( string $account )

Method for setting account name

Method for setting account name

Parameters

$account
Account name

Returns

DevStrefa\Esemeser\Esemeser
public string
# getLogin( )

Method returns account login

Method returns account login

Returns

string
public DevStrefa\Esemeser\Esemeser
# setLogin( string $login )

Method for setting login to account

Method for setting login to account

Parameters

$login

Returns

DevStrefa\Esemeser\Esemeser
public string
# getPassword( )

Method return password

Method return password

Returns

string
public DevStrefa\Esemeser\Esemeser
# setPassword( string $password )

Method for setting password to account

Method for setting password to account

Parameters

$password

Returns

DevStrefa\Esemeser\Esemeser

Constants summary

string SEND_URL
# 'https://esemeser.pl/0api/wyslij.php'
string CHECK_URL
# 'https://esemeser.pl/0api/sprawdz.php'
API documentation generated by ApiGen