Download the PHP package florianwolters/component-core-hashcode without Composer
On this page you can find all versions of the php package florianwolters/component-core-hashcode. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download florianwolters/component-core-hashcode
More information about florianwolters/component-core-hashcode
Files in florianwolters/component-core-hashcode
Package component-core-hashcode
Short Description Provides a hash code value for objects as a PHP component.
License LGPL-3.0+
Homepage http://github.com/FlorianWolters/PHP-Component-Core-HashCode
Informations about the package component-core-hashcode
Component\Core\HashCode
Component\Core\HashCode is a simple-to-use PHP component that provides a hash code value for objects.
Table of Contents (ToC)
- Introduction
- Features
- Requirements
- Usage
- Installation
- Testing
- Contributing
- Credits
- License
Introduction
This component is inspired by the method java.lang.Object.hashCode
of
the Java programming language.
Component\Core\HashCode consists of two artifacts:
- The interface
FlorianWolters\Component\Core\HashCodeInterface
: Indicates that an implementing class provides a hash code value for objects. - The trait
FlorianWolters\Component\Core\HashCodeTrait
: Provides a default hash code value implementation for objects.
Features
- Offers a default hash code value implementation for objects via the method
hashCode
of the traitHashCodeTrait
. Refer to the section Usage below for an example. - Allows to create a custom hash code value implementation by implementing the
interface
HashCodeInterface
, more precisely implementing the public methodhashCode
of that interface. Refer to the section Usage below for an example. - Artifacts tested with both static and dynamic test procedures:
- Dynamic component tests (unit and integration tests) implemented with PHPUnit.
- Static code analysis performed using the following tools:
- PHP_CodeSniffer: Style Checker
- PHP Mess Detector (PHPMD): Code Analyzer
- PHP Depend: Code Metrics
- phpcpd: Copy/Paste Detector (CPD)
- phpdcd: Dead Code Detector (DCD)
- SensioLabs Security Checker: Security Checker
- Continuous Integration (CI) using the following web services:
- Provides a Packagist package which can be installed using the dependency manager Composer. Click here for the package on Packagist.
- Provides a complete Application Programming Interface (API) documentation generated with the documentation generator Sami. Click here for the API documentation.
-
Follows the following "standards" from the PHP Framework Interoperability Group (FIG). PSR stands for PHP Standards Recommendation:
-
PSR-0: Autoloading Standards
Aims to provide a standard file, class and namespace convention to allow plug-and-play code.
-
PSR-1: Basic Coding Standard
Aims to ensure a high level of technical interoperability between shared PHP code.
-
PSR-2: Coding Style Guide
Provides a Coding Style Guide for projects looking to standardize their code.
-
A more modern take on autoloading reflecting advances in the ecosystem.
-
- Follows the Semantic Versioning (SemVer) specification version 2.0.0.
Requirements
Production
Development
- PHPUnit
- phpcpd
- phpdcd
- PHP_CodeSniffer
- PHP Mess Detector (PHPMD)
- Sami
- SensioLabs Security Checker
- php-coveralls
Installation
Component\Core\HashCode should be installed using the dependency manager Composer.
Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you.
The Composer installer can be downloaded with php
.
php -r "readfile('https://getcomposer.org/installer');" | php
This will just check a few PHP settings and then download
composer.phar
to your working directory. This file is the Composer binary. It is a PHAR (PHP archive), which is an archive format for PHP which can be run on the command line, amongst other things.To resolve and download dependencies, run the
install
command:
php composer.phar install
If you are creating a component that relies on Component\Core\HashCode,
please make sure that you add Component\Core\HashCode to your component's
composer.json
file:
Usage
The best documentation for Component\Core\HashCode are the unit tests, which are shipped in the package.
The most important usage rule:
Always implement the interface
HashCodeInterface
if using the trait Type Hinting.
The class HashCodeExample
can be run via the command
php resources/php/HashCodeExample.php
from the root of the project.
Default Hash Code
The class HashCodeDefaultImpl
uses the default implementation of the
trait HashCodeTrait
. The trait uses the global function
spl_object_hash
to calculate the hash code for the object.
Custom Hash Code
The class HashCodeCustomImpl
implements a custom implementation, which
fulfills the design contract for a Value Object. The value of the object is
used to calculate the hash code for the object.
Testing
phpunit
Contributing
Please see CONTRIBUTING for details.
Credits
License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://gnu.org/licenses/lgpl.txt.
"PHP: Hypertext Preprocessor"
"Composer"
"Packagist"
"Semantic Versioning"
"FlorianWolters · GitHub"
"PHP-FIG — PHP Framework Interop Group"
"PSR-0 requirements for autoloader interoperability"
"PSR-1 basic coding style guide"
"PSR-2 coding style guide"
"PSR-4: Improved Autoloading"
"Travis CI"
"Scrutinizer CI"
"SensioLabsInsight"
"Coveralls"
"VersionEye"
"Depending"
"Waffle"
"HHVM Support in PHP Projects"
"PHP_CodeSniffer"
"PHPUnit"
"sebastianbergmann/phpcpd · GitHub"
"sebastianbergmann/phpdcd · GitHub"
"PHPMD - PHP Mess Detector"
"PHP Depend - Software Metrics for PHP"
"fabpot/sami · GitHub"
"SensioLabs Security Checker"
"satooshi/php-coveralls · GitHub"
"Contributors to FlorianWolters/PHP-Component-Core-HashCode"
"florianwolters/component-core-hashcode - Packagist"
"Application Programming Interface (API) documentation"
"Object (Java Platform SE 7)"
"Java"
"PHP: spl_object_hash - Manual"
"PHP: Type Hinting - Manual"
"FlorianWolters\Component\Core\HashCodeInterface"
"FlorianWolters\Component\Core\HashCodeTrait"
"FlorianWolters\Example\HashCodeExample"
"FlorianWolters\Example\HashCodeDefaultImpl.php"
"FlorianWolters\Example\HashCodeCustomImpl.php"