Overview

Namespaces

  • Cz
    • Git

Classes

  • Cz\Git\GitRepository

Interfaces

  • Cz\Git\IGit

Exceptions

  • Cz\Git\GitException
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 
<?php
    /**
     * IGit interface
     *
     * @author  Jan Pecha, <janpecha@email.cz>
     * @license New BSD License (BSD-3), see file license.md
     */

    namespace Cz\Git;

    interface IGit
    {
        /**
         * Creates a tag.
         * @param  string
         * @param  array|NULL
         * @throws Cz\Git\GitException
         */
        function createTag($name, $options = NULL);


        /**
         * Removes tag.
         * @param  string
         * @throws Cz\Git\GitException
         */
        function removeTag($name);


        /**
         * Renames tag.
         * @param  string
         * @param  string
         * @throws Cz\Git\GitException
         */
        function renameTag($oldName, $newName);


        /**
         * Returns list of tags in repo.
         * @return string[]|NULL  NULL => no tags
         */
        function getTags();


        /**
         * Merges branches.
         * @param  string
         * @param  array|NULL
         * @throws Cz\Git\GitException
         */
        function merge($branch, $options = NULL);


        /**
         * Creates new branch.
         * @param  string
         * @param  bool
         * @throws Cz\Git\GitException
         */
        function createBranch($name, $checkout = FALSE);


        /**
         * Removes branch.
         * @param  string
         * @throws Cz\Git\GitException
         */
        function removeBranch($name);


        /**
         * Gets name of current branch
         * @return string
         * @throws Cz\Git\GitException
         */
        function getCurrentBranchName();


        /**
         * Returns list of branches in repo.
         * @return string[]|NULL  NULL => no branches
         */
        function getBranches();


        /**
         * Returns list of local branches in repo.
         * @return string[]|NULL  NULL => no branches
         */
        function getLocalBranches();


        /**
         * Checkout branch.
         * @param  string
         * @throws Cz\Git\GitException
         */
        function checkout($name);


        /**
         * Removes file(s).
         * @param  string|string[]
         * @throws Cz\Git\GitException
         */
        function removeFile($file);


        /**
         * Adds file(s).
         * @param  string|string[]
         * @throws Cz\Git\GitException
         */
        function addFile($file);


        /**
         * Adds all created, modified & removed files.
         * @throws Cz\Git\GitException
         */
        function addAllChanges();


        /**
         * Renames file(s).
         * @param  string|string[]  from: array('from' => 'to', ...) || (from, to)
         * @param  string|NULL
         * @throws Cz\Git\GitException
         */
        function renameFile($file, $to = NULL);


        /**
         * Commits changes
         * @param  string
         * @param  string[]  param => value
         * @throws Cz\Git\GitException
         */
        function commit($message, $params = NULL);


        /**
         * Exists changes?
         * @return bool
         */
        function hasChanges();


        /**
         * Pull changes from a remote
         * @param  string|NULL
         * @param  array|NULL
         * @return self
         * @throws GitException
         */
        function pull($remote = NULL, array $params = NULL);


        /**
         * Push changes to a remote
         * @param  string|NULL
         * @param  array|NULL
         * @return self
         * @throws GitException
         */
        function push($remote = NULL, array $params = NULL);


        /**
         * Run fetch command to get latest branches
         * @param  string|NULL
         * @param  array|NULL
         * @return self
         * @throws GitException
         */
        function fetch($remote = NULL, array $params = NULL);

        /**
         * Adds new remote repository
         * @param  string
         * @param  string
         * @param  array|NULL
         * @return self
         */
        function addRemote($name, $url, array $params = NULL);


        /**
         * Renames remote repository
         * @param  string
         * @param  string
         * @return self
         */
        function renameRemote($oldName, $newName);


        /**
         * Removes remote repository
         * @param  string
         * @return self
         */
        function removeRemote($name);


        /**
         * Changes remote repository URL
         * @param  string
         * @param  string
         * @param  array|NULL
         * @return self
         */
        function setRemoteUrl($name, $url, array $params = NULL);


        /**
         * Init repo in directory
         * @param  string
         * @param  array|NULL
         * @return self
         * @throws GitException
         */
        static function init($directory, array $params = NULL);


        /**
         * Clones GIT repository from $url into $directory
         * @param  string
         * @param  string|NULL
         * @return self
         */
        static function cloneRepository($url, $directory = NULL);
    }


    class GitException extends \Exception
    {
    }
czproject/git-php v3.11.0 API documentation API documentation generated by ApiGen