From 7518de09980d7020b4e54b205012b2aaabd0056e Mon Sep 17 00:00:00 2001 From: akagisho Date: Sun, 2 Sep 2012 14:56:34 +0900 Subject: [PATCH] Update classes/str.html --- classes/str.html | 334 +++++++++++++++++++++++------------------------ 1 file changed, 167 insertions(+), 167 deletions(-) diff --git a/classes/str.html b/classes/str.html index a5329752c..2cceb867b 100644 --- a/classes/str.html +++ b/classes/str.html @@ -45,13 +45,13 @@

-

Str Class

+

Str クラス

-

The str class is a set of methods to help with the manipulation of strings.

+

str クラスは、文字列の操作を手助けするメソッドの集合です。

increment($str, $first = 1)

-

The increment method allows you to append a number to the end of a string or increment that number if it already exists.

+

increment メソッドは、文字列の後ろに数字を付加したり、既に数字が付いている場合はそれに 1 加算します。

@@ -59,42 +59,42 @@

increment($str, $first = 1)

- + - + - + @@ -104,7 +104,7 @@

increment($str, $first = 1)

random($type = 'alnum', $length = 8)

-

The random method generates a random string based on the type given.

+

random メソッドは、type で指定された文字種のランダムな文字列を生成します。

Yes
Parametersパラメータ - - - + + + - - + + - +
ParamDefaultDescriptionパラメータ規定値説明
$stringrequiredThe string to increment.必須対象の文字列
$first 
1
The first number to increment with.加算を開始する最初の番号
Returns返り値 string
Example例 
$string = "filename";
-Str::increment($string); // returns filename_1
+Str::increment($string); // 返り値: filename_1
 
 $string = "filename_1";
-Str::increment($string); // returns filename_2
+Str::increment($string); // 返り値: filename_2
 
 $string = "filename";
-Str::increment($string, 3); // returns filename_3
+Str::increment($string, 3); // 返り値: filename_3
@@ -112,63 +112,63 @@

random($type = 'alnum', $length = 8)

- + - + - + @@ -179,7 +179,7 @@

random($type = 'alnum', $length = 8)

truncate($string, $limit, $continuation = '...', $is_html = false)

-

The truncate method allows you to limit characters and provide a continuation string without breaking html.

+

truncate メソッドは、文字列を指定した長さで切り詰めます。文字列が HTML を含む場合は、それを破壊しないようにすることもできます。

Yes
Parametersパラメータ - - - + + + - + - +
ParamDefaultDescriptionパラメータ規定値説明
$type alnumThe type of string to generate. Your choices are alnum, numeric, nozero, alpha, distinct, hexdec, unique, and sha1.生成する文字列の文字種。(選択肢: alnum, numeric, nozero, alpha, distinct, hexdec, unique, sha1)
$length 
16
The number of characters you would like the final string to be (unique and sha1 ignore this parameter).生成する文字列の長さ。 (unique と sha1 の場合は無視します)
Returns返り値 string
Example例 - 
// alnum (uppercase and lowercase letters mixed with numbers)
+								
// alnum (アルファベット大文字、小文字、数字)
 Str::random('alnum', 16);
 // Returns: SvZi9Dh3lq7zQYim
 
-// numeric (just numbers)
+// numeric (数字のみ)
 Str::random('numeric', 16);
 // Returns: 1045343964672481
 
-// nozero (just numbers excluding zero)
+// nozero (0 を除いた数字)
 Str::random('nozero', 16);
 // Returns: 3244623373994515
 
-// alpha (just uppercase and lowercase letters)
+// alpha (アルファベット大文字と小文字)
 Str::random('alpha', 16);
 // Returns: LuVAXbmxQbbWoYqz
 
-// distinct (uppercase letters and numbers that cannot be confused)
+// distinct (読み間違えづらいアルファベット大文字と数字)
 Str::random('distinct', 16);
 // Returns: R79MPKMH4KTRN35J
 
-// hexdec (hexadecimal characters a-f, 0-9)
+// hexdec (16進数の文字列: a-f, 0-9)
 Str::random('hexdec', 16);
 // Returns: 09c34e42f36547f8
 
-// unique (32 character string based on md5)
+// unique (md5 を基にした32文字の文字列)
 Str::random('unique');
 // Returns: ed4bb844a35b7a4edb7eed0d3795d328
 
