Skip to content

Commit

Permalink
Bump version to v3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
frost-nzcr4 committed Sep 13, 2016
1 parent 13abcc9 commit a636179
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 14 deletions.
21 changes: 18 additions & 3 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,35 @@
Changes
=======

JAXL introduces changes that affect compatibility:
JAXL introduces changes that affects on backward compatibility:

v3.1.0

* PHP version >= 5.3: namespaces and anonymous functions.
* All methods now in camel case format (i.e. JAXL->require_xep => JAXL->requireXep).
* JAXL now use autoloader from Composer, so no more `require_once 'jaxl.php'`.
* Sources moves to subfolder `src/JAXL`, class JAXLCtl goes from `jaxlctl`
to `src/JAXL/jaxlctl.php`, class HTTPDispathRule goes from `http_dispatcher.php`
to `src/JAXL/http_dispatch_rule.php`.
* Class names XEP_* drops underscores and changed to XEP* to conform PSR-2.
* All config parameters of JAXL sets on instantiation to their default values,
previously used code like `isset(JAXL->cfg['some-parameter'])` not need
`isset` anymore.
* Globally defined log functions drops their underscores and moves
to JAXLLogger, _colorize renamed to JAXLLogger::cliLog.
* JAXLXml->childrens fixed to children.
* Some methods now in camel case format (i.e. JAXL->require_xep => JAXL->requireXep).
* All constants now in upper case format (i.e. JAXL::version => JAXL::VERSION).
* Renaming of methods that starts with _ prefix, they only used in private API
and shouldn't affect you.
* JAXL_CWD not used anymore and changed to getcwd().
* Move JAXL_MULTI_CLIENT to "multi_client" config parameter.
* Globally defined NS_* now moves to XEPs constants. File xmpp_nss.php was
renamed to xmpp.php, so use XMPP::NS_*.
* JAXL_ERROR and other log levels goes to JAXLLogger::ERROR constant and so on.
* HTTP_CRLF and other HTTP_* codes goes to HTTPServer::HTTP_* constants.
* JAXLEvent->reg is not public property anymore, but you can get
it with JAXLEvent->getRegistry()
* In JAXLXml::construct first argument $name is required.
* JAXL->add_exception_handlers moves to JAXLException::addHandlers.
* If some of your applications watch for debug message that starts with
"active read fds: " then you've warned about new message format
"Watch: active read fds: " and "Unwatch: active read fds: ".
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Jaxl v3.0.3
Jaxl v3.1.0
-----------

Jaxl v3.x is a successor of v2.x (and is NOT backward compatible),
Expand All @@ -10,17 +10,17 @@ philosophies from my experience with erlang and python languages.
Jaxl is an asynchronous, non-blocking I/O, event based PHP library
for writing custom TCP/IP client and server implementations.
From it's previous versions, library inherits a full blown stable support
for [XMPP protocol stack](https://github.com/jaxl/JAXL/tree/v3.0.3/xmpp).
In v3.0, support for [HTTP protocol stack](https://github.com/jaxl/JAXL/tree/v3.0.3/http)
for [XMPP protocol stack](https://github.com/jaxl/JAXL/tree/v3.1.0/xmpp).
In v3.0, support for [HTTP protocol stack](https://github.com/jaxl/JAXL/tree/v3.1.0/http)
has also been added.

At the heart of every protocol stack sits the [Core stack](https://github.com/jaxl/JAXL/tree/v3.0.3/core).
At the heart of every protocol stack sits the [Core stack](https://github.com/jaxl/JAXL/tree/v3.1.0/core).
It contains all the building blocks for everything that we aim to do with Jaxl library.
Both XMPP and HTTP protocol stacks are written on top of the Core stack.
Infact the source code of protocol implementations knows nothing
about the standard (inbuilt) PHP socket and stream methods.

[Examples](https://github.com/jaxl/JAXL/tree/v3.0.3/examples/)
[Examples](https://github.com/jaxl/JAXL/tree/v3.1.0/examples/)

[Documentation](http://jaxl.readthedocs.org/)

Expand All @@ -30,6 +30,12 @@ about the standard (inbuilt) PHP socket and stream methods.

[Author](http://abhinavsingh.com/)

## Installation

```ShellSession
php composer.phar require "jaxl/jaxl=^3.1.0"
```

## Contributing

JAXL since v3.0.1 adopt [PSR-2](http://www.php-fig.org/psr/psr-2/).
Expand Down
9 changes: 7 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
}
],
"require": {
"php": ">=5.3",
"php": ">=5.2.4",
"ext-curl": "*",
"ext-hash": "*",
"ext-json": "*",
Expand All @@ -41,5 +41,10 @@
"/tests/"
]
},
"bin": ["jaxlctl"]
"bin": ["jaxlctl"],
"extra": {
"branch-alias": {
"dev-master": "3.1.x-dev"
}
}
}
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
# The short X.Y version.
version = '3.0'
# The full version, including alpha/beta/rc tags.
release = '3.0.3'
release = '3.1.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
3 changes: 1 addition & 2 deletions docs/users/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ Install

Use `Composer <https://getcomposer.org>`_ to install:

php composer.phar require "jaxl/jaxl=^3.0.3"
php composer.phar update
php composer.phar require "jaxl/jaxl=^3.1.0"

Then use autoloader in your application:

Expand Down
2 changes: 1 addition & 1 deletion src/JAXL/jaxl.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class JAXL extends XMPPStream
{

// lib meta info
const VERSION = '3.0.3';
const VERSION = '3.1.0';
const NAME = 'JAXL :: Jabber XMPP Library';

// cached init config array
Expand Down

0 comments on commit a636179

Please sign in to comment.