Update third-party composer package in your project

Sometimes you encounter some issue or would like to add some feature to the open source package you use in your project. And it useful enough to be contributed to the original package. Or you fixed some bug and want to share it with package maintainer.
The best way (and usually the only way) to do this is to fork the package on github and send the pull request. But what if your application can't work without this fix? 
The simplest way to resolve this matter is to move package from vendor to your project and maintain it there. But this approach has a few flaws - it is quite hard to keep library up to date with original and not so easy to contribute to the package.
It is much better to fork the package, switch composer to your fork, fix the bug and contribute it back on github.

So the steps are:


Fork the package on github


Just go to the package github page and press button "Fork". As a result you will have a copy of the original package in your account, like a this https://github.com/cmyker/PACKAGE

Clone forked repository somewhere

git clone git@github.com:cmyker/PACKAGE.git

Add original package repository as upstream

git remote add upstream https://github.com/AUTHOR/PACKAGE.git
git fetch upstream

Update your fork if it is behind




git fetch upstream
git merge upstream/master

















Create a branch for your fix










git branch some-fix



At this stage I replace original package in vendor directory with symlink to my cloned fork, change or fix something, and once it ready to be published I do the following



Change the branch in composer.json
















  "require": {
    ...
    "AUTHOR/PACKAGE": "dev-some-fix"
    ...
  }





Add your repository to composer.json
















  "repositories": [


    ...
    {
      "type": "vcs",
      "url": "https://github.com/cmyker/Holiday.git"
    }


    ...
  ],





Replace original package with your version










composer update AUTHOR/PACKAGE







Send pull request on github https://help.github.com/articles/using-pull-requests/ and once your contribution will be approved and merged you can switch back the package to the original repository.


























































Comments











Post a Comment



















Popular posts from this blog









Memory efficient array permutation in PHP 5.5 using generators





















Generators support was introduced in PHP 5.5.  The yield  keyword is a really cool thing that allows to write an elegant and memory efficient code.  It was existing in another dynamic languages like python for quite a long time and now it is in PHP as well!  To demonstrate generators concept, i wrote a sample function that  yields  all permutations  of the given array and avoids of data copying on recursive calls:    function permute( $array ) {       $length = sizeof( $array );       $inner = function ( $ix = []) use ( $array , $length , & $inner ) {           $yield = sizeof( $ix ) == $length - 1 ;           for ( $i = 0 ; $i < $length ; $i ++) {               if (in_array( $i , $ix )) {                   continue ;               } elseif ( $yield ) {                   $toYield = [];                   foreach (array_merge( $ix , [ $i ]) as $index ) {                       $toYield [] = $array [ $index ];                   }                   yield $toYield ;               } el








Read more










How to dump http request headers with PHP under CGI/FastCGI SAPI





















Good old days of PHP installation exclusively as an Apache module are gone. Most of the modern PHP installations interact with a web server via FastCGI protocol. For instance nginx webserver and php-fpm daemon. This means that certain apache SAPI functions are not available anymore. One of this functions is apache_request_headers() to dump http headers sent by client.   From CGI specification rfc3875, section 4.1.18:   Meta-variables with names beginning with "HTTP_" contain values read from the client request header fields, if the protocol used is HTTP. The HTTP header field name is converted to upper case, has all occurrences of "-" replaced with "_" and has "HTTP_" prepended to give the meta-variable name.     According to the specification above i wrote a piece of the PHP code that dumps all headers sent by client under any PHP SAPI:   foreach ($_SERVER as $key => $value) {     if (strpos($key, 'HTTP_') === 0) {         $chunks = e








Read more










Zend Framework 2 AJAX: return JSON response from controller action. The proper way.





















There is a lot of solutions over the web on how to return data on AJAX request in your Zend Framework 2 application. But none of them seems to be aware of the "right way" described in Zend Framework 2 manual - http://framework.zend.com/manual/2.0/en/modules/zend.mvc.examples.html#returning-early   Implementation example:   <?php  namespace <YOUR_MODULE>\Controller;  use Zend\Mvc\Controller\AbstractActionController; use Zend\Json\Json;  class AjaxController extends AbstractActionController {      public function testAction()     {         $data = array(             'result' => true,             'data' => array()         )         return $this->getResponse()->setContent(Json::encode($data));     }      }  








Read more