-// sha1 (40 character string based on sha1)
+// sha1 (sha1 を基にした40文字の文字列)
 Str::random('sha1');
 // Returns: af5c5a8cc3be9a3180205c1ed2975015cd6cf1e7
@@ -187,49 +187,49 @@

truncate($string, $limit, $continuation

- + - + - + @@ -249,28 +249,28 @@

alternator(*$args)

- + - + - +
Yes
Parametersパラメータ - - - + + + - - + + - - + + - + - +
ParamDefaultDescriptionパラメータ規定値説明
$stringrequiredThe string to truncate.必須切り詰める文字列
$limitrequiredThe number of characters to allow in the string.必須文字列の最大長 (文字列の長さがこの値を超えると切り詰める)
$continuation 
'...'
The string to append to the end of the truncated string.切り詰めた文字列の末尾に付加する文字列
$is_html 
false
If the string contains html. Setting this as true will make the method not break html.文字列が HTML を含む場合、この引数を true にすると、このメソッドは HTML タグを破壊しません。
Returns返り値 string
Example例 
$string = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.";
-Str::truncate($string, 15); // returns Lorem ipsum dol...
+Str::truncate($string, 15); // 返り値: Lorem ipsum dol...
 
 $string = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.";
-Str::truncate($string, 15, '...Read More'); // returns Lorem ipsum dol...Read More
+Str::truncate($string, 15, '...Read More'); // 返り値: Lorem ipsum dol...Read More
Yes
Parametersパラメータ - - - + + + - +
ParamDefaultDescriptionパラメータ規定値説明
*$argsrequired必須 As many arguments as you need to alternate
Returns返り値 Closure
Example例 
$alt = Str::alternator('one', 'two', 'three', 'four');
 echo $alt(); // outputs 'one'
@@ -288,7 +288,7 @@ 
alternator(*$args)

 
 			

 				
upper($str, $encoding = null)

-				
The upper method converts all characters to uppercase. It is equivalent to PHP's strtoupper() for your specific character encoding.

+				
upper メソッドは、すべてのアルファベットを大文字に変換します。特定の文字のエンコーディングについては、PHP の strtoupper() と同等です。

 				
@@ -296,38 +296,38 @@ 
upper($str, $encoding = null)

-							
+							
-							
+							
-							
+							
@@ -336,7 +336,7 @@ 
upper($str, $encoding = null)

 				
lower($str, $encoding = null)

-				
The lower method converts all characters to lowercase. It is equivalent to PHP's strtolower() for your specific character encoding.

+				
lower メソッドは、すべてのアルファベットを小文字に変換します。特定の文字のエンコーディングについては、PHP の strtoupper() と同等です。

 				

 					
 						

 							Yes
 						

 						
Parametersパラメータ
 							
 								
-										
-										
-										
-										
+										
+										
+										
+										
-										
-										
+										
+										
-										
+										

 									
ParamTypeDefaultDescriptionパラメータ型規定値説明
 									

 									

 										$string
 										stringRequiredThe input string.必須入力文字列
 									

 									

 										$encoding
 										string
 										
null
The character encoding.文字エンコーディング
 									

 								

 									
 						

 						
Returns返り値
 							string
 						

 						
Example例
 							
-								
Str::upper('User Data'); // returns 'USER DATA'

+								
Str::upper('User Data'); // 返り値: 'USER DATA'

 									
 						

 					
 
 			

@@ -344,38 +344,38 @@ 
lower($str, $encoding = null)

-							
+							
-							
+							
-							
+							
@@ -384,7 +384,7 @@ 
lower($str, $encoding = null)

 				
tr($string, $array = array())

-				
The tr method parse the params from given string using PHP's strtr().

+				
tr メソッドは、PHP の strtr() を用いて、与えられた文字列からパラメータをパースします。

 				

 					
 						

 							Yes
 						

 						
Parametersパラメータ
 							
 								
-										
-										
-										
-										
+										
+										
+										
+										
-										
-										
+										
+										
-										
+										

 									
ParamTypeDefaultDescriptionパラメータ型規定値説明
 									

 									

 										$string
 										stringRequiredThe input string.必須入力文字列
 									

 									

 										$encoding
 										string
 										
null
The character encoding.文字エンコーディング
 									

 								

 									
 						

 						
Returns返り値
 							string
 						

 						
Example例
 							
-								
Str::lower('User Data'); // returns 'user data'

+								
Str::lower('User Data'); // 返り値: 'user data'

 									
 						

 					
 
 			

@@ -392,38 +392,38 @@ 
tr($string, $array = array())

-							
+							
-							
+							
-							
+							
@@ -432,7 +432,7 @@ 
tr($string, $array = array())

 				
is_json($string)

-				
The is_json method check if a string is json encoded.

+				
is_json メソッドは、文字列が json エンコードされているかチェックします。

 				

 					
 						

 							Yes
 						

 						
Parametersパラメータ
 							
 								
-										
-										
-										
-										
+										
+										
+										
+										
-										
-										
+										
+										
-										
+										

 									
ParamTypeDefaultDescriptionパラメータ型規定値説明
 									

 									

 										$string
 										stringRequiredThe input string.必須入力文字列
 									

 									

 										$array
 										array
 										
array()
params to str_replace.str_replace に渡すパラメータ
 									

 								

 									
 						

 						
Returns返り値
 							string
 						

 						
Example例
 							
-								
Str::tr('Hello :name', array('name' => 'World')); // returns 'Hello World'

+								
Str::tr('Hello :name', array('name' => 'World')); // 返り値: 'Hello World'

 									
 						

 					
 
 			

@@ -440,32 +440,32 @@ 
is_json($string)

-							
+							
-							
+							
-							
+							
@@ -474,7 +474,7 @@ 
is_json($string)

 				
is_serialized($string)

-				
The is_serialized method check if a string is serialized.

+				
is_serialized メソッドは、文字列が PHP シリアライズされているかチェックします。

 				

 					
 						

 							Yes
 						

 						
Parametersパラメータ
 							
 								
-										
-										
-										
-										
+										
+										
+										
+										
-										
-										
+										
+										

 									
ParamTypeDefaultDescriptionパラメータ型規定値説明
 									

 									

 										$string
 										stringRequiredThe input string.必須入力文字列
 									

 								

 									
 						

 						
Returns返り値
 							bool
 						

 						
Example例
 							
-								
Str::is_json('{"0":"An","encoded":["string"]}'); // returns true

+								
Str::is_json('{"0":"An","encoded":["string"]}'); // 返り値: true

 									
 						

 					
 
 			

@@ -482,33 +482,33 @@ 
is_serialized($string)

-							
+							
-							
+							
-							
+							
@@ -517,7 +517,7 @@ 
is_serialized($string)

 				
is_html($string)

-				
The is_html method check if a string is html.

+				
is_html メソッドは、文字列が HTML かチェックします。

 				

 					
 						

 							Yes
 						

 						
Parametersパラメータ
 							
 								
-										
-										
-										
-										
+										
+										
+										
+										
-										
-										
+										
+										

 									
ParamTypeDefaultDescriptionパラメータ型規定値説明
 									

 									

 										$string
 										stringRequiredThe input string.必須入力文字列
 									

 								

 									
 						

 						
Returns返り値
 							bool
 						

 						
Example例
 							
 								
Str::is_serialized('a:2:{i:0;s:2:"An";s:7:"encoded";a:1:{i:0;s:6:"string";}}');
-// returns true

+// 返り値: true
 									
 						

 					
 
 			

@@ -525,33 +525,33 @@ 
is_html($string)

-							
+							
-							
+							
-							
+							
@@ -560,7 +560,7 @@ 
is_html($string)

 				
starts_with($str, $start, $ignore_case = false)

-				
The starts_with method checks wether a string has a precific beginning.

+				
starts_with メソッドは、文字列が指定した文字列で始まっているかチェックします。

 				

 					
 						

 							Yes
 						

 						
Parametersパラメータ
 							
 								
-										
-										
-										
-										
+										
+										
+										
+										
-										
-										
+										
+										

 									
ParamTypeDefaultDescriptionパラメータ型規定値説明
 									

 									

 										$string
 										stringRequiredThe input string.必須入力文字列
 									

 								

 									
 						

 						
Returns返り値
 							bool
 						

 						
Example例
 							
 								
Str::is_html('Lorem ipsum <b>dolor sit amet</b>, consectetur <u>adipiscing</u> elit.');
-// returns true

+// 返り値: true
 									
 						

 					
 
 			

@@ -568,44 +568,44 @@ 
starts_with($str, $start, $ignore_cas
 							

-							
+							
-							
+							
-							
+							
@@ -615,7 +615,7 @@ 
starts_with($str, $start, $ignore_cas
 
 			

 				
ends_with($str, $end, $ignore_case = false)

-				
The ends_with method checks wether a string has a precific ending.

+				
ends_with メソッドは、文字列が指定した文字列で終わっているかチェックします。

 				

 					
 						
Yes
 						

 						
Parametersパラメータ
 							
 								
-										
-										
-										
+										
+										
+										
-										
-										
+										
+										
-										
-										
+										
+										
-										
+										

 									
ParamDefaultDescriptionパラメータ規定値説明
 									

 									

 										$strrequiredThe string to check.必須チェック対象の文字列
 									

 									

 										$startrequiredThe beginning to check for.必須この文字列で始まっているか
 									

 									

 										$ignore_case
 										
false
Wether to ignore the case.大文字小文字を無視するかどうか
 									

 								

 									
 						

 						
Returns返り値
 							bool
 						

 						
Example例
 							
 								
$string = "Lorem ipsum dolor sit amet";
 
-Str::starts_with($string, 'Lorem'); // returns true
-Str::starts_with($string, 'lorem'); // returns false
-Str::starts_with($string, 'lorem', true); // returns true
+Str::starts_with($string, 'Lorem'); // 返り値: true
+Str::starts_with($string, 'lorem'); // 返り値: false
+Str::starts_with($string, 'lorem', true); // 返り値: true
 

 									
 						

@@ -623,44 +623,44 @@ 
ends_with($str, $end, $ignore_case = fa
 							

-							
+							
-							
+							
-							
+							
@@ -670,7 +670,7 @@ 
ends_with($str, $end, $ignore_case = fa
 
 			

 				
sub($str, $start, $length = null, $encoding = null)

-				
The sub method returns the portion of the string specified. It is equivalent to PHP's substr() for your specific character encoding.

+				
sub メソッドは、指定された文字列の一部分を返します。特定の文字のエンコーディングについては、PHP の substr() と同等です。

 				

 					
 						
Yes
 						

 						
Parametersパラメータ
 							
 								
-										
-										
-										
+										
+										
+										
-										
-										
+										
+										
-										
-										
+										
+										
-										
+										

 									
ParamDefaultDescriptionパラメータ規定値説明
 									

 									

 										$strrequiredThe string to check.必須チェック対象の文字列
 									

 									

 										$endrequiredThe ending to check for.必須この文字列で終わっているか
 									

 									

 										$ignore_case
 										
false
Wether to ignore the case.大文字小文字を無視するかどうか
 									

 								

 									
 						

 						
Returns返り値
 							bool
 						

 						
Example例
 							
 								
$string = "Lorem ipsum dolor sit amet";
 
-Str::ends_with($string, 'amet'); // returns true
-Str::ends_with($string, 'Amet'); // returns false
-Str::ends_with($string, 'Amet', true); // returns true
+Str::ends_with($string, 'amet'); // 返り値: true
+Str::ends_with($string, 'Amet'); // 返り値: false
+Str::ends_with($string, 'Amet', true); // 返り値: true
 

 									
 						

@@ -678,45 +678,45 @@ 
sub($str, $start, $length = null, $encoding =
 							

-							
+							
-							
+							
-							
+							

 					
 						
Yes
 						

 						
Parametersパラメータ
 							
 								
-										
-										
-										
+										
+										
+										
-										
-										
+										
+										
-										
-										
+										
+										
-										
+										
-										
+										

 									
ParamDefaultDescriptionパラメータ規定値説明
 									

 									

 										$strrequiredThe input string.必須入力文字列
 									

 									

 										$startrequiredPosition of first character. See php.net for detailed usage.必須開始位置 (詳細は php.net を参照してください)
 									

 									

 										$length
 										
null
Maximum number of characters. See php.net for detailed usage.文字数の最大値 (詳細は php.net を参照してください)
 									

 									

 										$encoding
 										
null
The character encoding.文字エンコーディング
 									

 								

 									
 						

 						
Returns返り値
 							string
 						

 						
Example例
 							
-								
Str::sub('User Data', 3, -1); // returns 'r Dat'

+								
Str::sub('User Data', 3, -1); // 返り値: 'r Dat'