├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── Tests ├── Bootstrap.php ├── HookTest.php └── phpunit.xml ├── composer.json └── src └── Pentagonal └── Hookable └── Hookable.php /.gitignore: -------------------------------------------------------------------------------- 1 | # ####################################################################### 2 | # Gitignore 3 | # Add Some Common OS and Code Editor 4 | # ####################################################################### 5 | 6 | # 7 | # ================================= 8 | # Gitignore For Mac 9 | # ================================= 10 | # 11 | 12 | # Apple Default hidden 13 | .DS_Store 14 | .AppleDouble 15 | .LSOverride 16 | 17 | # Icon must end with two \r 18 | Icon 19 | 20 | 21 | # Thumbnails 22 | ._* 23 | 24 | # Files that might appear in the root of a volume 25 | .DocumentRevisions-V100 26 | .fseventsd 27 | .Spotlight-V100 28 | .TemporaryItems 29 | .Trashes 30 | .VolumeIcon.icns 31 | 32 | # Directories potentially created on remote AFP share 33 | .AppleDB 34 | .AppleDesktop 35 | Network Trash Folder 36 | Temporary Items 37 | .apdisk 38 | 39 | # 40 | # ================================= 41 | # Gitignore For Windows 42 | # ================================= 43 | # 44 | 45 | # Windows image file caches 46 | Thumbs.db 47 | thumbs.db 48 | ehthumbs.db 49 | 50 | # Folder config file 51 | Desktop.ini 52 | 53 | # Recycle Bin used on file shares 54 | $RECYCLE.BIN/ 55 | 56 | # System Volumes Information used on file shares 57 | System Volume Information/ 58 | 59 | # Windows Installer files 60 | *.cab 61 | *.msi 62 | *.msm 63 | *.msp 64 | *.exe 65 | 66 | # Windows shortcuts 67 | *.lnk 68 | 69 | # 70 | # ================================= 71 | # Gitignore For Linux OS 72 | # ================================= 73 | 74 | # KDE directory preferences 75 | .directory 76 | 77 | # Linux trash folder which might appear on any partition or disk 78 | .Trash-* 79 | 80 | # 81 | # ================================= 82 | # Gitignore For SublimeText 83 | # ================================= 84 | 85 | # cache files for sublime text 86 | *.tmlanguage.cache 87 | *.tmPreferences.cache 88 | *.stTheme.cache 89 | 90 | # workspace files are user-specific 91 | *.sublime-workspace 92 | 93 | # project files should be checked into the repository, unless a significant 94 | # proportion of contributors will probably not be using SublimeText 95 | # *.sublime-project 96 | 97 | # sftp configuration file 98 | sftp-config.json 99 | 100 | # 101 | # ================================= 102 | # Gitignore For Jetbrain 103 | # ================================= 104 | # 105 | 106 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm 107 | *.iml 108 | 109 | ## Directory-based project format: 110 | .idea/ 111 | # if you remove the above rule, at least ignore the following: 112 | 113 | # User-specific stuff: 114 | # .idea/workspace.xml 115 | # .idea/tasks.xml 116 | # .idea/dictionaries 117 | # .idea/shelf 118 | 119 | # Sensitive or high-churn files: 120 | # .idea/dataSources.ids 121 | # .idea/dataSources.xml 122 | # .idea/sqlDataSources.xml 123 | # .idea/dynamic.xml 124 | # .idea/uiDesigner.xml 125 | 126 | # Gradle: 127 | # .idea/gradle.xml 128 | # .idea/libraries 129 | 130 | # Mongo Explorer plugin: 131 | # .idea/mongoSettings.xml 132 | 133 | ## File-based project format: 134 | *.ipr 135 | *.iws 136 | 137 | ## Plugin-specific files: 138 | 139 | # IntelliJ 140 | /out/ 141 | 142 | # mpeltonen/sbt-idea plugin 143 | .idea_modules/ 144 | 145 | # JIRA plugin 146 | atlassian-ide-plugin.xml 147 | 148 | # Crashlytics plugin (for Android Studio and IntelliJ) 149 | com_crashlytics_export_strings.xml 150 | crashlytics.properties 151 | crashlytics-build.properties 152 | fabric.properties 153 | 154 | # Gitignore For Composer 155 | # ================================= 156 | # 157 | 158 | # ignore all lock file 159 | *.lock 160 | # ignore composer phar file 161 | composer.phar 162 | 163 | # add exclude vendor 164 | vendor/ 165 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | 3 | language: php 4 | 5 | php: 6 | - 5.3 7 | - 5.4 8 | - 5.5 9 | - 5.6 10 | - 7.0 11 | - hhvm 12 | 13 | before_script: 14 | - composer install 15 | 16 | script: cd Tests && phpunit --configuration phpunit.xml --coverage-text 17 | 18 | matrix: 19 | fast_finish: true 20 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Hookable 2 | Hook able Library like a WordPress uses 3 | 4 | [![Build Status](https://travis-ci.org/pentagonal/Hookable.svg?branch=master)](https://travis-ci.org/pentagonal/Hookable) 5 | [![Latest Stable Version](https://poser.pugx.org/pentagonal/hookable/v/stable)](https://packagist.org/packages/pentagonal/hookable) 6 | [![License](https://poser.pugx.org/pentagonal/hookable/license)](https://packagist.org/packages/pentagonal/hookable) 7 | [![Total Downloads](https://poser.pugx.org/pentagonal/hookable/downloads)](https://packagist.org/packages/pentagonal/hookable) 8 | 9 | ### Usage 10 | 11 | ```php 12 | $hook = new \Pentagonal\Hookable\Hookable(); 13 | 14 | /** 15 | * Add Hook into functions example 16 | */ 17 | function thIsIsOnHookReturn() 18 | { 19 | global $hooks; 20 | /** 21 | * .... run the code 22 | */ 23 | $the_result = array('array_result'); // the returning result 24 | return $hook->apply('callback_name', $the_result); 25 | } 26 | 27 | /** 28 | * in here 29 | * Calling thIsIsOnHookReturn() 30 | * will be returning array 31 | */ 32 | var_dump(thIsIsOnHookReturn()); 33 | 34 | /** 35 | * add filter / action on determined callback 36 | */ 37 | $hook->add( 38 | 'callback_name', // the callback 39 | function ($returning_old_result) { 40 | $new_result = print_r($returning_result, true); 41 | return $new_result; 42 | }, 43 | 10, // priority 44 | 1 // arguments accepted 45 | ); 46 | 47 | /** 48 | * in here 49 | * Calling thIsIsOnHookReturn() 50 | * will be returning string of array printed 51 | */ 52 | var_dump(thIsIsOnHookReturn()); 53 | 54 | ``` 55 | ### Install 56 | 57 | ```json 58 | { 59 | "require": { 60 | "pentagonal/hookable": "^1" 61 | } 62 | } 63 | ``` 64 | -------------------------------------------------------------------------------- /Tests/Bootstrap.php: -------------------------------------------------------------------------------- 1 | hook = new Hookable(); 25 | } 26 | 27 | /** 28 | * Function assert String return valu 29 | * 30 | * @return mixed 31 | */ 32 | public function callbackAssertedAsString() 33 | { 34 | $asserted_string = $this->asserted_string; 35 | // appling 36 | return $this->hook->apply( 37 | $this->asserted_string_callback_name, 38 | $asserted_string 39 | ); 40 | } 41 | 42 | /** 43 | * Callback for Override Hook 44 | * 45 | * @return string 46 | */ 47 | public function callbackAssertedAsStringOverrideHook() 48 | { 49 | return $this->asserted_string_overriden; 50 | } 51 | 52 | /** 53 | * Assert Test 54 | * 55 | * @return void 56 | * @throws Exception 57 | */ 58 | public function testAssertEqualities() 59 | { 60 | /** 61 | * Asserting Equals 62 | */ 63 | $this->assertEquals( 64 | $this->asserted_string, 65 | $this->callbackAssertedAsString() 66 | ); 67 | 68 | /** 69 | * Add action Hooks 70 | * @priority 90 71 | */ 72 | $this->hook->add( 73 | $this->asserted_string_callback_name, 74 | array($this, 'callbackAssertedAsStringOverrideHook'), 75 | 90 76 | ); 77 | 78 | // re^check result function 79 | $this->assertNotEquals( 80 | $this->asserted_string, 81 | $this->callbackAssertedAsString() 82 | ); 83 | 84 | /** 85 | * Asserting Equals from overriden 86 | */ 87 | $this->assertEquals( 88 | $this->asserted_string_overriden, 89 | $this->callbackAssertedAsString() 90 | ); 91 | 92 | /** 93 | * remove the previous callback, so it must back onto standard 94 | * Because Callback using dynamic object uses Hookable::removeAll() 95 | * and set the priority check to make sure it was removed 96 | */ 97 | $this->hook->removeAll( 98 | $this->asserted_string_callback_name, 99 | 90 100 | ); 101 | 102 | /** 103 | * Asserting Equals from overriden 104 | */ 105 | $this->assertNotEquals( 106 | $this->asserted_string_overriden, 107 | $this->callbackAssertedAsString() 108 | ); 109 | 110 | /** 111 | * Asserting Equals from Original 112 | */ 113 | $this->assertEquals( 114 | $this->asserted_string, 115 | $this->callbackAssertedAsString() 116 | ); 117 | } 118 | 119 | /** 120 | * @return mixed dynamic result 121 | */ 122 | public function callbackAssertArray(array $additional_array = array()) 123 | { 124 | $assert_array_merged = array_merge( 125 | /** 126 | * Return values @array 127 | */ 128 | array( 129 | 'keyname' => true 130 | ), 131 | $additional_array 132 | ); 133 | 134 | return $this->hook->apply( 135 | 'array_example_callback', // callback name 136 | $assert_array_merged 137 | ); 138 | } 139 | 140 | public function testAssertElse() 141 | { 142 | /** 143 | * Assery array has key 144 | */ 145 | $this->assertArrayHasKey( 146 | 'keyname', 147 | $this->callbackAssertArray() 148 | ); 149 | 150 | $c = $this; 151 | $this->hook->add( 152 | 'array_example_callback', // callback name 153 | function () use ($c) { 154 | return $c->callbackAssertArray(array('keyname_2' => true)); 155 | } 156 | ); 157 | 158 | /** 159 | * assert Check if Hooks exists 160 | */ 161 | $this->assertTrue( 162 | $this->hook->has('array_example_callback') 163 | ); 164 | 165 | /** 166 | * assert Check if Hooks not exists 167 | */ 168 | $this->assertFalse( 169 | $this->hook->has('nocallback') 170 | ); 171 | } 172 | } 173 | -------------------------------------------------------------------------------- /Tests/phpunit.xml: -------------------------------------------------------------------------------- 1 | 8 | 9 | . 10 | 11 | 12 | 13 | ../ 14 | 15 | 16 | ../src/Pentagonal/Hookable 17 | 18 | ./Bootstrap.php 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pentagonal/hookable", 3 | "description": "Hook able Library like a WordPress uses", 4 | "keywords": ["Hooks", "Library", "Utility", "Module", "WordPress"], 5 | "homepage": "https://www.pentagonal.org/", 6 | "type": "library", 7 | "version": "1.0", 8 | "license": "GPL-3.0+", 9 | "authors": [ 10 | { 11 | "name": "awan", 12 | "email": "nawa@yahoo.com", 13 | "homepage":"https://www.pentagonal.org", 14 | "role": "Developer" 15 | } 16 | ], 17 | "autoload": { 18 | "psr-0": { 19 | "Pentagonal\\Hookable\\": "src/" 20 | } 21 | }, 22 | "require": { 23 | "php": ">=5.3" 24 | }, 25 | "require-dev": { 26 | "phpunit/phpunit": "4.5.*" 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /src/Pentagonal/Hookable/Hookable.php: -------------------------------------------------------------------------------- 1 | 4 | * @license GPL-3.0+ 5 | * @version 1.0 6 | */ 7 | namespace Pentagonal\Hookable; 8 | 9 | /** 10 | * Class Hookable 11 | * @license Follow WordPress GPL-3.0+ 12 | * @see {@link: https://wordpress.org/license} for more related WordPress License 13 | * @package Pentagonal\Hookable 14 | */ 15 | class Hookable 16 | { 17 | /** 18 | * Merged Hooks Records 19 | * @var array 20 | */ 21 | protected $merged = array(); 22 | 23 | /** 24 | * Current Hooks Record 25 | * @var array 26 | */ 27 | protected $current = array(); 28 | 29 | /** 30 | * Actions Records 31 | * @var array 32 | */ 33 | protected $actions = array(); 34 | 35 | /** 36 | * Filter Records 37 | * @var array 38 | */ 39 | protected $filters = array(); 40 | 41 | /** 42 | * PHP5 Constructor 43 | */ 44 | public function __construct() 45 | { 46 | } 47 | 48 | /** 49 | * Create Unique ID if function is not string 50 | * 51 | * @param string $hookName determine the hook name 52 | * @param callable $function function to call 53 | * @param integer $priority the priority of hooks 54 | * 55 | * @access private 56 | * @return string|bool 57 | */ 58 | private function uniqueId($hookName, $function, $priority) 59 | { 60 | static $count = 0; 61 | if (is_string($function)) { 62 | return $function; 63 | } 64 | if (is_object($function)) { 65 | // Closures are currently implemented as objects 66 | $function = array($function, ''); 67 | } elseif (!is_array($function)) { 68 | $function = array($function); 69 | } 70 | 71 | if (is_object($function[0])) { 72 | // Object Class Calling 73 | if (function_exists('spl_object_hash')) { 74 | return spl_object_hash($function[0]) . $function[1]; 75 | } else { 76 | $object_id = get_class($function[0]).$function[1]; 77 | if (!isset($function[0]->id)) { 78 | if (false === $priority) { 79 | return false; 80 | } 81 | $object_id .= isset($this->filters[$hookName][$priority]) 82 | ? count((array) $this->filters[$hookName][$priority]) 83 | : $count; 84 | $function[0]->id = $count; 85 | $count++; 86 | } else { 87 | $object_id .= $function[0]->id; 88 | } 89 | return $object_id; 90 | } 91 | } elseif (is_string($function[0])) { 92 | // callas static 93 | return $function[0] . '::' . $function[1]; 94 | } 95 | // unexpected result 96 | return null; 97 | } 98 | 99 | /** 100 | * Call the 'all' hook, which will process the functions hooked into it. 101 | * 102 | * The 'all' hook passes all of the arguments or parameters that were used for 103 | * the hook, which this function was called for. 104 | * 105 | * Inherited docs from WordPress : 106 | * ------------------------------- 107 | * This function is used internally for apply_filters(), do_action(), and 108 | * do_action_ref_array() and is not meant to be used from outside those 109 | * functions. This function does not check for the existence of the all hook, so 110 | * it will fail unless the all hook exists prior to this function call. 111 | * 112 | * @access private 113 | * @param array $args The collected parameters from the hook that was called. 114 | */ 115 | private function callAll($args) 116 | { 117 | if (isset($this->filters['all'])) { 118 | reset($this->filters['all']); 119 | do { 120 | foreach ((array) current($this->filters['all']) as $fn_arr) { 121 | if (!is_null($fn_arr['function'])) { 122 | call_user_func_array($fn_arr['function'], $args); 123 | } 124 | } 125 | } while (next($this->filters['all']) !== false); 126 | } 127 | } 128 | 129 | /** 130 | * Sanitize keyname that must be as string and not empty 131 | * 132 | * @param string $key 133 | * 134 | * @return bool|string 135 | */ 136 | public function sanitize($key) 137 | { 138 | if (is_string($key) && trim($key)) { 139 | return trim($key); 140 | } 141 | return false; 142 | } 143 | 144 | /** 145 | * Add Hooks Function it just like a WordPress add_action() / add_filter() hooks 146 | * 147 | * @param string $hookName Hook Name 148 | * @param Callable $callable Callable 149 | * @param integer $priority priority 150 | * @param integer $accepted_args num count of accepted args / parameter 151 | * 152 | * @return boolean 153 | * @throws \Exception 154 | */ 155 | public function add($hookName, $callable, $priority = 10, $accepted_args = 1) 156 | { 157 | $hookName = $this->sanitize($hookName); 158 | if (!$hookName) { 159 | throw new \Exception("Invalid Hook Name Specified", E_USER_ERROR); 160 | } 161 | 162 | $id = $this->uniqueId($hookName, $callable, $priority); 163 | if ($id === null) { 164 | throw new \Exception( 165 | sprintf("Invalid callable specified on hook name %s", $hookName), 166 | E_USER_ERROR 167 | ); 168 | } 169 | 170 | $hook_list = $this->filters; 171 | $hook_list[$hookName][$priority][$id] = array( 172 | 'function' => $callable, 173 | 'accepted_args' => $accepted_args 174 | ); 175 | $this->filters = array_merge($this->filters, $hook_list); 176 | unset($this->merged[$hookName]); 177 | return true; 178 | } 179 | 180 | /** 181 | * Appending Hooks Function, if hooks existor just append the hooks 182 | * 183 | * @param string $hookName Hook Name 184 | * @param Callable $callable Callable 185 | * @param integer $priority priority 186 | * @param integer $accepted_args num count of accepted args / parameter 187 | * @param boolean $create true if want to create new if not exists 188 | * 189 | * @return boolean 190 | */ 191 | public function append($hookName, $callable, $priority = 10, $accepted_args = 1, $create = true) 192 | { 193 | if ($create || ! $this->has($hookName, $callable)) { 194 | return $this->add($hookName, $callable, $priority, $accepted_args); 195 | } 196 | return false; 197 | } 198 | 199 | /** 200 | * Check if hook name exists 201 | * 202 | * @param string $hookName Hook name 203 | * @param string|mixed $function_to_check Specially Functions on Hook 204 | * 205 | * @return boolean|int 206 | */ 207 | public function exists($hookName, $function_to_check = false) 208 | { 209 | $hookName = $this->sanitize($hookName); 210 | if (!$hookName || !isset($this->filters[$hookName])) { 211 | return false; 212 | } 213 | // Don't reset the internal array pointer 214 | $has = !empty($this->filters[$hookName]); 215 | // Make sure at least one priority has a filter callback 216 | if ($has) { 217 | $exists = false; 218 | foreach ($this->filters[$hookName] as $callbacks) { 219 | if (! empty($callbacks)) { 220 | $exists = true; 221 | break; 222 | } 223 | } 224 | 225 | if (! $exists) { 226 | $has = false; 227 | } 228 | } 229 | 230 | // recheck 231 | if (false === $function_to_check || false === $has) { 232 | return $has; 233 | } 234 | 235 | if (! $id = $this->uniqueId($hookName, $function_to_check, false)) { 236 | return false; 237 | } 238 | 239 | foreach (array_keys($this->filters[$hookName]) as $priority) { 240 | if (isset($this->filters[$hookName][$priority][$id])) { 241 | return $priority; 242 | } 243 | } 244 | 245 | return false; 246 | } 247 | 248 | /** 249 | * Check if hook name exists 250 | * 251 | * @param string $hookName Hook name 252 | * @param string|mixed $function_to_check Specially Functions on Hook 253 | * 254 | * @return boolean 255 | */ 256 | public function has($hookName, $function_to_check = false) 257 | { 258 | return $this->exists($hookName, $function_to_check) !== false; 259 | } 260 | 261 | /** 262 | * Applying Hooks for replaceable and returning as $value param 263 | * 264 | * @param string $hookName Hook Name replaceable 265 | * @param mixed $value returning value 266 | * 267 | * @return mixed 268 | */ 269 | public function apply($hookName, $value) 270 | { 271 | $hookName = $this->sanitize($hookName); 272 | if (!$hookName) { 273 | return $value; 274 | } 275 | 276 | $args = array(); 277 | // Do 'all' actions first. 278 | if (isset($this->filters['all'])) { 279 | $this->current[] = $hookName; 280 | $args = func_get_args(); 281 | $this->callAll($args); 282 | } 283 | 284 | if (! isset($this->filters[$hookName])) { 285 | if (isset($this->filters['all'])) { 286 | array_pop($this->current); 287 | } 288 | return $value; 289 | } 290 | 291 | if (! isset($this->filters['all'])) { 292 | $this->current[] = $hookName; 293 | } 294 | 295 | // Sort. 296 | if (!isset($this->merged[$hookName])) { 297 | ksort($this->filters[$hookName]); 298 | $this->merged[$hookName] = true; 299 | } 300 | 301 | reset($this->filters[$hookName]); 302 | if (empty($args)) { 303 | $args = func_get_args(); 304 | } 305 | do { 306 | foreach ((array) current($this->filters[$hookName]) as $fn_array) { 307 | if (!is_null($fn_array['function'])) { 308 | $args[1] = $value; 309 | $value = call_user_func_array( 310 | $fn_array['function'], 311 | array_slice($args, 1, (int) $fn_array['accepted_args']) 312 | ); 313 | } 314 | } 315 | } while (next($this->filters[$hookName]) !== false); 316 | 317 | array_pop($this->current); 318 | return $value; 319 | } 320 | 321 | /** 322 | * Call hook from existing declared hook record 323 | * 324 | * @param string $hookName Hook Name 325 | * @param string $arg the arguments for next parameter 326 | * 327 | * @return boolean 328 | */ 329 | public function call($hookName, $arg = '') 330 | { 331 | $hookName = $this->sanitize($hookName); 332 | if (!$hookName) { 333 | return false; 334 | } 335 | if (! isset($this->actions[$hookName])) { 336 | $this->actions[$hookName] = 1; 337 | } else { 338 | $this->actions[$hookName]++; 339 | } 340 | 341 | // Do 'all' actions first 342 | if (isset($this->filters['all'])) { 343 | $this->current[] = $hookName; 344 | $all_args = func_get_args(); 345 | $this->callAll($all_args); 346 | } 347 | 348 | if (!isset($this->filters[$hookName])) { 349 | if (isset($this->filters['all'])) { 350 | array_pop($this->current); 351 | } 352 | return null; 353 | } 354 | 355 | if (!isset($this->filters['all'])) { 356 | $this->current[] = $hookName; 357 | } 358 | 359 | $args = array(); 360 | if (is_array($arg) && 1 == count($arg) && isset($arg[0]) && is_object($arg[0])) { 361 | // array(&$this) 362 | $args[] =& $arg[0]; 363 | } else { 364 | $args[] = $arg; 365 | } 366 | 367 | for ($a = 2, $num = func_num_args(); $a < $num; $a++) { 368 | $args[] = func_get_arg($a); 369 | } 370 | // Sort 371 | if (!isset($this->merged[$hookName])) { 372 | ksort($this->filters[$hookName]); 373 | $this->merged[$hookName] = true; 374 | } 375 | reset($this->filters[$hookName]); 376 | do { 377 | foreach ((array) current($this->filters[$hookName]) as $the_) { 378 | if (!is_null($the_['function'])) { 379 | call_user_func_array( 380 | $the_['function'], 381 | array_slice($args, 0, (int) $the_['accepted_args']) 382 | ); 383 | } 384 | } 385 | } while (next($this->filters[$hookName]) !== false); 386 | array_pop($this->current); 387 | 388 | return true; 389 | } 390 | 391 | /** 392 | * Replace Hooks Function, this will replace all existing hooks 393 | * 394 | * @param string $hookName Hook Name 395 | * @param string $function_to_replace Function to replace 396 | * @param Callable $callable Callable 397 | * @param integer $priority priority 398 | * @param integer $accepted_args num count of accepted args / parameter 399 | * @param boolean $create true if want to create new if not exists 400 | * 401 | * @return boolean 402 | * @throws \Exception 403 | */ 404 | public function replace( 405 | $hookName, 406 | $function_to_replace, 407 | $callable, 408 | $priority = 10, 409 | $accepted_args = 1, 410 | $create = true 411 | ) { 412 | $hookName = $this->sanitize($hookName); 413 | if (!$hookName) { 414 | throw new \Exception("Invalid Hook Name Specified", E_ERROR); 415 | } 416 | 417 | if (!is_callable($callable)) { 418 | throw new \Exception("Invalid Hook Callable Specified", E_ERROR); 419 | } 420 | 421 | if (($has = $this->has($hookName, $function_to_replace)) || $create) { 422 | $has && $this->remove($hookName, $function_to_replace); 423 | // add hooks first 424 | return $this->add($hookName, $callable, $priority, $accepted_args); 425 | } 426 | 427 | return false; 428 | } 429 | 430 | /** 431 | * Removing Hook (remove single hook) 432 | * 433 | * @param string $hookName Hook Name 434 | * @param string $function_to_remove functions that to remove from determine $hookName 435 | * @param integer $priority priority 436 | * 437 | * @return boolean 438 | */ 439 | public function remove($hookName, $function_to_remove, $priority = 10) 440 | { 441 | $hookName = $this->sanitize($hookName); 442 | if (!$hookName) { 443 | return false; 444 | } 445 | $function_to_remove = $this->uniqueId($hookName, $function_to_remove, $priority); 446 | $r = isset($this->filters[$hookName][$priority][$function_to_remove]); 447 | if (true === $r) { 448 | unset($this->filters[$hookName][$priority][$function_to_remove]); 449 | if (empty($this->filters[$hookName][$priority])) { 450 | unset($this->filters[$hookName][$priority]); 451 | } 452 | if (empty($this->filters[$hookName])) { 453 | $this->filters[$hookName] = array(); 454 | } 455 | unset($this->merged[$hookName]); 456 | } 457 | 458 | return $r; 459 | } 460 | 461 | /** 462 | * Remove all of the hooks from a filter. 463 | * 464 | * @param string $hookName The filter to remove hooks from. 465 | * @param int|bool $priority Optional. The priority number to remove. Default false. 466 | * 467 | * @return boolean 468 | */ 469 | public function removeAll($hookName, $priority = false) 470 | { 471 | if (isset($this->filters[$hookName])) { 472 | if (false === $priority) { 473 | $this->filters[$hookName] = array(); 474 | } elseif (isset($this->filters[$hookName][$priority])) { 475 | $this->filters[$hookName][$priority] = array(); 476 | } 477 | } 478 | unset($this->merged[$hookName]); 479 | return true; 480 | } 481 | 482 | /** 483 | * Current position 484 | * 485 | * @return string functions 486 | */ 487 | public function current() 488 | { 489 | return end($this->current); 490 | } 491 | 492 | /** 493 | * Count all existences Hook 494 | * 495 | * @param string $hookName Hook name 496 | * 497 | * @return integer Hooks Count 498 | */ 499 | public function count($hookName) 500 | { 501 | $hookName = $this->sanitize($hookName); 502 | if (!$hookName || !isset($this->filters[$hookName])) { 503 | return false; 504 | } 505 | return count((array) $this->filters[$hookName]); 506 | } 507 | 508 | /** 509 | * Check if hook has doing 510 | * 511 | * @param string $hookName Hook name 512 | * 513 | * @return boolean true if has doing 514 | */ 515 | public function isDo($hookName = null) 516 | { 517 | if (null === $hookName) { 518 | return ! empty($this->current); 519 | } 520 | 521 | $hookName = $this->sanitize($hookName); 522 | return $hookName && in_array($hookName, $this->current); 523 | } 524 | 525 | /** 526 | * Check if action hook as execute 527 | * 528 | * @param string $hookName Hook Name 529 | * 530 | * @return integer Count of hook action if has did action 531 | */ 532 | public function isCalled($hookName) 533 | { 534 | $hookName = $this->sanitize($hookName); 535 | if (!$hookName || ! isset($this->actions[$hookName])) { 536 | return 0; 537 | } 538 | 539 | return $this->actions[$hookName]; 540 | } 541 | 542 | /** 543 | * Clear all resource properties 544 | */ 545 | public function clear() 546 | { 547 | $this->merged = array(); 548 | $this->current = array(); 549 | $this->actions = array(); 550 | $this->filters = array(); 551 | } 552 | } 553 | --------------------------------------------------------------------------------