[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/utilities/ -> string.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: string.php 14401 2010-01-26 14:10:00Z louis $
File Size: 445 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JString:: (20 methods):
  strpos()
  strrpos()
  substr()
  strtolower()
  strtoupper()
  strlen()
  str_ireplace()
  str_split()
  strcasecmp()
  strcspn()
  stristr()
  strrev()
  strspn()
  substr_replace()
  ltrim()
  rtrim()
  trim()
  ucfirst()
  ucwords()
  transcode()


Class: JString  - X-Ref

String handling class for utf-8 data
Wraps the phputf8 library
All functions assume the validity of utf-8 strings.

strpos($str, $search, $offset = FALSE)   X-Ref
UTF-8 aware alternative to strpos
Find position of first occurrence of a string

param: $str - string String being examined
param: $search - string String being searced for
param: $offset - int Optional, specifies the position from which the search should be performed
return: mixed Number of characters before the first match or FALSE on failure

strrpos($str, $search)   X-Ref
UTF-8 aware alternative to strrpos
Finds position of last occurrence of a string

param: $str - string String being examined
param: $search - string String being searced for
return: mixed Number of characters before the last match or FALSE on failure

substr($str, $offset, $length = FALSE)   X-Ref
UTF-8 aware alternative to substr
Return part of a string given character offset (and optionally length)

param: string
param: integer number of UTF-8 characters offset (from left)
param: integer (optional) length in UTF-8 characters from offset
return: mixed string or FALSE if failure

strtolower($str)   X-Ref
UTF-8 aware alternative to strtlower
Make a string lowercase
Note: The concept of a characters "case" only exists is some alphabets
such as Latin, Greek, Cyrillic, Armenian and archaic Georgian - it does
not exist in the Chinese alphabet, for example. See Unicode Standard
Annex #21: Case Mappings

param: string
return: mixed either string in lowercase or FALSE is UTF-8 invalid

strtoupper($str)   X-Ref
UTF-8 aware alternative to strtoupper
Make a string uppercase
Note: The concept of a characters "case" only exists is some alphabets
such as Latin, Greek, Cyrillic, Armenian and archaic Georgian - it does
not exist in the Chinese alphabet, for example. See Unicode Standard
Annex #21: Case Mappings

param: string
return: mixed either string in uppercase or FALSE is UTF-8 invalid

strlen($str)   X-Ref
UTF-8 aware alternative to strlen
Returns the number of characters in the string (NOT THE NUMBER OF BYTES),

param: string UTF-8 string
return: int number of UTF-8 characters in string

str_ireplace($search, $replace, $str, $count = NULL)   X-Ref
UTF-8 aware alternative to str_ireplace
Case-insensitive version of str_replace

param: string string to search
param: string existing string to replace
param: string new string to replace with
param: int optional count value to be passed by referene

str_split($str, $split_len = 1)   X-Ref
UTF-8 aware alternative to str_split
Convert a string to an array

param: string UTF-8 encoded
param: int number to characters to split string by
return: array

strcasecmp($str1, $str2)   X-Ref
UTF-8 aware alternative to strcasecmp
A case insensivite string comparison

param: string string 1 to compare
param: string string 2 to compare
return: int < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.

strcspn($str, $mask, $start = NULL, $length = NULL)   X-Ref
UTF-8 aware alternative to strcspn
Find length of initial segment not matching mask

param: string
param: string the mask
param: int Optional starting character position (in characters)
param: int Optional length
return: int the length of the initial segment of str1 which does not contain any of the characters in str2

stristr($str, $search)   X-Ref
UTF-8 aware alternative to stristr
Returns all of haystack from the first occurrence of needle to the end.
needle and haystack are examined in a case-insensitive manner
Find first occurrence of a string using case insensitive comparison

param: string the haystack
param: string the needle
return: string the sub string

strrev($str)   X-Ref
UTF-8 aware alternative to strrev
Reverse a string

param: string String to be reversed
return: string The string in reverse character order

strspn($str, $mask, $start = NULL, $length = NULL)   X-Ref
UTF-8 aware alternative to strspn
Find length of initial segment matching mask

param: string the haystack
param: string the mask
param: int start optional
param: int length optional

substr_replace($str, $repl, $start, $length = NULL )   X-Ref
UTF-8 aware substr_replace
Replace text within a portion of a string

param: string the haystack
param: string the replacement string
param: int start
param: int length (optional)

ltrim( $str, $charlist = FALSE )   X-Ref
UTF-8 aware replacement for ltrim()
Strip whitespace (or other characters) from the beginning of a string
Note: you only need to use this if you are supplying the charlist
optional arg and it contains UTF-8 characters. Otherwise ltrim will
work normally on a UTF-8 string

param: string the string to be trimmed
param: string the optional charlist of additional characters to trim
return: string the trimmed string

rtrim( $str, $charlist = FALSE )   X-Ref
UTF-8 aware replacement for rtrim()
Strip whitespace (or other characters) from the end of a string
Note: you only need to use this if you are supplying the charlist
optional arg and it contains UTF-8 characters. Otherwise rtrim will
work normally on a UTF-8 string

param: string the string to be trimmed
param: string the optional charlist of additional characters to trim
return: string the trimmed string

trim( $str, $charlist = FALSE )   X-Ref
UTF-8 aware replacement for trim()
Strip whitespace (or other characters) from the beginning and end of a string
Note: you only need to use this if you are supplying the charlist
optional arg and it contains UTF-8 characters. Otherwise trim will
work normally on a UTF-8 string

param: string the string to be trimmed
param: string the optional charlist of additional characters to trim
return: string the trimmed string

ucfirst($str)   X-Ref
UTF-8 aware alternative to ucfirst
Make a string's first character uppercase

param: string
return: string with first character as upper case (if applicable)

ucwords($str)   X-Ref
UTF-8 aware alternative to ucwords
Uppercase the first character of each word in a string

param: string
return: string with first char of each word uppercase

transcode($source, $from_encoding, $to_encoding)   X-Ref
Transcode a string.

param: string $source The string to transcode.
param: string $from_encoding The source encoding.
param: string $to_encoding The target encoding.
return: string Transcoded string



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1