Page MenuHomeWickedGov Phorge
Files F4152817

WrappedString.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

WrappedString.php
View Options

<?php
/**
* Copyright 2015 Timo Tijhof
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* @file
*/
namespace Wikimedia;
use DomainException;
class WrappedString {
/** @var string */
protected $value;
/** @var string|null */
protected $prefix;
/** @var string|null */
protected $suffix;
/**
* @param string $value
* @param string|null $prefix
* @param string|null $suffix
*/
public function __construct( $value, $prefix = null, $suffix = null ) {
$prefixlen = strlen( $prefix );
if ( $prefixlen && substr( $value, 0, $prefixlen ) !== $prefix ) {
throw new DomainException( 'Prefix must match value' );
}
$suffixlen = strlen( $suffix );
if ( $suffixlen && substr( $value, -$suffixlen ) !== $suffix ) {
throw new DomainException( 'Suffix must match value' );
}
$this->value = $value;
$this->prefix = $prefix;
$this->suffix = $suffix;
}
/**
* @param string $value Value of a WrappedString with the same prefix and suffix
* @return WrappedString Newly wrapped string
*/
protected function extend( $value ) {
$wrap = clone $this;
$suffixlen = strlen( $this->suffix );
// Remove the suffix (temporarily), to open the string for merging.
if ( $suffixlen ) {
$wrap->value = substr( $this->value, 0, -$suffixlen );
}
// Append the next value without prefix, thus ending with the suffix again.
$prefixlen = strlen( $this->prefix );
$wrap->value .= substr( $value, $prefixlen );
return $wrap;
}
/**
* Merge consecutive WrappedString objects with the same prefix and suffix.
*
* Does not modify the array or the WrappedString objects.
*
* NOTE: This is an internal method. Use join() or WrappedStringList instead.
*
* @param (string|WrappedString|WrappedStringList)[] $wraps
* @return string[] Compacted list to be treated as strings
* (may contain WrappedString and WrappedStringList objects)
*/
public static function compact( array $wraps ) {
$consolidated = [];
if ( $wraps === [] ) {
// Return early so that we don't have to deal with $prev being
// set or not set, and avoid risk of adding $prev's initial null
// value to the list as extra value (T196496).
return $consolidated;
}
$first = true;
$prev = null;
foreach ( $wraps as $wrap ) {
if ( $first ) {
$first = false;
$prev = $wrap;
continue;
}
if ( $prev instanceof WrappedString
&& $wrap instanceof WrappedString
&& $prev->prefix !== null
&& $prev->prefix === $wrap->prefix
&& $prev->suffix !== null
&& $prev->suffix === $wrap->suffix
) {
$prev = $prev->extend( $wrap->value );
} else {
$consolidated[] = $prev;
$prev = $wrap;
}
}
// Add last one
$consolidated[] = $prev;
return $consolidated;
}
/**
* Join several wrapped strings with a separator between each.
*
* This method is compatibile with native PHP implode(). The actual join
* operation is deferred to WrappedStringList::__toString(). This allows
* callers to collect multiple lists and compact them together.
*
* @param string $sep
* @param (string|WrappedString|WrappedStringList)[] $wraps
* @return WrappedStringList
*/
public static function join( $sep, array $wraps ) {
return new WrappedStringList( $sep, $wraps );
}
/** @return string */
public function __toString() {
return $this->value;
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 20:29 (7 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
14/97/9b3d44d203e584bc6d1439e16d45
Default Alt Text
WrappedString.php (4 KB)

Event Timeline