PHP array_pad() Function

कई बार हमें ऐसी जरूरत पडती है कि हम किसी Array के विभिन्न Elements को समान Values से Fill करना चाहते हैं। इस जरूरत को पूरा करने के लिये PHP हमें array_pad() नाम का Built-In Function Provide करता है।

ये Function Argument के रूप में तीन Parameters Accept करता है। पहला Parameter वह Array होता है, जिसकी शुरूआत अथवा अन्त में किसी मान को Fill करना है। दूसरा Parameter Return होने वाले नए Array के कुल Elements की संख्‍या को Represent करता है जबकि तीसरा Parameter उस मान को Represent करता है, जिसे Fill करना है।  इस Function को हम निम्नानुसार Use कर सकते हैं:

<?php
	$cities = array('Bali', 'Falna', 'Rani', 'Pali');

	$addedCities = array_pad($cities, 7, 'Unknown');
	
	print_r($addedCities); 
?>

//Output
Array
(
    [0] => Bali
    [1] => Falna
    [2] => Rani
    [3] => Pali
    [4] => Unknown
    [5] => Unknown
    [6] => Unknown
)

उपरोक्त उदाहरण में हमने $cities नाम का एक Array बनाया है और उसके अन्त में हमने तीन “Unknown” Cities को Add किया है।

पहले Argument के रूप में हमने array_pad() Function में $cities Array को Pass किया है, क्योंकि हम इसी Array के अन्त में तीन और Unknown Cities के “Unknown” String को Pad करना चाहते हैं।

दूसरे Argument के रूप में हमने Value 7 Specify की है, क्योंकि हम Create होने वाले नए Array में कुल 7 Cities के नाम चाहते हैं, जिनमें पहले चार नाम $cities नाम के Array से ही आऐंगे, जबकि तीन नए नामों के लिए बनने वाले Space में “Unknown” String Store हो जाएगा।

तीसरे Argument के रूप में हमने “Unknown” मान Specify किया है। ये वही मान है, जिसे हम Create होने वाले तीन नए Space में Store करना चाहते हैं।

हम देख सकते हैं कि Array में Pad होने वाली सभी नई Strings Array के अन्त में Add हो रही हैं। यदि हम चाहते हैं, कि ये Strings Array की शुरूआत में Pad हो, तो हमें array_pad() Function के दूसरे Argument को Negative Value के रूप में Specify करना होगा। यानी हमारा उपरोक्त Program निम्नानुसार बनेगाः

<?php
	$cities = array('Bali', 'Falna', 'Rani', 'Pali');

	$addedCities = array_pad($cities, -7, 'Unknown');
	
	print_r($addedCities); 
?>

//Output
Array
(
    [0] => Unknown
    [1] => Unknown
    [2] => Unknown
    [3] => Bali
    [4] => Falna
    [5] => Rani
    [6] => Pali
)

ऐसा जरूरी नहीं है कि array_pad() Function के तीसरे Argument के रूप में हम किसी String को ही Specify कर सकते हैं, बल्कि हम किसी भी प्रकार के Data Type के मान को तीसरे Argument के रूप में Specify कर सकते हैं। हम जिस भी प्रकार के मान को तीसरे Argument के रूप में Specify करते हैं, वही मान Create होने वाले Array की शुरूआत या अन्त में Pad हो जाता है।

जब हम किसी Associative Array के साथ इस array_pad() Function को Use करते हैं, तब PHP Array के Key व Value Pair को सुरक्षित रखता है और Pad होने वाले नए Elements के लिए Zero Based Indexing Number Assign कर देता है। जैसेः

<?php
	$cities = array('city1'=>'Bali', 'city2'=>'Falna', 'city3'=>'Rani', 'city4'=>'Pali');

	$addedCities = array_pad($cities, 7, 'Unknown');
	
	print_r($addedCities); 
?>

//Output
Array
(
    [city1] => Bali
    [city2] => Falna
    [city3] => Rani
    [city4] => Pali
    [0] => Unknown
    [1] => Unknown
    [2] => Unknown
)